@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,362 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentAttachmentsService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/CommonHttpClient");
+const CommonHttpService_1 = require("../core/CommonHttpService");
+const common_1 = require("../models/common");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class ContentAttachmentsService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Adds an attachment to a piece of content. This method only adds a new
+     * attachment. If you want to update an existing attachment, use
+     * [Create or update attachments](#api-content-id-child-attachment-put).
+     *
+     * Note, you must set a `X-Atlassian-Token: nocheck` header on the request
+     * for this method, otherwise it will be blocked. This protects against XSRF
+     * attacks, which is necessary as this method accepts multipart/form-data.
+     *
+     * The media type 'multipart/form-data' is defined in [RFC
+     * 7578](https://www.ietf.org/rfc/rfc7578.txt).
+     * Most client libraries have classes that make it easier to implement
+     * multipart posts, like the
+     * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/)
+     * Java class provided by Apache HTTP Components.
+     *
+     * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5),
+     * in the case where the form data is text,
+     * the charset parameter for the "text/plain" Content-Type may be used to
+     * indicate the character encoding used in that part. In the case of this
+     * API endpoint, the `comment` body parameter should be sent with `type=text/plain`
+     * and `charset=utf-8` values. This will force the charset to be UTF-8.
+     *
+     * Example: This curl command attaches a file ('example.txt') to a container
+     * (id='123') with a comment and `minorEdits`=true.
+     *
+     * ``` bash
+     * curl -D- \
+     *   -u admin:admin \
+     *   -X POST \
+     *   -H 'X-Atlassian-Token: nocheck' \
+     *   -F 'file=@"example.txt"' \
+     *   -F 'minorEdit="true"' \
+     *   -F 'comment="Example attachment comment"; type=text/plain; charset=utf-8' \
+     *   http://myhost/rest/api/content/123/child/attachment
+     * ```
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the attachments were added to the content.
+     * @path {POST} /wiki/rest/api/content/{id}/child/attachment
+     * @scopes-current write:confluence-file
+     * @scopes-beta read:content-details:confluence, write:attachment:confluence
+     */
+    createAttachment({ id, status, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/child/attachment",
+            method: "POST",
+            pathParams: {
+                id,
+            },
+            query: {
+                status,
+            },
+            headers: {
+                "Content-Type": "multipart/form-data",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentAttachmentsService.createAttachment.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Adds an attachment to a piece of content. If the attachment already exists
+     * for the content, then the attachment is updated (i.e. a new version of the
+     * attachment is created).
+     *
+     * Note, you must set a `X-Atlassian-Token: nocheck` header on the request
+     * for this method, otherwise it will be blocked. This protects against XSRF
+     * attacks, which is necessary as this method accepts multipart/form-data.
+     *
+     * The media type 'multipart/form-data' is defined in [RFC
+     * 7578](https://www.ietf.org/rfc/rfc7578.txt).
+     * Most client libraries have classes that make it easier to implement
+     * multipart posts, like the
+     * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/)
+     * Java class provided by Apache HTTP Components.
+     *
+     * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5),
+     * in the case where the form data is text,
+     * the charset parameter for the "text/plain" Content-Type may be used to
+     * indicate the character encoding used in that part. In the case of this
+     * API endpoint, the `comment` body parameter should be sent with `type=text/plain`
+     * and `charset=utf-8` values. This will force the charset to be UTF-8.
+     *
+     * Example: This curl command attaches a file ('example.txt') to a piece of
+     * content (id='123') with a comment and `minorEdits`=true. If the 'example.txt'
+     * file already exists, it will update it with a new version of the attachment.
+     *
+     * ``` bash
+     * curl -D- \
+     *   -u admin:admin \
+     *   -X PUT \
+     *   -H 'X-Atlassian-Token: nocheck' \
+     *   -F 'file=@"example.txt"' \
+     *   -F 'minorEdit="true"' \
+     *   -F 'comment="Example attachment comment"; type=text/plain; charset=utf-8' \
+     *   http://myhost/rest/api/content/123/child/attachment
+     * ```
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the attachments were added to the content.
+     * @path {PUT} /wiki/rest/api/content/{id}/child/attachment
+     * @scopes-current write:confluence-file
+     * @scopes-beta read:content-details:confluence, write:attachment:confluence
+     */
+    createOrUpdateAttachments({ id, status, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/child/attachment",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            query: {
+                status,
+            },
+            headers: {
+                "Content-Type": "multipart/form-data",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentAttachmentsService.createOrUpdateAttachments.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Redirects the client to a URL that serves an attachment's binary data.
+     *
+     * @path {GET} /wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download
+     * @scopes-current readonly:content.attachment:confluence
+     * @scopes-beta read:attachment:confluence
+     */
+    downloadAttatchment({ id, attachmentId, version, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download",
+            method: "GET",
+            pathParams: {
+                id,
+                attachmentId,
+            },
+            query: {
+                version,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns the attachments for a piece of content.
+     *
+     * By default, the following objects are expanded: `metadata`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content. If the content is a blog post, 'View' permission
+     * for the space is required.
+     *
+     * @deprecated
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/child/attachment
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getAttachments({ id, expand, start, limit, filename, mediaType, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/child/attachment",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                expand,
+                start,
+                limit,
+                filename,
+                mediaType,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentAttachmentsService.getAttachments.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates the binary data of an attachment, given the attachment ID, and
+     * optionally the comment and the minor edit field.
+     *
+     * This method is essentially the same as [Create or update
+     * attachments](#api-content-id-child-attachment-put),
+     * except that it matches the attachment ID rather than the name.
+     *
+     * Note, you must set a `X-Atlassian-Token: nocheck` header on the request
+     * for this method, otherwise it will be blocked. This protects against XSRF
+     * attacks, which is necessary as this method accepts multipart/form-data.
+     *
+     * The media type 'multipart/form-data' is defined in [RFC
+     * 7578](https://www.ietf.org/rfc/rfc7578.txt).
+     * Most client libraries have classes that make it easier to implement
+     * multipart posts, like the
+     * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/)
+     * Java class provided by Apache HTTP Components.
+     *
+     * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5),
+     * in the case where the form data is text,
+     * the charset parameter for the "text/plain" Content-Type may be used to
+     * indicate the character encoding used in that part. In the case of this
+     * API endpoint, the `comment` body parameter should be sent with `type=text/plain`
+     * and `charset=utf-8` values. This will force the charset to be UTF-8.
+     *
+     * Example: This curl command updates an attachment (id='att456') that is attached
+     * to a piece of content (id='123') with a comment and `minorEdits`=true.
+     *
+     * ``` bash
+     * curl -D- \
+     *   -u admin:admin \
+     *   -X POST \
+     *   -H 'X-Atlassian-Token: nocheck' \
+     *   -F 'file=@"example.txt"' \
+     *   -F 'minorEdit="true"' \
+     *   -F 'comment="Example attachment comment"; type=text/plain; charset=utf-8' \
+     *   http://myhost/rest/api/content/123/child/attachment/att456/data
+     * ```
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the attachment is updated.
+     * @path {POST} /wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data
+     * @scopes-current write:confluence-file
+     * @scopes-beta read:content-details:confluence, write:attachment:confluence
+     */
+    updateAttachmentData({ id, attachmentId, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data",
+            method: "POST",
+            pathParams: {
+                id,
+                attachmentId,
+            },
+            headers: {
+                "Content-Type": "multipart/form-data",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentAttachmentsService.updateAttachmentData.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates the attachment properties, i.e. the non-binary data of an attachment
+     * like the filename, media-type, comment, and parent container.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the attachment is updated.
+     * @path {PUT} /wiki/rest/api/content/{id}/child/attachment/{attachmentId}
+     * @scopes-current write:confluence-file, write:confluence-props
+     * @scopes-beta read:content-details:confluence, write:attachment:confluence
+     */
+    updateAttachmentProperties({ id, attachmentId, attachmentPropertiesUpdateBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/child/attachment/{attachmentId}",
+            method: "PUT",
+            pathParams: {
+                id,
+                attachmentId,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: attachmentPropertiesUpdateBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentAttachmentsService.updateAttachmentProperties.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentAttachmentsService.getAttachments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentArray"),
+        })
+            .describe("ContentAttachmentsService.getAttachments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentAttachmentsService.createOrUpdateAttachments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentArray"),
+        })
+            .describe("ContentAttachmentsService.createOrUpdateAttachments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentAttachmentsService.createAttachment.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentArray"),
+        })
+            .describe("ContentAttachmentsService.createAttachment.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentAttachmentsService.updateAttachmentProperties.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.nullable(validationSchemaStorage_1.validationSchemaStorage.lazy("Content")),
+        })
+            .describe("ContentAttachmentsService.updateAttachmentProperties.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentAttachmentsService.updateAttachmentData.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.nullable(validationSchemaStorage_1.validationSchemaStorage.lazy("Content")),
+        })
+            .describe("ContentAttachmentsService.updateAttachmentData.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.ContentAttachmentsService = ContentAttachmentsService;
+//# sourceMappingURL=ContentAttachmentsService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContentAttachmentsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentAttachmentsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAE1B,wEAAqE;AACrE,MAAa,yBAA0B,SAAQ,qCAAiB;IAC9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,gBAAgB,CAAC,EACf,EAAE,EACF,MAAM,EACN,WAAW,GAOZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8CAA8C;YACpD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;aACP;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,qBAAqB;aACtC;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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,qDAAqD,CACtD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,yBAAyB,CAAC,EACxB,EAAE,EACF,MAAM,EACN,WAAW,GAUZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8CAA8C;YACpD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;aACP;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,qBAAqB;aACtC;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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,8DAA8D,CAC/D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;OAMG;IACH,mBAAmB,CAAC,EAClB,EAAE,EACF,YAAY,EACZ,OAAO,GAWR;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;gBACF,YAAY;aACb;YACD,KAAK,EAAE;gBACL,OAAO;aACR;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CAAC,EACb,EAAE,EACF,MAAM,EACN,KAAK,EACL,KAAK,EACL,QAAQ,EACR,SAAS,GA8GV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8CAA8C;YACpD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,KAAK;gBACL,KAAK;gBACL,QAAQ;gBACR,SAAS;aACV;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,oBAAoB,CAAC,EACnB,EAAE,EACF,YAAY,EACZ,WAAW,GAOZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;gBACF,YAAY;aACb;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,qBAAqB;aACtC;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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yDAAyD,CAC1D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,0BAA0B,CAAC,EACzB,EAAE,EACF,YAAY,EACZ,8BAA8B,GAQ/B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6DAA6D;YACnE,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;gBACF,YAAY;aACb;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,8BAA8B;SACrC,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,+DAA+D,CAChE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;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,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,mDAAmD,CAAC,CACjE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,8DAA8D,EAC9D,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,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CACP,8DAA8D,CAC/D,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,qDAAqD,EACrD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,+DAA+D,EAC/D,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,QAAQ,CAAC,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC1D,CAAC;aACD,QAAQ,CACP,+DAA+D,CAChE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yDAAyD,EACzD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,QAAQ,CAAC,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC1D,CAAC;aACD,QAAQ,CAAC,yDAAyD,CAAC,CACvE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAzlBD,8DAylBC"}

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

@@ -0,0 +1,227 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type AsyncId, type ContentBody, type ContentBodyCreate } from "../models/common";
+import { type AsyncContentBody } from "../models/contentBody";
+export declare class ContentBodyService extends CommonHttpService {
+    /**
+     * Converts a content body from one format to another format asynchronously.
+     * Returns the asyncId for the asynchronous task.
+     *
+     * Supported conversions:
+     *
+     * - storage: export_view
+     *
+     * No other conversions are supported at the moment.
+     * Once a conversion is completed, it will be available for 5 minutes at the
+     * result endpoint.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * If request specifies 'contentIdContext', 'View' permission for the space, and
+     * permission to view the content.
+     *
+     * @returns Returned if the content is added to the messaging queue for conversion. This id
+     * will be available for 5 minutes after the conversion is complete.
+     * @path {POST} /wiki/rest/api/contentbody/convert/async/{to}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.metadata:confluence
+     */
+    asyncConvertContentBodyRequest({ to, expand, spaceKeyContext, contentIdContext, allowCache, embeddedContentRender, contentBodyCreate, }: {
+        /** The name of the target format for the content body. */
+        to: "export_view";
+        /**
+         * A multi-value parameter indicating which properties of the content to expand
+         * and populate. Expands are dependent on the
+         * `to` conversion format and may be irrelevant for certain conversions (e.g.
+         * `macroRenderedOutput` is redundant when
+         * converting to `view` format).
+         *
+         * If rendering to `view` format, and the body content being converted includes
+         * arbitrary nested content (such as macros); then it is
+         * necessary to include webresource expands in the request. Webresources for
+         * content body are the batched JS and CSS dependencies for
+         * any nested dynamic content (i.e. macros).
+         *
+         * - `embeddedContent` returns metadata for nested content (e.g. page included
+         * using page include macro)
+         * - `mediaToken` returns JWT token for retrieving attachment data from Media API
+         * - `macroRenderedOutput` additionally converts body to view format
+         * - `webresource.superbatch.uris.js` returns all common JS dependencies as static
+         * URLs
+         * - `webresource.superbatch.uris.css` returns all common CSS dependencies as
+         * static URLs
+         * - `webresource.superbatch.uris.all` returns all common dependencies as static
+         * URLs
+         * - `webresource.superbatch.tags.all` returns all common JS dependencies as html
+         * `<script>` tags
+         * - `webresource.superbatch.tags.css` returns all common CSS dependencies as html
+         * `<style>` tags
+         * - `webresource.superbatch.tags.js` returns all common dependencies as html
+         * `<script>` and `<style>` tags
+         * - `webresource.uris.js` returns JS dependencies specific to conversion
+         * - `webresource.uris.css` returns CSS dependencies specific to conversion
+         * - `webresource.uris.all` returns all dependencies specific to conversion
+         * - `webresource.tags.all` returns common JS dependencies as html `<script>` tags
+         * - `webresource.tags.css` returns common CSS dependencies as html `<style>` tags
+         * - `webresource.tags.js` returns common dependencies as html `<script>` and
+         * `<style>` tags
+         */
+        expand?: string[];
+        /**
+         * The space key used for resolving embedded content (page includes,
+         * files, and links) in the content body. For example, if the source content
+         * contains the link `<ac:link><ri:page ri:content-title="Example page"
+         * /><ac:link>`
+         * and the `spaceKeyContext=TEST` parameter is provided, then the link
+         * will be converted to a link to the "Example page" page in the "TEST" space.
+         */
+        spaceKeyContext?: string;
+        /**
+         * The content ID used to find the space for resolving embedded content
+         * (page includes, files, and links) in the content body. For example,
+         * if the source content contains the link `<ac:link><ri:page
+         * ri:content-title="Example page" /><ac:link>`
+         * and the `contentIdContext=123` parameter is provided, then the link
+         * will be converted to a link to the "Example page" page in the same space
+         * that has the content with ID=123. Note, `spaceKeyContext` will be ignored
+         * if this parameter is provided.
+         */
+        contentIdContext?: string;
+        /**
+         * If this field is false, the cache will erase its current value and begin a new
+         * conversion.
+         * If this field is true, the cache will not erase its current value, and will set
+         * the status of the
+         * async conversion to RERUNNING. Once the data is updated, the status will change
+         * to COMPLETED.
+         * Large macros that take long to convert, and whose data need not immediately up
+         * to date (same as previous conversion's result within last 5 minutes)
+         * should set this fields to true. Cache values are stored per user per content
+         * body and expansions.
+         */
+        allowCache?: boolean;
+        /**
+         * Mode used for rendering embedded content, like attachments.
+         *
+         * - `current` renders the embedded content using the latest version.
+         * - `version-at-save` renders the embedded content using the version at
+         * the time of save.
+         */
+        embeddedContentRender?: "current" | "version-at-save";
+        /** The content body to convert. */
+        contentBodyCreate: ContentBodyCreate;
+    }): Promise<AsyncId>;
+    /**
+     * Returns the asynchronous content body for the corresponding id if the task is
+     * complete
+     * or returns the status of the task.
+     *
+     * After the task is completed, the result can be obtained for 5 minutes, or until
+     * an identical conversion request is made again,
+     * with allowCache query param set to false.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * If request specifies 'contentIdContext', 'View' permission for the space, and
+     * permission to view the content.
+     *
+     * @returns Returned if successfully found an async conversion task associated with the id.
+     * @path {GET} /wiki/rest/api/contentbody/convert/async/{id}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.metadata:confluence
+     */
+    asyncConvertContentBodyResponse({ id, }: {
+        /** The asyncId of the macro task to get the converted body. */
+        id: string;
+    }): Promise<AsyncContentBody>;
+    /**
+     * Converts a content body from one format to another format.
+     *
+     * Supported conversions:
+     *
+     * - storage: view, export_view, styled_view, editor
+     * - editor: storage
+     * - view: none
+     * - export_view: none
+     * - styled_view: none
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * If request specifies 'contentIdContext', 'View' permission for the space, and
+     * permission to view the content.
+     *
+     * @returns Returned if the content is converted.
+     * @path {POST} /wiki/rest/api/contentbody/convert/{to}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.metadata:confluence
+     */
+    convertContentBody({ to, spaceKeyContext, contentIdContext, embeddedContentRender, expand, contentBodyCreate, }: {
+        /** The name of the target format for the content body. */
+        to: string;
+        /**
+         * The space key used for resolving embedded content (page includes,
+         * files, and links) in the content body. For example, if the source content
+         * contains the link `<ac:link><ri:page ri:content-title="Example page"
+         * /><ac:link>`
+         * and the `spaceKeyContext=TEST` parameter is provided, then the link
+         * will be converted to a link to the "Example page" page in the "TEST" space.
+         */
+        spaceKeyContext?: string;
+        /**
+         * The content ID used to find the space for resolving embedded content
+         * (page includes, files, and links) in the content body. For example,
+         * if the source content contains the link `<ac:link><ri:page
+         * ri:content-title="Example page" /><ac:link>`
+         * and the `contentIdContext=123` parameter is provided, then the link
+         * will be converted to a link to the "Example page" page in the same space
+         * that has the content with ID=123. Note, `spaceKeyContext` will be ignored
+         * if this parameter is provided.
+         */
+        contentIdContext?: string;
+        /**
+         * Mode used for rendering embedded content, like attachments.
+         *
+         * - `current` renders the embedded content using the latest version.
+         * - `version-at-save` renders the embedded content using the version at
+         * the time of save.
+         */
+        embeddedContentRender?: "current" | "version-at-save";
+        /**
+         * A multi-value parameter indicating which properties of the content to expand
+         * and populate. Expands are dependent on the
+         * `to` conversion format and may be irrelevant for certain conversions (e.g.
+         * `macroRenderedOutput` is redundant when
+         * converting to `view` format).
+         *
+         * If rendering to `view` format, and the body content being converted includes
+         * arbitrary nested content (such as macros); then it is
+         * necessary to include webresource expands in the request. Webresources for
+         * content body are the batched JS and CSS dependencies for
+         * any nested dynamic content (i.e. macros).
+         *
+         * - `embeddedContent` returns metadata for nested content (e.g. page included
+         * using page include macro)
+         * - `mediaToken` returns JWT token for retrieving attachment data from Media API
+         * - `macroRenderedOutput` additionally converts body to view format
+         * - `webresource.superbatch.uris.js` returns all common JS dependencies as static
+         * URLs
+         * - `webresource.superbatch.uris.css` returns all common CSS dependencies as
+         * static URLs
+         * - `webresource.superbatch.uris.all` returns all common dependencies as static
+         * URLs
+         * - `webresource.superbatch.tags.all` returns all common JS dependencies as html
+         * `<script>` tags
+         * - `webresource.superbatch.tags.css` returns all common CSS dependencies as html
+         * `<style>` tags
+         * - `webresource.superbatch.tags.js` returns all common dependencies as html
+         * `<script>` and `<style>` tags
+         * - `webresource.uris.js` returns JS dependencies specific to conversion
+         * - `webresource.uris.css` returns CSS dependencies specific to conversion
+         * - `webresource.uris.all` returns all dependencies specific to conversion
+         * - `webresource.tags.all` returns common JS dependencies as html `<script>` tags
+         * - `webresource.tags.css` returns common CSS dependencies as html `<style>` tags
+         * - `webresource.tags.js` returns common dependencies as html `<script>` and
+         * `<style>` tags
+         */
+        expand?: string[];
+        /** The content body to convert. */
+        contentBodyCreate: ContentBodyCreate;
+    }): Promise<ContentBody>;
+    static initialize(): void;
+}