AwardEmojiApi.java

package org.gitlab4j.api;

import java.util.List;

import jakarta.ws.rs.core.GenericType;
import jakarta.ws.rs.core.Response;

import org.gitlab4j.api.models.AwardEmoji;

/**
 * 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
 */
public class AwardEmojiApi extends AbstractApi {

    public AwardEmojiApi(GitLabApi gitLabApi) {
        super(gitLabApi);
    }

    /**
     * Get a list of award emoji for the specified issue.
     *
     * <pre><code>GitLab Endpoint: GET /projects/:id/issues/:issue_iid/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 to get the award emojis for
     * @return a list of AwardEmoji for the specified issue
     * @throws GitLabApiException if any exception occurs
     */
    public List<AwardEmoji> getIssueAwardEmojis(Object projectIdOrPath, Long issueIid) throws GitLabApiException {
        Response response = get(
                Response.Status.OK,
                getPageQueryParams(1, getDefaultPerPage()),
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "issues",
                issueIid,
                "award_emoji");
        return response.readEntity(new GenericType<List<AwardEmoji>>() {});
    }

    /**
     *  Get a list of award emoji for the specified merge request.
     *
     * <pre><code>GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/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 to get the award emojis for
     * @return a list of AwardEmoji for the specified merge request
     * @throws GitLabApiException if any exception occurs
     */
    public List<AwardEmoji> getMergeRequestAwardEmojis(Object projectIdOrPath, Long mergeRequestIid)
            throws GitLabApiException {
        Response response = get(
                Response.Status.OK,
                getPageQueryParams(1, getDefaultPerPage()),
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "merge_requests",
                mergeRequestIid,
                "award_emoji");
        return response.readEntity(new GenericType<List<AwardEmoji>>() {});
    }

    /**
     *  Get a list of award emoji for the specified snippet.
     *
     * <pre><code>GitLab Endpoint: GET /projects/:id/snippets/:snippet_id/award_emoji</code></pre>
     *
     * @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 emojis for
     * @return a list of AwardEmoji for the specified snippet
     * @throws GitLabApiException if any exception occurs
     */
    public List<AwardEmoji> getSnippetAwardEmojis(Object projectIdOrPath, Long snippetId) throws GitLabApiException {
        Response response = get(
                Response.Status.OK,
                getPageQueryParams(1, getDefaultPerPage()),
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "snippets",
                snippetId,
                "award_emoji");
        return response.readEntity(new GenericType<List<AwardEmoji>>() {});
    }

    /**
     * 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>
     *
     * @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 List<AwardEmoji> getIssueNoteAwardEmojis(Object projectIdOrPath, Long issueIid, Long noteId)
            throws GitLabApiException {
        Response response = get(
                Response.Status.OK,
                getPageQueryParams(1, getDefaultPerPage()),
                "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 issue note.
     *
     * <pre><code>GitLab Endpoint: GET /projects/:id/issues/:issue_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 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 List<AwardEmoji> getNoteAwardEmojis(Object projectIdOrPath, Long issueIid, Long noteId)
            throws GitLabApiException {
        return getIssueNoteAwardEmojis(projectIdOrPath, issueIid, noteId);
    }

    /**
     * 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, Long mergeRequestIid, Long 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>>() {});
    }

    /**
     * Get the specified award emoji for the specified issue.
     *
     * <pre><code>GitLab Endpoint: GET /projects/:id/issues/:issue_iid/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 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
     * @throws GitLabApiException if any exception occurs
     */
    public AwardEmoji getIssueAwardEmoji(Object projectIdOrPath, Long issueIid, Long awardId)
            throws GitLabApiException {
        Response response = get(
                Response.Status.OK,
                getPageQueryParams(1, getDefaultPerPage()),
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "issues",
                issueIid,
                "award_emoji",
                awardId);
        return (response.readEntity(AwardEmoji.class));
    }

    /**
     * Get the specified award emoji for the specified merge request.
     *
     * <pre><code>GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/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 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
     * @throws GitLabApiException if any exception occurs
     */
    public AwardEmoji getMergeRequestAwardEmoji(Object projectIdOrPath, Long mergeRequestIid, Long awardId)
            throws GitLabApiException {
        Response response = get(
                Response.Status.OK,
                getPageQueryParams(1, getDefaultPerPage()),
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "merge_requests",
                mergeRequestIid,
                "award_emoji",
                awardId);
        return (response.readEntity(AwardEmoji.class));
    }

    /**
     *  Get the specified award emoji for the specified snippet.
     *
     * <pre><code>GitLab Endpoint: GET /projects/:id/snippets/:snippet_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 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
     * @throws GitLabApiException if any exception occurs
     */
    public AwardEmoji getSnippetAwardEmoji(Object projectIdOrPath, Long snippetId, Long awardId)
            throws GitLabApiException {
        Response response = get(
                Response.Status.OK,
                getPageQueryParams(1, getDefaultPerPage()),
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "snippets",
                snippetId,
                "award_emoji",
                awardId);
        return (response.readEntity(AwardEmoji.class));
    }

