@resolution/jira-api-client 0.1.6 → 0.3.0

package/lib/openapi/platform/services/IssueNotificationSchemesService.js

@@ -0,0 +1,917 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IssueNotificationSchemesService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/CommonHttpClient");
+const CommonHttpService_1 = require("../core/CommonHttpService");
+const common_1 = require("../models/common");
+const issueNotificationSchemes_1 = require("../models/issueNotificationSchemes");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+/**
+ * This resource represents notification schemes, lists of events and the
+ * recipients who will receive notifications for those events. Use it to get
+ * details of a notification scheme and a list of notification schemes.
+ *
+ * ### About notification schemes ###
+ *
+ * A notification scheme is a list of events and recipients who will receive
+ * notifications for those events. The list is contained within the
+ * `notificationSchemeEvents` object and contains pairs of `events` and
+ * `notifications`:
+ *
+ *  *  `event` Identifies the type of event. The events can be [Jira system
+ * events](https://support.atlassian.com/jira-cloud-administration/docs/configure-notification-schemes/)
+ * (see the *Events* section) or [custom
+ * events](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-event/).
+ *  *  `notifications` Identifies the
+ * [recipients](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-recipientsRecipients)
+ * of notifications for each event. Recipients can be any of the following types:
+ *
+ *      *  `CurrentAssignee`
+ *      *  `Reporter`
+ *      *  `CurrentUser`
+ *      *  `ProjectLead`
+ *      *  `ComponentLead`
+ *      *  `User` (the `parameter` is the user key)
+ *      *  `Group` (the `parameter` is the group name)
+ *      *  `ProjectRole` (the `parameter` is the project role ID)
+ *      *  `EmailAddress` *(deprecated)*
+ *      *  `AllWatchers`
+ *      *  `UserCustomField` (the `parameter` is the ID of the custom field)
+ *      *  `GroupCustomField`(the `parameter` is the ID of the custom field)
+ */
+class IssueNotificationSchemesService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Adds notifications to a notification scheme. You can add up to 1000
+     * notifications per request.
+     *
+     * *Deprecated: The notification type `EmailAddress` is no longer supported in
+     * Cloud. Refer to the
+     * [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031)
+     * for more details.*
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/notificationscheme/{id}/notification
+     */
+    addNotifications({ id, addNotificationsDetails, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/notificationscheme/{id}/notification",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: addNotificationsDetails,
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.addNotifications.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Creates a notification scheme with notifications. You can create up to 1000
+     * notifications per request.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": "10001"
+     * }
+     * @path {POST} /rest/api/3/notificationscheme
+     */
+    createNotificationScheme({ createNotificationSchemeDetails, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/notificationscheme",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: createNotificationSchemeDetails,
+        })
+            .then(this.getClientInstance().responseHandler({
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.createNotificationScheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deletes a notification scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {DELETE} /rest/api/3/notificationscheme/{notificationSchemeId}
+     */
+    deleteNotificationScheme({ notificationSchemeId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/notificationscheme/{notificationSchemeId}",
+            method: "DELETE",
+            pathParams: {
+                notificationSchemeId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.deleteNotificationScheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg),
+     * including the list of events and the recipients who will receive notifications
+     * for those events.
+     *
+     * **[Permissions](#permissions) required:** Permission to access Jira, however,
+     * the user must have permission to administer at least one project associated
+     * with the notification scheme.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "description": "description",
+     *   "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
+     *   "id": 10100,
+     *   "name": "notification scheme name",
+     *   "notificationSchemeEvents": [
+     *     {
+     *       "event": {
+     *         "description": "Event published when an issue is created",
+     *         "id": 1,
+     *         "name": "Issue created"
+     *       },
+     *       "notifications": [
+     *         {
+     *           "expand": "group",
+     *           "group": {
+     *             "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+     *             "name": "jira-administrators",
+     *             "self":
+     * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+     *           },
+     *           "id": 1,
+     *           "notificationType": "Group",
+     *           "parameter": "jira-administrators",
+     *           "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
+     *         },
+     *         {
+     *           "id": 2,
+     *           "notificationType": "CurrentAssignee"
+     *         },
+     *         {
+     *           "expand": "projectRole",
+     *           "id": 3,
+     *           "notificationType": "ProjectRole",
+     *           "parameter": "10360",
+     *           "projectRole": {
+     *             "self":
+     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *             "name": "Developers",
+     *             "id": 10360,
+     *             "description": "A project role that represents developers in a
+     * project",
+     *             "actors": [
+     *               {
+     *                 "actorGroup": {
+     *                   "name": "jira-developers",
+     *                   "displayName": "jira-developers",
+     *                   "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+     *                 },
+     *                 "displayName": "jira-developers",
+     *                 "id": 10240,
+     *                 "name": "jira-developers",
+     *                 "type": "atlassian-group-role-actor"
+     *               },
+     *               {
+     *                 "actorUser": {
+     *                   "accountId": "5b10a2844c20165700ede21g"
+     *                 },
+     *                 "displayName": "Mia Krystof",
+     *                 "id": 10241,
+     *                 "type": "atlassian-user-role-actor"
+     *               }
+     *             ],
+     *             "scope": {
+     *               "project": {
+     *                 "id": "10000",
+     *                 "key": "KEY",
+     *                 "name": "Next Gen Project"
+     *               },
+     *               "type": "PROJECT"
+     *             }
+     *           },
+     *           "recipient": "10360"
+     *         },
+     *         {
+     *           "emailAddress": "rest-developer@atlassian.com",
+     *           "id": 4,
+     *           "notificationType": "EmailAddress",
+     *           "parameter": "rest-developer@atlassian.com",
+     *           "recipient": "rest-developer@atlassian.com"
+     *         },
+     *         {
+     *           "expand": "user",
+     *           "id": 5,
+     *           "notificationType": "User",
+     *           "parameter": "5b10a2844c20165700ede21g",
+     *           "recipient": "5b10a2844c20165700ede21g",
+     *           "user": {
+     *             "accountId": "5b10a2844c20165700ede21g",
+     *             "active": false,
+     *             "displayName": "Mia Krystof",
+     *             "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *           }
+     *         },
+     *         {
+     *           "expand": "field",
+     *           "field": {
+     *             "clauseNames": [
+     *               "cf[10101]",
+     *               "New custom field"
+     *             ],
+     *             "custom": true,
+     *             "id": "customfield_10101",
+     *             "key": "customfield_10101",
+     *             "name": "New custom field",
+     *             "navigable": true,
+     *             "orderable": true,
+     *             "schema": {
+     *               "custom":
+     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *               "customId": 10101,
+     *               "type": "project"
+     *             },
+     *             "searchable": true,
+     *             "untranslatedName": "New custom field"
+     *           },
+     *           "id": 6,
+     *           "notificationType": "GroupCustomField",
+     *           "parameter": "customfield_10101",
+     *           "recipient": "customfield_10101"
+     *         }
+     *       ]
+     *     },
+     *     {
+     *       "event": {
+     *         "description": "Custom event that is published together with an issue
+     * created event",
+     *         "id": 20,
+     *         "name": "Custom event",
+     *         "templateEvent": {
+     *           "description": "Event published when an issue is created",
+     *           "id": 1,
+     *           "name": "Issue created"
+     *         }
+     *       },
+     *       "notifications": [
+     *         {
+     *           "expand": "group",
+     *           "group": {
+     *             "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+     *             "name": "jira-administrators",
+     *             "self":
+     * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+     *           },
+     *           "id": 1,
+     *           "notificationType": "Group",
+     *           "parameter": "jira-administrators",
+     *           "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
+     *         },
+     *         {
+     *           "id": 2,
+     *           "notificationType": "CurrentAssignee"
+     *         },
+     *         {
+     *           "expand": "projectRole",
+     *           "id": 3,
+     *           "notificationType": "ProjectRole",
+     *           "parameter": "10360",
+     *           "projectRole": {
+     *             "self":
+     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *             "name": "Developers",
+     *             "id": 10360,
+     *             "description": "A project role that represents developers in a
+     * project",
+     *             "actors": [
+     *               {
+     *                 "actorGroup": {
+     *                   "name": "jira-developers",
+     *                   "displayName": "jira-developers",
+     *                   "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+     *                 },
+     *                 "displayName": "jira-developers",
+     *                 "id": 10240,
+     *                 "name": "jira-developers",
+     *                 "type": "atlassian-group-role-actor"
+     *               },
+     *               {
+     *                 "actorUser": {
+     *                   "accountId": "5b10a2844c20165700ede21g"
+     *                 },
+     *                 "displayName": "Mia Krystof",
+     *                 "id": 10241,
+     *                 "type": "atlassian-user-role-actor"
+     *               }
+     *             ],
+     *             "scope": {
+     *               "project": {
+     *                 "id": "10000",
+     *                 "key": "KEY",
+     *                 "name": "Next Gen Project"
+     *               },
+     *               "type": "PROJECT"
+     *             }
+     *           },
+     *           "recipient": "10360"
+     *         },
+     *         {
+     *           "emailAddress": "rest-developer@atlassian.com",
+     *           "id": 4,
+     *           "notificationType": "EmailAddress",
+     *           "parameter": "rest-developer@atlassian.com",
+     *           "recipient": "rest-developer@atlassian.com"
+     *         },
+     *         {
+     *           "expand": "user",
+     *           "id": 5,
+     *           "notificationType": "User",
+     *           "parameter": "5b10a2844c20165700ede21g",
+     *           "recipient": "5b10a2844c20165700ede21g",
+     *           "user": {
+     *             "accountId": "5b10a2844c20165700ede21g",
+     *             "active": false,
+     *             "displayName": "Mia Krystof",
+     *             "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *           }
+     *         },
+     *         {
+     *           "expand": "field",
+     *           "field": {
+     *             "clauseNames": [
+     *               "cf[10101]",
+     *               "New custom field"
+     *             ],
+     *             "custom": true,
+     *             "id": "customfield_10101",
+     *             "key": "customfield_10101",
+     *             "name": "New custom field",
+     *             "navigable": true,
+     *             "orderable": true,
+     *             "schema": {
+     *               "custom":
+     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *               "customId": 10101,
+     *               "type": "project"
+     *             },
+     *             "searchable": true,
+     *             "untranslatedName": "New custom field"
+     *           },
+     *           "id": 6,
+     *           "notificationType": "GroupCustomField",
+     *           "parameter": "customfield_10101",
+     *           "recipient": "customfield_10101"
+     *         }
+     *       ]
+     *     }
+     *   ],
+     *   "projects": [
+     *     10001,
+     *     10002
+     *   ],
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
+     * }
+     * @path {GET} /rest/api/3/notificationscheme/{id}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field:jira, read:notification-scheme:jira, read:project:jira,
+     * read:project-role:jira, read:user:jira, read:avatar:jira,
+     * read:field-configuration:jira, read:group:jira, read:project-category:jira
+     */
+    getNotificationScheme({ id, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/notificationscheme/{id}",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.getNotificationScheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a [paginated](#pagination) list of [notification
+     * schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name.
+     *
+     * *Note that you should allow for events without recipients to appear in
+     * responses.*
+     *
+     * **[Permissions](#permissions) required:** Permission to access Jira, however,
+     * the user must have permission to administer at least one project associated
+     * with a notification scheme for it to be returned.
+     *
+     * @returns Returned if the request is successful. Only returns notification schemes that
+     * the user has permission to access. An empty list is returned if the user lacks
+     * permission to access all notification schemes.
+     *
+     * example: {
+     *   "isLast": false,
+     *   "maxResults": 6,
+     *   "startAt": 1,
+     *   "total": 5,
+     *   "values": [
+     *     {
+     *       "description": "description",
+     *       "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
+     *       "id": 10100,
+     *       "name": "notification scheme name",
+     *       "notificationSchemeEvents": [
+     *         {
+     *           "event": {
+     *             "description": "Event published when an issue is created",
+     *             "id": 1,
+     *             "name": "Issue created"
+     *           },
+     *           "notifications": [
+     *             {
+     *               "expand": "group",
+     *               "group": {
+     *                 "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+     *                 "name": "jira-administrators",
+     *                 "self":
+     * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+     *               },
+     *               "id": 1,
+     *               "notificationType": "Group",
+     *               "parameter": "jira-administrators",
+     *               "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
+     *             },
+     *             {
+     *               "id": 2,
+     *               "notificationType": "CurrentAssignee"
+     *             },
+     *             {
+     *               "expand": "projectRole",
+     *               "id": 3,
+     *               "notificationType": "ProjectRole",
+     *               "parameter": "10360",
+     *               "projectRole": {
+     *                 "self":
+     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *                 "name": "Developers",
+     *                 "id": 10360,
+     *                 "description": "A project role that represents developers in a
+     * project",
+     *                 "actors": [
+     *                   {
+     *                     "actorGroup": {
+     *                       "name": "jira-developers",
+     *                       "displayName": "jira-developers",
+     *                       "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+     *                     },
+     *                     "displayName": "jira-developers",
+     *                     "id": 10240,
+     *                     "name": "jira-developers",
+     *                     "type": "atlassian-group-role-actor"
+     *                   },
+     *                   {
+     *                     "actorUser": {
+     *                       "accountId": "5b10a2844c20165700ede21g"
+     *                     },
+     *                     "displayName": "Mia Krystof",
+     *                     "id": 10241,
+     *                     "type": "atlassian-user-role-actor"
+     *                   }
+     *                 ],
+     *                 "scope": {
+     *                   "project": {
+     *                     "id": "10000",
+     *                     "key": "KEY",
+     *                     "name": "Next Gen Project"
+     *                   },
+     *                   "type": "PROJECT"
+     *                 }
+     *               },
+     *               "recipient": "10360"
+     *             },
+     *             {
+     *               "emailAddress": "rest-developer@atlassian.com",
+     *               "id": 4,
+     *               "notificationType": "EmailAddress",
+     *               "parameter": "rest-developer@atlassian.com",
+     *               "recipient": "rest-developer@atlassian.com"
+     *             },
+     *             {
+     *               "expand": "user",
+     *               "id": 5,
+     *               "notificationType": "User",
+     *               "parameter": "5b10a2844c20165700ede21g",
+     *               "recipient": "5b10a2844c20165700ede21g",
+     *               "user": {
+     *                 "accountId": "5b10a2844c20165700ede21g",
+     *                 "active": false,
+     *                 "displayName": "Mia Krystof",
+     *                 "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *               }
+     *             },
+     *             {
+     *               "expand": "field",
+     *               "field": {
+     *                 "clauseNames": [
+     *                   "cf[10101]",
+     *                   "New custom field"
+     *                 ],
+     *                 "custom": true,
+     *                 "id": "customfield_10101",
+     *                 "key": "customfield_10101",
+     *                 "name": "New custom field",
+     *                 "navigable": true,
+     *                 "orderable": true,
+     *                 "schema": {
+     *                   "custom":
+     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *                   "customId": 10101,
+     *                   "type": "project"
+     *                 },
+     *                 "searchable": true,
+     *                 "untranslatedName": "New custom field"
+     *               },
+     *               "id": 6,
+     *               "notificationType": "GroupCustomField",
+     *               "parameter": "customfield_10101",
+     *               "recipient": "customfield_10101"
+     *             }
+     *           ]
+     *         },
+     *         {
+     *           "event": {
+     *             "description": "Custom event that is published together with an
+     * issue created event",
+     *             "id": 20,
+     *             "name": "Custom event",
+     *             "templateEvent": {
+     *               "description": "Event published when an issue is created",
+     *               "id": 1,
+     *               "name": "Issue created"
+     *             }
+     *           },
+     *           "notifications": [
+     *             {
+     *               "expand": "group",
+     *               "group": {
+     *                 "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+     *                 "name": "jira-administrators",
+     *                 "self":
+     * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+     *               },
+     *               "id": 1,
+     *               "notificationType": "Group",
+     *               "parameter": "jira-administrators",
+     *               "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
+     *             },
+     *             {
+     *               "id": 2,
+     *               "notificationType": "CurrentAssignee"
+     *             },
+     *             {
+     *               "expand": "projectRole",
+     *               "id": 3,
+     *               "notificationType": "ProjectRole",
+     *               "parameter": "10360",
+     *               "projectRole": {
+     *                 "self":
+     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *                 "name": "Developers",
+     *                 "id": 10360,
+     *                 "description": "A project role that represents developers in a
+     * project",
+     *                 "actors": [
+     *                   {
+     *                     "actorGroup": {
+     *                       "name": "jira-developers",
+     *                       "displayName": "jira-developers",
+     *                       "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+     *                     },
+     *                     "displayName": "jira-developers",
+     *                     "id": 10240,
+     *                     "name": "jira-developers",
+     *                     "type": "atlassian-group-role-actor"
+     *                   },
+     *                   {
+     *                     "actorUser": {
+     *                       "accountId": "5b10a2844c20165700ede21g"
+     *                     },
+     *                     "displayName": "Mia Krystof",
+     *                     "id": 10241,
+     *                     "type": "atlassian-user-role-actor"
+     *                   }
+     *                 ],
+     *                 "scope": {
+     *                   "project": {
+     *                     "id": "10000",
+     *                     "key": "KEY",
+     *                     "name": "Next Gen Project"
+     *                   },
+     *                   "type": "PROJECT"
+     *                 }
+     *               },
+     *               "recipient": "10360"
+     *             },
+     *             {
+     *               "emailAddress": "rest-developer@atlassian.com",
+     *               "id": 4,
+     *               "notificationType": "EmailAddress",
+     *               "parameter": "rest-developer@atlassian.com",
+     *               "recipient": "rest-developer@atlassian.com"
+     *             },
+     *             {
+     *               "expand": "user",
+     *               "id": 5,
+     *               "notificationType": "User",
+     *               "parameter": "5b10a2844c20165700ede21g",
+     *               "recipient": "5b10a2844c20165700ede21g",
+     *               "user": {
+     *                 "accountId": "5b10a2844c20165700ede21g",
+     *                 "active": false,
+     *                 "displayName": "Mia Krystof",
+     *                 "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *               }
+     *             },
+     *             {
+     *               "expand": "field",
+     *               "field": {
+     *                 "clauseNames": [
+     *                   "cf[10101]",
+     *                   "New custom field"
+     *                 ],
+     *                 "custom": true,
+     *                 "id": "customfield_10101",
+     *                 "key": "customfield_10101",
+     *                 "name": "New custom field",
+     *                 "navigable": true,
+     *                 "orderable": true,
+     *                 "schema": {
+     *                   "custom":
+     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *                   "customId": 10101,
+     *                   "type": "project"
+     *                 },
+     *                 "searchable": true,
+     *                 "untranslatedName": "New custom field"
+     *               },
+     *               "id": 6,
+     *               "notificationType": "GroupCustomField",
+     *               "parameter": "customfield_10101",
+     *               "recipient": "customfield_10101"
+     *             }
+     *           ]
+     *         }
+     *       ],
+     *       "projects": [
+     *         10001,
+     *         10002
+     *       ],
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/notificationscheme
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field:jira, read:notification-scheme:jira, read:project:jira,
+     * read:project-role:jira, read:user:jira, read:avatar:jira, read:group:jira,
+     * read:project-category:jira, read:field-configuration:jira
+     */
+    getNotificationSchemes({ startAt, maxResults, id, projectId, onlyDefault, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/notificationscheme",
+            method: "GET",
+            query: {
+                startAt,
+                maxResults,
+                id,
+                projectId,
+                onlyDefault,
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.getNotificationSchemes.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a [paginated](#pagination) mapping of project that have notification
+     * scheme assigned. You can provide either one or multiple notification scheme IDs
+     * or project IDs to filter by. If you don't provide any, this will return a list
+     * of all mappings. Note that only company-managed (classic) projects are
+     * supported. This is because team-managed projects don't have a concept of a
+     * default notification scheme. The mappings are ordered by projectId.
+     *
+     * **[Permissions](#permissions) required:** Permission to access Jira.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 50,
+     *   "startAt": 0,
+     *   "total": 4,
+     *   "values": [
+     *     {
+     *       "notificationSchemeId": "10001",
+     *       "projectId": "100001"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/notificationscheme/project
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:notification-scheme:jira, read:project:jira
+     */
+    getNotificationSchemeToProjectMappings({ startAt, maxResults, notificationSchemeId, projectId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/notificationscheme/project",
+            method: "GET",
+            query: {
+                startAt,
+                maxResults,
+                notificationSchemeId,
+                projectId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.getNotificationSchemeToProjectMappings.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Removes a notification from a notification scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {DELETE}
+     * /rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}
+     */
+    removeNotificationFromNotificationScheme({ notificationSchemeId, notificationId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}",
+            method: "DELETE",
+            pathParams: {
+                notificationSchemeId,
+                notificationId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.removeNotificationFromNotificationScheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates a notification scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/notificationscheme/{id}
+     */
+    updateNotificationScheme({ id, updateNotificationSchemeDetails, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/notificationscheme/{id}",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: updateNotificationSchemeDetails,
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.updateNotificationScheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNotificationSchemesService.getNotificationSchemes.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("PageBeanNotificationScheme"),
+        })
+            .describe("IssueNotificationSchemesService.getNotificationSchemes.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNotificationSchemesService.createNotificationScheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(201),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("NotificationSchemeId"),
+        })
+            .describe("IssueNotificationSchemesService.createNotificationScheme.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNotificationSchemesService.getNotificationScheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("NotificationScheme"),
+        })
+            .describe("IssueNotificationSchemesService.getNotificationScheme.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNotificationSchemesService.updateNotificationScheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("IssueNotificationSchemesService.updateNotificationScheme.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNotificationSchemesService.addNotifications.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("IssueNotificationSchemesService.addNotifications.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNotificationSchemesService.deleteNotificationScheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("IssueNotificationSchemesService.deleteNotificationScheme.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNotificationSchemesService.removeNotificationFromNotificationScheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("IssueNotificationSchemesService.removeNotificationFromNotificationScheme.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNotificationSchemesService.getNotificationSchemeToProjectMappings.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("PageBeanNotificationSchemeAndProjectMappingJsonBean"),
+        })
+            .describe("IssueNotificationSchemesService.getNotificationSchemeToProjectMappings.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            issueNotificationSchemes_1.registerIssueNotificationSchemesValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.IssueNotificationSchemesService = IssueNotificationSchemesService;
+//# sourceMappingURL=IssueNotificationSchemesService.js.map