@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,163 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type BlueprintTemplateArray, type ContentTemplate, type ContentTemplateArray, type ContentTemplateCreate, type ContentTemplateUpdate } from "../models/template";
+export declare class TemplateService extends CommonHttpService {
+    /**
+     * Creates a new content template. Note, blueprint templates cannot be created via
+     * the REST API.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space to create a space template or 'Confluence
+     * Administrator'
+     * global permission to create a global template.
+     *
+     * @returns Returned if the template is created.
+     * @path {POST} /wiki/rest/api/template
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:template:confluence, read:content-details:confluence,
+     * write:template:confluence
+     */
+    createContentTemplate({ contentTemplateCreate, }: {
+        /**
+         * The content template to be created.
+         * The content body must be in 'storage' format.
+         */
+        contentTemplateCreate: ContentTemplateCreate;
+    }): Promise<ContentTemplate>;
+    /**
+     * Returns all templates provided by blueprints. Use this method to retrieve
+     * all global blueprint templates or all blueprint templates in a space.
+     *
+     * Note, all global blueprints are inherited by each space. Space blueprints
+     * can be customised without affecting the global blueprints.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space to view blueprints for the space and permission
+     * to access the Confluence site ('Can use' global permission) to view global
+     * blueprints.
+     *
+     * @returns Returned if the requested templates are returned.
+     * @path {GET} /wiki/rest/api/template/blueprint
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:template:confluence, read:content-details:confluence
+     */
+    getBlueprintTemplates({ spaceKey, start, limit, expand, }: {
+        /**
+         * The key of the space to be queried for templates. If the `spaceKey`
+         * is not specified, global blueprint templates will be returned.
+         */
+        spaceKey?: string;
+        /** The starting index of the returned templates. */
+        start?: number;
+        /**
+         * The maximum number of templates to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+        /**
+         * A multi-value parameter indicating which properties of the template
+         * to expand.
+         *
+         * - `body` returns the content of the template in storage format.
+         */
+        expand?: "body"[];
+    }): Promise<BlueprintTemplateArray>;
+    /**
+     * Returns a content template. This includes information about template,
+     * like the name, the space or blueprint that the template is in, the body
+     * of the template, and more.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space to view space templates and permission to
+     * access the Confluence site ('Can use' global permission) to view global
+     * templates.
+     *
+     * @returns Returned if the requested template is returned.
+     * @path {GET} /wiki/rest/api/template/{contentTemplateId}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:template:confluence, read:content-details:confluence
+     */
+    getContentTemplate({ contentTemplateId, }: {
+        /** The ID of the content template to be returned. */
+        contentTemplateId: string;
+    }): Promise<ContentTemplate>;
+    /**
+     * Returns all content templates. Use this method to retrieve all global
+     * content templates or all content templates in a space.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space to view space templates and permission to
+     * access the Confluence site ('Can use' global permission) to view global
+     * templates.
+     *
+     * @returns Returned if the requested templates are returned.
+     * @path {GET} /wiki/rest/api/template/page
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:template:confluence, read:content-details:confluence
+     */
+    getContentTemplates({ spaceKey, start, limit, expand, }: {
+        /**
+         * The key of the space to be queried for templates. If the `spaceKey`
+         * is not specified, global templates will be returned.
+         */
+        spaceKey?: string;
+        /** The starting index of the returned templates. */
+        start?: number;
+        /**
+         * The maximum number of templates to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+        /**
+         * A multi-value parameter indicating which properties of the template
+         * to expand.
+         *
+         * - `body` returns the content of the template in storage format.
+         */
+        expand?: "body"[];
+    }): Promise<ContentTemplateArray>;
+    /**
+     * Deletes a template. This results in different actions depending on the
+     * type of template:
+     *
+     * - If the template is a content template, it is deleted.
+     * - If the template is a modified space-level blueprint template, it reverts
+     * to the template inherited from the global-level blueprint template.
+     * - If the template is a modified global-level blueprint template, it reverts
+     * to the default global-level blueprint template.
+     *
+     *  Note, unmodified blueprint templates cannot be deleted.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     *         'Admin' permission for the space to delete a space template or
+     * 'Confluence Administrator'
+     *         global permission to delete a global template.
+     *
+     * @path {DELETE} /wiki/rest/api/template/{contentTemplateId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:template:confluence
+     */
+    removeTemplate({ contentTemplateId, }: {
+        /** The ID of the template to be deleted. */
+        contentTemplateId: string;
+    }): Promise<void>;
+    /**
+     * Updates a content template. Note, blueprint templates cannot be updated
+     * via the REST API.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space to update a space template or 'Confluence
+     * Administrator'
+     * global permission to update a global template.
+     *
+     * @returns Returned if the template is updated.
+     * @path {PUT} /wiki/rest/api/template
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:template:confluence, read:content-details:confluence,
+     * write:template:confluence
+     */
+    updateContentTemplate({ contentTemplateUpdate, }: {
+        /** The updated content template. */
+        contentTemplateUpdate: ContentTemplateUpdate;
+    }): Promise<ContentTemplate>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,259 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemplateService = 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 template_1 = require("../models/template");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class TemplateService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Creates a new content template. Note, blueprint templates cannot be created via
+     * the REST API.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space to create a space template or 'Confluence
+     * Administrator'
+     * global permission to create a global template.
+     *
+     * @returns Returned if the template is created.
+     * @path {POST} /wiki/rest/api/template
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:template:confluence, read:content-details:confluence,
+     * write:template:confluence
+     */
+    createContentTemplate({ contentTemplateCreate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/template",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: contentTemplateCreate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("TemplateService.createContentTemplate.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all templates provided by blueprints. Use this method to retrieve
+     * all global blueprint templates or all blueprint templates in a space.
+     *
+     * Note, all global blueprints are inherited by each space. Space blueprints
+     * can be customised without affecting the global blueprints.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space to view blueprints for the space and permission
+     * to access the Confluence site ('Can use' global permission) to view global
+     * blueprints.
+     *
+     * @returns Returned if the requested templates are returned.
+     * @path {GET} /wiki/rest/api/template/blueprint
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:template:confluence, read:content-details:confluence
+     */
+    getBlueprintTemplates({ spaceKey, start, limit, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/template/blueprint",
+            method: "GET",
+            query: {
+                spaceKey,
+                start,
+                limit,
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("TemplateService.getBlueprintTemplates.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a content template. This includes information about template,
+     * like the name, the space or blueprint that the template is in, the body
+     * of the template, and more.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space to view space templates and permission to
+     * access the Confluence site ('Can use' global permission) to view global
+     * templates.
+     *
+     * @returns Returned if the requested template is returned.
+     * @path {GET} /wiki/rest/api/template/{contentTemplateId}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:template:confluence, read:content-details:confluence
+     */
+    getContentTemplate({ contentTemplateId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/template/{contentTemplateId}",
+            method: "GET",
+            pathParams: {
+                contentTemplateId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("TemplateService.getContentTemplate.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all content templates. Use this method to retrieve all global
+     * content templates or all content templates in a space.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space to view space templates and permission to
+     * access the Confluence site ('Can use' global permission) to view global
+     * templates.
+     *
+     * @returns Returned if the requested templates are returned.
+     * @path {GET} /wiki/rest/api/template/page
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:template:confluence, read:content-details:confluence
+     */
+    getContentTemplates({ spaceKey, start, limit, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/template/page",
+            method: "GET",
+            query: {
+                spaceKey,
+                start,
+                limit,
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("TemplateService.getContentTemplates.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deletes a template. This results in different actions depending on the
+     * type of template:
+     *
+     * - If the template is a content template, it is deleted.
+     * - If the template is a modified space-level blueprint template, it reverts
+     * to the template inherited from the global-level blueprint template.
+     * - If the template is a modified global-level blueprint template, it reverts
+     * to the default global-level blueprint template.
+     *
+     *  Note, unmodified blueprint templates cannot be deleted.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     *         'Admin' permission for the space to delete a space template or
+     * 'Confluence Administrator'
+     *         global permission to delete a global template.
+     *
+     * @path {DELETE} /wiki/rest/api/template/{contentTemplateId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:template:confluence
+     */
+    removeTemplate({ contentTemplateId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/template/{contentTemplateId}",
+            method: "DELETE",
+            pathParams: {
+                contentTemplateId,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Updates a content template. Note, blueprint templates cannot be updated
+     * via the REST API.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space to update a space template or 'Confluence
+     * Administrator'
+     * global permission to update a global template.
+     *
+     * @returns Returned if the template is updated.
+     * @path {PUT} /wiki/rest/api/template
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:template:confluence, read:content-details:confluence,
+     * write:template:confluence
+     */
+    updateContentTemplate({ contentTemplateUpdate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/template",
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: contentTemplateUpdate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("TemplateService.updateContentTemplate.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("TemplateService.updateContentTemplate.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentTemplate"),
+        })
+            .describe("TemplateService.updateContentTemplate.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("TemplateService.createContentTemplate.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentTemplate"),
+        })
+            .describe("TemplateService.createContentTemplate.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("TemplateService.getContentTemplate.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentTemplate"),
+        })
+            .describe("TemplateService.getContentTemplate.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("TemplateService.getBlueprintTemplates.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("BlueprintTemplateArray"),
+        })
+            .describe("TemplateService.getBlueprintTemplates.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("TemplateService.getContentTemplates.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentTemplateArray"),
+        })
+            .describe("TemplateService.getContentTemplates.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([template_1.registerTemplateValidationSchemas]);
+    }
+}
+exports.TemplateService = TemplateService;
+//# sourceMappingURL=TemplateService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/TemplateService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iDAO4B;AAC5B,wEAAqE;AACrE,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,EACpB,qBAAqB,GAOtB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,qBAAqB;SAC5B,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,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CAAC,EACpB,QAAQ,EACR,KAAK,EACL,KAAK,EACL,MAAM,GAqBP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,QAAQ;gBACR,KAAK;gBACL,KAAK;gBACL,MAAM;aACP;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,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAAC,EACjB,iBAAiB,GAIlB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,iBAAiB;aAClB;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,6CAA6C,CAC9C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAClB,QAAQ,EACR,KAAK,EACL,KAAK,EACL,MAAM,GAqBP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8BAA8B;YACpC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,QAAQ;gBACR,KAAK;gBACL,KAAK;gBACL,MAAM;aACP;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,8CAA8C,CAC/C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,CAAC,EACb,iBAAiB,GAIlB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,iBAAiB;aAClB;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,EACpB,qBAAqB,GAItB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,qBAAqB;SAC5B,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,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,6CAA6C,EAC7C,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,CAAC,6CAA6C,CAAC,CAC3D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,wBAAwB,CAAC;SAC7D,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,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,iDAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC;SAC3D,CAAC;aACD,QAAQ,CAAC,8CAA8C,CAAC,CAC5D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AAzYD,0CAyYC"}

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

@@ -0,0 +1,101 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type Theme } from "../models/common";
+import { type ThemeArray, type ThemeUpdate } from "../models/themes";
+export declare class ThemesService extends CommonHttpService {
+    /**
+     * Returns the globally assigned theme.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
+     *
+     * @returns Returned if the global theme is returned.
+     * @path {GET} /wiki/rest/api/settings/theme/selected
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence
+     */
+    getGlobalTheme(): Promise<Theme>;
+    /**
+     * Returns the theme selected for a space, if one is set. If no space
+     * theme is set, this means that the space is inheriting the global look
+     * and feel settings.
+     *
+     * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’
+     * permission for the space.
+     *
+     * @returns Returned if the requested theme is returned.
+     * @path {GET} /wiki/rest/api/space/{spaceKey}/theme
+     * @scopes-current read:confluence-space.summary
+     * @scopes-beta read:space.setting:confluence
+     */
+    getSpaceTheme({ spaceKey, }: {
+        /** The key of the space to be queried for its theme. */
+        spaceKey: string;
+    }): Promise<Theme>;
+    /**
+     * Returns a theme. This includes information about the theme name,
+     * description, and icon.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
+     *
+     * @returns Returned if the requested theme is returned.
+     * @path {GET} /wiki/rest/api/settings/theme/{themeKey}
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence
+     */
+    getTheme({ themeKey, }: {
+        /** The key of the theme to be returned. */
+        themeKey: string;
+    }): Promise<Theme>;
+    /**
+     * Returns all themes, not including the default theme.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
+     *
+     * @returns Returned if the requested themes are returned.
+     * @path {GET} /wiki/rest/api/settings/theme
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence
+     */
+    getThemes({ start, limit, }: {
+        /** The starting index of the returned themes. */
+        start?: number;
+        /**
+         * The maximum number of themes to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<ThemeArray>;
+    /**
+     * Resets the space theme. This means that the space will inherit the
+     * global look and feel settings
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @path {DELETE} /wiki/rest/api/space/{spaceKey}/theme
+     * @scopes-current write:confluence-space
+     * @scopes-beta write:space.setting:confluence
+     */
+    resetSpaceTheme({ spaceKey, }: {
+        /** The key of the space to reset the theme for. */
+        spaceKey: string;
+    }): Promise<void>;
+    /**
+     * Sets the theme for a space. Note, if you want to reset the space theme to
+     * the default Confluence theme, use the 'Reset space theme' method instead
+     * of this method.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the theme was set for the space.
+     * @path {PUT} /wiki/rest/api/space/{spaceKey}/theme
+     * @scopes-current write:confluence-space
+     * @scopes-beta read:space.setting:confluence, write:space.setting:confluence
+     */
+    setSpaceTheme({ spaceKey, themeUpdate, }: {
+        /** The key of the space to set the theme for. */
+        spaceKey: string;
+        themeUpdate: ThemeUpdate;
+    }): Promise<Theme>;
+    static initialize(): void;
+}