@resolution/jira-api-client 0.5.2 → 0.5.4

package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type NotificationScheme } from "../models/common";
 import { type AddNotificationsDetails, type CreateNotificationSchemeDetails, type NotificationSchemeId, type PageBeanNotificationScheme, type PageBeanNotificationSchemeAndProjectMappingJsonBean, type UpdateNotificationSchemeDetails } from "../models/issueNotificationSchemes";
 /**
@@ -50,14 +50,16 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/notificationscheme/{id}/notification
+     * @path PUT `/rest/api/3/notificationscheme/{id}/notification`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-notification-put
+     * @param params
      */
     addNotifications: ({ id, addNotificationsDetails, }: {
         /** The ID of the notification scheme. */
         id: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "notificationSchemeEvents": [
          *         {
          *             "event": {
@@ -84,15 +86,20 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": "10001"
      * }
-     * @path {POST} /rest/api/3/notificationscheme
+     * ```
+     * @path POST `/rest/api/3/notificationscheme`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-post
+     * @param params
      */
     createNotificationScheme: ({ createNotificationSchemeDetails, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "description": "My new scheme description",
          *     "name": "My new notification scheme",
          *     "notificationSchemeEvents": [
@@ -119,8 +126,9 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {DELETE} /rest/api/3/notificationscheme/{notificationSchemeId}
+     * @path DELETE `/rest/api/3/notificationscheme/{notificationSchemeId}`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-notificationschemeid-delete
+     * @param params
      */
     deleteNotificationScheme: ({ notificationSchemeId, }: {
         /** The ID of the notification scheme. */
@@ -137,7 +145,9 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "description": "description",
      *   "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
      *   "id": 10100,
@@ -155,8 +165,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *           "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"
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
      *           },
      *           "id": 1,
      *           "notificationType": "Group",
@@ -173,12 +182,10 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *           "notificationType": "ProjectRole",
      *           "parameter": "10360",
      *           "projectRole": {
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *             "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",
+     *             "description": "A project role that represents developers in a project",
      *             "actors": [
      *               {
      *                 "actorGroup": {
@@ -228,8 +235,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *             "accountId": "5b10a2844c20165700ede21g",
      *             "active": false,
      *             "displayName": "Mia Krystof",
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *           }
      *         },
      *         {
@@ -246,8 +252,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *             "navigable": true,
      *             "orderable": true,
      *             "schema": {
-     *               "custom":
-     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *               "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
      *               "customId": 10101,
      *               "type": "project"
      *             },
@@ -263,8 +268,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *     },
      *     {
      *       "event": {
-     *         "description": "Custom event that is published together with an issue
-     * created event",
+     *         "description": "Custom event that is published together with an issue created event",
      *         "id": 20,
      *         "name": "Custom event",
      *         "templateEvent": {
@@ -279,8 +283,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *           "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"
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
      *           },
      *           "id": 1,
      *           "notificationType": "Group",
@@ -297,12 +300,10 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *           "notificationType": "ProjectRole",
      *           "parameter": "10360",
      *           "projectRole": {
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *             "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",
+     *             "description": "A project role that represents developers in a project",
      *             "actors": [
      *               {
      *                 "actorGroup": {
@@ -352,8 +353,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *             "accountId": "5b10a2844c20165700ede21g",
      *             "active": false,
      *             "displayName": "Mia Krystof",
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *           }
      *         },
      *         {
@@ -370,8 +370,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *             "navigable": true,
      *             "orderable": true,
      *             "schema": {
-     *               "custom":
-     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *               "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
      *               "customId": 10101,
      *               "type": "project"
      *             },
@@ -392,12 +391,12 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *   ],
      *   "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
      * }
-     * @path {GET} /rest/api/3/notificationscheme/{id}
+     * ```
+     * @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
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-get
+     * @param params
      */
     getNotificationScheme: ({ id, expand, }: {
         /**
@@ -433,11 +432,11 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * 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.
+     * @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: {
+     * example:
+     * ```
+     * {
      *   "isLast": false,
      *   "maxResults": 6,
      *   "startAt": 1,
@@ -461,8 +460,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *               "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"
+     *                 "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
      *               },
      *               "id": 1,
      *               "notificationType": "Group",
@@ -479,12 +477,10 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *               "notificationType": "ProjectRole",
      *               "parameter": "10360",
      *               "projectRole": {
-     *                 "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *                 "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",
+     *                 "description": "A project role that represents developers in a project",
      *                 "actors": [
      *                   {
      *                     "actorGroup": {
@@ -534,8 +530,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *                 "accountId": "5b10a2844c20165700ede21g",
      *                 "active": false,
      *                 "displayName": "Mia Krystof",
-     *                 "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *                 "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *               }
      *             },
      *             {
@@ -552,8 +547,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *                 "navigable": true,
      *                 "orderable": true,
      *                 "schema": {
-     *                   "custom":
-     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *                   "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
      *                   "customId": 10101,
      *                   "type": "project"
      *                 },
@@ -569,8 +563,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *         },
      *         {
      *           "event": {
-     *             "description": "Custom event that is published together with an
-     * issue created event",
+     *             "description": "Custom event that is published together with an issue created event",
      *             "id": 20,
      *             "name": "Custom event",
      *             "templateEvent": {
@@ -585,8 +578,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *               "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"
+     *                 "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
      *               },
      *               "id": 1,
      *               "notificationType": "Group",
@@ -603,12 +595,10 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *               "notificationType": "ProjectRole",
      *               "parameter": "10360",
      *               "projectRole": {
-     *                 "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *                 "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",
+     *                 "description": "A project role that represents developers in a project",
      *                 "actors": [
      *                   {
      *                     "actorGroup": {
@@ -658,8 +648,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *                 "accountId": "5b10a2844c20165700ede21g",
      *                 "active": false,
      *                 "displayName": "Mia Krystof",
-     *                 "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *                 "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *               }
      *             },
      *             {
@@ -676,8 +665,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *                 "navigable": true,
      *                 "orderable": true,
      *                 "schema": {
-     *                   "custom":
-     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *                   "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
      *                   "customId": 10101,
      *                   "type": "project"
      *                 },
@@ -700,12 +688,12 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /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
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-get
+     * @param params
      */
     getNotificationSchemes: ({ startAt, maxResults, id, projectId, onlyDefault, expand, }?: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -750,7 +738,9 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 50,
      *   "startAt": 0,
@@ -762,10 +752,12 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/notificationscheme/project
+     * ```
+     * @path GET `/rest/api/3/notificationscheme/project`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:notification-scheme:jira, read:project:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-project-get
+     * @param params
      */
     getNotificationSchemeToProjectMappings: ({ startAt, maxResults, notificationSchemeId, projectId, }?: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -784,9 +776,9 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {DELETE}
-     * /rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}
+     * @path DELETE `/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-notificationschemeid-notification-notificationid-delete
+     * @param params
      */
     removeNotificationFromNotificationScheme: ({ notificationSchemeId, notificationId, }: {
         /** The ID of the notification scheme. */
@@ -801,14 +793,16 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/notificationscheme/{id}
+     * @path PUT `/rest/api/3/notificationscheme/{id}`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-put
+     * @param params
      */
     updateNotificationScheme: ({ id, updateNotificationSchemeDetails, }: {
         /** The ID of the notification scheme. */
         id: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "description": "My updated notification scheme description",
          *     "name": "My updated notification scheme"
          * }