org.gitlab4j.api.NotificationSettingsApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gitlab4j-api Show documentation
GitLab4J-API (gitlab4j-api) provides a full featured Java client library for working with GitLab repositories and servers via the GitLab REST API.
There is a newer version: 6.0.0-rc.6
Show newest version
package org.gitlab4j.api;

import jakarta.ws.rs.core.Response;

import org.gitlab4j.api.models.NotificationSettings;
import org.gitlab4j.api.models.NotificationSettings.Events;

public class NotificationSettingsApi extends AbstractApi {

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

    /**
     * Get the global notification settings.
     *
     * GitLab Endpoint: GET /notification_settings
     *
     * @return a NotificationSettings instance containing the global notification settings
     * @throws GitLabApiException if any exception occurs
     */
    public NotificationSettings getGlobalNotificationSettings() throws GitLabApiException {
        Response response = get(Response.Status.OK, null, "notification_settings");
        return (response.readEntity(NotificationSettings.class));
    }

    /**
     * Update the global notification settings.
     *
     * GitLab Endpoint: PUT /notification_settings
     *
     * @param settings a NotificationSettings instance with the new settings
     * @return a NotificationSettings instance containing the updated global notification settings
     * @throws GitLabApiException if any exception occurs
     */
    public NotificationSettings updateGlobalNotificationSettings(NotificationSettings settings) throws GitLabApiException {

        GitLabApiForm formData = new GitLabApiForm()
                .withParam("level",  settings.getLevel())
                .withParam("email",  settings.getEmail());

        Events events = settings.getEvents();
        if (events != null) {
                formData.withParam("new_note", events.getNewNote())
                .withParam("new_issue", events.getNewIssue())
                .withParam("reopen_issue", events.getReopenIssue())
                .withParam("close_issue", events.getCloseIssue())
                .withParam("reassign_issue", events.getReassignIssue())
                .withParam("new_merge_request", events.getNewMergeRequest())
                .withParam("reopen_merge_request", events.getReopenMergeRequest())
                .withParam("close_merge_request", events.getCloseMergeRequest())
                .withParam("reassign_merge_request", events.getReassignMergeRequest())
                .withParam("merge_merge_request", events.getMergeMergeRequest())
                .withParam("failed_pipeline", events.getFailedPipeline())
                .withParam("success_pipeline", events.getSuccessPipeline());
        }

        Response response = put(Response.Status.OK, formData.asMap(), "notification_settings");
        return (response.readEntity(NotificationSettings.class));
    }

    /**
     * Get the notification settings for a group.
     *
     * GitLab Endpoint: GET /groups/:id/notification_settings
     *
     * @param groupId the group ID to get the notification settings for
     * @return a NotificationSettings instance containing the specified group's notification settings
     * @throws GitLabApiException if any exception occurs
     */
    public NotificationSettings getGroupNotificationSettings(long groupId) throws GitLabApiException {
        Response response = get(Response.Status.OK, null, "groups", groupId, "notification_settings");
        return (response.readEntity(NotificationSettings.class));
    }

    /**
     * Update the notification settings for a group
     *
     * GitLab Endpoint: PUT /groups/:id/notification_settings
     *
     * @param groupId the group ID to update the notification settings for
     * @param settings a NotificationSettings instance with the new settings
     * @return a NotificationSettings instance containing the updated group notification settings
     * @throws GitLabApiException if any exception occurs
     */
    public NotificationSettings updateGroupNotificationSettings(long groupId, NotificationSettings settings) throws GitLabApiException {

        GitLabApiForm formData = new GitLabApiForm()
                .withParam("level",  settings.getLevel())
                .withParam("email",  settings.getEmail());

        Events events = settings.getEvents();
        if (events != null) {
                formData.withParam("new_note", events.getNewNote())
                .withParam("new_issue", events.getNewIssue())
                .withParam("reopen_issue", events.getReopenIssue())
                .withParam("close_issue", events.getCloseIssue())
                .withParam("reassign_issue", events.getReassignIssue())
                .withParam("new_merge_request", events.getNewMergeRequest())
                .withParam("reopen_merge_request", events.getReopenMergeRequest())
                .withParam("close_merge_request", events.getCloseMergeRequest())
                .withParam("reassign_merge_request", events.getReassignMergeRequest())
                .withParam("merge_merge_request", events.getMergeMergeRequest())
                .withParam("failed_pipeline", events.getFailedPipeline())
                .withParam("success_pipeline", events.getSuccessPipeline());
        }

        Response response = put(Response.Status.OK, formData.asMap(), "groups", groupId, "notification_settings");
        return (response.readEntity(NotificationSettings.class));
    }

    /**
     * Get the notification settings for a project.
     *
     * GitLab Endpoint: GET /projects/:id/notification_settings
     *
     * @param projectId the project ID to get the notification settings for
     * @return a NotificationSettings instance containing the specified project's notification settings
     * @throws GitLabApiException if any exception occurs
     */
    public NotificationSettings getProjectNotificationSettings(long projectId) throws GitLabApiException {
        Response response = get(Response.Status.OK, null, "projects", projectId, "notification_settings");
        return (response.readEntity(NotificationSettings.class));
    }

    /**
     * Update the notification settings for a project
     *
     * GitLab Endpoint: PUT /projects/:id/notification_settings
     *
     * @param projectId the project ID to update the notification settings for
     * @param settings a NotificationSettings instance with the new settings
     * @return a NotificationSettings instance containing the updated project notification settings
     * @throws GitLabApiException if any exception occurs
     */
    public NotificationSettings updateProjectNotificationSettings(long projectId, NotificationSettings settings) throws GitLabApiException {

        GitLabApiForm formData = new GitLabApiForm()
                .withParam("level",  settings.getLevel())
                .withParam("email",  settings.getEmail());

        Events events = settings.getEvents();
        if (events != null) {
                formData.withParam("new_note", events.getNewNote())
                .withParam("new_issue", events.getNewIssue())
                .withParam("reopen_issue", events.getReopenIssue())
                .withParam("close_issue", events.getCloseIssue())
                .withParam("reassign_issue", events.getReassignIssue())
                .withParam("new_merge_request", events.getNewMergeRequest())
                .withParam("reopen_merge_request", events.getReopenMergeRequest())
                .withParam("close_merge_request", events.getCloseMergeRequest())
                .withParam("reassign_merge_request", events.getReassignMergeRequest())
                .withParam("merge_merge_request", events.getMergeMergeRequest())
                .withParam("failed_pipeline", events.getFailedPipeline())
                .withParam("success_pipeline", events.getSuccessPipeline());
        }

        Response response = put(Response.Status.OK, formData.asMap(), "projects", projectId, "notification_settings");
        return (response.readEntity(NotificationSettings.class));
    }
}