confluence.js 2.0.0 → 2.1.0

package/src/api/contentProperties.ts

@@ -4,6 +4,7 @@ import type { Callback } from '../callback';
 import type { Client } from '../clients';
 import type { RequestConfig } from '../requestConfig';
 
+/** @deprecated Will be removed in next major version. */
 export class ContentProperties {
   constructor(private client: Client) {}
 
@@ -13,6 +14,8 @@ export 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.
    */
   async getContentProperties<T = Models.ContentPropertyArray>(
     parameters: Parameters.GetContentProperties,
@@ -24,6 +27,8 @@ export 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.
    */
   async getContentProperties<T = Models.ContentPropertyArray>(
     parameters: Parameters.GetContentProperties,
@@ -58,6 +63,8 @@ export 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.
    */
   async createContentProperty<T = Models.ContentProperty>(
     parameters: Parameters.CreateContentProperty,
@@ -74,6 +81,8 @@ export 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.
    */
   async createContentProperty<T = Models.ContentProperty>(
     parameters: Parameters.CreateContentProperty,
@@ -101,6 +110,8 @@ export 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.
    */
   async getContentProperty<T = Models.ContentProperty>(
     parameters: Parameters.GetContentProperty,
@@ -112,6 +123,8 @@ export 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.
    */
   async getContentProperty<T = Models.ContentProperty>(
     parameters: Parameters.GetContentProperty,
@@ -144,6 +157,8 @@ export 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.
    */
   async createContentPropertyForKey<T = Models.ContentProperty>(
     parameters: Parameters.CreateContentPropertyForKey,
@@ -160,6 +175,8 @@ export 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.
    */
   async createContentPropertyForKey<T = Models.ContentProperty>(
     parameters: Parameters.CreateContentPropertyForKey,
@@ -186,6 +203,8 @@ export 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.
    */
   async updateContentProperty<T = Models.ContentProperty>(
     parameters: Parameters.UpdateContentProperty,
@@ -197,6 +216,8 @@ export 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.
    */
   async updateContentProperty<T = Models.ContentProperty>(
     parameters: Parameters.UpdateContentProperty,
@@ -223,6 +244,8 @@ export 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.
    */
   async deleteContentProperty<T = void>(
     parameters: Parameters.DeleteContentProperty,
@@ -233,6 +256,8 @@ export 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.
    */
   async deleteContentProperty<T = void>(parameters: Parameters.DeleteContentProperty, callback?: never): Promise<T>;
   async deleteContentProperty<T = void>(

package/src/api/contentRestrictions.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class ContentRestrictions {
@@ -221,13 +221,15 @@ export 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.
    */
   async getContentRestrictionStatusForGroup<T = unknown>(
     parameters: Parameters.GetContentRestrictionStatusForGroup,
@@ -237,13 +239,15 @@ export 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.
    */
   async getContentRestrictionStatusForGroup<T = unknown>(
     parameters: Parameters.GetContentRestrictionStatusForGroup,
@@ -266,6 +270,8 @@ export class ContentRestrictions {
    * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async addGroupToContentRestriction<T = unknown>(
     parameters: Parameters.AddGroupToContentRestriction,
@@ -276,6 +282,8 @@ export class ContentRestrictions {
    * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async addGroupToContentRestriction<T = unknown>(
     parameters: Parameters.AddGroupToContentRestriction,
@@ -298,6 +306,8 @@ export class ContentRestrictions {
    * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async removeGroupByName<T = unknown>(parameters: Parameters.RemoveGroupByName, callback: Callback<T>): Promise<void>;
   /**
@@ -305,6 +315,8 @@ export class ContentRestrictions {
    * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async removeGroupByName<T = unknown>(parameters: Parameters.RemoveGroupByName, callback?: never): Promise<T>;
   async removeGroupByName<T = unknown>(
@@ -323,7 +335,7 @@ export 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
@@ -339,7 +351,7 @@ export 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
@@ -426,7 +438,7 @@ export 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
@@ -443,7 +455,7 @@ export 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/src/api/contentStates.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class ContentStates {
@@ -191,7 +191,7 @@ export 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.
    */
   async getSpaceContentStates<T = Models.ContentState[]>(
     parameters: Parameters.GetSpaceContentStates,
@@ -200,7 +200,7 @@ export 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.
    */
   async getSpaceContentStates<T = Models.ContentState[]>(
     parameters: Parameters.GetSpaceContentStates,
@@ -222,7 +222,7 @@ export class ContentStates {
    * 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.
    */
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,
@@ -232,7 +232,7 @@ export class ContentStates {
    * 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.
    */
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,
@@ -249,4 +249,46 @@ export class ContentStates {
 
     return this.client.sendRequest(config, callback);
   }
+
+  /**
+   * 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.
+   */
+  async 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.
+   */
+  async getContentsWithState<T = Models.ContentArray>(
+    parameters: Parameters.GetContentsWithState,
+    callback?: never,
+  ): Promise<T>;
+  async getContentsWithState<T = Models.ContentArray>(
+    parameters: Parameters.GetContentsWithState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/state/content`,
+      method: 'GET',
+      params: {
+        'state-id': parameters.stateId,
+        expand: parameters.expand,
+        limit: parameters.limit,
+        start: parameters.start,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
 }

package/src/api/contentVersions.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class ContentVersions {
@@ -12,6 +12,8 @@ export 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.
    */
   async getContentVersions<T = Models.VersionArray>(
     parameters: Parameters.GetContentVersions,
@@ -22,6 +24,8 @@ export 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.
    */
   async getContentVersions<T = Models.VersionArray>(
     parameters: Parameters.GetContentVersions,
@@ -88,6 +92,8 @@ export 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.
    */
   async getContentVersion<T = Models.Version>(
     parameters: Parameters.GetContentVersion,
@@ -98,6 +104,8 @@ export 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.
    */
   async getContentVersion<T = Models.Version>(parameters: Parameters.GetContentVersion, callback?: never): Promise<T>;
   async getContentVersion<T = Models.Version>(

package/src/api/contentWatches.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class ContentWatches {

package/src/api/dynamicModules.ts

@@ -1,6 +1,6 @@
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class DynamicModules {

package/src/api/experimental.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class Experimental {
@@ -150,6 +150,8 @@ export 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.
    */
   async getUserProperties<T = Models.UserPropertyKeyArray>(
     parameters: Parameters.GetUserProperties,
@@ -162,6 +164,8 @@ export 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.
    */
   async getUserProperties<T = Models.UserPropertyKeyArray>(
     parameters: Parameters.GetUserProperties,
@@ -190,6 +194,8 @@ export 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.
    */
   async getUserProperty<T = Models.UserProperty>(
     parameters: Parameters.GetUserProperty,
@@ -202,6 +208,8 @@ export 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.
    */
   async getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback?: never): Promise<T>;
   async getUserProperty<T = Models.UserProperty>(
@@ -224,6 +232,8 @@ export 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.
    */
   async createUserProperty<T = unknown>(
     parameters: Parameters.CreateUserProperty,
@@ -237,6 +247,8 @@ export 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.
    */
   async createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback?: never): Promise<T>;
   async createUserProperty<T = unknown>(
@@ -262,6 +274,8 @@ export 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.
    */
   async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback: Callback<T>): Promise<void>;
   /**
@@ -272,6 +286,8 @@ export 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.
    */
   async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback?: never): Promise<T>;
   async updateUserProperty<T = void>(
@@ -296,6 +312,8 @@ export 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.
    */
   async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback: Callback<T>): Promise<void>;
   /**
@@ -305,6 +323,8 @@ export 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.
    */
   async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback?: never): Promise<T>;
   async deleteUserProperty<T = void>(