diff --git a/src/main/java/org/gitlab4j/api/AwardEmojiApi.java b/src/main/java/org/gitlab4j/api/AwardEmojiApi.java index a38b1d7c22232fc17c31e220cc01e09f7d15ec93..5e1ce181e5b76579a4457362fc2a13645a084102 100644 --- a/src/main/java/org/gitlab4j/api/AwardEmojiApi.java +++ b/src/main/java/org/gitlab4j/api/AwardEmojiApi.java @@ -9,7 +9,7 @@ import org.gitlab4j.api.models.AwardEmoji; /** * This class implements the client side API for the GitLab Award Emoji API calls. - * + * * @see GitLab Award Emoji API Documentaion * @since v4.8.31 */ @@ -68,7 +68,24 @@ public class AwardEmojiApi extends AbstractApi { } /** - * Get a list of award emoji for the specified note. + * Get a list of award emoji for the specified issue note. + * + *
GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji
+ *
+ * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
+ * @param issueIid the issue IID of the issue that owns the note
+ * @param noteId the note ID to get the award emojis for
+ * @return a list of AwardEmoji for the specified note
+ * @throws GitLabApiException if any exception occurs
+ */
+ public ListGitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji
*
@@ -79,8 +96,23 @@ public class AwardEmojiApi extends AbstractApi {
* @throws GitLabApiException if any exception occurs
*/
public ListGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji
+ *
+ * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
+ * @param mergeRequestIid the merge request IID of the merge request that owns the note
+ * @param noteId the note ID to get the award emojis for
+ * @return a list of AwardEmoji for the specified note
+ * @throws GitLabApiException if any exception occurs
+ */
+ public ListGitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id
*
@@ -144,12 +176,48 @@ public class AwardEmojiApi extends AbstractApi {
* @param issueIid the issue IID of the issue that owns the note
* @param noteId the note ID to get the award emoji from
* @param awardId the ID of the award emoji to get
- * @return an AwardEmoji instance for the specified award emoji
+ * @return an AwardEmoji instance for the specified award emoji
* @throws GitLabApiException if any exception occurs
*/
+ public AwardEmoji getIssueNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, Integer awardId) throws GitLabApiException {
+ Response response = get(Response.Status.OK, getPageQueryParams(1, getDefaultPerPage()),
+ "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji", awardId);
+ return (response.readEntity(AwardEmoji.class));
+ }
+
+ /**
+ * Get the specified award emoji for the specified issue note.
+ *
+ * GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id
+ *
+ * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
+ * @param issueIid the issue IID of the issue that owns the note
+ * @param noteId the note ID to get the award emoji from
+ * @param awardId the ID of the award emoji to get
+ * @return an AwardEmoji instance for the specified award emoji
+ * @throws GitLabApiException if any exception occurs
+ * @deprecated use {@link #getIssueNoteAwardEmoji(Object, Integer, Integer, Integer)} instead
+ */
+ @Deprecated
public AwardEmoji getNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, Integer awardId) throws GitLabApiException {
+ return getIssueNoteAwardEmoji(projectIdOrPath, issueIid, noteId, awardId);
+ }
+
+ /**
+ * Get the specified award emoji for the specified merge request note.
+ *
+ * GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id
+ *
+ * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
+ * @param mergeRequestIid the merge request IID of the merge request that owns the note
+ * @param noteId the note ID to get the award emoji from
+ * @param awardId the ID of the award emoji to get
+ * @return an AwardEmoji instance for the specified award emoji
+ * @throws GitLabApiException if any exception occurs
+ */
+ public AwardEmoji getMergeRequestNoteAwardEmoji(Object projectIdOrPath, Integer mergeRequestIid, Integer noteId, Integer awardId) throws GitLabApiException {
Response response = get(Response.Status.OK, getPageQueryParams(1, getDefaultPerPage()),
- "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji", awardId);
+ "projects", getProjectIdOrPath(projectIdOrPath), "merge_requests", mergeRequestIid, "notes", noteId, "award_emoji", awardId);
return (response.readEntity(AwardEmoji.class));
}
@@ -161,7 +229,7 @@ public class AwardEmojiApi extends AbstractApi {
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param issueIid the issue IID to add the award emoji to
* @param name the name of the award emoji to add
- * @return an AwardEmoji instance for the added award emoji
+ * @return an AwardEmoji instance for the added award emoji
* @throws GitLabApiException if any exception occurs
*/
public AwardEmoji addIssueAwardEmoji(Object projectIdOrPath, Integer issueIid, String name) throws GitLabApiException {
@@ -179,7 +247,7 @@ public class AwardEmojiApi extends AbstractApi {
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param mergeRequestIid the merge request IID to add the award emoji to
* @param name the name of the award emoji to add
- * @return an AwardEmoji instance for the added award emoji
+ * @return an AwardEmoji instance for the added award emoji
* @throws GitLabApiException if any exception occurs
*/
public AwardEmoji addMergeRequestAwardEmoji(Object projectIdOrPath, Integer mergeRequestIid, String name) throws GitLabApiException {
@@ -197,7 +265,7 @@ public class AwardEmojiApi extends AbstractApi {
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param snippetId the snippet ID to add the award emoji to
* @param name the name of the award emoji to add
- * @return an AwardEmoji instance for the added award emoji
+ * @return an AwardEmoji instance for the added award emoji
* @throws GitLabApiException if any exception occurs
*/
public AwardEmoji addSnippetAwardEmoji(Object projectIdOrPath, Integer snippetId, String name) throws GitLabApiException {
@@ -208,7 +276,7 @@ public class AwardEmojiApi extends AbstractApi {
}
/**
- * Add an award emoji for the specified note.
+ * Add an award emoji for the specified issue note.
*
* GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:noteId/award_emoji
*
@@ -216,13 +284,50 @@ public class AwardEmojiApi extends AbstractApi {
* @param issueIid the issue IID of the issue that owns the note
* @param noteId the note ID to add the award emoji to
* @param name the name of the award emoji to add
- * @return an AwardEmoji instance for the added award emoji
+ * @return an AwardEmoji instance for the added award emoji
* @throws GitLabApiException if any exception occurs
*/
+ public AwardEmoji addIssueNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, String name) throws GitLabApiException {
+ GitLabApiForm form = new GitLabApiForm().withParam("name", name, true);
+ Response response = post(Response.Status.CREATED, form.asMap(),
+ "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji");
+ return (response.readEntity(AwardEmoji.class));
+ }
+
+ /**
+ * Add an award emoji for the specified issue note.
+ *
+ * GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:noteId/award_emoji
+ *
+ * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
+ * @param issueIid the issue IID of the issue that owns the note
+ * @param noteId the note ID to add the award emoji to
+ * @param name the name of the award emoji to add
+ * @return an AwardEmoji instance for the added award emoji
+ * @throws GitLabApiException if any exception occurs
+ * @deprecated use {@link #addIssueNoteAwardEmoji(Object, Integer, Integer, String)}
+ */
+ @Deprecated
public AwardEmoji addNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, String name) throws GitLabApiException {
+ return addIssueNoteAwardEmoji(projectIdOrPath, issueIid, noteId, name);
+ }
+
+ /**
+ * Add an award emoji for the specified merge request note.
+ *
+ * GitLab Endpoint: POST /projects/:id/merge_requests/:merge_request_iid/notes/:noteId/award_emoji
+ *
+ * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
+ * @param mergeRequestIid the merge request IID of the merge request that owns the note
+ * @param noteId the note ID to add the award emoji to
+ * @param name the name of the award emoji to add
+ * @return an AwardEmoji instance for the added award emoji
+ * @throws GitLabApiException if any exception occurs
+ */
+ public AwardEmoji addMergeRequestAwardEmoji(Object projectIdOrPath, Integer mergeRequestIid, Integer noteId, String name) throws GitLabApiException {
GitLabApiForm form = new GitLabApiForm().withParam("name", name, true);
Response response = post(Response.Status.CREATED, form.asMap(),
- "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji");
+ "projects", getProjectIdOrPath(projectIdOrPath), "merge_requests", mergeRequestIid, "notes", noteId, "award_emoji");
return (response.readEntity(AwardEmoji.class));
}
@@ -269,10 +374,26 @@ public class AwardEmojiApi extends AbstractApi {
public void deleteSnippetAwardEmoji(Object projectIdOrPath, Integer snippetId, Integer awardId) throws GitLabApiException {
delete(Response.Status.NO_CONTENT, null,
"projects", getProjectIdOrPath(projectIdOrPath), "snippets", snippetId, "award_emoji", awardId);
- }
+ }
+
+ /**
+ * Delete an award emoji from the specified issue note.
+ *
+ * GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id
+ *
+ * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
+ * @param issueIid the issue IID that owns the note
+ * @param noteId the note ID of the note to delete the award emoji from
+ * @param awardId the ID of the award emoji to delete
+ * @throws GitLabApiException if any exception occurs
+ */
+ public void deleteIssueNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, Integer awardId) throws GitLabApiException {
+ delete(Response.Status.NO_CONTENT, null,
+ "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji", awardId);
+ }
/**
- * Delete an award emoji from the specified note.
+ * Delete an award emoji from the specified issue note.
*
* GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id
*
@@ -281,9 +402,26 @@ public class AwardEmojiApi extends AbstractApi {
* @param noteId the note ID of the note to delete the award emoji from
* @param awardId the ID of the award emoji to delete
* @throws GitLabApiException if any exception occurs
+ * @deprecated use {@link #deleteIssueNoteAwardEmoji(Object, Integer, Integer, Integer)} instead
*/
+ @Deprecated
public void deleteNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, Integer awardId) throws GitLabApiException {
+ deleteIssueNoteAwardEmoji(projectIdOrPath, issueIid, noteId, awardId);
+ }
+
+ /**
+ * Delete an award emoji from the specified merge request note.
+ *
+ * GitLab Endpoint: DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id
+ *
+ * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
+ * @param mergeRequestIid the merge request IID of the merge request that owns the note
+ * @param noteId the note ID of the note to delete the award emoji from
+ * @param awardId the ID of the award emoji to delete
+ * @throws GitLabApiException if any exception occurs
+ */
+ public void deleteMergeRequestNoteAwardEmoji(Object projectIdOrPath, Integer mergeRequestIid, Integer noteId, Integer awardId) throws GitLabApiException {
delete(Response.Status.NO_CONTENT, null,
- "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji", awardId);
+ "projects", getProjectIdOrPath(projectIdOrPath), "merge_requests", mergeRequestIid, "notes", noteId, "award_emoji", awardId);
}
}