confluence.js 2.0.0 → 2.2.0-dev20260318121920

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>;
 }

package/dist/esm/types/api/contentRestrictions.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 ContentRestrictions {
     private client;
     constructor(client: Client);
@@ -87,26 +87,30 @@ export declare class ContentRestrictions {
      * Returns whether the specified content restriction applies to a group. For example, if a page with `id=123` has a
      * `read` restriction for the `admins` group, the following request will return `true`:
      *
-     * `https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/group/admins`
+     * `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/group/admins`
      *
      * Note that a response of `true` does not guarantee that the group can view the page, as it does not account for
      * account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
      * permissions](https://confluence.atlassian.com/x/_AozKw).
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     getContentRestrictionStatusForGroup<T = unknown>(parameters: Parameters.GetContentRestrictionStatusForGroup, callback: Callback<T>): Promise<void>;
     /**
      * Returns whether the specified content restriction applies to a group. For example, if a page with `id=123` has a
      * `read` restriction for the `admins` group, the following request will return `true`:
      *
-     * `https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/group/admins`
+     * `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/group/admins`
      *
      * Note that a response of `true` does not guarantee that the group can view the page, as it does not account for
      * account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
      * permissions](https://confluence.atlassian.com/x/_AozKw).
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     getContentRestrictionStatusForGroup<T = unknown>(parameters: Parameters.GetContentRestrictionStatusForGroup, callback?: never): Promise<T>;
     /**
@@ -114,6 +118,8 @@ export declare class ContentRestrictions {
      * content.
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     addGroupToContentRestriction<T = unknown>(parameters: Parameters.AddGroupToContentRestriction, callback: Callback<T>): Promise<void>;
     /**
@@ -121,6 +127,8 @@ export declare class ContentRestrictions {
      * content.
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     addGroupToContentRestriction<T = unknown>(parameters: Parameters.AddGroupToContentRestriction, callback?: never): Promise<T>;
     /**
@@ -128,6 +136,8 @@ export declare class ContentRestrictions {
      * content.
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     removeGroupByName<T = unknown>(parameters: Parameters.RemoveGroupByName, callback: Callback<T>): Promise<void>;
     /**
@@ -135,13 +145,15 @@ export declare class ContentRestrictions {
      * content.
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+     *
+     * @deprecated Will be removed in next major version.
      */
     removeGroupByName<T = unknown>(parameters: Parameters.RemoveGroupByName, callback?: never): Promise<T>;
     /**
      * Returns whether the specified content restriction applies to a group. For example, if a page with `id=123` has a
      * `read` restriction for the `123456` group id, the following request will return `true`:
      *
-     * `https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/byGroupId/123456`
+     * `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/byGroupId/123456`
      *
      * Note that a response of `true` does not guarantee that the group can view the page, as it does not account for
      * account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
@@ -154,7 +166,7 @@ export declare class ContentRestrictions {
      * Returns whether the specified content restriction applies to a group. For example, if a page with `id=123` has a
      * `read` restriction for the `123456` group id, the following request will return `true`:
      *
-     * `https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/byGroupId/123456`
+     * `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/byGroupId/123456`
      *
      * Note that a response of `true` does not guarantee that the group can view the page, as it does not account for
      * account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
@@ -196,7 +208,7 @@ export declare class ContentRestrictions {
      * `read` restriction for a user with an account ID of `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`, the following
      * request will return `true`:
      *
-     * `https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`
+     * `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`
      *
      * Note that a response of `true` does not guarantee that the user can view the page, as it does not account for
      * account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
@@ -210,7 +222,7 @@ export declare class ContentRestrictions {
      * `read` restriction for a user with an account ID of `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`, the following
      * request will return `true`:
      *
-     * `https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`
+     * `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`
      *
      * Note that a response of `true` does not guarantee that the user can view the page, as it does not account for
      * account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence

package/dist/esm/types/api/contentStates.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 ContentStates {
     private client;
     constructor(client: Client);
@@ -94,27 +94,45 @@ export declare class ContentStates {
     /**
      * Get content states that are suggested in the space.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Space view permission
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
      */
     getSpaceContentStates<T = Models.ContentState[]>(parameters: Parameters.GetSpaceContentStates, callback: Callback<T>): Promise<void>;
     /**
      * Get content states that are suggested in the space.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Space view permission
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
      */
     getSpaceContentStates<T = Models.ContentState[]>(parameters: Parameters.GetSpaceContentStates, callback?: never): Promise<T>;
     /**
      * Get object describing whether content states are allowed at all, if custom content states or space content states
      * are restricted, and a list of space content states allowed for the space if they are not restricted.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Space admin permission
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      */
     getContentStateSettings<T = Models.ContentStateSettings>(parameters: Parameters.GetContentStateSettings, callback: Callback<T>): Promise<void>;
     /**
      * Get object describing whether content states are allowed at all, if custom content states or space content states
      * are restricted, and a list of space content states allowed for the space if they are not restricted.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Space admin permission
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      */
     getContentStateSettings<T = Models.ContentStateSettings>(parameters: Parameters.GetContentStateSettings, callback?: never): Promise<T>;
+    /**
+     * Returns all content that has the provided content state in a space.
+     *
+     * 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.
+     */
+    getContentsWithState<T = Models.ContentArray>(parameters: Parameters.GetContentsWithState, callback: Callback<T>): Promise<void>;
+    /**
+     * Returns all content that has the provided content state in a space.
+     *
+     * 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.
+     */
+    getContentsWithState<T = Models.ContentArray>(parameters: Parameters.GetContentsWithState, callback?: never): Promise<T>;
 }

package/dist/esm/types/api/contentVersions.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 ContentVersions {
     private client;
     constructor(client: Client);
@@ -10,6 +10,8 @@ export declare class ContentVersions {
      *
      * **[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 Will be removed in next major version.
      */
     getContentVersions<T = Models.VersionArray>(parameters: Parameters.GetContentVersions, callback: Callback<T>): Promise<void>;
     /**
@@ -17,6 +19,8 @@ export declare class ContentVersions {
      *
      * **[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 Will be removed in next major version.
      */
     getContentVersions<T = Models.VersionArray>(parameters: Parameters.GetContentVersions, callback?: never): Promise<T>;
     /**
@@ -38,6 +42,8 @@ export declare class ContentVersions {
      *
      * **[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 Will be removed in next major version.
      */
     getContentVersion<T = Models.Version>(parameters: Parameters.GetContentVersion, callback: Callback<T>): Promise<void>;
     /**
@@ -45,6 +51,8 @@ export declare class ContentVersions {
      *
      * **[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 Will be removed in next major version.
      */
     getContentVersion<T = Models.Version>(parameters: Parameters.GetContentVersion, callback?: never): Promise<T>;
     /**

package/dist/esm/types/api/contentWatches.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 ContentWatches {
     private client;
     constructor(client: Client);

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

@@ -1,6 +1,6 @@
 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 DynamicModules {
     private client;
     constructor(client: Client);

package/dist/esm/types/api/experimental.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 Experimental {
     private client;
     constructor(client: Client);
@@ -76,6 +76,8 @@ export declare class Experimental {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.getUserProperties` instead.
      */
     getUserProperties<T = Models.UserPropertyKeyArray>(parameters: Parameters.GetUserProperties, callback: Callback<T>): Promise<void>;
     /**
@@ -85,6 +87,8 @@ export declare class Experimental {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.getUserProperties` instead.
      */
     getUserProperties<T = Models.UserPropertyKeyArray>(parameters: Parameters.GetUserProperties, callback?: never): Promise<T>;
     /**
@@ -94,6 +98,8 @@ export declare class Experimental {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.getUserProperty` instead.
      */
     getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback: Callback<T>): Promise<void>;
     /**
@@ -103,6 +109,8 @@ export declare class Experimental {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.getUserProperty` instead.
      */
     getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback?: never): Promise<T>;
     /**
@@ -113,6 +121,8 @@ export declare class Experimental {
      * `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
      * fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
      * the Confluence site ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.createUserProperty` instead.
      */
     createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback: Callback<T>): Promise<void>;
     /**
@@ -123,6 +133,8 @@ export declare class Experimental {
      * `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
      * fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
      * the Confluence site ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.createUserProperty` instead.
      */
     createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback?: never): Promise<T>;
     /**
@@ -133,6 +145,8 @@ export declare class Experimental {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.updateUserProperty` instead.
      */
     updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback: Callback<T>): Promise<void>;
     /**
@@ -143,6 +157,8 @@ export declare class Experimental {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.updateUserProperty` instead.
      */
     updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback?: never): Promise<T>;
     /**
@@ -152,6 +168,8 @@ export declare class Experimental {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.deleteUserProperty` instead.
      */
     deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback: Callback<T>): Promise<void>;
     /**
@@ -161,6 +179,8 @@ export declare class Experimental {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
+     *
+     * @deprecated Will be removed in next major version. Use `userProperties.deleteUserProperty` instead.
      */
     deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback?: never): Promise<T>;
 }