@resolution/jira-api-client 0.4.2 → 0.4.5

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

@@ -16,75 +16,78 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings
  */
 class IssueNavigatorSettingsService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Returns the default issue navigator columns.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: [
-     *   {
-     *     "label": "Key",
-     *     "value": "issuekey"
-     *   },
-     *   {
-     *     "label": "Summary",
-     *     "value": "summary"
-     *   }
-     * ]
-     * @path {GET} /rest/api/3/settings/columns
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings#api-rest-api-3-settings-columns-get
-     */
-    getIssueNavigatorDefaultColumns() {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/settings/columns",
-            method: "GET",
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNavigatorSettingsService.getIssueNavigatorDefaultColumns.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Sets the default issue navigator columns.
-     *
-     * The `columns` parameter accepts a navigable field value and is expressed as
-     * HTML form data. To specify multiple columns, pass multiple `columns`
-     * parameters. For example, in curl:
-     *
-     * `curl -X PUT -d columns=summary -d columns=description
-     * https://your-domain.atlassian.net/rest/api/3/settings/columns`
-     *
-     * If no column details are sent, then all default columns are removed.
-     *
-     * A navigable field is one that can be used as a column on the issue navigator.
-     * Find details of navigable issue columns using [Get
-     * fields](#api-rest-api-3-field-get).
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @path {PUT} /rest/api/3/settings/columns
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings#api-rest-api-3-settings-columns-put
-     */
-    setIssueNavigatorDefaultColumns({ columnRequestBody, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/settings/columns",
-            method: "PUT",
-            headers: {
-                "Content-Type": "multipart/form-data",
-            },
-            body: columnRequestBody,
-        })
-            .then(commonHttpClient.discardResult);
+    constructor() {
+        super(...arguments);
+        /**
+         * Returns the default issue navigator columns.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: [
+         *   {
+         *     "label": "Key",
+         *     "value": "issuekey"
+         *   },
+         *   {
+         *     "label": "Summary",
+         *     "value": "summary"
+         *   }
+         * ]
+         * @path {GET} /rest/api/3/settings/columns
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings#api-rest-api-3-settings-columns-get
+         */
+        this.getIssueNavigatorDefaultColumns = () => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/settings/columns",
+                method: "GET",
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNavigatorSettingsService.getIssueNavigatorDefaultColumns.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Sets the default issue navigator columns.
+         *
+         * The `columns` parameter accepts a navigable field value and is expressed as
+         * HTML form data. To specify multiple columns, pass multiple `columns`
+         * parameters. For example, in curl:
+         *
+         * `curl -X PUT -d columns=summary -d columns=description
+         * https://your-domain.atlassian.net/rest/api/3/settings/columns`
+         *
+         * If no column details are sent, then all default columns are removed.
+         *
+         * A navigable field is one that can be used as a column on the issue navigator.
+         * Find details of navigable issue columns using [Get
+         * fields](#api-rest-api-3-field-get).
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @path {PUT} /rest/api/3/settings/columns
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings#api-rest-api-3-settings-columns-put
+         */
+        this.setIssueNavigatorDefaultColumns = ({ columnRequestBody, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/settings/columns",
+                method: "PUT",
+                headers: {
+                    "Content-Type": "multipart/form-data",
+                },
+                body: columnRequestBody,
+            })
+                .then(commonHttpClient.discardResult);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNavigatorSettingsService.getIssueNavigatorDefaultColumns.response", zod_1.z

package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"IssueNavigatorSettingsService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/IssueNavigatorSettingsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,wEAAqE;AACrE;;;;;GAKG;AACH,MAAa,6BAA8B,SAAQ,qCAAiB;IAClE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,+BAA+B;QAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8BAA8B;YACpC,MAAM,EAAE,KAAK;SACd,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wEAAwE,CACzE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,+BAA+B,CAAC,EAC9B,iBAAiB,GAIlB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8BAA8B;YACpC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,cAAc,EAAE,qBAAqB;aACtC;YACD,IAAI,EAAE,iBAAiB;SACxB,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,wEAAwE,EACxE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC1D,CAAC;aACD,QAAQ,CACP,wEAAwE,CACzE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAvGD,sEAuGC"}
+{"version":3,"file":"IssueNavigatorSettingsService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/IssueNavigatorSettingsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,wEAAqE;AACrE;;;;;GAKG;AACH,MAAa,6BAA8B,SAAQ,qCAAiB;IAApE;;QACE;;;;;;;;;;;;;;;;;;;;WAoBG;QACH,oCAA+B,GAAG,GAA0B,EAAE;YAC5D,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8BAA8B;gBACpC,MAAM,EAAE,KAAK;aACd,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wEAAwE,CACzE,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,oCAA+B,GAAG,CAAC,EACjC,iBAAiB,GAIlB,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8BAA8B;gBACpC,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,qBAAqB;iBACtC;gBACD,IAAI,EAAE,iBAAiB;aACxB,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;IAgBJ,CAAC;IAfC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,wEAAwE,EACxE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC1D,CAAC;aACD,QAAQ,CACP,wEAAwE,CACzE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAvGD,sEAuGC"}

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

@@ -53,7 +53,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * @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
      */
-    addNotifications({ id, addNotificationsDetails, }: {
+    addNotifications: ({ id, addNotificationsDetails, }: {
         /** The ID of the notification scheme. */
         id: string;
         /**
@@ -74,7 +74,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
          * }
          */
         addNotificationsDetails: AddNotificationsDetails;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Creates a notification scheme with notifications. You can create up to 1000
      * notifications per request.
@@ -90,7 +90,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * @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
      */
-    createNotificationScheme({ createNotificationSchemeDetails, }: {
+    createNotificationScheme: ({ createNotificationSchemeDetails, }: {
         /**
          * @example {
          *     "description": "My new scheme description",
@@ -111,7 +111,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
          * }
          */
         createNotificationSchemeDetails: CreateNotificationSchemeDetails;
-    }): Promise<NotificationSchemeId>;
+    }) => Promise<NotificationSchemeId>;
     /**
      * Deletes a notification scheme.
      *
@@ -122,10 +122,10 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * @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
      */
-    deleteNotificationScheme({ notificationSchemeId, }: {
+    deleteNotificationScheme: ({ notificationSchemeId, }: {
         /** The ID of the notification scheme. */
         notificationSchemeId: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg),
      * including the list of events and the recipients who will receive notifications
@@ -399,7 +399,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * 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
      */
-    getNotificationScheme({ id, expand, }: {
+    getNotificationScheme: ({ id, expand, }: {
         /**
          * The ID of the notification scheme. Use [Get notification schemes
          * paginated](#api-rest-api-3-notificationscheme-get) to get a list of
@@ -420,8 +420,8 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
          * receive an event
          *  *  `user` Returns information about any users assigned to receive an event
          */
-        expand?: string;
-    }): Promise<NotificationScheme>;
+        expand?: string | undefined;
+    }) => Promise<NotificationScheme>;
     /**
      * Returns a [paginated](#pagination) list of [notification
      * schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name.
@@ -707,21 +707,21 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * 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
      */
-    getNotificationSchemes({ startAt, maxResults, id, projectId, onlyDefault, expand, }?: {
+    getNotificationSchemes: ({ startAt, maxResults, id, projectId, onlyDefault, expand, }?: {
         /** The index of the first item to return in a page of results (page offset). */
-        startAt?: string;
+        startAt?: string | undefined;
         /** The maximum number of items to return per page. */
-        maxResults?: string;
+        maxResults?: string | undefined;
         /** The list of notification schemes IDs to be filtered by */
-        id?: string[];
+        id?: string[] | undefined;
         /** The list of projects IDs to be filtered by */
-        projectId?: string[];
+        projectId?: string[] | undefined;
         /**
          * When set to true, returns only the default notification scheme. If you provide
          * project IDs not associated with the default, returns an empty page. The default
          * value is false.
          */
-        onlyDefault?: boolean;
+        onlyDefault?: boolean | undefined;
         /**
          * Use [expand](#expansion) to include additional information in the response.
          * This parameter accepts a comma-separated list. Expand options include:
@@ -736,8 +736,8 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
          * receive an event
          *  *  `user` Returns information about any users assigned to receive an event
          */
-        expand?: string;
-    }): Promise<PageBeanNotificationScheme>;
+        expand?: string | undefined;
+    }) => Promise<PageBeanNotificationScheme>;
     /**
      * Returns a [paginated](#pagination) mapping of project that have notification
      * scheme assigned. You can provide either one or multiple notification scheme IDs
@@ -767,16 +767,16 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * @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
      */
-    getNotificationSchemeToProjectMappings({ startAt, maxResults, notificationSchemeId, projectId, }?: {
+    getNotificationSchemeToProjectMappings: ({ startAt, maxResults, notificationSchemeId, projectId, }?: {
         /** The index of the first item to return in a page of results (page offset). */
-        startAt?: string;
+        startAt?: string | undefined;
         /** The maximum number of items to return per page. */
-        maxResults?: string;
+        maxResults?: string | undefined;
         /** The list of notifications scheme IDs to be filtered out */
-        notificationSchemeId?: string[];
+        notificationSchemeId?: string[] | undefined;
         /** The list of project IDs to be filtered out */
-        projectId?: string[];
-    }): Promise<PageBeanNotificationSchemeAndProjectMappingJsonBean>;
+        projectId?: string[] | undefined;
+    }) => Promise<PageBeanNotificationSchemeAndProjectMappingJsonBean>;
     /**
      * Removes a notification from a notification scheme.
      *
@@ -788,12 +788,12 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * /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
      */
-    removeNotificationFromNotificationScheme({ notificationSchemeId, notificationId, }: {
+    removeNotificationFromNotificationScheme: ({ notificationSchemeId, notificationId, }: {
         /** The ID of the notification scheme. */
         notificationSchemeId: string;
         /** The ID of the notification. */
         notificationId: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Updates a notification scheme.
      *
@@ -804,7 +804,7 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
      * @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
      */
-    updateNotificationScheme({ id, updateNotificationSchemeDetails, }: {
+    updateNotificationScheme: ({ id, updateNotificationSchemeDetails, }: {
         /** The ID of the notification scheme. */
         id: string;
         /**
@@ -814,6 +814,6 @@ export declare class IssueNotificationSchemesService extends CommonHttpService {
          * }
          */
         updateNotificationSchemeDetails: UpdateNotificationSchemeDetails;
-    }): Promise<void>;
+    }) => Promise<void>;
     static initialize(): void;
 }