@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"RelationService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/RelationService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iDAI4B;AAC5B,wEAAqE;AACrE,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CAAC,EACjB,YAAY,EACZ,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,GAwDd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,kGAAkG;YACxG,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,YAAY;gBACZ,UAAU;gBACV,SAAS;gBACT,UAAU;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,YAAY;gBACZ,YAAY;gBACZ,aAAa;gBACb,aAAa;aACd;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,kBAAkB,CAAC,EACjB,YAAY,EACZ,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,GAoDd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,kGAAkG;YACxG,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,YAAY;gBACZ,UAAU;gBACV,SAAS;gBACT,UAAU;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,YAAY;gBACZ,YAAY;gBACZ,aAAa;gBACb,aAAa;aACd;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAAC,EACnB,YAAY,EACZ,UAAU,EACV,UAAU,EACV,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,MAAM,EACN,KAAK,EACL,KAAK,GAgEN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sFAAsF;YAC5F,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,YAAY;gBACZ,UAAU;gBACV,UAAU;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,YAAY;gBACZ,YAAY;gBACZ,aAAa;gBACb,aAAa;gBACb,MAAM;gBACN,KAAK;gBACL,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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,+CAA+C,CAChD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAAC,EACnB,YAAY,EACZ,UAAU,EACV,SAAS,EACT,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,MAAM,EACN,KAAK,EACL,KAAK,GAgEN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sFAAsF;YAC5F,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,YAAY;gBACZ,UAAU;gBACV,SAAS;gBACT,UAAU;aACX;YACD,KAAK,EAAE;gBACL,YAAY;gBACZ,YAAY;gBACZ,aAAa;gBACb,aAAa;gBACb,MAAM;gBACN,KAAK;gBACL,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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,+CAA+C,CAChD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,EACd,YAAY,EACZ,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,MAAM,GA6EP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,kGAAkG;YACxG,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,YAAY;gBACZ,UAAU;gBACV,SAAS;gBACT,UAAU;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,YAAY;gBACZ,YAAY;gBACZ,aAAa;gBACb,aAAa;gBACb,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,0CAA0C,CAC3C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,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,+CAA+C,CAAC,CAC7D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,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,UAAU,CAAC;SAC/C,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,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,UAAU,CAAC;SAC/C,CAAC;aACD,QAAQ,CAAC,6CAA6C,CAAC,CAC3D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,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,+CAA+C,CAAC,CAC7D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AAvqBD,0CAuqBC"}

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

