@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,541 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionService = 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 version_1 = require("../models/version");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class VersionService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Retrieves version details for the specified attachment and version number.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /attachments/{attachment-id}/versions/{version-number}
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachmentVersionDetails({ attachmentId, versionNumber, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/attachments/{attachment-id}/versions/{version-number}",
+            method: "GET",
+            pathParams: {
+                "attachment-id": attachmentId,
+                "version-number": versionNumber,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getAttachmentVersionDetails.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the versions of specific attachment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment and its corresponding space.
+     *
+     * @returns Returned if the requested attachment versions are returned.
+     * @path {GET} /attachments/{id}/versions
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachmentVersions({ id, cursor, limit, sort, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/attachments/{id}/versions",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                cursor,
+                limit,
+                sort,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getAttachmentVersions.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Retrieves version details for the specified blog post and version number.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the blog post.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /blogposts/{blogpost-id}/versions/{version-number}
+     * @scopes-current read:page:confluence
+     */
+    getBlogPostVersionDetails({ blogpostId, versionNumber, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/blogposts/{blogpost-id}/versions/{version-number}",
+            method: "GET",
+            pathParams: {
+                "blogpost-id": blogpostId,
+                "version-number": versionNumber,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getBlogPostVersionDetails.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the versions of specific blog post.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the blog post and its corresponding space.
+     *
+     * @returns Returned if the requested blog post versions are returned.
+     * @path {GET} /blogposts/{id}/versions
+     * @scopes-current read:page:confluence
+     */
+    getBlogPostVersions({ id, bodyFormat, cursor, limit, sort, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/blogposts/{id}/versions",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                "body-format": bodyFormat,
+                cursor,
+                limit,
+                sort,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getBlogPostVersions.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Retrieves version details for the specified custom content and version number.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /custom-content/{custom-content-id}/versions/{version-number}
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentVersionDetails({ customContentId, versionNumber, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/custom-content/{custom-content-id}/versions/{version-number}",
+            method: "GET",
+            pathParams: {
+                "custom-content-id": customContentId,
+                "version-number": versionNumber,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getCustomContentVersionDetails.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the versions of specific custom content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the custom content and its corresponding page and space.
+     *
+     * @returns Returned if the requested custom content versions are returned.
+     * @path {GET} /custom-content/{custom-content-id}/versions
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentVersions({ customContentId, bodyFormat, cursor, limit, sort, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/custom-content/{custom-content-id}/versions",
+            method: "GET",
+            pathParams: {
+                "custom-content-id": customContentId,
+            },
+            query: {
+                "body-format": bodyFormat,
+                cursor,
+                limit,
+                sort,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getCustomContentVersions.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Retrieves version details for the specified footer comment version.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blog post and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /footer-comments/{id}/versions/{version-number}
+     * @scopes-current read:comment:confluence
+     */
+    getFooterCommentVersionDetails({ id, versionNumber, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/footer-comments/{id}/versions/{version-number}",
+            method: "GET",
+            pathParams: {
+                id,
+                "version-number": versionNumber,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getFooterCommentVersionDetails.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Retrieves the versions of the specified footer comment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blog post and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested footer comment versions are returned.
+     * @path {GET} /footer-comments/{id}/versions
+     * @scopes-current read:comment:confluence
+     */
+    getFooterCommentVersions({ id, bodyFormat, cursor, limit, sort, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/footer-comments/{id}/versions",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                "body-format": bodyFormat,
+                cursor,
+                limit,
+                sort,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getFooterCommentVersions.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Retrieves version details for the specified inline comment version.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blog post and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /inline-comments/{id}/versions/{version-number}
+     * @scopes-current read:comment:confluence
+     */
+    getInlineCommentVersionDetails({ id, versionNumber, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/inline-comments/{id}/versions/{version-number}",
+            method: "GET",
+            pathParams: {
+                id,
+                "version-number": versionNumber,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getInlineCommentVersionDetails.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Retrieves the versions of the specified inline comment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blog post and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested inline comment versions are returned.
+     * @path {GET} /inline-comments/{id}/versions
+     * @scopes-current read:comment:confluence
+     */
+    getInlineCommentVersions({ id, bodyFormat, cursor, limit, sort, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/inline-comments/{id}/versions",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                "body-format": bodyFormat,
+                cursor,
+                limit,
+                sort,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getInlineCommentVersions.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Retrieves version details for the specified page and version number.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /pages/{page-id}/versions/{version-number}
+     * @scopes-current read:page:confluence
+     */
+    getPageVersionDetails({ pageId, versionNumber, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages/{page-id}/versions/{version-number}",
+            method: "GET",
+            pathParams: {
+                "page-id": pageId,
+                "version-number": versionNumber,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getPageVersionDetails.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the versions of specific page.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page and its corresponding space.
+     *
+     * @returns Returned if the requested page versions are returned.
+     * @path {GET} /pages/{id}/versions
+     * @scopes-current read:page:confluence
+     */
+    getPageVersions({ id, bodyFormat, cursor, limit, sort, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages/{id}/versions",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                "body-format": bodyFormat,
+                cursor,
+                limit,
+                sort,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getPageVersions.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getAttachmentVersionDetails.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("DetailedVersion"),
+        })
+            .describe("VersionService.getAttachmentVersionDetails.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getAttachmentVersions.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("AttachmentVersion"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("VersionService.getAttachmentVersions.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getBlogPostVersionDetails.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("DetailedVersion"),
+        })
+            .describe("VersionService.getBlogPostVersionDetails.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getBlogPostVersions.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("BlogPostVersion"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("VersionService.getBlogPostVersions.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getCustomContentVersions.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("CustomContentVersion"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("VersionService.getCustomContentVersions.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getCustomContentVersionDetails.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("DetailedVersion"),
+        })
+            .describe("VersionService.getCustomContentVersionDetails.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getFooterCommentVersions.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("CommentVersion"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("VersionService.getFooterCommentVersions.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getFooterCommentVersionDetails.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("DetailedVersion"),
+        })
+            .describe("VersionService.getFooterCommentVersionDetails.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getInlineCommentVersions.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("CommentVersion"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("VersionService.getInlineCommentVersions.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getInlineCommentVersionDetails.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("DetailedVersion"),
+        })
+            .describe("VersionService.getInlineCommentVersionDetails.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getPageVersions.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("PageVersion"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("VersionService.getPageVersions.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getPageVersionDetails.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("DetailedVersion"),
+        })
+            .describe("VersionService.getPageVersionDetails.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            version_1.registerVersionValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.VersionService = VersionService;
+//# sourceMappingURL=VersionService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"VersionService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/VersionService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAK0B;AAC1B,+CAS2B;AAC3B,wEAAqE;AACrE,MAAa,cAAe,SAAQ,qCAAiB;IACnD;;;;;;;;;OASG;IACH,2BAA2B,CAAC,EAC1B,YAAY,EACZ,aAAa,GAMd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,eAAe,EAAE,YAAY;gBAC7B,gBAAgB,EAAE,aAAa;aAChC;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,qDAAqD,CACtD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EACpB,EAAE,EACF,MAAM,EACN,KAAK,EACL,IAAI,GAqBL;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,MAAM;gBACN,KAAK;gBACL,IAAI;aACL;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,+CAA+C,CAChD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,yBAAyB,CAAC,EACxB,UAAU,EACV,aAAa,GAMd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oDAAoD;YAC1D,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,aAAa,EAAE,UAAU;gBACzB,gBAAgB,EAAE,aAAa;aAChC;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,mDAAmD,CACpD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,mBAAmB,CAAC,EAClB,EAAE,EACF,UAAU,EACV,MAAM,EACN,KAAK,EACL,IAAI,GA2BL;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,0BAA0B;YAChC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,aAAa,EAAE,UAAU;gBACzB,MAAM;gBACN,KAAK;gBACL,IAAI;aACL;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,6CAA6C,CAC9C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,8BAA8B,CAAC,EAC7B,eAAe,EACf,aAAa,GAMd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+DAA+D;YACrE,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,mBAAmB,EAAE,eAAe;gBACpC,gBAAgB,EAAE,aAAa;aAChC;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,wDAAwD,CACzD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,wBAAwB,CAAC,EACvB,eAAe,EACf,UAAU,EACV,MAAM,EACN,KAAK,EACL,IAAI,GA+BL;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8CAA8C;YACpD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,mBAAmB,EAAE,eAAe;aACrC;YACD,KAAK,EAAE;gBACL,aAAa,EAAE,UAAU;gBACzB,MAAM;gBACN,KAAK;gBACL,IAAI;aACL;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;;;;;;;;;;OAUG;IACH,8BAA8B,CAAC,EAC7B,EAAE,EACF,aAAa,GAMd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iDAAiD;YACvD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;gBACF,gBAAgB,EAAE,aAAa;aAChC;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,wDAAwD,CACzD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EACvB,EAAE,EACF,UAAU,EACV,MAAM,EACN,KAAK,EACL,IAAI,GAwBL;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,aAAa,EAAE,UAAU;gBACzB,MAAM;gBACN,KAAK;gBACL,IAAI;aACL;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;;;;;;;;;;OAUG;IACH,8BAA8B,CAAC,EAC7B,EAAE,EACF,aAAa,GAMd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iDAAiD;YACvD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;gBACF,gBAAgB,EAAE,aAAa;aAChC;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,wDAAwD,CACzD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EACvB,EAAE,EACF,UAAU,EACV,MAAM,EACN,KAAK,EACL,IAAI,GAwBL;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,aAAa,EAAE,UAAU;gBACzB,MAAM;gBACN,KAAK;gBACL,IAAI;aACL;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;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EACpB,MAAM,EACN,aAAa,GAMd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,SAAS,EAAE,MAAM;gBACjB,gBAAgB,EAAE,aAAa;aAChC;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;;;;;;;;;OASG;IACH,eAAe,CAAC,EACd,EAAE,EACF,UAAU,EACV,MAAM,EACN,KAAK,EACL,IAAI,GA2BL;QAQC,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,MAAM;gBACN,KAAK;gBACL,IAAI;aACL;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,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,qDAAqD,EACrD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,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,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,+CAA+C,CAAC,CAC7D,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,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,mDAAmD,CAAC,CACjE,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,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,6CAA6C,CAAC,CAC3D,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,sBAAsB,CAAC,CAAC;qBAC3D,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,kBAAkB,CACxC,wDAAwD,EACxD,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,wDAAwD,CAAC,CACtE,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,gBAAgB,CAAC,CAAC;qBACrD,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,kBAAkB,CACxC,wDAAwD,EACxD,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,wDAAwD,CAAC,CACtE,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,gBAAgB,CAAC,CAAC;qBACrD,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,kBAAkB,CACxC,wDAAwD,EACxD,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,wDAAwD,CAAC,CACtE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,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,aAAa,CAAC,CAAC;qBAClD,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,yCAAyC,CAAC,CACvD,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,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,+CAA+C,CAAC,CAC7D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,0CAAgC;YAChC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AAj/BD,wCAi/BC"}

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

@@ -0,0 +1,82 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type WhiteboardSingle } from "../models/whiteboard";
+export declare class WhiteboardService extends CommonHttpService {
+    /**
+     * Creates a whiteboard in the space.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the corresponding space. Permission to create a whiteboard
+     * in the space.
+     *
+     * @returns Returned if the whiteboard was successfully created.
+     * @path {POST} /whiteboards
+     * @scopes-current write:whiteboard:confluence
+     */
+    createWhiteboard({ private: privateQuery, requestBody, }: {
+        /**
+         * The whiteboard will be private. Only the user who creates this whiteboard will
+         * have permission to view and edit one.
+         */
+        private?: boolean;
+        requestBody: {
+            /** ID of the space. */
+            spaceId: string;
+            /** Title of the whiteboard. */
+            title?: string;
+            /** The parent content ID of the whiteboard. */
+            parentId?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    }): Promise<WhiteboardSingle & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Delete a whiteboard by id.
+     *
+     * Deleting a whiteboard moves the whiteboard to the trash, where it can be
+     * restored later
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the whiteboard and its corresponding space.
+     * Permission to delete whiteboards in the space.
+     *
+     * @path {DELETE} /whiteboards/{id}
+     * @scopes-current delete:whiteboard:confluence
+     */
+    deleteWhiteboard({ id, }: {
+        /** The ID of the whiteboard to be deleted. */
+        id: number;
+    }): Promise<void>;
+    /**
+     * Returns a specific whiteboard.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the whiteboard and its corresponding space.
+     *
+     * @returns Returned if the requested whiteboard is returned.
+     * @path {GET} /whiteboards/{id}
+     * @scopes-current read:whiteboard:confluence
+     */
+    getWhiteboardById({ id, }: {
+        /** The ID of the whiteboard to be returned */
+        id: number;
+    }): Promise<WhiteboardSingle & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    static initialize(): void;
+}