@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpacePermissionsService = 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");
+class SpacePermissionsService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Returns space permissions 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.
+     * @path {GET} /spaces/{id}/permissions
+     * @scopes-current read:space:confluence
+     */
+    getSpacePermissions({ id, cursor, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/spaces/{id}/permissions",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                cursor,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePermissionsService.getSpacePermissions.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePermissionsService.getSpacePermissions.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("SpacePermission"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("SpacePermissionsService.getSpacePermissions.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.SpacePermissionsService = SpacePermissionsService;
+//# sourceMappingURL=SpacePermissionsService.js.map

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

@@ -0,0 +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,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,wEAAqE;AACrE,MAAa,uBAAwB,SAAQ,qCAAiB;IAC5D;;;;;;;;;OASG;IACH,mBAAmB,CAAC,EAClB,EAAE,EACF,MAAM,EACN,KAAK,GAgBN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,0BAA0B;YAChC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,KAAK;aACN;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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,sDAAsD,CACvD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,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;AAlGD,0DAkGC"}

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

@@ -0,0 +1,118 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type MultiEntityLinks, type SpaceProperty } from "../models/common";
+import type { SpacePropertyCreateRequest, SpacePropertyUpdateRequest } from "../models/spaceProperties";
+export declare class SpacePropertiesService extends CommonHttpService {
+    /**
+     * Creates a new space property.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the space property was created successfully.
+     * @path {POST} /spaces/{space-id}/properties
+     * @scopes-current read:space:confluence, write:space:confluence
+     */
+    createSpaceProperty({ spaceId, spacePropertyCreateRequest, }: {
+        /** The ID of the space for which space properties should be returned. */
+        spaceId: number;
+        /** The space property to be created */
+        spacePropertyCreateRequest: SpacePropertyCreateRequest;
+    }): Promise<SpaceProperty>;
+    /**
+     * Deletes a space property by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'Admin' permission for the space.
+     *
+     * @path {DELETE} /spaces/{space-id}/properties/{property-id}
+     * @scopes-current read:space:confluence, write:space:confluence
+     */
+    deleteSpacePropertyById({ spaceId, propertyId, }: {
+        /** The ID of the space the property belongs to. */
+        spaceId: number;
+        /** The ID of the property to be deleted. */
+        propertyId: number;
+    }): Promise<void>;
+    /**
+     * Returns all properties for the given space. Space properties are a key-value
+     * storage associated with a space.
+     * The limit parameter specifies the maximum number of results returned in a
+     * single response. Use the `link` response header
+     * to paginate through additional results.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'View' permission for the space.
+     *
+     * @returns Returned if the requested space properties are returned. `results` may be empty
+     * if no results were found.
+     * @path {GET} /spaces/{space-id}/properties
+     * @scopes-current read:space:confluence
+     */
+    getSpaceProperties({ spaceId, key, cursor, limit, }: {
+        /** The ID of the space for which space properties should be returned. */
+        spaceId: number;
+        /**
+         * The key of the space property to retrieve. This should be used when a user
+         * knows the key of their property, but needs to retrieve the id for use in other
+         * methods.
+         */
+        key?: string;
+        /**
+         * 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;
+        /**
+         * Maximum number of pages per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: SpaceProperty[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieve a space property by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'View' permission for the space.
+     *
+     * @returns Returned if the space property was retrieved.
+     * @path {GET} /spaces/{space-id}/properties/{property-id}
+     * @scopes-current read:space:confluence
+     */
+    getSpacePropertyById({ spaceId, propertyId, }: {
+        /** The ID of the space the property belongs to. */
+        spaceId: number;
+        /** The ID of the property to be retrieved. */
+        propertyId: number;
+    }): Promise<SpaceProperty>;
+    /**
+     * Update a space property by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the space property was updated successfully.
+     * @path {PUT} /spaces/{space-id}/properties/{property-id}
+     * @scopes-current read:space:confluence, write:space:confluence
+     */
+    updateSpacePropertyById({ spaceId, propertyId, spacePropertyUpdateRequest, }: {
+        /** The ID of the space the property belongs to. */
+        spaceId: number;
+        /** The ID of the property to be updated. */
+        propertyId: number;
+        /** The space property to be updated. */
+        spacePropertyUpdateRequest: SpacePropertyUpdateRequest;
+    }): Promise<SpaceProperty>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,213 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpacePropertiesService = 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");
+class SpacePropertiesService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Creates a new space property.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the space property was created successfully.
+     * @path {POST} /spaces/{space-id}/properties
+     * @scopes-current read:space:confluence, write:space:confluence
+     */
+    createSpaceProperty({ spaceId, spacePropertyCreateRequest, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/spaces/{space-id}/properties",
+            method: "POST",
+            pathParams: {
+                "space-id": spaceId,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: spacePropertyCreateRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.createSpaceProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deletes a space property by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'Admin' permission for the space.
+     *
+     * @path {DELETE} /spaces/{space-id}/properties/{property-id}
+     * @scopes-current read:space:confluence, write:space:confluence
+     */
+    deleteSpacePropertyById({ spaceId, propertyId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/spaces/{space-id}/properties/{property-id}",
+            method: "DELETE",
+            pathParams: {
+                "space-id": spaceId,
+                "property-id": propertyId,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns all properties for the given space. Space properties are a key-value
+     * storage associated with a space.
+     * The limit parameter specifies the maximum number of results returned in a
+     * single response. Use the `link` response header
+     * to paginate through additional results.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'View' permission for the space.
+     *
+     * @returns Returned if the requested space properties are returned. `results` may be empty
+     * if no results were found.
+     * @path {GET} /spaces/{space-id}/properties
+     * @scopes-current read:space:confluence
+     */
+    getSpaceProperties({ spaceId, key, cursor, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/spaces/{space-id}/properties",
+            method: "GET",
+            pathParams: {
+                "space-id": spaceId,
+            },
+            query: {
+                key,
+                cursor,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpaceProperties.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Retrieve a space property by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'View' permission for the space.
+     *
+     * @returns Returned if the space property was retrieved.
+     * @path {GET} /spaces/{space-id}/properties/{property-id}
+     * @scopes-current read:space:confluence
+     */
+    getSpacePropertyById({ spaceId, propertyId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/spaces/{space-id}/properties/{property-id}",
+            method: "GET",
+            pathParams: {
+                "space-id": spaceId,
+                "property-id": propertyId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpacePropertyById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Update a space property by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the space property was updated successfully.
+     * @path {PUT} /spaces/{space-id}/properties/{property-id}
+     * @scopes-current read:space:confluence, write:space:confluence
+     */
+    updateSpacePropertyById({ spaceId, propertyId, spacePropertyUpdateRequest, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/spaces/{space-id}/properties/{property-id}",
+            method: "PUT",
+            pathParams: {
+                "space-id": spaceId,
+                "property-id": propertyId,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: spacePropertyUpdateRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.updateSpacePropertyById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.getSpaceProperties.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("SpaceProperty"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("SpacePropertiesService.getSpaceProperties.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.createSpaceProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(201),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpaceProperty"),
+        })
+            .describe("SpacePropertiesService.createSpaceProperty.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.getSpacePropertyById.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpaceProperty"),
+        })
+            .describe("SpacePropertiesService.getSpacePropertyById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.updateSpacePropertyById.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpaceProperty"),
+        })
+            .describe("SpacePropertiesService.updateSpacePropertyById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.SpacePropertiesService = SpacePropertiesService;
+//# sourceMappingURL=SpacePropertiesService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SpacePropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpacePropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAK1B,wEAAqE;AACrE,MAAa,sBAAuB,SAAQ,qCAAiB;IAC3D;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,EAClB,OAAO,EACP,0BAA0B,GAM3B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+BAA+B;YACrC,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;aACpB;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,0BAA0B;SACjC,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,qDAAqD,CACtD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,uBAAuB,CAAC,EACtB,OAAO,EACP,UAAU,GAMX;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;gBACnB,aAAa,EAAE,UAAU;aAC1B;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,EACjB,OAAO,EACP,GAAG,EACH,MAAM,EACN,KAAK,GAsBN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+BAA+B;YACrC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;aACpB;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,MAAM;gBACN,KAAK;aACN;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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EACnB,OAAO,EACP,UAAU,GAMX;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;gBACnB,aAAa,EAAE,UAAU;aAC1B;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,sDAAsD,CACvD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,EACtB,OAAO,EACP,UAAU,EACV,0BAA0B,GAQ3B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;gBACnB,aAAa,EAAE,UAAU;aAC1B;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,0BAA0B;SACjC,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,yDAAyD,CAC1D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;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,eAAe,CAAC,CAAC;qBACpD,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,qDAAqD,EACrD,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,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,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,iDAAuB,CAAC,IAAI,CAAC,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,sDAAsD,CAAC,CACpE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yDAAyD,EACzD,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,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,yDAAyD,CAAC,CACvE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AA5UD,wDA4UC"}

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

@@ -0,0 +1,141 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type MultiEntityLinks, type SpaceSortOrder } from "../models/common";
+import { type SpaceBulk, type SpaceDescriptionBodyRepresentation, type SpaceSingle } from "../models/space";
+export declare class SpaceService extends CommonHttpService {
+    /**
+     * Returns a specific space.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the space.
+     *
+     * @returns Returned if the requested space is returned.
+     * @path {GET} /spaces/{id}
+     * @scopes-current read:space:confluence
+     */
+    getSpaceById({ id, descriptionFormat, includeIcon, includeOperations, includeProperties, includePermissions, includeLabels, }: {
+        /** The ID of the space to be returned. */
+        id: number;
+        /**
+         * The content format type to be returned in the `description` field of the
+         * response. If available, the representation will be available under a response
+         * field of the same name under the `description` field.
+         */
+        descriptionFormat?: SpaceDescriptionBodyRepresentation;
+        /** If the icon for the space should be fetched or not. */
+        includeIcon?: boolean;
+        /**
+         * Includes operations associated with this space in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeOperations?: boolean;
+        /**
+         * Includes space properties associated with this space in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeProperties?: boolean;
+        /**
+         * Includes space permissions associated with this space in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includePermissions?: boolean;
+        /**
+         * Includes labels associated with this space in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeLabels?: boolean;
+    }): Promise<SpaceSingle & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Returns all spaces. The results will be sorted by id ascending. The number of
+     * results is limited by the `limit` parameter and
+     * additional results (if available) will be available through the `next` URL
+     * present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Only spaces that the user has permission to view will be returned.
+     *
+     * @returns Returned if the requested spaces are returned.
+     * @path {GET} /spaces
+     * @scopes-current read:space:confluence
+     */
+    getSpaces({ ids, keys, type, status, labels, favoritedBy, notFavoritedBy, sort, descriptionFormat, includeIcon, cursor, limit, }: {
+        /**
+         * Filter the results to spaces based on their IDs. Multiple IDs can be specified
+         * as a comma-separated list.
+         */
+        ids?: number[];
+        /**
+         * Filter the results to spaces based on their keys. Multiple keys can be
+         * specified as a comma-separated list.
+         */
+        keys?: string[];
+        /** Filter the results to spaces based on their type. */
+        type?: "global" | "collaboration" | "knowledge_base" | "personal";
+        /** Filter the results to spaces based on their status. */
+        status?: "current" | "archived";
+        /**
+         * Filter the results to spaces based on their labels. Multiple labels can be
+         * specified as a comma-separated list.
+         */
+        labels?: string[];
+        /**
+         * Filter the results to spaces favorited by the user with the specified account
+         * ID.
+         */
+        favoritedBy?: string;
+        /**
+         * Filter the results to spaces NOT favorited by the user with the specified
+         * account ID.
+         */
+        notFavoritedBy?: string;
+        /** Used to sort the result by a particular field. */
+        sort?: SpaceSortOrder;
+        /**
+         * The content format type to be returned in the `description` field of the
+         * response. If available, the representation will be available under a response
+         * field of the same name under the `description` field.
+         */
+        descriptionFormat?: SpaceDescriptionBodyRepresentation;
+        /** If the icon for the space should be fetched or not. */
+        includeIcon?: boolean;
+        /**
+         * 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;
+        /**
+         * 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.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: SpaceBulk[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    static initialize(): void;
+}