@@ -0,0 +1,175 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type SearchPageResponseSearchResult } from "../models/search";
+export declare class SearchService extends CommonHttpService {
+    /**
+     * Searches for content using the
+     * [Confluence Query Language
+     * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
+     *
+     * **Note that CQL input queries submitted through the `/wiki/rest/api/search`
+     * endpoint no longer support user-specific fields like `user`, `user.fullname`,
+     * `user.accountid`, and `user.userkey`.**
+     * See this [deprecation
+     * notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/)
+     * for more details.
+     *
+     * Example initial call:
+     * ```
+     * /wiki/rest/api/search?cql=type=page&limit=25
+     * ```
+     *
+     * Example response:
+     * ```
+     * {
+     *   "results": [
+     *     { ... },
+     *     { ... },
+     *     ...
+     *     { ... }
+     *   ],
+     *   "limit": 25,
+     *   "size": 25,
+     *   ...
+     *   "_links": {
+     *     "base": "<url>",
+     *     "context": "<url>",
+     *     "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
+     *     "self": "<url>"
+     *   }
+     * }
+     * ```
+     *
+     * When additional results are available, returns `next` and `prev` URLs to
+     * retrieve them in subsequent calls. The URLs each contain a cursor that points
+     * to the appropriate set of results. Use `limit` to specify the number of results
+     * returned in each call.
+     *
+     * Example subsequent call (taken from example response):
+     * ```
+     * /wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
+     * ```
+     * The response to this will have a `prev` URL similar to the `next` in the
+     * example response.
+     *
+     * Starting on Dec 10, 2024, if the expand query parameter is used with the
+     * `body.export_view` and/or `body.styled_view` properties, then the query limit
+     * parameter will be restricted to a maximum value of 25.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the entities. Note, only entities that the user has
+     * permission to view will be returned.
+     *
+     * @returns Returned if the requested results are returned.
+     * @path {GET} /wiki/rest/api/search
+     * @scopes-current search:confluence
+     * @scopes-beta read:content-details:confluence
+     */
+    searchByCql({ cql, cqlcontext, cursor, next, prev, limit, start, includeArchivedSpaces, excludeCurrentSpaces, excerpt, sitePermissionTypeFilter, _, expand, }: {
+        /**
+         * The CQL query to be used for the search. See
+         * [Advanced Searching using
+         * CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)
+         * for instructions on how to build a CQL query.
+         */
+        cql: string;
+        /**
+         * The space, content, and content status to execute the search
+         * against.
+         *
+         * - `spaceKey` Key of the space to search against. Optional.
+         * - `contentId` ID of the content to search against. Optional. Must be
+         * in the space specified by `spaceKey`.
+         * - `contentStatuses` Content statuses to search against. Optional.
+         *
+         * Specify these values in an object. For example,
+         * `cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22}`
+         */
+        cqlcontext?: string;
+        /**
+         * Pointer to a set of search results, returned as part of the `next` or `prev`
+         * URL from the previous search call.
+         */
+        cursor?: string;
+        next?: boolean;
+        prev?: boolean;
+        /**
+         * The maximum number of content objects to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+        /** The start point of the collection to return */
+        start?: number;
+        /** Whether to include content from archived spaces in the results. */
+        includeArchivedSpaces?: boolean;
+        /** Whether to exclude current spaces and only show archived spaces. */
+        excludeCurrentSpaces?: boolean;
+        /** The excerpt strategy to apply to the result */
+        excerpt?: "highlight" | "indexed" | "none" | "highlight_unescaped" | "indexed_unescaped";
+        /**
+         * Filters users by permission type. Use `none` to default to licensed users,
+         * `externalCollaborator`
+         * for external/guest users, and `all` to include all permission types.
+         */
+        sitePermissionTypeFilter?: "all" | "externalCollaborator" | "none";
+        _?: number;
+        expand?: string[];
+    }): Promise<SearchPageResponseSearchResult>;
+    /**
+     * Searches for users using user-specific queries from the
+     * [Confluence Query Language
+     * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
+     *
+     * Note that CQL input queries submitted through the `/wiki/rest/api/search/user`
+     * endpoint only support user-specific fields like `user`, `user.fullname`,
+     * `user.accountid`, and `user.userkey`.
+     *
+     * Note that some user fields may be set to null depending on the user's privacy
+     * settings.
+     * These are: email, profilePicture, displayName, and timeZone.
+     *
+     * @returns Returned if the requested results are returned.
+     * @path {GET} /wiki/rest/api/search/user
+     * @scopes-current read:content-details:confluence
+     */
+    searchUser({ cql, start, limit, expand, sitePermissionTypeFilter, }: {
+        /**
+         * The CQL query to be used for the search. See
+         * [Advanced Searching using
+         * CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)
+         * for instructions on how to build a CQL query.
+         *
+         * Example queries:
+         *           cql=type=user will return up to 10k users
+         *           cql=user="1234" will return user with accountId "1234"
+         *           You can also use IN, NOT IN, != operators
+         *           cql=user IN ("12", "34") will return users with accountids "12" and
+         * "34"
+         *           cql=user.fullname~jo will return users with nickname/full name
+         * starting with "jo"
+         *           cql=user.accountid="123" will return user with accountId "123"
+         */
+        cql: string;
+        /** The starting index of the returned users. */
+        start?: number;
+        /**
+         * The maximum number of user objects to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+        /**
+         * A multi-value parameter indicating which properties of the user to expand.
+         *
+         * - `operations` returns the operations for the user, which are used
+         * when setting permissions.
+         * - `personalSpace` returns the personal space of the user.
+         */
+        expand?: string[];
+        /**
+         * Filters users by permission type. Use `none` to default to licensed users,
+         * `externalCollaborator`
+         * for external/guest users, and `all` to include all permission types.
+         */
+        sitePermissionTypeFilter?: "all" | "externalCollaborator" | "none";
+    }): Promise<SearchPageResponseSearchResult>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchService = 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 search_1 = require("../models/search");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class SearchService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Searches for content using the
+     * [Confluence Query Language
+     * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
+     *
+     * **Note that CQL input queries submitted through the `/wiki/rest/api/search`
+     * endpoint no longer support user-specific fields like `user`, `user.fullname`,
+     * `user.accountid`, and `user.userkey`.**
+     * See this [deprecation
+     * notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/)
+     * for more details.
+     *
+     * Example initial call:
+     * ```
+     * /wiki/rest/api/search?cql=type=page&limit=25
+     * ```
+     *
+     * Example response:
+     * ```
+     * {
+     *   "results": [
+     *     { ... },
+     *     { ... },
+     *     ...
+     *     { ... }
+     *   ],
+     *   "limit": 25,
+     *   "size": 25,
+     *   ...
+     *   "_links": {
+     *     "base": "<url>",
+     *     "context": "<url>",
+     *     "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
+     *     "self": "<url>"
+     *   }
+     * }
+     * ```
+     *
+     * When additional results are available, returns `next` and `prev` URLs to
+     * retrieve them in subsequent calls. The URLs each contain a cursor that points
+     * to the appropriate set of results. Use `limit` to specify the number of results
+     * returned in each call.
+     *
+     * Example subsequent call (taken from example response):
+     * ```
+     * /wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
+     * ```
+     * The response to this will have a `prev` URL similar to the `next` in the
+     * example response.
+     *
+     * Starting on Dec 10, 2024, if the expand query parameter is used with the
+     * `body.export_view` and/or `body.styled_view` properties, then the query limit
+     * parameter will be restricted to a maximum value of 25.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the entities. Note, only entities that the user has
+     * permission to view will be returned.
+     *
+     * @returns Returned if the requested results are returned.
+     * @path {GET} /wiki/rest/api/search
+     * @scopes-current search:confluence
+     * @scopes-beta read:content-details:confluence
+     */
+    searchByCql({ cql, cqlcontext, cursor, next, prev, limit, start, includeArchivedSpaces, excludeCurrentSpaces, excerpt, sitePermissionTypeFilter, _, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/search",
+            method: "GET",
+            query: {
+                cql,
+                cqlcontext,
+                cursor,
+                next,
+                prev,
+                limit,
+                start,
+                includeArchivedSpaces,
+                excludeCurrentSpaces,
+                excerpt,
+                sitePermissionTypeFilter,
+                _,
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SearchService.searchByCQL.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Searches for users using user-specific queries from the
+     * [Confluence Query Language
+     * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
+     *
+     * Note that CQL input queries submitted through the `/wiki/rest/api/search/user`
+     * endpoint only support user-specific fields like `user`, `user.fullname`,
+     * `user.accountid`, and `user.userkey`.
+     *
+     * Note that some user fields may be set to null depending on the user's privacy
+     * settings.
+     * These are: email, profilePicture, displayName, and timeZone.
+     *
+     * @returns Returned if the requested results are returned.
+     * @path {GET} /wiki/rest/api/search/user
+     * @scopes-current read:content-details:confluence
+     */
+    searchUser({ cql, start, limit, expand, sitePermissionTypeFilter, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/search/user",
+            method: "GET",
+            query: {
+                cql,
+                start,
+                limit,
+                expand,
+                sitePermissionTypeFilter,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SearchService.searchUser.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SearchService.searchByCQL.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SearchPageResponseSearchResult"),
+        })
+            .describe("SearchService.searchByCQL.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SearchService.searchUser.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SearchPageResponseSearchResult"),
+        })
+            .describe("SearchService.searchUser.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([search_1.registerSearchValidationSchemas]);
+    }
+}
+exports.SearchService = SearchService;
+//# sourceMappingURL=SearchService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SearchService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SearchService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,wEAAqE;AACrE,MAAa,aAAc,SAAQ,qCAAiB;IAClD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,WAAW,CAAC,EACV,GAAG,EACH,UAAU,EACV,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,EACL,qBAAqB,EACrB,oBAAoB,EACpB,OAAO,EACP,wBAAwB,EACxB,CAAC,EACD,MAAM,GAuDP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,GAAG;gBACH,UAAU;gBACV,MAAM;gBACN,IAAI;gBACJ,IAAI;gBACJ,KAAK;gBACL,KAAK;gBACL,qBAAqB;gBACrB,oBAAoB;gBACpB,OAAO;gBACP,wBAAwB;gBACxB,CAAC;gBACD,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,CAAC,oCAAoC,CAAC,CACxE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,EACT,GAAG,EACH,KAAK,EACL,KAAK,EACL,MAAM,EACN,wBAAwB,GAwCzB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4BAA4B;YAClC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,MAAM;gBACN,wBAAwB;aACzB;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,CAAC,mCAAmC,CAAC,CACvE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,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,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,mCAAmC,EACnC,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,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,mCAAmC,CAAC,CACjD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAjSD,sCAiSC"}

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

@@ -0,0 +1,143 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import type { LookAndFeel } from "../models/common";
+import { type LookAndFeelSelection, type LookAndFeelSettings, type LookAndFeelWithLinks, type SystemInfoEntity } from "../models/settings";
+export declare class SettingsService extends CommonHttpService {
+    /**
+     * Returns the look and feel settings for the site or a single space. This
+     * includes attributes such as the color scheme, padding, and border radius.
+     *
+     * The look and feel settings for a space can be inherited from the global
+     * look and feel settings or provided by a theme.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * None
+     *
+     * @returns Returned if the requested look and feel settings are returned.
+     * @path {GET} /wiki/rest/api/settings/lookandfeel
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence, read:space.setting:confluence
+     */
+    getLookAndFeelSettings({ spaceKey, }: {
+        /**
+         * The key of the space for which the look and feel settings will be
+         * returned. If this is not set, only the global look and feel settings
+         * are returned.
+         */
+        spaceKey?: string;
+    }): Promise<LookAndFeelSettings>;
+    /**
+     * Returns the system information for the Confluence Cloud tenant. This
+     * information is used by Atlassian.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the system information for the Confluence Cloud tenant
+     * is returned.
+     * @path {GET} /wiki/rest/api/settings/systemInfo
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence
+     */
+    getSystemInfo(): Promise<SystemInfoEntity | null>;
+    /**
+     * Resets the custom look and feel settings for the site or a single space.
+     * This changes the values of the custom settings to be the same as the
+     * default settings. It does not change which settings (default or custom)
+     * are selected. Note, the default space settings are inherited from the
+     * current global settings.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @path {DELETE} /wiki/rest/api/settings/lookandfeel/custom
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta write:configuration:confluence, write:space.setting:confluence
+     */
+    resetLookAndFeelSettings({ spaceKey, }: {
+        /**
+         * The key of the space for which the look and feel settings will be
+         * reset. If this is not set, the global look and feel settings will
+         * be reset.
+         */
+        spaceKey?: string;
+    }): Promise<void>;
+    /**
+     * Sets the look and feel settings to either the default settings or the
+     * custom settings, for the site or a single space. Note, the default
+     * space settings are inherited from the current global settings.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @deprecated
+     * @returns Returned if the look and feel settings were set.
+     * @path {PUT} /wiki/rest/api/settings/lookandfeel/selected
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence, read:space.setting:confluence,
+     * write:configuration:confluence, write:space.setting:confluence
+     */
+    setLookAndFeelSettings({ spaceKey, requestBody, }: {
+        /**
+         * The key of the space for which the look and feel settings will be
+         * set. If this is not set, the global look and feel settings will be
+         * set.
+         */
+        spaceKey?: string;
+        /** The look and feel type to be set. */
+        requestBody: "global" | "custom" | "theme";
+    }): Promise<string>;
+    /**
+     * Sets the look and feel settings to the default (global) settings, the
+     * custom settings, or the current theme's settings for a space.
+     * The custom and theme settings can only be selected if there is already
+     * a theme set for a space. Note, the default space settings are inherited
+     * from the current global settings.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the look and feel settings were set.
+     * @path {PUT} /wiki/rest/api/settings/lookandfeel
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:space.setting:confluence, write:space.setting:confluence
+     */
+    updateLookAndFeel({ lookAndFeelSelection, }: {
+        /** The look and feel type to be set. */
+        lookAndFeelSelection: LookAndFeelSelection;
+    }): Promise<LookAndFeelSelection>;
+    /**
+     * Updates the look and feel settings for the site or for a single space.
+     * If custom settings exist, they are updated. If no custom settings exist,
+     * then a set of custom settings is created.
+     *
+     * Note, if a theme is selected for a space, the space look and feel settings
+     * are provided by the theme and cannot be overridden.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the look and feel settings are updated.
+     * @path {POST} /wiki/rest/api/settings/lookandfeel/custom
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence, read:space.setting:confluence,
+     * write:configuration:confluence, write:space.setting:confluence
+     */
+    updateLookAndFeelSettings({ spaceKey, lookAndFeel, }: {
+        /**
+         * The key of the space for which the look and feel settings will be
+         * updated. If this is not set, the global look and feel settings will
+         * be updated.
+         */
+        spaceKey?: string;
+        /**
+         * The updated settings. All values for the settings must be included,
+         * regardless of whether they are being changed.
+         *
+         * One way to create the request body is to copy the settings from the
+         * response body of [Get look and feel settings](#api-settings-lookandfeel-get)
+         * and modify it as needed.
+         */
+        lookAndFeel: LookAndFeel;
+    }): Promise<LookAndFeelWithLinks>;
+    static initialize(): void;
+}