@resolution/jira-api-client 0.4.2 → 0.4.5

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

@@ -15,103 +15,106 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation
  */
 class ProjectKeyAndNameValidationService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Validates a project key and, if the key is invalid or in use, generates a valid
-     * random string for the project key.
-     *
-     * **[Permissions](#permissions) required:** None.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: "VPNE"
-     * @path {GET} /rest/api/3/projectvalidate/validProjectKey
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation#api-rest-api-3-projectvalidate-validprojectkey-get
-     */
-    getValidProjectKey({ key, } = {}) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/projectvalidate/validProjectKey",
-            method: "GET",
-            query: {
-                key,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectKeyAndNameValidationService.getValidProjectKey.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Checks that a project name isn't in use. If the name isn't in use, the passed
-     * string is returned. If the name is in use, this operation attempts to generate
-     * a valid project name based on the one supplied, usually by adding a sequence
-     * number. If a valid project name cannot be generated, a 404 response is returned.
-     *
-     * **[Permissions](#permissions) required:** None.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: "Valid Project Name Example"
-     * @path {GET} /rest/api/3/projectvalidate/validProjectName
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation#api-rest-api-3-projectvalidate-validprojectname-get
-     */
-    getValidProjectName({ name, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/projectvalidate/validProjectName",
-            method: "GET",
-            query: {
-                name,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectKeyAndNameValidationService.getValidProjectName.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Validates a project key by confirming the key is a valid string and not in use.
-     *
-     * **[Permissions](#permissions) required:** None.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "errorMessages": [],
-     *   "errors": {
-     *     "projectKey": "A project with that project key already exists."
-     *   }
-     * }
-     * @path {GET} /rest/api/3/projectvalidate/key
-     * @scopes-current read:jira-work
-     * @scopes-beta read:project:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation#api-rest-api-3-projectvalidate-key-get
-     */
-    validateProjectKey({ key, } = {}) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/projectvalidate/key",
-            method: "GET",
-            query: {
-                key,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectKeyAndNameValidationService.validateProjectKey.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Validates a project key and, if the key is invalid or in use, generates a valid
+         * random string for the project key.
+         *
+         * **[Permissions](#permissions) required:** None.
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: "VPNE"
+         * @path {GET} /rest/api/3/projectvalidate/validProjectKey
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation#api-rest-api-3-projectvalidate-validprojectkey-get
+         */
+        this.getValidProjectKey = ({ key, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/projectvalidate/validProjectKey",
+                method: "GET",
+                query: {
+                    key,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectKeyAndNameValidationService.getValidProjectKey.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Checks that a project name isn't in use. If the name isn't in use, the passed
+         * string is returned. If the name is in use, this operation attempts to generate
+         * a valid project name based on the one supplied, usually by adding a sequence
+         * number. If a valid project name cannot be generated, a 404 response is returned.
+         *
+         * **[Permissions](#permissions) required:** None.
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: "Valid Project Name Example"
+         * @path {GET} /rest/api/3/projectvalidate/validProjectName
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation#api-rest-api-3-projectvalidate-validprojectname-get
+         */
+        this.getValidProjectName = ({ name, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/projectvalidate/validProjectName",
+                method: "GET",
+                query: {
+                    name,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectKeyAndNameValidationService.getValidProjectName.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Validates a project key by confirming the key is a valid string and not in use.
+         *
+         * **[Permissions](#permissions) required:** None.
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "errorMessages": [],
+         *   "errors": {
+         *     "projectKey": "A project with that project key already exists."
+         *   }
+         * }
+         * @path {GET} /rest/api/3/projectvalidate/key
+         * @scopes-current read:jira-work
+         * @scopes-beta read:project:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation#api-rest-api-3-projectvalidate-key-get
+         */
+        this.validateProjectKey = ({ key, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/projectvalidate/key",
+                method: "GET",
+                query: {
+                    key,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectKeyAndNameValidationService.validateProjectKey.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ProjectKeyAndNameValidationService.validateProjectKey.response", zod_1.z

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

@@ -1 +1 @@
-{"version":3,"file":"ProjectKeyAndNameValidationService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/ProjectKeyAndNameValidationService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,wEAAqE;AACrE;;;;GAIG;AACH,MAAa,kCAAmC,SAAQ,qCAAiB;IACvE;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EACjB,GAAG,MAID,EAAE;QACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,GAAG;aACJ;SACF,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,gEAAgE,CACjE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAClB,IAAI,GAIL;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8CAA8C;YACpD,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,IAAI;aACL;SACF,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,iEAAiE,CAClE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,kBAAkB,CAAC,EACjB,GAAG,MAID,EAAE;QACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iCAAiC;YACvC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,GAAG;aACJ;SACF,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,gEAAgE,CACjE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,gEAAgE,EAChE,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,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CACP,gEAAgE,CACjE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gEAAgE,EAChE,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,MAAM,EAAE;SACjB,CAAC;aACD,QAAQ,CACP,gEAAgE,CACjE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iEAAiE,EACjE,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,MAAM,EAAE;SACjB,CAAC;aACD,QAAQ,CACP,iEAAiE,CAClE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AA7LD,gFA6LC"}
+{"version":3,"file":"ProjectKeyAndNameValidationService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/ProjectKeyAndNameValidationService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,wEAAqE;AACrE;;;;GAIG;AACH,MAAa,kCAAmC,SAAQ,qCAAiB;IAAzE;;QACE;;;;;;;;;;;WAWG;QACH,uBAAkB,GAAG,CAAC,EACpB,GAAG,MAID,EAAE,EAAmB,EAAE;YACzB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,GAAG;iBACJ;aACF,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,gEAAgE,CACjE,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,wBAAmB,GAAG,CAAC,EACrB,IAAI,GAIL,EAAmB,EAAE;YACpB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8CAA8C;gBACpD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,IAAI;iBACL;aACF,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,iEAAiE,CAClE,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,uBAAkB,GAAG,CAAC,EACpB,GAAG,MAID,EAAE,EAA4B,EAAE;YAClC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,iCAAiC;gBACvC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,GAAG;iBACJ;aACF,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,gEAAgE,CACjE,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAwCJ,CAAC;IAvCC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,gEAAgE,EAChE,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,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CACP,gEAAgE,CACjE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gEAAgE,EAChE,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,MAAM,EAAE;SACjB,CAAC;aACD,QAAQ,CACP,gEAAgE,CACjE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iEAAiE,EACjE,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,MAAM,EAAE;SACjB,CAAC;aACD,QAAQ,CACP,iEAAiE,CAClE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AA7LD,gFA6LC"}

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

@@ -40,7 +40,7 @@ export declare class ProjectPermissionSchemesService extends CommonHttpService {
      * read:project-category:jira, read:project:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes#api-rest-api-3-project-projectkeyorid-permissionscheme-put
      */
-    assignPermissionScheme({ projectKeyOrId, expand, idBean, }: {
+    assignPermissionScheme: ({ projectKeyOrId, expand, idBean, }: {
         /** The project ID or project key (case sensitive). */
         projectKeyOrId: string;
         /**
@@ -56,14 +56,14 @@ export declare class ProjectPermissionSchemesService extends CommonHttpService {
          * permission.
          *  *  `user` Returns information about the user who is granted the permission.
          */
-        expand?: string;
+        expand?: string | undefined;
         /**
          * @example {
          *     "id": 10000
          * }
          */
         idBean: IdBean;
-    }): Promise<PermissionScheme>;
+    }) => Promise<PermissionScheme>;
     /**
      * Gets the [permission scheme](https://confluence.atlassian.com/x/yodKLg)
      * associated with the project.
@@ -87,7 +87,7 @@ export declare class ProjectPermissionSchemesService extends CommonHttpService {
      * read:user:jira, read:avatar:jira, read:project-category:jira, read:project:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes#api-rest-api-3-project-projectkeyorid-permissionscheme-get
      */
-    getAssignedPermissionScheme({ projectKeyOrId, expand, }: {
+    getAssignedPermissionScheme: ({ projectKeyOrId, expand, }: {
         /** The project ID or project key (case sensitive). */
         projectKeyOrId: string;
         /**
@@ -103,8 +103,8 @@ export declare class ProjectPermissionSchemesService extends CommonHttpService {
          * permission.
          *  *  `user` Returns information about the user who is granted the permission.
          */
-        expand?: string;
-    }): Promise<PermissionScheme>;
+        expand?: string | undefined;
+    }) => Promise<PermissionScheme>;
     /**
      * Returns the [issue security scheme](https://confluence.atlassian.com/x/J4lKLg)
      * associated with the project.
@@ -136,10 +136,10 @@ export declare class ProjectPermissionSchemesService extends CommonHttpService {
      * @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes#api-rest-api-3-project-projectkeyorid-issuesecuritylevelscheme-get
      */
-    getProjectIssueSecurityScheme({ projectKeyOrId, }: {
+    getProjectIssueSecurityScheme: ({ projectKeyOrId, }: {
         /** The project ID or project key (case sensitive). */
         projectKeyOrId: string;
-    }): Promise<SecurityScheme>;
+    }) => Promise<SecurityScheme>;
     /**
      * Returns all [issue security](https://confluence.atlassian.com/x/J4lKLg) levels
      * for the project that the user has access to.
@@ -177,9 +177,9 @@ export declare class ProjectPermissionSchemesService extends CommonHttpService {
      * @scopes-beta read:issue-security-level:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes#api-rest-api-3-project-projectkeyorid-securitylevel-get
      */
-    getSecurityLevelsForProject({ projectKeyOrId, }: {
+    getSecurityLevelsForProject: ({ projectKeyOrId, }: {
         /** The project ID or project key (case sensitive). */
         projectKeyOrId: string;
-    }): Promise<ProjectIssueSecurityLevels>;
+    }) => Promise<ProjectIssueSecurityLevels>;
     static initialize(): void;
 }