@resolution/confluence-api-client 0.4.4 → 0.4.6

package/lib/openapi/v1/services/SpacePermissionsService.js

@@ -11,102 +11,105 @@ const spacePermissions_1 = require("../models/spacePermissions");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions */
 class SpacePermissionsService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Adds new custom content permission to space.
-     *
-     * If the permission to be added is a group permission, the group can be identified
-     * by its group name or group id.
-     *
-     * Note: Only apps can access this REST resource and only make changes to the
-     * respective app permissions.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'Admin' permission for the space.
-     *
-     * @path {POST} /wiki/rest/api/space/{spaceKey}/permission/custom-content
-     * @scopes-current read:space.permission:confluence, write:space.permission:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-custom-content-post
-     */
-    addCustomContentPermissions({ spaceKey, spacePermissionCustomContent, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space/{spaceKey}/permission/custom-content",
-            method: "POST",
-            pathParams: {
-                spaceKey,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: spacePermissionCustomContent,
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Adds new permission to space.
-     *
-     * If the permission to be added is a group permission, the group can be identified
-     * by its group name or group id.
-     *
-     * Note: Apps cannot access this REST resource - including when utilizing user
-     * impersonation.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'Admin' permission for the space.
-     *
-     * @returns Returned if the requested content is returned.
-     * @path {POST} /wiki/rest/api/space/{spaceKey}/permission
-     * @scopes-current read:space.permission:confluence, write:space.permission:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-post
-     */
-    addPermissionToSpace({ spaceKey, spacePermissionRequest, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space/{spaceKey}/permission",
-            method: "POST",
-            pathParams: {
-                spaceKey,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: spacePermissionRequest,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePermissionsService.addPermissionToSpace.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Removes a space permission. Note that removing Read Space permission for a user
-     * or group will remove all
-     * the space permissions for that user or group.
-     *
-     * Note: Apps cannot access this REST resource - including when utilizing user
-     * impersonation.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'Admin' permission for the space.
-     *
-     * @path {DELETE} /wiki/rest/api/space/{spaceKey}/permission/{id}
-     * @scopes-current write:space.permission:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-id-delete
-     */
-    removePermission({ spaceKey, id, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space/{spaceKey}/permission/{id}",
-            method: "DELETE",
-            pathParams: {
-                spaceKey,
-                id,
-            },
-        })
-            .then(commonHttpClient.discardResult);
+    constructor() {
+        super(...arguments);
+        /**
+         * Adds new custom content permission to space.
+         *
+         * If the permission to be added is a group permission, the group can be identified
+         * by its group name or group id.
+         *
+         * Note: Only apps can access this REST resource and only make changes to the
+         * respective app permissions.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'Admin' permission for the space.
+         *
+         * @path {POST} /wiki/rest/api/space/{spaceKey}/permission/custom-content
+         * @scopes-current read:space.permission:confluence, write:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-custom-content-post
+         */
+        this.addCustomContentPermissions = ({ spaceKey, spacePermissionCustomContent, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space/{spaceKey}/permission/custom-content",
+                method: "POST",
+                pathParams: {
+                    spaceKey,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: spacePermissionCustomContent,
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Adds new permission to space.
+         *
+         * If the permission to be added is a group permission, the group can be identified
+         * by its group name or group id.
+         *
+         * Note: Apps cannot access this REST resource - including when utilizing user
+         * impersonation.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'Admin' permission for the space.
+         *
+         * @returns Returned if the requested content is returned.
+         * @path {POST} /wiki/rest/api/space/{spaceKey}/permission
+         * @scopes-current read:space.permission:confluence, write:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-post
+         */
+        this.addPermissionToSpace = ({ spaceKey, spacePermissionRequest, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space/{spaceKey}/permission",
+                method: "POST",
+                pathParams: {
+                    spaceKey,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: spacePermissionRequest,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePermissionsService.addPermissionToSpace.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Removes a space permission. Note that removing Read Space permission for a user
+         * or group will remove all
+         * the space permissions for that user or group.
+         *
+         * Note: Apps cannot access this REST resource - including when utilizing user
+         * impersonation.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'Admin' permission for the space.
+         *
+         * @path {DELETE} /wiki/rest/api/space/{spaceKey}/permission/{id}
+         * @scopes-current write:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-id-delete
+         */
+        this.removePermission = ({ spaceKey, id, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space/{spaceKey}/permission/{id}",
+                method: "DELETE",
+                pathParams: {
+                    spaceKey,
+                    id,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePermissionsService.addPermissionToSpace.response", zod_1.z

package/lib/openapi/v1/services/SpacePermissionsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"SpacePermissionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SpacePermissionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iEAKoC;AACpC,wEAAqE;AACrE,gGAAgG;AAChG,MAAa,uBAAwB,SAAQ,qCAAiB;IAC5D;;;;;;;;;;;;;;;OAeG;IACH,2BAA2B,CAAC,EAC1B,QAAQ,EACR,4BAA4B,GAM7B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2DAA2D;YACjE,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,4BAA4B;SACnC,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAAC,EACnB,QAAQ,EACR,sBAAsB,GAMvB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,sBAAsB;SAC7B,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,uDAAuD,CACxD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,EACf,QAAQ,EACR,EAAE,GAMH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iDAAiD;YACvD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,QAAQ;gBACR,EAAE;aACH;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,uDAAuD,EACvD,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,mBAAmB,CAAC;SACxD,CAAC;aACD,QAAQ,CAAC,uDAAuD,CAAC,CACrE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,4DAAyC;SAC1C,CAAC,CAAC;IACL,CAAC;CACF;AArJD,0DAqJC"}
+{"version":3,"file":"SpacePermissionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SpacePermissionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iEAKoC;AACpC,wEAAqE;AACrE,gGAAgG;AAChG,MAAa,uBAAwB,SAAQ,qCAAiB;IAA9D;;QACE;;;;;;;;;;;;;;;WAeG;QACH,gCAA2B,GAAG,CAAC,EAC7B,QAAQ,EACR,4BAA4B,GAM7B,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,2DAA2D;gBACjE,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,4BAA4B;aACnC,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;WAgBG;QACH,yBAAoB,GAAG,CAAC,EACtB,QAAQ,EACR,sBAAsB,GAMvB,EAA8B,EAAE;YAC/B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,sBAAsB;aAC7B,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,uDAAuD,CACxD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,qBAAgB,GAAG,CAAC,EAClB,QAAQ,EACR,EAAE,GAMH,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,iDAAiD;gBACvD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,QAAQ;oBACR,EAAE;iBACH;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;IAgBJ,CAAC;IAfC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,uDAAuD,EACvD,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,mBAAmB,CAAC;SACxD,CAAC;aACD,QAAQ,CAAC,uDAAuD,CAAC,CACrE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,4DAAyC;SAC1C,CAAC,CAAC;IACL,CAAC;CACF;AArJD,0DAqJC"}

package/lib/openapi/v1/services/SpacePropertiesService.d.ts

@@ -21,12 +21,12 @@ export declare class SpacePropertiesService extends CommonHttpService {
      * @scopes-beta read:space.property:confluence, write:space.property:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-post
      */
-    createSpaceProperty({ spaceKey, spacePropertyCreate, }: {
+    createSpaceProperty: ({ spaceKey, spacePropertyCreate, }: {
         /** The key of the space that the property will be created in. */
         spaceKey: string;
         /** The space property to be created. */
         spacePropertyCreate: SpacePropertyCreate;
-    }): Promise<SpacePropertyV1>;
+    }) => Promise<SpacePropertyV1>;
     /**
      * Deprecated, use [Confluence's v2
      * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
@@ -46,14 +46,14 @@ export declare class SpacePropertiesService extends CommonHttpService {
      * @scopes-beta read:space.property:confluence, write:space.property:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-post
      */
-    createSpacePropertyForKey({ spaceKey, key, spacePropertyCreateNoKey, }: {
+    createSpacePropertyForKey: ({ spaceKey, key, spacePropertyCreateNoKey, }: {
         /** The key of the space that the property will be created in. */
         spaceKey: string;
         /** The key of the property to be created. */
         key: string;
         /** The space property to be created. */
         spacePropertyCreateNoKey: SpacePropertyCreateNoKey;
-    }): Promise<SpacePropertyV1>;
+    }) => Promise<SpacePropertyV1>;
     /**
      * Deprecated, use [Confluence's v2
      * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
@@ -69,12 +69,12 @@ export declare class SpacePropertiesService extends CommonHttpService {
      * @scopes-beta write:space.property:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-delete
      */
-    deleteSpaceProperty({ spaceKey, key, }: {
+    deleteSpaceProperty: ({ spaceKey, key, }: {
         /** The key of the space that the property is in. */
         spaceKey: string;
         /** The key of the property to be deleted. */
         key: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Deprecated, use [Confluence's v2
      * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
@@ -92,7 +92,7 @@ export declare class SpacePropertiesService extends CommonHttpService {
      * @scopes-beta read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-get
      */
-    getSpaceProperties({ spaceKey, expand, start, limit, }: {
+    getSpaceProperties: ({ spaceKey, expand, start, limit, }: {
         /** The key of the space to be queried for its properties. */
         spaceKey: string;
         /**
@@ -102,15 +102,15 @@ export declare class SpacePropertiesService extends CommonHttpService {
          * - `version` returns information about the version of the content.
          * - `space` returns the space that the properties are in.
          */
-        expand?: ("version" | "space")[];
+        expand?: ("version" | "space")[] | undefined;
         /** The starting index of the returned objects. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of properties to return per page. Note, this may be
          * restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<SpacePropertyArray>;
+        limit?: number | undefined;
+    }) => Promise<SpacePropertyArray>;
     /**
      * Deprecated, use [Confluence's v2
      * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
@@ -127,7 +127,7 @@ export declare class SpacePropertiesService extends CommonHttpService {
      * @scopes-beta read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-get
      */
-    getSpaceProperty({ spaceKey, key, expand, }: {
+    getSpaceProperty: ({ spaceKey, key, expand, }: {
         /** The key of the space that the property is in. */
         spaceKey: string;
         /** The key of the space property. */
@@ -139,8 +139,8 @@ export declare class SpacePropertiesService extends CommonHttpService {
          * - `version` returns information about the version of the content.
          * - `space` returns the space that the properties are in.
          */
-        expand?: ("version" | "space")[];
-    }): Promise<SpacePropertyV1>;
+        expand?: ("version" | "space")[] | undefined;
+    }) => Promise<SpacePropertyV1>;
     /**
      * Deprecated, use [Confluence's v2
      * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
@@ -158,13 +158,13 @@ export declare class SpacePropertiesService extends CommonHttpService {
      * @scopes-beta read:space.property:confluence, write:space.property:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-put
      */
-    updateSpaceProperty({ spaceKey, key, spacePropertyUpdate, }: {
+    updateSpaceProperty: ({ spaceKey, key, spacePropertyUpdate, }: {
         /** The key of the space that the property is in. */
         spaceKey: string;
         /** The key of the property to be updated. */
         key: string;
         /** The space property being updated. */
         spacePropertyUpdate: SpacePropertyUpdate;
-    }): Promise<SpacePropertyV1>;
+    }) => Promise<SpacePropertyV1>;
     static initialize(): void;
 }