confluence.js 2.0.0-dev20250512202536 → 2.1.0

package/dist/esm/types/api/contentBody.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class ContentBody {
     private client;
     constructor(client: Client);
@@ -18,6 +18,8 @@ export declare class ContentBody {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext',
      * 'View' permission for the space, and permission to view the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     convertContentBody<T = Models.ContentBody>(parameters: Parameters.ConvertContentBody, callback: Callback<T>): Promise<void>;
     /**
@@ -33,6 +35,8 @@ export declare class ContentBody {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext',
      * 'View' permission for the space, and permission to view the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     convertContentBody<T = Models.ContentBody>(parameters: Parameters.ConvertContentBody, callback?: never): Promise<T>;
     /**
@@ -41,7 +45,9 @@ export declare class ContentBody {
      *
      * Supported conversions:
      *
-     * - Storage: export_view
+     * - Atlas_doc_format: editor, export_view, storage, styled_view, view
+     * - Storage: atlas_doc_format, editor, export_view, styled_view, view
+     * - Editor: storage
      *
      * No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5
      * minutes at the result endpoint.
@@ -56,7 +62,9 @@ export declare class ContentBody {
      *
      * Supported conversions:
      *
-     * - Storage: export_view
+     * - Atlas_doc_format: editor, export_view, storage, styled_view, view
+     * - Storage: atlas_doc_format, editor, export_view, styled_view, view
+     * - Editor: storage
      *
      * No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5
      * minutes at the result endpoint.
@@ -66,8 +74,8 @@ export declare class ContentBody {
      */
     asyncConvertContentBodyRequest<T = Models.AsyncId>(parameters: Parameters.AsyncConvertContentBodyRequest, callback?: never): Promise<T>;
     /**
-     * Returns the Asynchronous Content Body for the corresponding asyncId if the task is complete or returns the status
-     * of the task.
+     * 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.
@@ -77,8 +85,8 @@ export declare class ContentBody {
      */
     asyncConvertContentBodyResponse<T = Models.AsyncContentBody>(parameters: Parameters.AsyncConvertContentBodyResponse, callback: Callback<T>): Promise<void>;
     /**
-     * Returns the Asynchronous Content Body for the corresponding asyncId if the task is complete or returns the status
-     * of the task.
+     * 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.
@@ -87,4 +95,62 @@ export declare class ContentBody {
      * 'View' permission for the space, and permission to view the content.
      */
     asyncConvertContentBodyResponse<T = Models.AsyncContentBody>(parameters: Parameters.AsyncConvertContentBodyResponse, callback?: never): Promise<T>;
+    /**
+     * Returns the content body for the corresponding `asyncId` of a completed conversion task. If the task is not
+     * completed, the task status is returned instead.
+     *
+     * Once a conversion task is completed, the result can be obtained for up to 5 minutes, or until an identical
+     * conversion request is made again with the `allowCache` parameter set to false.
+     *
+     * Note that there is a maximum limit of 50 task results per request to this endpoint.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+     * ('Can use' global permission).
+     */
+    bulkAsyncConvertContentBodyResponse<T = Models.AsyncContentBody[]>(parameters: Parameters.BulkAsyncConvertContentBodyResponse, callback: Callback<T>): Promise<void>;
+    /**
+     * Returns the content body for the corresponding `asyncId` of a completed conversion task. If the task is not
+     * completed, the task status is returned instead.
+     *
+     * Once a conversion task is completed, the result can be obtained for up to 5 minutes, or until an identical
+     * conversion request is made again with the `allowCache` parameter set to false.
+     *
+     * Note that there is a maximum limit of 50 task results per request to this endpoint.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+     * ('Can use' global permission).
+     */
+    bulkAsyncConvertContentBodyResponse<T = Models.AsyncContentBody[]>(parameters: Parameters.BulkAsyncConvertContentBodyResponse, callback?: never): Promise<T>;
+    /**
+     * Asynchronously converts content bodies from one format to another format in bulk. Use the Content body REST API to
+     * get the status of conversion tasks. Note that there is a maximum limit of 10 conversions per request to this
+     * endpoint.
+     *
+     * Supported conversions:
+     *
+     * - Storage: editor, export_view, styled_view, view
+     * - Editor: storage
+     *
+     * Once a conversion task is completed, it is available for polling for up to 5 minutes.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
+     * permission to view the content if the `spaceKeyContext` or `contentIdContext` are present.
+     */
+    bulkAsyncConvertContentBodyRequest<T = Models.AsyncId[]>(parameters: Parameters.BulkAsyncConvertContentBodyRequest, callback: Callback<T>): Promise<void>;
+    /**
+     * Asynchronously converts content bodies from one format to another format in bulk. Use the Content body REST API to
+     * get the status of conversion tasks. Note that there is a maximum limit of 10 conversions per request to this
+     * endpoint.
+     *
+     * Supported conversions:
+     *
+     * - Storage: editor, export_view, styled_view, view
+     * - Editor: storage
+     *
+     * Once a conversion task is completed, it is available for polling for up to 5 minutes.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
+     * permission to view the content if the `spaceKeyContext` or `contentIdContext` are present.
+     */
+    bulkAsyncConvertContentBodyRequest<T = Models.AsyncId[]>(parameters: Parameters.BulkAsyncConvertContentBodyRequest, callback?: never): Promise<T>;
 }

package/dist/esm/types/api/contentChildrenAndDescendants.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class ContentChildrenAndDescendants {
     private client;
     constructor(client: Client);
@@ -22,6 +22,8 @@ export declare class ContentChildrenAndDescendants {
      *
      * **[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 Will be removed in next major version.
      */
     getContentChildren<T = Models.ContentChildren>(parameters: Parameters.GetContentChildren, callback: Callback<T>): Promise<void>;
     /**
@@ -41,6 +43,8 @@ export declare class ContentChildrenAndDescendants {
      *
      * **[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 Will be removed in next major version.
      */
     getContentChildren<T = Models.ContentChildren>(parameters: Parameters.GetContentChildren, callback?: never): Promise<T>;
     /**
@@ -83,6 +87,8 @@ export declare class ContentChildrenAndDescendants {
      *
      * **[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 Will be removed in next major version.
      */
     getContentChildrenByType<T = Models.ContentArray>(parameters: Parameters.GetContentChildrenByType, callback: Callback<T>): Promise<void>;
     /**
@@ -101,6 +107,8 @@ export declare class ContentChildrenAndDescendants {
      *
      * **[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 Will be removed in next major version.
      */
     getContentChildrenByType<T = Models.ContentArray>(parameters: Parameters.GetContentChildrenByType, callback?: never): Promise<T>;
     /**
@@ -110,7 +118,11 @@ export declare class ContentChildrenAndDescendants {
      *
      * A piece of content has different types of descendants, depending on its type:
      *
-     * - `page`: descendant is `page`, `comment`, `attachment`
+     * - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
      * - `blogpost`: descendant is `comment`, `attachment`
      * - `attachment`: descendant is `comment`
      * - `comment`: descendant is `attachment`
@@ -129,7 +141,11 @@ export declare class ContentChildrenAndDescendants {
      *
      * A piece of content has different types of descendants, depending on its type:
      *
-     * - `page`: descendant is `page`, `comment`, `attachment`
+     * - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
      * - `blogpost`: descendant is `comment`, `attachment`
      * - `attachment`: descendant is `comment`
      * - `comment`: descendant is `attachment`
@@ -148,13 +164,20 @@ export declare class ContentChildrenAndDescendants {
      *
      * A piece of content has different types of descendants, depending on its type:
      *
-     * - `page`: descendant is `page`, `comment`, `attachment`
+     * - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
      * - `blogpost`: descendant is `comment`, `attachment`
      * - `attachment`: descendant is `comment`
      * - `comment`: descendant is `attachment`
      *
      * Custom content types that are provided by apps can also be returned.
      *
+     * 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.
      */
@@ -166,13 +189,20 @@ export declare class ContentChildrenAndDescendants {
      *
      * A piece of content has different types of descendants, depending on its type:
      *
-     * - `page`: descendant is `page`, `comment`, `attachment`
+     * - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
+     * - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
      * - `blogpost`: descendant is `comment`, `attachment`
      * - `attachment`: descendant is `comment`
      * - `comment`: descendant is `attachment`
      *
      * Custom content types that are provided by apps can also be returned.
      *
+     * 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.
      */
@@ -200,6 +230,7 @@ export declare class ContentChildrenAndDescendants {
      *
      * - `space`: page will be copied to the specified space as a root page on the space
      * - `parent_page`: page will be copied as a child of the specified parent page
+     * - `parent_content`: page will be copied as a child of the specified parent content
      * - `existing_page`: page will be copied and replace the specified page
      *
      * By default, the following objects are expanded: `space`, `history`, `version`.
@@ -215,6 +246,7 @@ export declare class ContentChildrenAndDescendants {
      *
      * - `space`: page will be copied to the specified space as a root page on the space
      * - `parent_page`: page will be copied as a child of the specified parent page
+     * - `parent_content`: page will be copied as a child of the specified parent content
      * - `existing_page`: page will be copied and replace the specified page
      *
      * By default, the following objects are expanded: `space`, `history`, `version`.

package/dist/esm/types/api/contentComments.d.ts

@@ -2,6 +2,7 @@ import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
 import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+/** @deprecated Will be removed in next major version. */
 export declare class ContentComments {
     private client;
     constructor(client: Client);
@@ -10,6 +11,8 @@ export declare class ContentComments {
      *
      * **[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 Will be removed in next major version.
      */
     getContentComments<T = Models.ContentArray>(parameters: Parameters.GetContentComments, callback: Callback<T>): Promise<void>;
     /**
@@ -17,6 +20,8 @@ export declare class ContentComments {
      *
      * **[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 Will be removed in next major version.
      */
     getContentComments<T = Models.ContentArray>(parameters: Parameters.GetContentComments, callback?: never): Promise<T>;
 }

package/dist/esm/types/api/contentLabels.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class ContentLabels {
     private client;
     constructor(client: Client);
@@ -10,6 +10,8 @@ export declare class ContentLabels {
      *
      * **[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 Will be removed in next major version.
      */
     getLabelsForContent<T = Models.LabelArray>(parameters: Parameters.GetLabelsForContent, callback: Callback<T>): Promise<void>;
     /**
@@ -17,6 +19,8 @@ export declare class ContentLabels {
      *
      * **[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 Will be removed in next major version.
      */
     getLabelsForContent<T = Models.LabelArray>(parameters: Parameters.GetLabelsForContent, callback?: never): Promise<T>;
     /**
@@ -44,8 +48,9 @@ export declare class ContentLabels {
      */
     addLabelsToContent<T = Models.LabelArray>(parameters: Parameters.AddLabelsToContent, callback?: never): Promise<T>;
     /**
-     * Removes a label from a piece of 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.
+     * 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.
@@ -54,8 +59,9 @@ export declare class ContentLabels {
      */
     removeLabelFromContentUsingQueryParameter<T = void>(parameters: Parameters.RemoveLabelFromContentUsingQueryParameter, callback: Callback<T>): Promise<void>;
     /**
-     * Removes a label from a piece of 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.
+     * 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.
@@ -64,8 +70,9 @@ export declare class ContentLabels {
      */
     removeLabelFromContentUsingQueryParameter<T = void>(parameters: Parameters.RemoveLabelFromContentUsingQueryParameter, callback?: never): Promise<T>;
     /**
-     * Removes a label from a piece of 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.
+     * 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
@@ -75,8 +82,9 @@ export declare class ContentLabels {
      */
     removeLabelFromContent<T = void>(parameters: Parameters.RemoveLabelFromContent, callback: Callback<T>): Promise<void>;
     /**
-     * Removes a label from a piece of 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.
+     * 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

package/dist/esm/types/api/contentMacroBody.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class ContentMacroBody {
     private client;
     constructor(client: Client);
@@ -14,10 +14,23 @@ export declare class ContentMacroBody {
      * '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.
      *
+     * For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved
+     * either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by
+     * examining the "local-id" parameter node inside the "parameters" node.
+     *
+     * Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID.
+     *
+     * Example: <ac:adf-node type="extension"> <ac:adf-attribute
+     * key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters">
+     * <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter>
+     * </ac:adf-node>
+     *
      * 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.
      *
+     * This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID.
+     *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
      * macro is in.
      */
@@ -31,10 +44,23 @@ export declare class ContentMacroBody {
      * '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.
      *
+     * For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved
+     * either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by
+     * examining the "local-id" parameter node inside the "parameters" node.
+     *
+     * Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID.
+     *
+     * Example: <ac:adf-node type="extension"> <ac:adf-attribute
+     * key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters">
+     * <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter>
+     * </ac:adf-node>
+     *
      * 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.
      *
+     * This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID.
+     *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
      * macro is in.
      */
@@ -48,10 +74,23 @@ export declare class ContentMacroBody {
      * '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.
      *
+     * For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved
+     * either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by
+     * examining the "local-id" parameter node inside the "parameters" node.
+     *
+     * Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID.
+     *
+     * Example: <ac:adf-node type="extension"> <ac:adf-attribute
+     * key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters">
+     * <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter>
+     * </ac:adf-node>
+     *
      * 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.
      *
+     * This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID.
+     *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
      * macro is in.
      */
@@ -65,10 +104,23 @@ export declare class ContentMacroBody {
      * '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.
      *
+     * For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved
+     * either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by
+     * examining the "local-id" parameter node inside the "parameters" node.
+     *
+     * Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID.
+     *
+     * Example: <ac:adf-node type="extension"> <ac:adf-attribute
+     * key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters">
+     * <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter>
+     * </ac:adf-node>
+     *
      * 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.
      *
+     * This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID.
+     *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
      * macro is in.
      */
@@ -82,10 +134,23 @@ export declare class ContentMacroBody {
      * '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.
      *
+     * For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved
+     * either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by
+     * examining the "local-id" parameter node inside the "parameters" node.
+     *
+     * Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID.
+     *
+     * Example: <ac:adf-node type="extension"> <ac:adf-attribute
+     * key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters">
+     * <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter>
+     * </ac:adf-node>
+     *
      * 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.
      *
+     * This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID.
+     *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
      * macro is in.
      */
@@ -99,10 +164,23 @@ export declare class ContentMacroBody {
      * '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.
      *
+     * For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved
+     * either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by
+     * examining the "local-id" parameter node inside the "parameters" node.
+     *
+     * Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID.
+     *
+     * Example: <ac:adf-node type="extension"> <ac:adf-attribute
+     * key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters">
+     * <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter>
+     * </ac:adf-node>
+     *
      * 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.
      *
+     * This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID.
+     *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
      * macro is in.
      */

package/dist/esm/types/api/contentPermissions.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class ContentPermissions {
     private client;
     constructor(client: Client);

package/dist/esm/types/api/contentProperties.d.ts

@@ -2,6 +2,7 @@ import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
 import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+/** @deprecated Will be removed in next major version. */
 export declare class ContentProperties {
     private client;
     constructor(client: Client);
@@ -11,6 +12,8 @@ export declare class ContentProperties {
      *
      * **[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 Will be removed in next major version.
      */
     getContentProperties<T = Models.ContentPropertyArray>(parameters: Parameters.GetContentProperties, callback: Callback<T>): Promise<void>;
     /**
@@ -19,6 +22,8 @@ export declare class ContentProperties {
      *
      * **[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 Will be removed in next major version.
      */
     getContentProperties<T = Models.ContentPropertyArray>(parameters: Parameters.GetContentProperties, callback?: never): Promise<T>;
     /**
@@ -32,6 +37,8 @@ export declare class ContentProperties {
      * `metadata.properties` of the request.
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     createContentProperty<T = Models.ContentProperty>(parameters: Parameters.CreateContentProperty, callback: Callback<T>): Promise<void>;
     /**
@@ -45,6 +52,8 @@ export declare class ContentProperties {
      * `metadata.properties` of the request.
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     createContentProperty<T = Models.ContentProperty>(parameters: Parameters.CreateContentProperty, callback?: never): Promise<T>;
     /**
@@ -53,6 +62,8 @@ export declare class ContentProperties {
      *
      * **[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 Will be removed in next major version.
      */
     getContentProperty<T = Models.ContentProperty>(parameters: Parameters.GetContentProperty, callback: Callback<T>): Promise<void>;
     /**
@@ -61,6 +72,8 @@ export declare class ContentProperties {
      *
      * **[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 Will be removed in next major version.
      */
     getContentProperty<T = Models.ContentProperty>(parameters: Parameters.GetContentProperty, callback?: never): Promise<T>;
     /**
@@ -74,6 +87,8 @@ export declare class ContentProperties {
      * `metadata.properties` of the request.
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     createContentPropertyForKey<T = Models.ContentProperty>(parameters: Parameters.CreateContentPropertyForKey, callback: Callback<T>): Promise<void>;
     /**
@@ -87,6 +102,8 @@ export declare class ContentProperties {
      * `metadata.properties` of the request.
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     createContentPropertyForKey<T = Models.ContentProperty>(parameters: Parameters.CreateContentPropertyForKey, callback?: never): Promise<T>;
     /**
@@ -95,6 +112,8 @@ export declare class ContentProperties {
      * [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     updateContentProperty<T = Models.ContentProperty>(parameters: Parameters.UpdateContentProperty, callback: Callback<T>): Promise<void>;
     /**
@@ -103,6 +122,8 @@ export declare class ContentProperties {
      * [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     updateContentProperty<T = Models.ContentProperty>(parameters: Parameters.UpdateContentProperty, callback?: never): Promise<T>;
     /**
@@ -110,6 +131,8 @@ export declare class ContentProperties {
      * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     deleteContentProperty<T = void>(parameters: Parameters.DeleteContentProperty, callback: Callback<T>): Promise<void>;
     /**
@@ -117,6 +140,8 @@ export declare class ContentProperties {
      * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     deleteContentProperty<T = void>(parameters: Parameters.DeleteContentProperty, callback?: never): Promise<T>;
 }