    /**
     * 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
     * @throws GitLabApiException if any exception occurs
     */
    public AwardEmoji getIssueNoteAwardEmoji(Object projectIdOrPath, Long issueIid, Long noteId, Long 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.
     *
     * <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
     * @throws GitLabApiException if any exception occurs
     * @deprecated use {@link #getIssueNoteAwardEmoji(Object, Long, Long, Long)} instead
     */
    @Deprecated
    public AwardEmoji getNoteAwardEmoji(Object projectIdOrPath, Long issueIid, Long noteId, Long awardId)
            throws GitLabApiException {
        return getIssueNoteAwardEmoji(projectIdOrPath, issueIid, noteId, awardId);
    }

    /**
     * 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, Long mergeRequestIid, Long noteId, Long 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));
    }

    /**
     * Add an award emoji for the specified issue.
     *
     * <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/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 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 addIssueAwardEmoji(Object projectIdOrPath, Long issueIid, 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,
                "award_emoji");
        return (response.readEntity(AwardEmoji.class));
    }

    /**
     * Add an award emoji to the specified merge request.
     *
     * <pre><code>GitLab Endpoint: POST /projects/:id/merge_requests/:merge_request_iid/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 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, Long mergeRequestIid, 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,
                "award_emoji");
        return (response.readEntity(AwardEmoji.class));
    }

    /**
     *  Add an award emoji to the specified snippet.
     *
     * <pre><code>GitLab Endpoint: POST /projects/:id/snippets/:snippet_id/award_emoji</code></pre>
     *
     * @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
     * @throws GitLabApiException if any exception occurs
     */
    public AwardEmoji addSnippetAwardEmoji(Object projectIdOrPath, Long snippetId, String name)
            throws GitLabApiException {
        GitLabApiForm form = new GitLabApiForm().withParam("name", name, true);
        Response response = post(
                Response.Status.CREATED,
                form.asMap(),
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "snippets",
                snippetId,
                "award_emoji");
        return (response.readEntity(AwardEmoji.class));
    }

    /**
     * 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
     * @throws GitLabApiException if any exception occurs
     */
    public AwardEmoji addIssueNoteAwardEmoji(Object projectIdOrPath, Long issueIid, Long 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.
     *
     * <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
     * @throws GitLabApiException if any exception occurs
     * @deprecated use {@link #addIssueNoteAwardEmoji(Object, Long, Long, String)}
     */
    @Deprecated
    public AwardEmoji addNoteAwardEmoji(Object projectIdOrPath, Long issueIid, Long noteId, String name)
            throws GitLabApiException {
        return addIssueNoteAwardEmoji(projectIdOrPath, issueIid, noteId, name);
    }

    /**
     * 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 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),
                "merge_requests",
                mergeRequestIid,
                "notes",
                noteId,
                "award_emoji");
        return (response.readEntity(AwardEmoji.class));
    }

    /**
     * Delete an award emoji from the specified issue.
     *
     * <pre><code>GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/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 to delete the award emoji from
     * @param awardId the ID of the award emoji to delete
     * @throws GitLabApiException if any exception occurs
     */
    public void deleteIssueAwardEmoji(Object projectIdOrPath, Long issueIid, Long awardId) throws GitLabApiException {
        delete(
                Response.Status.NO_CONTENT,
                null,
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "issues",
                issueIid,
                "award_emoji",
                awardId);
    }

    /**
     * Delete an award emoji from the specified merge request.
     *
     * <pre><code>GitLab Endpoint: DELETE /projects/:id/merge_requests/:merge_request_iid/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 to delete the award emoji from
     * @param awardId the ID of the award emoji to delete
     * @throws GitLabApiException if any exception occurs
     */
    public void deleteMergeRequestAwardEmoji(Object projectIdOrPath, Long mergeRequestIid, Long awardId)
            throws GitLabApiException {
        delete(
                Response.Status.NO_CONTENT,
                null,
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "merge_requests",
                mergeRequestIid,
                "award_emoji",
                awardId);
    }

    /**
     *  Delete an award emoji from the specified snippet.
     *
     * <pre><code>GitLab Endpoint: DELETE /projects/:id/snippets/:snippet_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 snippetId the snippet ID to delete the award emoji from
     * @param awardId the ID of the award emoji to delete
     * @throws GitLabApiException if any exception occurs
     */
    public void deleteSnippetAwardEmoji(Object projectIdOrPath, Long snippetId, Long 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.
     *
     * <pre><code>GitLab Endpoint: DELETE /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 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, Long issueIid, Long noteId, Long 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 issue note.
     *
     * <pre><code>GitLab Endpoint: DELETE /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 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
     * @deprecated use {@link #deleteIssueNoteAwardEmoji(Object, Long, Long, Long)} instead
     */
    @Deprecated
    public void deleteNoteAwardEmoji(Object projectIdOrPath, Long issueIid, Long noteId, Long awardId)
            throws GitLabApiException {
        deleteIssueNoteAwardEmoji(projectIdOrPath, issueIid, noteId, 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 deleteMergeRequestNoteAwardEmoji(
            Object projectIdOrPath, Long mergeRequestIid, Long noteId, Long awardId) throws GitLabApiException {
        delete(
                Response.Status.NO_CONTENT,
                null,
                "projects",
                getProjectIdOrPath(projectIdOrPath),
                "merge_requests",
                mergeRequestIid,
                "notes",
                noteId,
                "award_emoji",
                awardId);
    }
}