Fix #767 : Adding merge request note award functions and renaming issue functions

Author: didacarbones

src/main/java/org/gitlab4j/api/AwardEmojiApi.java

@@ -9,7 +9,7 @@
 
 /**
  * This class implements the client side API for the GitLab Award Emoji API calls.
- * 
+ *
  * @see <a href="https://docs.gitlab.com/ce/api/award_emoji.html">GitLab Award Emoji API Documentaion</a>
  * @since v4.8.31
  */
@@ -68,7 +68,7 @@ public List<AwardEmoji> getSnippetAwardEmojis(Object projectIdOrPath, Integer sn
     }
 
     /**
-     * Get a list of award emoji for the specified note.
+     * Get a list of award emoji for the specified issue note.
      *
      * <pre><code>GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji</code></pre>
      *
@@ -78,9 +78,26 @@ public List<AwardEmoji> getSnippetAwardEmojis(Object projectIdOrPath, Integer sn
      * @return a list of AwardEmoji for the specified note
      * @throws GitLabApiException if any exception occurs
      */
-    public List<AwardEmoji> getNoteAwardEmojis(Object projectIdOrPath, Integer issueIid, Integer noteId) throws GitLabApiException {
+    public List<AwardEmoji> getIssueNoteAwardEmojis(Object projectIdOrPath, Integer issueIid, Integer noteId) throws GitLabApiException {
         Response response = get(Response.Status.OK, getPageQueryParams(1, getDefaultPerPage()),
-                "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji");
+            "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji");
+        return response.readEntity(new GenericType<List<AwardEmoji>>() {});
+    }
+
+    /**
+     * Get a list of award emoji for the specified merge request note.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji</code></pre>
+     *
+     * @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 List<AwardEmoji> getMergeRequestNoteAwardEmojis(Object projectIdOrPath, Integer mergeRequestIid, Integer noteId) throws GitLabApiException {
+        Response response = get(Response.Status.OK, getPageQueryParams(1, getDefaultPerPage()),
+            "projects", getProjectIdOrPath(projectIdOrPath), "merge_requests", mergeRequestIid, "notes", noteId, "award_emoji");
         return response.readEntity(new GenericType<List<AwardEmoji>>() {});
     }
 
@@ -92,7 +109,7 @@ public List<AwardEmoji> getNoteAwardEmojis(Object projectIdOrPath, Integer issue
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param issueIid the issue IID to get the award emoji for
      * @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 getIssueAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer awardId) throws GitLabApiException {
@@ -109,7 +126,7 @@ public AwardEmoji getIssueAwardEmoji(Object projectIdOrPath, Integer issueIid, I
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param mergeRequestIid the merge request IID to get the award emoji for
      * @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 getMergeRequestAwardEmoji(Object projectIdOrPath, Integer mergeRequestIid, Integer awardId) throws GitLabApiException {
@@ -126,7 +143,7 @@ public AwardEmoji getMergeRequestAwardEmoji(Object projectIdOrPath, Integer merg
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param snippetId the snippet ID to get the award emoji for
      * @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 getSnippetAwardEmoji(Object projectIdOrPath, Integer snippetId, Integer awardId) throws GitLabApiException {
@@ -136,20 +153,38 @@ public AwardEmoji getSnippetAwardEmoji(Object projectIdOrPath, Integer snippetId
     }
 
     /**
-     * Get the specified award emoji for the specified note.
+     * Get the specified award emoji for the specified issue note.
      *
      * <pre><code>GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id</code></pre>
      *
      * @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 
+     * @return an AwardEmoji instance for the specified award emoji
      * @throws GitLabApiException if any exception occurs
      */
-    public AwardEmoji getNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, Integer awardId) throws GitLabApiException {
+    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);
+            "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji", awardId);
+        return (response.readEntity(AwardEmoji.class));
+    }
+
+    /**
+     * Get the specified award emoji for the specified merge request note.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id</code></pre>
+     *
+     * @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), "merge_requests", mergeRequestIid, "notes", noteId, "award_emoji", awardId);
         return (response.readEntity(AwardEmoji.class));
     }
 
@@ -161,7 +196,7 @@ public AwardEmoji getNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, In
      * @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 +214,7 @@ public AwardEmoji addIssueAwardEmoji(Object projectIdOrPath, Integer issueIid, S
      * @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 +232,7 @@ public AwardEmoji addMergeRequestAwardEmoji(Object projectIdOrPath, Integer merg
      * @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,21 +243,40 @@ public AwardEmoji addSnippetAwardEmoji(Object projectIdOrPath, Integer snippetId
     }
 
     /**
-     * Add an award emoji for the specified note.
+     * Add an award emoji for the specified issue note.
      *
      * <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:noteId/award_emoji</code></pre>
      *
      * @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 
+     * @return an AwardEmoji instance for the added award emoji
      * @throws GitLabApiException if any exception occurs
      */
-    public AwardEmoji addNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, String name) throws GitLabApiException {
+    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");
+            "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji");
+        return (response.readEntity(AwardEmoji.class));
+    }
+
+    /**
+     * Add an award emoji for the specified merge request note.
+     *
+     * <pre><code>GitLab Endpoint: POST /projects/:id/merge_requests/:merge_request_iid/notes/:noteId/award_emoji</code></pre>
+     *
+     * @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 addNoteAwardEmoji(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), "merge_requests", mergeRequestIid, "notes", noteId, "award_emoji");
         return (response.readEntity(AwardEmoji.class));
     }
 
@@ -269,10 +323,10 @@ public void deleteMergeRequestAwardEmoji(Object projectIdOrPath, Integer mergeRe
     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 note.
+     *  Delete an award emoji from the specified issue note.
      *
      * <pre><code>GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id</code></pre>
      *
@@ -284,6 +338,22 @@ public void deleteSnippetAwardEmoji(Object projectIdOrPath, Integer snippetId, I
      */
     public void deleteNoteAwardEmoji(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);
+            "projects", getProjectIdOrPath(projectIdOrPath), "issues", issueIid, "notes", noteId, "award_emoji", awardId);
+    }
+
+    /**
+     *  Delete an award emoji from the specified merge request note.
+     *
+     * <pre><code>GitLab Endpoint: DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id</code></pre>
+     *
+     * @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 deleteNoteAwardEmoji(Object projectIdOrPath, Integer mergeRequestIid, Integer noteId, Integer awardId) throws GitLabApiException {
+        delete(Response.Status.NO_CONTENT, null,
+            "projects", getProjectIdOrPath(projectIdOrPath), "merge_requests", mergeRequestIid, "notes", noteId, "award_emoji", awardId);
     }
 }