@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentCommentsService = 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");
+/** @deprecated */
+class ContentCommentsService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns the comments on a piece of content.
+     *
+     * Starting on Dec 10, 2024, if the expand query parameter is used with the
+     * `body.export_view` and/or `body.styled_view` properties, then the query limit
+     * parameter will be restricted to a maximum value of 25.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
+     * permission for the space,
+     * and permission to view the content if it is a page.
+     *
+     * @deprecated
+     * @returns Returned if the requested comments are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/child/comment
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentComments({ id, expand, parentVersion, start, limit, location, depth, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/child/comment",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                expand,
+                parentVersion,
+                start,
+                limit,
+                location,
+                depth,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentCommentsService.getContentComments.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentCommentsService.getContentComments.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("ContentCommentsService.getContentComments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.ContentCommentsService = ContentCommentsService;
+//# sourceMappingURL=ContentCommentsService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContentCommentsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentCommentsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,wEAAqE;AACrE,kBAAkB;AAClB,MAAa,sBAAuB,SAAQ,qCAAiB;IAC3D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBAAkB,CAAC,EACjB,EAAE,EACF,MAAM,EACN,aAAa,EACb,KAAK,EACL,KAAK,EACL,QAAQ,EACR,KAAK,GAyHN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,KAAK;gBACL,QAAQ;gBACR,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,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,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAxMD,wDAwMC"}

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

@@ -0,0 +1,122 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type LabelArray, type LabelCreate } from "../models/common";
+import type { LabelCreateArray } from "../models/contentLabels";
+export declare class ContentLabelsService extends CommonHttpService {
+    /**
+     * Adds labels to a piece of content. Does not modify the existing labels.
+     *
+     * Notes:
+     *
+     * - Labels can also be added when creating content ([Create
+     * content](#api-content-post)).
+     * - Labels can be updated when updating content ([Update
+     * content](#api-content-id-put)).
+     * This will delete the existing labels and replace them with the labels in
+     * the request.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the labels are added to the content.
+     * @path {POST} /wiki/rest/api/content/{id}/label
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:label:confluence, write:label:confluence
+     */
+    addLabelsToContent({ id, requestBody, }: {
+        /** The ID of the content that will have labels added to it. */
+        id: string;
+        /** The labels to add to the content. */
+        requestBody: LabelCreateArray | LabelCreate;
+    }): Promise<LabelArray>;
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns the labels on a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space and permission to view the content if it is a
+     * page.
+     *
+     * @deprecated
+     * @returns Returned if the requested labels are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/label
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:label:confluence
+     */
+    getLabelsForContent({ id, prefix, start, limit, }: {
+        /** The ID of the content to be queried for its labels. */
+        id: string;
+        /**
+         * Filters the results to labels with the specified prefix. If this parameter
+         * is not specified, then labels with any prefix will be returned.
+         *
+         * - `global` prefix is used by default when a user adds a label
+         * via the UI.
+         * - `my` prefix can be explicitly added by a user when adding a label
+         * via the UI, e.g. 'my:example-label'. Also, when a page is selected as
+         * a favourite, the 'my:favourite' label is automatically added.
+         * - `team` can used when adding labels via [Add labels to
+         * content](#api-content-id-label-post)
+         * but is not used in the UI.
+         */
+        prefix?: "global" | "my" | "team";
+        /** The starting index of the returned labels. */
+        start?: number;
+        /**
+         * The maximum number of labels to return per page. Note,
+         * this may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<LabelArray>;
+    /**
+     * Removes a label from a piece of content. Labels can't be deleted from archived
+     * content.
+     * This is similar to [Remove label from content using query
+     * parameter](#api-content-id-label-delete)
+     * except that the label name is specified via a path parameter.
+     *
+     * Use this method if the label name does not have "/" characters, as the path
+     * parameter does not accept "/" characters for security reasons. Otherwise,
+     * use [Remove label from content using query
+     * parameter](#api-content-id-label-delete).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @path {DELETE} /wiki/rest/api/content/{id}/label/{label}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:label:confluence
+     */
+    removeLabelFromContent({ id, label, }: {
+        /** The ID of the content that the label will be removed from. */
+        id: string;
+        /** The name of the label to be removed. */
+        label: string;
+    }): Promise<void>;
+    /**
+     * Removes a label from a piece of content. Labels can't be deleted from archived
+     * content.
+     * This is similar to [Remove label from
+     * content](#api-content-id-label-label-delete)
+     * except that the label name is specified via a query parameter.
+     *
+     * Use this method if the label name has "/" characters, as
+     * [Remove label from content using query parameter](#api-content-id-label-delete)
+     * does not accept "/" characters for the label name.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @path {DELETE} /wiki/rest/api/content/{id}/label
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:label:confluence
+     */
+    removeLabelFromContentUsingQueryParameter({ id, name, }: {
+        /** The ID of the content that the label will be removed from. */
+        id: string;
+        /** The name of the label to be removed. */
+        name: string;
+    }): Promise<void>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentLabelsService = 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 ContentLabelsService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Adds labels to a piece of content. Does not modify the existing labels.
+     *
+     * Notes:
+     *
+     * - Labels can also be added when creating content ([Create
+     * content](#api-content-post)).
+     * - Labels can be updated when updating content ([Update
+     * content](#api-content-id-put)).
+     * This will delete the existing labels and replace them with the labels in
+     * the request.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the labels are added to the content.
+     * @path {POST} /wiki/rest/api/content/{id}/label
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:label:confluence, write:label:confluence
+     */
+    addLabelsToContent({ id, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/label",
+            method: "POST",
+            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("ContentLabelsService.addLabelsToContent.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns the labels on a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space and permission to view the content if it is a
+     * page.
+     *
+     * @deprecated
+     * @returns Returned if the requested labels are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/label
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:label:confluence
+     */
+    getLabelsForContent({ id, prefix, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/label",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                prefix,
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentLabelsService.getLabelsForContent.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Removes a label from a piece of content. Labels can't be deleted from archived
+     * content.
+     * This is similar to [Remove label from content using query
+     * parameter](#api-content-id-label-delete)
+     * except that the label name is specified via a path parameter.
+     *
+     * Use this method if the label name does not have "/" characters, as the path
+     * parameter does not accept "/" characters for security reasons. Otherwise,
+     * use [Remove label from content using query
+     * parameter](#api-content-id-label-delete).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @path {DELETE} /wiki/rest/api/content/{id}/label/{label}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:label:confluence
+     */
+    removeLabelFromContent({ id, label, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/label/{label}",
+            method: "DELETE",
+            pathParams: {
+                id,
+                label,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Removes a label from a piece of content. Labels can't be deleted from archived
+     * content.
+     * This is similar to [Remove label from
+     * content](#api-content-id-label-label-delete)
+     * except that the label name is specified via a query parameter.
+     *
+     * Use this method if the label name has "/" characters, as
+     * [Remove label from content using query parameter](#api-content-id-label-delete)
+     * does not accept "/" characters for the label name.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @path {DELETE} /wiki/rest/api/content/{id}/label
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:label:confluence
+     */
+    removeLabelFromContentUsingQueryParameter({ id, name, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/label",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+            query: {
+                name,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentLabelsService.getLabelsForContent.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("LabelArray"),
+        })
+            .describe("ContentLabelsService.getLabelsForContent.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentLabelsService.addLabelsToContent.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("LabelArray"),
+        })
+            .describe("ContentLabelsService.addLabelsToContent.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.ContentLabelsService = ContentLabelsService;
+//# sourceMappingURL=ContentLabelsService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContentLabelsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentLabelsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAE1B,wEAAqE;AACrE,MAAa,oBAAqB,SAAQ,qCAAiB;IACzD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBAAkB,CAAC,EACjB,EAAE,EACF,WAAW,GAMZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,MAAM;YACd,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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,kDAAkD,CACnD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,EAClB,EAAE,EACF,MAAM,EACN,KAAK,EACL,KAAK,GAyBN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,KAAK;gBACL,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,mDAAmD,CACpD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,sBAAsB,CAAC,EACrB,EAAE,EACF,KAAK,GAMN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;gBACF,KAAK;aACN;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,yCAAyC,CAAC,EACxC,EAAE,EACF,IAAI,GAML;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;aACL;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,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,YAAY,CAAC;SACjD,CAAC;aACD,QAAQ,CAAC,mDAAmD,CAAC,CACjE,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,iDAAuB,CAAC,IAAI,CAAC,YAAY,CAAC;SACjD,CAAC;aACD,QAAQ,CAAC,kDAAkD,CAAC,CAChE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AArPD,oDAqPC"}

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

@@ -0,0 +1,268 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type AsyncId, type ContentBody } from "../models/common";
+import { type MacroInstance } from "../models/contentMacroBody";
+export declare class ContentMacroBodyService extends CommonHttpService {
+    /**
+     * Returns Async Id of the conversion task which will convert the macro into a
+     * content body of the desired format.
+     * The result will be available for 5 minutes after completion of the conversion.
+     *
+     * About the macro ID: When a macro is created in a new version of content,
+     * Confluence will generate a random ID for it, unless an ID is specified
+     * (by an app). The macro ID will look similar to this:
+     * '884bd9-0cb8-41d5-98be-f80943c14f96'.
+     * The ID is then persisted as new versions of content are created, and is
+     * only modified by Confluence if there are conflicting IDs.
+     *
+     * Note, to preserve backwards compatibility this resource will also match on
+     * the hash of the macro body, even if a macro ID is found. This check will
+     * eventually become redundant, as macro IDs are generated for pages and
+     * transparently propagate out to all instances.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content that the macro is in.
+     *
+     * @returns Returned if the requested macro conversion request is created.
+     * @path {GET}
+     * /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/async/{to}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.metadata:confluence
+     */
+    getAndAsyncConvertMacroBodyByMacroId({ id, version, macroId, to, expand, allowCache, spaceKeyContext, embeddedContentRender, }: {
+        /** The ID for the content that contains the macro. */
+        id: string;
+        /**
+         * The version of the content that contains the macro. Specifying `0` as the
+         * `version` will return
+         * the macro body for the latest content version.
+         */
+        version: number;
+        /**
+         * The ID of the macro. For apps, this is passed to the macro by the Connect/Forge
+         * framework.
+         * Otherwise, find the macro ID by querying the desired
+         * content and version, then expanding the body in storage format.
+         * For example, '/content/196611/version/7?expand=content.body.storage'.
+         */
+        macroId: string;
+        /**
+         * The content representation to return the macro in.
+         * Currently, the following conversions are allowed:
+         *
+         * - `export_view`
+         * - `styled_view`
+         * - `view`
+         */
+        to: "export_view" | "view" | "styled_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[];
+        /**
+         * If this field is false, the cache will erase its current value and begin a
+         * conversion.
+         * If this field is true, the cache will not erase its current value, and will set
+         * the status of the
+         * result in cache to RERUNNING. Once the data is updated, the status will change
+         * to COMPLETED.
+         * Large macros that take long to convert, and who want to show intermediate, but
+         * potentially stale data, immediately should set this field to true.
+         * Cache values are stored per macro per user per content and expansions.
+         */
+        allowCache?: boolean;
+        /**
+         * 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;
+        /**
+         * 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";
+    }): Promise<AsyncId>;
+    /**
+     * Returns the body of a macro in format specified in path, for the given macro ID.
+     * This includes information like the name of the macro, the body of the macro,
+     * and any macro parameters.
+     *
+     * About the macro ID: When a macro is created in a new version of content,
+     * Confluence will generate a random ID for it, unless an ID is specified
+     * (by an app). The macro ID will look similar to this:
+     * '50884bd9-0cb8-41d5-98be-f80943c14f96'.
+     * The ID is then persisted as new versions of content are created, and is
+     * only modified by Confluence if there are conflicting IDs.
+     *
+     * Note, to preserve backwards compatibility this resource will also match on
+     * the hash of the macro body, even if a macro ID is found. This check will
+     * eventually become redundant, as macro IDs are generated for pages and
+     * transparently propagate out to all instances.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content that the macro is in.
+     *
+     * @returns Returned if the requested content body is returned.
+     * @path {GET}
+     * /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/{to}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.metadata:confluence
+     */
+    getAndConvertMacroBodyByMacroId({ id, version, macroId, to, expand, spaceKeyContext, embeddedContentRender, }: {
+        /** The ID for the content that contains the macro. */
+        id: string;
+        /**
+         * The version of the content that contains the macro. Specifying `0` as the
+         * `version` will return
+         * the macro body for the latest content version.
+         */
+        version: number;
+        /**
+         * The ID of the macro. This is usually passed by the app that the
+         * macro is in. Otherwise, find the macro ID by querying the desired
+         * content and version, then expanding the body in storage format.
+         * For example, '/content/196611/version/7?expand=content.body.storage'.
+         */
+        macroId: string;
+        /** The content representation to return the macro in. */
+        to: string;
+        /**
+         * 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;
+        /**
+         * 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";
+    }): Promise<ContentBody>;
+    /**
+     * Returns the body of a macro in storage format, for the given macro ID.
+     * This includes information like the name of the macro, the body of the macro,
+     * and any macro parameters. This method is mainly used by Cloud apps.
+     *
+     * About the macro ID: When a macro is created in a new version of content,
+     * Confluence will generate a random ID for it, unless an ID is specified
+     * (by an app). The macro ID will look similar to this:
+     * '50884bd9-0cb8-41d5-98be-f80943c14f96'.
+     * The ID is then persisted as new versions of content are created, and is
+     * only modified by Confluence if there are conflicting IDs.
+     *
+     * Note, to preserve backwards compatibility this resource will also match on
+     * the hash of the macro body, even if a macro ID is found. This check will
+     * eventually become redundant, as macro IDs are generated for pages and
+     * transparently propagate out to all instances.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content that the macro is in.
+     *
+     * @returns Returned if the requested macro body is returned.
+     * @path {GET} /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.metadata:confluence
+     */
+    getMacroBodyByMacroId({ id, version, macroId, }: {
+        /** The ID for the content that contains the macro. */
+        id: string;
+        /**
+         * The version of the content that contains the macro. Specifying `0` as the
+         * `version` will return
+         * the macro body for the latest content version.
+         */
+        version: number;
+        /**
+         * The ID of the macro. This is usually passed by the app that the
+         * macro is in. Otherwise, find the macro ID by querying the desired
+         * content and version, then expanding the body in storage format.
+         * For example, '/content/196611/version/7?expand=content.body.storage'.
+         */
+        macroId: string;
+    }): Promise<MacroInstance>;
+    static initialize(): void;
+}