@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,423 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomContentService = 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 customContent_1 = require("../models/customContent");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class CustomContentService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Creates a new custom content in the given space, page, blogpost or other custom
+     * content.
+     *
+     * Only one of `spaceId`, `pageId`, `blogPostId`, or `customContentId` is required
+     * in the request body.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space. Permission to create custom content in the space.
+     *
+     * @returns Returned if the requested custom content is created successfully.
+     * @path {POST} /custom-content
+     * @scopes-current write:custom-content:confluence
+     */
+    createCustomContent({ requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/custom-content",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.createCustomContent.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Delete a custom content by id.
+     *
+     * Deleting a custom content will either move it to the trash or permanently
+     * delete it (purge it), depending on the apiSupport.
+     * To permanently delete a **trashed** custom content, the endpoint must be called
+     * with the following param `purge=true`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space.
+     * Permission to delete custom content in the space.
+     * Permission to administer the space (if attempting to purge).
+     *
+     * @path {DELETE} /custom-content/{id}
+     * @scopes-current delete:custom-content:confluence
+     */
+    deleteCustomContent({ id, purge, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/custom-content/{id}",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+            query: {
+                purge,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns a specific piece of custom content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the custom content, the container of the custom content, and
+     * the corresponding space (if different from the container).
+     *
+     * @returns Returned if the requested custom content is returned.
+     * @path {GET} /custom-content/{id}
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentById({ id, bodyFormat, version, includeLabels, includeProperties, includeOperations, includeVersions, includeVersion, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/custom-content/{id}",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                "body-format": bodyFormat,
+                version,
+                "include-labels": includeLabels,
+                "include-properties": includeProperties,
+                "include-operations": includeOperations,
+                "include-versions": includeVersions,
+                "include-version": includeVersion,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all custom content for a given type. 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 view the custom content, the container of the custom content, and
+     * the corresponding space (if different from the container).
+     *
+     * @returns Returned if the requested custom content is returned.
+     * @path {GET} /custom-content
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentByType({ type, id, spaceId, sort, cursor, limit, bodyFormat, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/custom-content",
+            method: "GET",
+            query: {
+                type,
+                id,
+                "space-id": spaceId,
+                sort,
+                cursor,
+                limit,
+                "body-format": bodyFormat,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByType.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all custom content for a given type within a given blogpost. 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 view the custom content, the container of the custom content
+     * (blog post), and the corresponding space.
+     *
+     * @returns Returned if the requested custom content is returned.
+     * @path {GET} /blogposts/{id}/custom-content
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentByTypeInBlogPost({ id, type, sort, cursor, limit, bodyFormat, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/blogposts/{id}/custom-content",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                type,
+                sort,
+                cursor,
+                limit,
+                "body-format": bodyFormat,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByTypeInBlogPost.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all custom content for a given type within a given page. 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 view the custom content, the container of the custom content
+     * (page), and the corresponding space.
+     *
+     * @returns Returned if the requested custom content is returned.
+     * @path {GET} /pages/{id}/custom-content
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentByTypeInPage({ id, type, sort, cursor, limit, bodyFormat, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages/{id}/custom-content",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                type,
+                sort,
+                cursor,
+                limit,
+                "body-format": bodyFormat,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByTypeInPage.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all custom content for a given type within a given space. 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 view the custom content and the corresponding space.
+     *
+     * @returns Returned if the requested custom content is returned.
+     * @path {GET} /spaces/{id}/custom-content
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentByTypeInSpace({ id, type, cursor, limit, bodyFormat, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/spaces/{id}/custom-content",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                type,
+                cursor,
+                limit,
+                "body-format": bodyFormat,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByTypeInSpace.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Update a custom content by id.
+     *
+     * `spaceId` is always required and maximum one of `pageId`, `blogPostId`, or
+     * `customContentId` is allowed in the request body.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space. Permission to update custom content in the space.
+     *
+     * @returns Returned if the requested custom content is updated successfully.
+     * @path {PUT} /custom-content/{id}
+     * @scopes-current write:custom-content:confluence
+     */
+    updateCustomContent({ id, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/custom-content/{id}",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.updateCustomContent.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CustomContentService.getCustomContentByTypeInBlogPost.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("CustomContentBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("CustomContentService.getCustomContentByTypeInBlogPost.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CustomContentService.getCustomContentByType.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("CustomContentBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("CustomContentService.getCustomContentByType.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CustomContentService.createCustomContent.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(201),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("CustomContentSingle"), 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("CustomContentService.createCustomContent.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CustomContentService.getCustomContentById.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("CustomContentSingle"), 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("CustomContentService.getCustomContentById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CustomContentService.updateCustomContent.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("CustomContentSingle"), 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("CustomContentService.updateCustomContent.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CustomContentService.getCustomContentByTypeInPage.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("CustomContentBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("CustomContentService.getCustomContentByTypeInPage.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CustomContentService.getCustomContentByTypeInSpace.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("CustomContentBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("CustomContentService.getCustomContentByTypeInSpace.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            customContent_1.registerCustomContentValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.CustomContentService = CustomContentService;
+//# sourceMappingURL=CustomContentService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CustomContentService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/CustomContentService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,2DAQiC;AACjC,wEAAqE;AACrE,MAAa,oBAAqB,SAAQ,qCAAiB;IACzD;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAClB,WAAW,GAqBZ;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,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,EAazB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,mDAAmD,CACpD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,mBAAmB,CAAC,EAClB,EAAE,EACF,KAAK,GAMN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,KAAK;aACN;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EACnB,EAAE,EACF,UAAU,EACV,OAAO,EACP,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,cAAc,GA4Df;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,aAAa,EAAE,UAAU;gBACzB,OAAO;gBACP,gBAAgB,EAAE,aAAa;gBAC/B,oBAAoB,EAAE,iBAAiB;gBACvC,oBAAoB,EAAE,iBAAiB;gBACvC,kBAAkB,EAAE,eAAe;gBACnC,iBAAiB,EAAE,cAAc;aAClC;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,EAazB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,EACrB,IAAI,EACJ,EAAE,EACF,OAAO,EACP,IAAI,EACJ,MAAM,EACN,KAAK,EACL,UAAU,GA0CX;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,IAAI;gBACJ,EAAE;gBACF,UAAU,EAAE,OAAO;gBACnB,IAAI;gBACJ,MAAM;gBACN,KAAK;gBACL,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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,sDAAsD,CACvD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,gCAAgC,CAAC,EAC/B,EAAE,EACF,IAAI,EACJ,IAAI,EACJ,MAAM,EACN,KAAK,EACL,UAAU,GAkCX;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gCAAgC;YACtC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,IAAI;gBACJ,MAAM;gBACN,KAAK;gBACL,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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,gEAAgE,CACjE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,4BAA4B,CAAC,EAC3B,EAAE,EACF,IAAI,EACJ,IAAI,EACJ,MAAM,EACN,KAAK,EACL,UAAU,GAkCX;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4BAA4B;YAClC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,IAAI;gBACJ,MAAM;gBACN,KAAK;gBACL,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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,4DAA4D,CAC7D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAAC,EAC5B,EAAE,EACF,IAAI,EACJ,MAAM,EACN,KAAK,EACL,UAAU,GAgCX;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6BAA6B;YACnC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;gBACN,KAAK;gBACL,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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,6DAA6D,CAC9D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAClB,EAAE,EACF,WAAW,GAoCZ;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,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,EAazB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,mDAAmD,CACpD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,gEAAgE,EAChE,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,mBAAmB,CAAC,CAAC;qBACxD,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,gEAAgE,CACjE,CACJ,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,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;qBACxD,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,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,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,EACnD,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,mDAAmD,CAAC,CACjE,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,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,EACnD,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,oDAAoD,CAAC,CAClE,CAAC;QACF,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,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,EACnD,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,mDAAmD,CAAC,CACjE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4DAA4D,EAC5D,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,mBAAmB,CAAC,CAAC;qBACxD,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,4DAA4D,CAAC,CAC1E,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,6DAA6D,EAC7D,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,mBAAmB,CAAC,CAAC;qBACxD,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,6DAA6D,CAC9D,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,sDAAsC;YACtC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA36BD,oDA26BC"}

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

@@ -0,0 +1,64 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type MultiEntityLinks, type SpaceSortOrder } from "../models/common";
+import { type DataPolicyMetadata, type DataPolicySpace } from "../models/dataPolicies";
+export declare class DataPoliciesService extends CommonHttpService {
+    /**
+     * Returns data policy metadata for the workspace.
+     *
+     * **[Permissions](#permissions) required:**
+     * Only apps can make this request.
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the request is successful.
+     * @path {GET} /data-policies/metadata
+     * @scopes-current read:configuration:confluence
+     */
+    getDataPolicyMetadata(): Promise<DataPolicyMetadata>;
+    /**
+     * 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**:
+     * Only apps can make this request.
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Only spaces that the app has permission to view will be returned.
+     *
+     * @returns Returned if the requested spaces are returned.
+     * @path {GET} /data-policies/spaces
+     * @scopes-current read:space:confluence
+     */
+    getDataPolicySpaces({ ids, keys, sort, 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[];
+        /** Used to sort the result by a particular field. */
+        sort?: SpaceSortOrder;
+        /**
+         * 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?: DataPolicySpace[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataPoliciesService = 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 dataPolicies_1 = require("../models/dataPolicies");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class DataPoliciesService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Returns data policy metadata for the workspace.
+     *
+     * **[Permissions](#permissions) required:**
+     * Only apps can make this request.
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the request is successful.
+     * @path {GET} /data-policies/metadata
+     * @scopes-current read:configuration:confluence
+     */
+    getDataPolicyMetadata() {
+        return this.getClientInstance()
+            .request({
+            path: "/data-policies/metadata",
+            method: "GET",
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("DataPoliciesService.getDataPolicyMetadata.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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**:
+     * Only apps can make this request.
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Only spaces that the app has permission to view will be returned.
+     *
+     * @returns Returned if the requested spaces are returned.
+     * @path {GET} /data-policies/spaces
+     * @scopes-current read:space:confluence
+     */
+    getDataPolicySpaces({ ids, keys, sort, cursor, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/data-policies/spaces",
+            method: "GET",
+            query: {
+                ids,
+                keys,
+                sort,
+                cursor,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("DataPoliciesService.getDataPolicySpaces.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("DataPoliciesService.getDataPolicyMetadata.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("DataPolicyMetadata"),
+        })
+            .describe("DataPoliciesService.getDataPolicyMetadata.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("DataPoliciesService.getDataPolicySpaces.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("DataPolicySpace"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("DataPoliciesService.getDataPolicySpaces.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            dataPolicies_1.registerDataPoliciesValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.DataPoliciesService = DataPoliciesService;
+//# sourceMappingURL=DataPoliciesService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DataPoliciesService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/DataPoliciesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,yDAIgC;AAChC,wEAAqE;AACrE,MAAa,mBAAoB,SAAQ,qCAAiB;IACxD;;;;;;;;;;OAUG;IACH,qBAAqB;QACnB,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,KAAK;SACd,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,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,CAAC,EAClB,GAAG,EACH,IAAI,EACJ,IAAI,EACJ,MAAM,EACN,KAAK,GA0BN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,GAAG;gBACH,IAAI;gBACJ,IAAI;gBACJ,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,kDAAkD,CACnD,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,iDAAuB,CAAC,IAAI,CAAC,oBAAoB,CAAC;SACzD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,kDAAkD,EAClD,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,kDAAkD,CAAC,CAChE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,oDAAqC;YACrC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AAtKD,kDAsKC"}