@resolution/confluence-api-client 0.7.6 → 0.7.8

package/lib/openapi/v2/services/SpacePermissionsService.d.ts

@@ -1,23 +1,55 @@
 import { CommonHttpService } from "../../core/CommonHttpService";
-import { type MultiEntityLinks, type SpacePermission } from "../models/common";
+import { type MultiEntityLinks, type SpacePermission, type SpacePermissionAssignment } from "../models/common";
 /**
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions
  * @category Services
  */
 export declare class SpacePermissionsService extends CommonHttpService {
     /**
-     * Returns space permissions for a specific space.
+     * Retrieves the available space permissions.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site.
+     *
+     * @returns Returned if the requested space permissions are retrieved.
+     * @path GET `/space-permissions`
+     * @scopes-current read:space.permission:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-space-permissions-get
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions#api-space-permissions-get
+     * @param params
+     */
+    getAvailableSpacePermissions: ({ cursor, limit, }?: {
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string | undefined;
+        /**
+         * Maximum number of space permissions to return. If more results exist, use the
+         * `Link` response header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: SpacePermission[] | undefined;
+        _links?: MultiEntityLinks | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns space permission assignments for a specific space.
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
      * Permission to view the space.
      *
-     * @returns Returned if the requested space permissions are returned.
+     * @returns Returned if the requested assignments are returned.
      * @path GET `/spaces/{id}/permissions`
      * @scopes-current read:space:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions#api-spaces-id-permissions-get
      * @param params
      */
-    getSpacePermissions: ({ id, cursor, limit, }: {
+    getSpacePermissionsAssignments: ({ id, cursor, limit, }: {
         /** The ID of the space to be returned. */
         id: number;
         /**
@@ -27,13 +59,13 @@ export declare class SpacePermissionsService extends CommonHttpService {
          */
         cursor?: string | undefined;
         /**
-         * Maximum number of spaces per result to return. If more results exist, use the
-         * `Link` response header to retrieve a relative URL that will return the next set
-         * of results.
+         * Maximum number of assignments to return. If more results exist, use the `Link`
+         * response header to retrieve a relative URL that will return the next set of
+         * results.
          */
         limit?: number | undefined;
     }) => Promise<{
-        results?: SpacePermission[] | undefined;
+        results?: SpacePermissionAssignment[] | undefined;
         _links?: MultiEntityLinks | undefined;
     } & {
         [key: string]: unknown;

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

@@ -17,18 +17,50 @@ class SpacePermissionsService extends CommonHttpService_1.CommonHttpService {
     constructor() {
         super(...arguments);
         /**
-         * Returns space permissions for a specific space.
+         * Retrieves the available space permissions.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to access the Confluence site.
+         *
+         * @returns Returned if the requested space permissions are retrieved.
+         * @path GET `/space-permissions`
+         * @scopes-current read:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-space-permissions-get
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions#api-space-permissions-get
+         * @param params
+         */
+        this.getAvailableSpacePermissions = ({ cursor, limit, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/space-permissions",
+                method: "GET",
+                query: {
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePermissionsService.getAvailableSpacePermissions.response")))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns space permission assignments for a specific space.
          *
          * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
          * Permission to view the space.
          *
-         * @returns Returned if the requested space permissions are returned.
+         * @returns Returned if the requested assignments are returned.
          * @path GET `/spaces/{id}/permissions`
          * @scopes-current read:space:confluence
          * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions#api-spaces-id-permissions-get
          * @param params
          */
-        this.getSpacePermissions = ({ id, cursor, limit, }) => {
+        this.getSpacePermissionsAssignments = ({ id, cursor, limit, }) => {
             return this.getClientInstance()
                 .request({
                 path: "/spaces/{id}/permissions",
@@ -47,12 +79,12 @@ class SpacePermissionsService extends CommonHttpService_1.CommonHttpService {
                 },
             }))
                 .then(commonHttpClient.castResponse())
-                .then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePermissionsService.getSpacePermissions.response")))
+                .then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePermissionsService.getSpacePermissionsAssignments.response")))
                 .then(commonHttpClient.getBody);
         };
     }
     static initialize() {
-        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePermissionsService.getSpacePermissions.response", zod_1.z
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePermissionsService.getAvailableSpacePermissions.response", zod_1.z
             .object({
             status: zod_1.z.literal(200),
             mediaType: zod_1.z.literal("application/json"),
@@ -67,7 +99,23 @@ class SpacePermissionsService extends CommonHttpService_1.CommonHttpService {
             })
                 .catchall(zod_1.z.unknown()),
         })
-            .describe("SpacePermissionsService.getSpacePermissions.response"));
+            .describe("SpacePermissionsService.getAvailableSpacePermissions.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePermissionsService.getSpacePermissionsAssignments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePermissionAssignment"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("SpacePermissionsService.getSpacePermissionsAssignments.response"));
         validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"SpacePermissionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpacePermissionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,6CAI0B;AAC1B,wEAAqE;AACrE;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,qCAAiB;IAA9D;;QACE;;;;;;;;;;;WAWG;QACH,wBAAmB,GAAG,CAAC,EACrB,EAAE,EACF,MAAM,EACN,KAAK,GAgBN,EAOC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,0BAA0B;gBAChC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK;iBACN;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,EASzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,sDAAsD,CACvD,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAuBJ,CAAC;IAtBW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,sDAAsD,EACtD,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;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;qBACtD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,sDAAsD,CAAC,CACpE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAtGD,0DAsGC"}
+{"version":3,"file":"SpacePermissionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpacePermissionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,6CAK0B;AAC1B,wEAAqE;AACrE;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,qCAAiB;IAA9D;;QACE;;;;;;;;;;;;WAYG;QACH,iCAA4B,GAAG,CAAC,EAC9B,MAAM,EACN,KAAK,MAcH,EAAE,EAOJ,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oBAAoB;gBAC1B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK;iBACN;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,EASzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,+DAA+D,CAChE,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,mCAA8B,GAAG,CAAC,EAChC,EAAE,EACF,MAAM,EACN,KAAK,GAgBN,EAOC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,0BAA0B;gBAChC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK;iBACN;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,EASzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,iEAAiE,CAClE,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAgDJ,CAAC;IA/CW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,+DAA+D,EAC/D,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;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;qBACtD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CACP,+DAA+D,CAChE,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;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CACJ,iDAAuB,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAC1D;qBACA,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CACP,iEAAiE,CAClE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAzMD,0DAyMC"}

package/lib/openapi/v2/services/SpaceRolesService.d.ts

@@ -0,0 +1,168 @@
+import { CommonHttpService } from "../../core/CommonHttpService";
+import { type MultiEntityLinks, type Principal, type PrincipalType, type SpaceRole, type SpaceRoleAssignment } from "../models/common";
+/**
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles
+ * @category Services
+ */
+export declare class SpaceRolesService extends CommonHttpService {
+    /**
+     * Retrieves the available space roles.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site; if requesting a certain space's
+     * roles, permission to view the space.
+     *
+     * @returns Returned if the requested space roles are retrieved.
+     * @path GET `/space-roles`
+     * @scopes-current read:space.permission:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-space-roles-get
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-space-roles-get
+     * @param params
+     */
+    getAvailableSpaceRoles: ({ spaceId, roleType, principalId, principalType, cursor, limit, }?: {
+        /**
+         * The space ID for which to filter available space roles; if empty, return all
+         * available space roles for the tenant.
+         */
+        spaceId?: string | undefined;
+        /** The space role type to filter results by. */
+        roleType?: string | undefined;
+        /**
+         * The principal ID to filter results by. If specified, a principal-type must also
+         * be specified. Paired with a `principal-type` of `ACCESS_CLASS`, valid values
+         * include [`anonymous-users`, `jsm-project-admins`, `authenticated-users`,
+         * `all-licensed-users`, `all-product-admins`]
+         */
+        principalId?: string | undefined;
+        /**
+         * The principal type to filter results by. If specified, a principal-id must also
+         * be specified.
+         */
+        principalType?: PrincipalType | undefined;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string | undefined;
+        /**
+         * Maximum number of space roles to return. If more results exist, use the `Link`
+         * response header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: SpaceRole[] | undefined;
+        _links?: MultiEntityLinks | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves the space role assignments.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the space.
+     *
+     * @returns Returned if the requested space role assignments are retrieved.
+     * @path GET `/spaces/{id}/role-assignments`
+     * @scopes-current read:space.permission:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-spaces-id-role-assignments-get
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-spaces-id-role-assignments-get
+     * @param params
+     */
+    getSpaceRoleAssignments: ({ id, roleId, roleType, principalId, principalType, cursor, limit, }: {
+        /** The ID of the space for which to retrieve assignments. */
+        id: number;
+        /** Filters the returned role assignments to the provided role ID. */
+        roleId?: string | undefined;
+        /** Filters the returned role assignments to the provided role type. */
+        roleType?: string | undefined;
+        /**
+         * Filters the returned role assignments to the provided principal id. If
+         * specified, a principal-type must also be specified. Paired with a
+         * `principal-type` of `ACCESS_CLASS`, valid values include [`anonymous-users`,
+         * `jsm-project-admins`, `authenticated-users`, `all-licensed-users`,
+         * `all-product-admins`]
+         */
+        principalId?: string | undefined;
+        /**
+         * Filters the returned role assignments to the provided principal type. If
+         * specified, a principal-id must also be specified.
+         */
+        principalType?: PrincipalType | undefined;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string | undefined;
+        /**
+         * Maximum number of space roles to return. If more results exist, use the `Link`
+         * response header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number | undefined;
+    }) => Promise<{
+        results?: SpaceRoleAssignment[] | undefined;
+        _links?: MultiEntityLinks | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves the space role by ID.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site.
+     *
+     * @returns Returned if the requested space role is retrieved.
+     * @path GET `/space-roles/{id}`
+     * @scopes-current read:space.permission:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-space-roles-id-get
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-space-roles-id-get
+     * @param params
+     */
+    getSpaceRolesById: ({ id, }: {
+        /** The ID of the space role to retrieve. */
+        id: number;
+    }) => Promise<SpaceRole & {
+        _links?: ({
+            /** Base url of the Confluence site. */
+            base?: string | undefined;
+        } & {
+            [key: string]: unknown;
+        }) | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Sets space role assignments as specified in the payload.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to manage roles in the space.
+     *
+     * @returns Returned if the requested update to space role assignments succeeds in its entirety.
+     * @path POST `/spaces/{id}/role-assignments`
+     * @scopes-current write:space.permission:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-spaces-id-role-assignments-post
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-spaces-id-role-assignments-post
+     * @param params
+     */
+    setSpaceRoleAssignments: ({ id, requestBody, }: {
+        /** The ID of the space for which to retrieve assignments. */
+        id: number;
+        requestBody: {
+            /** The principal of the role assignment. */
+            principal: Principal;
+            /** The role to which the principal is assigned. */
+            roleId?: string | undefined;
+        } & {
+            [key: string]: unknown;
+        };
+    }) => Promise<{
+        results?: SpaceRoleAssignment[] | undefined;
+        _links?: MultiEntityLinks | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    protected static initialize(): void;
+}

package/lib/openapi/v2/services/SpaceRolesService.js

@@ -0,0 +1,231 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpaceRolesService = 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 validationSchemaStorage_1 = require("../validationSchemaStorage");
+/**
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles
+ * @category Services
+ */
+class SpaceRolesService extends CommonHttpService_1.CommonHttpService {
+    constructor() {
+        super(...arguments);
+        /**
+         * Retrieves the available space roles.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to access the Confluence site; if requesting a certain space's
+         * roles, permission to view the space.
+         *
+         * @returns Returned if the requested space roles are retrieved.
+         * @path GET `/space-roles`
+         * @scopes-current read:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-space-roles-get
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-space-roles-get
+         * @param params
+         */
+        this.getAvailableSpaceRoles = ({ spaceId, roleType, principalId, principalType, cursor, limit, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/space-roles",
+                method: "GET",
+                query: {
+                    "space-id": spaceId,
+                    "role-type": roleType,
+                    "principal-id": principalId,
+                    "principal-type": principalType,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceRolesService.getAvailableSpaceRoles.response")))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Retrieves the space role assignments.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to view the space.
+         *
+         * @returns Returned if the requested space role assignments are retrieved.
+         * @path GET `/spaces/{id}/role-assignments`
+         * @scopes-current read:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-spaces-id-role-assignments-get
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-spaces-id-role-assignments-get
+         * @param params
+         */
+        this.getSpaceRoleAssignments = ({ id, roleId, roleType, principalId, principalType, cursor, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/spaces/{id}/role-assignments",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "role-id": roleId,
+                    "role-type": roleType,
+                    "principal-id": principalId,
+                    "principal-type": principalType,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceRolesService.getSpaceRoleAssignments.response")))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Retrieves the space role by ID.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to access the Confluence site.
+         *
+         * @returns Returned if the requested space role is retrieved.
+         * @path GET `/space-roles/{id}`
+         * @scopes-current read:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-space-roles-id-get
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-space-roles-id-get
+         * @param params
+         */
+        this.getSpaceRolesById = ({ id, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/space-roles/{id}",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceRolesService.getSpaceRolesById.response")))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Sets space role assignments as specified in the payload.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to manage roles in the space.
+         *
+         * @returns Returned if the requested update to space role assignments succeeds in its entirety.
+         * @path POST `/spaces/{id}/role-assignments`
+         * @scopes-current write:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-spaces-id-role-assignments-post
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-spaces-id-role-assignments-post
+         * @param params
+         */
+        this.setSpaceRoleAssignments = ({ id, requestBody, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/spaces/{id}/role-assignments",
+                method: "POST",
+                pathParams: {
+                    id,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: requestBody,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceRolesService.setSpaceRoleAssignments.response")))
+                .then(commonHttpClient.getBody);
+        };
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpaceRolesService.getAvailableSpaceRoles.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("SpaceRole"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("SpaceRolesService.getAvailableSpaceRoles.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpaceRolesService.getSpaceRolesById.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("SpaceRole"), zod_1.z
+                .object({
+                _links: zod_1.z
+                    .object({
+                    base: zod_1.z.string().optional(),
+                })
+                    .catchall(zod_1.z.unknown())
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown())),
+        })
+            .describe("SpaceRolesService.getSpaceRolesById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpaceRolesService.getSpaceRoleAssignments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("SpaceRoleAssignment"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("SpaceRolesService.getSpaceRoleAssignments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpaceRolesService.setSpaceRoleAssignments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("SpaceRoleAssignment"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("SpaceRolesService.setSpaceRoleAssignments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.SpaceRolesService = SpaceRolesService;
+//# sourceMappingURL=SpaceRolesService.js.map

package/lib/openapi/v2/services/SpaceRolesService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpaceRolesService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpaceRolesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,6CAO0B;AAC1B,wEAAqE;AACrE;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,qCAAiB;IAAxD;;QACE;;;;;;;;;;;;;WAaG;QACH,2BAAsB,GAAG,CAAC,EACxB,OAAO,EACP,QAAQ,EACR,WAAW,EACX,aAAa,EACb,MAAM,EACN,KAAK,MAiCH,EAAE,EAOJ,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,UAAU,EAAE,OAAO;oBACnB,WAAW,EAAE,QAAQ;oBACrB,cAAc,EAAE,WAAW;oBAC3B,gBAAgB,EAAE,aAAa;oBAC/B,MAAM;oBACN,KAAK;iBACN;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,EASzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,mDAAmD,CACpD,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,4BAAuB,GAAG,CAAC,EACzB,EAAE,EACF,MAAM,EACN,QAAQ,EACR,WAAW,EACX,aAAa,EACb,MAAM,EACN,KAAK,GAiCN,EAOC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,+BAA+B;gBACrC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,SAAS,EAAE,MAAM;oBACjB,WAAW,EAAE,QAAQ;oBACrB,cAAc,EAAE,WAAW;oBAC3B,gBAAgB,EAAE,aAAa;oBAC/B,MAAM;oBACN,KAAK;iBACN;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,EASzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,sBAAiB,GAAG,CAAC,EACnB,EAAE,GAIH,EAYC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;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,EAazB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,8CAA8C,CAC/C,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,4BAAuB,GAAG,CAAC,EACzB,EAAE,EACF,WAAW,GAYZ,EAOC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,+BAA+B;gBACrC,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,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,EASzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAmFJ,CAAC;IAlFW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,mDAAmD,EACnD,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;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;qBAChD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,mDAAmD,CAAC,CACjE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,8CAA8C,EAC9C,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,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,EACzC,OAAC;iBACE,MAAM,CAAC;gBACN,MAAM,EAAE,OAAC;qBACN,MAAM,CAAC;oBACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC;qBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;qBACrB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;SACF,CAAC;aACD,QAAQ,CAAC,8CAA8C,CAAC,CAC5D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,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;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;qBAC1D,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,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;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;qBAC1D,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AApbD,8CAobC"}