confluence.js 1.5.1 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "confluence.js",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "confluence.js is a powerful Node.JS/Browser module that allows you to interact with the Confluence API very easily",
   "author": "Vladislav Tupikin <mrrefactoring@yandex.ru>",
   "license": "MIT",
@@ -46,21 +46,21 @@
     "@types/express": "^4.17.13",
     "@types/oauth": "^0.9.1",
     "@types/sinon": "^10.0.13",
-    "@typescript-eslint/eslint-plugin": "^5.32.0",
-    "@typescript-eslint/parser": "^5.32.0",
-    "ava": "^4.3.1",
-    "dotenv": "^16.0.1",
-    "eslint": "^8.21.0",
+    "@typescript-eslint/eslint-plugin": "^5.36.2",
+    "@typescript-eslint/parser": "^5.36.2",
+    "ava": "^4.3.3",
+    "dotenv": "^16.0.2",
+    "eslint": "^8.23.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-import-resolver-typescript": "^3.4.0",
+    "eslint-import-resolver-typescript": "^3.5.1",
     "eslint-plugin-import": "^2.26.0",
     "prettier": "^2.7.1",
-    "prettier-plugin-jsdoc": "^0.3.38",
+    "prettier-plugin-jsdoc": "^0.4.2",
     "sinon": "^14.0.0",
-    "typedoc": "^0.23.10",
+    "typedoc": "^0.23.14",
     "typedoc-plugin-extras": "^2.3.0",
-    "typescript": "^4.7.4"
+    "typescript": "^4.8.3"
   },
   "dependencies": {
     "atlassian-jwt": "^2.0.2",

package/src/api/audit.ts

@@ -12,7 +12,8 @@ export class Audit {
    * like space exports, group membership changes, app installations, etc. For more information, see [Audit
    * log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) in the Confluence administrator's guide.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async getAuditRecords<T = Models.AuditRecordArray>(
     parameters: Parameters.GetAuditRecords | undefined,
@@ -23,7 +24,8 @@ export class Audit {
    * like space exports, group membership changes, app installations, etc. For more information, see [Audit
    * log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) in the Confluence administrator's guide.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async getAuditRecords<T = Models.AuditRecordArray>(
     parameters?: Parameters.GetAuditRecords,
@@ -51,7 +53,8 @@ export class Audit {
   /**
    * Creates a record in the audit log.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async createAuditRecord<T = Models.AuditRecord>(
     parameters: Parameters.CreateAuditRecord | undefined,
@@ -60,7 +63,8 @@ export class Audit {
   /**
    * Creates a record in the audit log.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async createAuditRecord<T = Models.AuditRecord>(
     parameters?: Parameters.CreateAuditRecord,
@@ -93,7 +97,8 @@ export class Audit {
   /**
    * Exports audit records as a CSV file or ZIP file.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async exportAuditRecords<T = unknown>(
     parameters: Parameters.ExportAuditRecords | undefined,
@@ -102,7 +107,8 @@ export class Audit {
   /**
    * Exports audit records as a CSV file or ZIP file.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async exportAuditRecords<T = unknown>(parameters?: Parameters.ExportAuditRecords, callback?: never): Promise<T>;
   async exportAuditRecords<T = unknown>(
@@ -127,14 +133,16 @@ export class Audit {
    * Returns the retention period for records in the audit log. The retention period is how long an audit record is kept
    * for, from creation date until it is deleted.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async getRetentionPeriod<T = Models.RetentionPeriod>(callback: Callback<T>): Promise<void>;
   /**
    * Returns the retention period for records in the audit log. The retention period is how long an audit record is kept
    * for, from creation date until it is deleted.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async getRetentionPeriod<T = Models.RetentionPeriod>(callback?: never): Promise<T>;
   async getRetentionPeriod<T = Models.RetentionPeriod>(callback?: Callback<T>): Promise<void | T> {
@@ -149,7 +157,8 @@ export class Audit {
   /**
    * Sets the retention period for records in the audit log. The retention period can be set to a maximum of 20 years.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async setRetentionPeriod<T = Models.RetentionPeriod>(
     parameters: Parameters.SetRetentionPeriod | undefined,
@@ -158,7 +167,8 @@ export class Audit {
   /**
    * Sets the retention period for records in the audit log. The retention period can be set to a maximum of 20 years.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async setRetentionPeriod<T = Models.RetentionPeriod>(
     parameters?: Parameters.SetRetentionPeriod,
@@ -188,7 +198,8 @@ export class Audit {
    * more information, see [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) in the
    * Confluence administrator's guide.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async getAuditRecordsForTimePeriod<T = Models.AuditRecordArray>(
     parameters: Parameters.GetAuditRecordsForTimePeriod | undefined,
@@ -202,7 +213,8 @@ export class Audit {
    * more information, see [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) in the
    * Confluence administrator's guide.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global
+   * permission.
    */
   async getAuditRecordsForTimePeriod<T = Models.AuditRecordArray>(
     parameters?: Parameters.GetAuditRecordsForTimePeriod,

package/src/api/content.ts

@@ -113,10 +113,7 @@ export class Content {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Archive' permission for each of the pages
    * in the corresponding space it belongs to.
    */
-  async archivePages<T = Models.LongTask>(
-    parameters: Parameters.ArchivePages,
-    callback: Callback<T>
-  ): Promise<void>;
+  async archivePages<T = Models.LongTask>(parameters: Parameters.ArchivePages, callback: Callback<T>): Promise<void>;
   /**
    * Archives a list of pages. The pages to be archived are specified as a list of content IDs. This API accepts the
    * archival request and returns a task ID. The archival process happens asynchronously. Use the /longtask/<taskId>
@@ -129,7 +126,10 @@ export class Content {
    * in the corresponding space it belongs to.
    */
   async archivePages<T = Models.LongTask>(parameters: Parameters.ArchivePages, callback?: never): Promise<T>;
-  async archivePages<T = Models.LongTask>(parameters: Parameters.ArchivePages, callback?: Callback<T>): Promise<void | T> {
+  async archivePages<T = Models.LongTask>(
+    parameters: Parameters.ArchivePages,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
     const config: RequestConfig = {
       url: '/api/content/archive',
       method: 'POST',
@@ -143,7 +143,8 @@ export class Content {
 
   /**
    * Publishes a legacy draft of a page created from a blueprint. Legacy drafts will eventually be removed in favor of
-   * shared drafts. For now, this method works the same as [Publish shared draft](#api-content-blueprint-instance-draftId-put).
+   * shared drafts. For now, this method works the same as [Publish shared
+   * draft](#api-content-blueprint-instance-draftId-put).
    *
    * By default, the following objects are expanded: `body.storage`, `history`, `space`, `version`, `ancestors`.
    *
@@ -156,7 +157,8 @@ export class Content {
   ): Promise<void>;
   /**
    * Publishes a legacy draft of a page created from a blueprint. Legacy drafts will eventually be removed in favor of
-   * shared drafts. For now, this method works the same as [Publish shared draft](#api-content-blueprint-instance-draftId-put).
+   * shared drafts. For now, this method works the same as [Publish shared
+   * draft](#api-content-blueprint-instance-draftId-put).
    *
    * By default, the following objects are expanded: `body.storage`, `history`, `space`, `version`, `ancestors`.
    *
@@ -240,9 +242,9 @@ export class Content {
    * When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The
    * URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of
    * results returned in each call. Example subsequent call (taken from example response):
-   * ```
-   * https://your-domain.atlassian.net/wiki/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
-   * ```
+   *
+   *     https://your-domain.atlassian.net/wiki/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
+   *
    * The response to this will have a `prev` URL similar to the `next` in the example response.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
@@ -259,9 +261,9 @@ export class Content {
    * When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The
    * URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of
    * results returned in each call. Example subsequent call (taken from example response):
-   * ```
-   * https://your-domain.atlassian.net/wiki/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
-   * ```
+   *
+   *     https://your-domain.atlassian.net/wiki/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
+   *
    * The response to this will have a `prev` URL similar to the `next` in the example response.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
@@ -369,11 +371,13 @@ export class Content {
   }
 
   /**
-   * Moves a piece of content to the space's trash or purges it from the trash, depending on the content's type and status:
+   * Moves a piece of content to the space's trash or purges it from the trash, depending on the content's type and
+   * status:
    *
    * - If the content's type is `page` or `blogpost` and its status is `current`, it will be trashed.
    * - If the content's type is `page` or `blogpost` and its status is `trashed`, the content will be purged from the
-   *   trash and deleted permanently. Note, you must also set the `status` query parameter to `trashed` in your request.
+   *   trash and deleted permanently. Note, you must also set the `status` query parameter to `trashed` in your
+   *   request.
    * - If the content's type is `comment` or `attachment`, it will be deleted permanently without being trashed.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the
@@ -381,11 +385,13 @@ export class Content {
    */
   async deleteContent<T = void>(parameters: Parameters.DeleteContent, callback: Callback<T>): Promise<void>;
   /**
-   * Moves a piece of content to the space's trash or purges it from the trash, depending on the content's type and status:
+   * Moves a piece of content to the space's trash or purges it from the trash, depending on the content's type and
+   * status:
    *
    * - If the content's type is `page` or `blogpost` and its status is `current`, it will be trashed.
    * - If the content's type is `page` or `blogpost` and its status is `trashed`, the content will be purged from the
-   *   trash and deleted permanently. Note, you must also set the `status` query parameter to `trashed` in your request.
+   *   trash and deleted permanently. Note, you must also set the `status` query parameter to `trashed` in your
+   *   request.
    * - If the content's type is `comment` or `attachment`, it will be deleted permanently without being trashed.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the

package/src/api/contentAttachments.ts

@@ -28,7 +28,10 @@ export class ContentAttachments {
    * **[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.
    */
-  async getAttachments<T = Models.ContentArray<Models.Attachment>>(parameters: Parameters.GetAttachments, callback?: never): Promise<T>;
+  async getAttachments<T = Models.ContentArray<Models.Attachment>>(
+    parameters: Parameters.GetAttachments,
+    callback?: never
+  ): Promise<T>;
   async getAttachments<T = Models.ContentArray<Models.Attachment>>(
     parameters: Parameters.GetAttachments,
     callback?: Callback<T>,
@@ -50,7 +53,8 @@ export class ContentAttachments {
 
   /**
    * Adds an attachment to a piece of content. This method only adds a new attachment. If you want to update an existing
-   * attachment, use [Create or update attachments](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-wiki-rest-api-content-id-child-attachment-put).
+   * attachment, use [Create or update
+   * attachments](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-wiki-rest-api-content-id-child-attachment-put).
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
    */
@@ -60,7 +64,8 @@ export class ContentAttachments {
   ): Promise<void>;
   /**
    * Adds an attachment to a piece of content. This method only adds a new attachment. If you want to update an existing
-   * attachment, use [Create or update attachments](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-wiki-rest-api-content-id-child-attachment-put).
+   * attachment, use [Create or update
+   * attachments](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-wiki-rest-api-content-id-child-attachment-put).
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
    */
@@ -194,10 +199,12 @@ export class ContentAttachments {
   }
 
   /**
-   * Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit field.
+   * Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit
+   * field.
    *
-   * This method is essentially the same as [Create or update attachments](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-wiki-rest-api-content-id-child-attachment-put), except
-   * that it matches the attachment ID rather than the name.
+   * This method is essentially the same as [Create or update
+   * attachments](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-wiki-rest-api-content-id-child-attachment-put),
+   * except that it matches the attachment ID rather than the name.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
    */
@@ -206,10 +213,12 @@ export class ContentAttachments {
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit field.
+   * Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit
+   * field.
    *
-   * This method is essentially the same as [Create or update attachments](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-wiki-rest-api-content-id-child-attachment-put), except
-   * that it matches the attachment ID rather than the name.
+   * This method is essentially the same as [Create or update
+   * attachments](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-wiki-rest-api-content-id-child-attachment-put),
+   * except that it matches the attachment ID rather than the name.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
    */
@@ -250,10 +259,7 @@ export class ContentAttachments {
   }
 
   /** Redirects the client to a URL that serves an attachment's binary data. */
-  async downloadAttachment<T = Buffer>(
-    parameters: Parameters.DownloadAttachment,
-    callback: Callback<T>
-  ): Promise<void>;
+  async downloadAttachment<T = Buffer>(parameters: Parameters.DownloadAttachment, callback: Callback<T>): Promise<void>;
   /** Redirects the client to a URL that serves an attachment's binary data. */
   async downloadAttachment<T = Buffer>(parameters: Parameters.DownloadAttachment, callback?: never): Promise<T>;
   async downloadAttachment<T = Buffer>(

package/src/api/contentBody.ts

@@ -54,13 +54,115 @@ export class ContentBody {
         spaceKeyContext: parameters.spaceKeyContext,
         contentIdContext: parameters.contentIdContext,
         embeddedContentRender: parameters.embeddedContentRender,
+        expand: parameters.expand,
       },
       data: {
         value: parameters.value,
         representation: parameters.representation,
+        ...parameters.additionalProperties,
       },
     };
 
     return this.client.sendRequest(config, callback);
   }
+
+  /**
+   * Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous
+   * task.
+   *
+   * Supported conversions:
+   *
+   * - Storage: export_view
+   *
+   * No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5
+   * minutes at the result endpoint.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext',
+   * 'View' permission for the space, and permission to view the content.
+   */
+  async asyncConvertContentBodyRequest<T = Models.AsyncId>(
+    parameters: Parameters.AsyncConvertContentBodyRequest,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous
+   * task.
+   *
+   * Supported conversions:
+   *
+   * - Storage: export_view
+   *
+   * No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5
+   * minutes at the result endpoint.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext',
+   * 'View' permission for the space, and permission to view the content.
+   */
+  async asyncConvertContentBodyRequest<T = Models.AsyncId>(
+    parameters: Parameters.AsyncConvertContentBodyRequest,
+    callback?: never
+  ): Promise<T>;
+  async asyncConvertContentBodyRequest<T = Models.AsyncId>(
+    parameters: Parameters.AsyncConvertContentBodyRequest,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/contentbody/convert/async/${parameters.to}`,
+      method: 'POST',
+      params: {
+        spaceKeyContext: parameters.spaceKeyContext,
+        contentIdContext: parameters.contentIdContext,
+        allowCache: parameters.allowCache,
+        embeddedContentRender: parameters.embeddedContentRender,
+        expand: parameters.expand,
+      },
+      data: {
+        value: parameters.value,
+        representation: parameters.representation,
+        ...parameters.additionalProperties,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Returns the Asynchronous Content Body for the corresponding asyncId if the task is complete or returns the status
+   * of the task.
+   *
+   * After the task is completed, the result can be obtained for 5 minutes, or until an identical conversion request is
+   * made again, with allowCache query param set to false.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext',
+   * 'View' permission for the space, and permission to view the content.
+   */
+  async 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.
+   *
+   * After the task is completed, the result can be obtained for 5 minutes, or until an identical conversion request is
+   * made again, with allowCache query param set to false.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext',
+   * 'View' permission for the space, and permission to view the content.
+   */
+  async asyncConvertContentBodyResponse<T = Models.AsyncContentBody>(
+    parameters: Parameters.AsyncConvertContentBodyResponse,
+    callback?: never
+  ): Promise<T>;
+  async asyncConvertContentBodyResponse<T = Models.AsyncContentBody>(
+    parameters: Parameters.AsyncConvertContentBodyResponse,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/contentbody/convert/async/${parameters.id}`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
 }

package/src/api/contentChildrenAndDescendants.ts

@@ -92,8 +92,10 @@ export class ContentChildrenAndDescendants {
    */
   async movePage<T = Models.MovePage>(parameters: Parameters.MovePage, callback?: never): Promise<T>;
   async movePage<T = Models.MovePage>(parameters: Parameters.MovePage, callback?: Callback<T>): Promise<void | T> {
+    const pageId = parameters.pageId || parameters.id;
+
     const config: RequestConfig = {
-      url: `/api/content/${parameters.id}/move/${parameters.position}/${parameters.targetId}`,
+      url: `/api/content/${pageId}/move/${parameters.position}/${parameters.targetId}`,
       method: 'PUT',
     };
 

package/src/api/contentContentState.ts

@@ -4,20 +4,22 @@ import { Callback } from '../callback';
 import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
+/** @deprecated Use {@link ContentStates} instead. */
 export class ContentContentState {
+  /** @deprecated */
   constructor(private client: Client) {}
 
   /**
-   * Gets the current page status of the draft or published version of content. To specify the draft version, set the
-   * parameter status to PUBLISHED, otherwise DRAFT.
+   * @deprecated Gets the current page status of the draft or published version of content. To specify the draft
+   *   version, set the parameter status to PUBLISHED, otherwise DRAFT.
    */
   async getContentState<T = Models.ContentStateContainer>(
     parameters: Parameters.GetContentState,
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Gets the current page status of the draft or published version of content. To specify the draft version, set the
-   * parameter status to PUBLISHED, otherwise DRAFT.
+   * @deprecated Gets the current page status of the draft or published version of content. To specify the draft
+   *   version, set the parameter status to PUBLISHED, otherwise DRAFT.
    */
   async getContentState<T = Models.ContentStateContainer>(
     parameters: Parameters.GetContentState,
@@ -39,28 +41,28 @@ export class ContentContentState {
   }
 
   /**
-   * Sets the content state of the content specified and creates a new version (publishes the content without changing
-   * the body) of the content with the new status. The desired type of status must be allowed. There are space suggested
-   * statuses and custom statuses. To specify the desired new status, one can use the id of the status or the name and
-   * color of the status. If contentStateId is defined, then name and color are ignored. If contentStateId is not
-   * defined, name and color will be used if provided. Firstly, we will determine if a status of this name and color
-   * exists, and if it does, that this status is used. If it does not exist, and custom statuses are allowed, a custom
-   * status with this name and color will be created. Color can be specified in traditional english colors (teal,
-   * magenta, lavender, etc.) or as a hex string ex: #0ff0Fd.
+   * @deprecated Sets the content state of the content specified and creates a new version (publishes the content
+   *   without changing the body) of the content with the new status. The desired type of status must be allowed. There
+   *   are space suggested statuses and custom statuses. To specify the desired new status, one can use the id of the
+   *   status or the name and color of the status. If contentStateId is defined, then name and color are ignored. If
+   *   contentStateId is not defined, name and color will be used if provided. Firstly, we will determine if a status of
+   *   this name and color exists, and if it does, that this status is used. If it does not exist, and custom statuses
+   *   are allowed, a custom status with this name and color will be created. Color can be specified in traditional
+   *   english colors (teal, magenta, lavender, etc.) or as a hex string ex: #0ff0Fd.
    */
   async setContentState<T = Models.ContentStateContainer>(
     parameters: Parameters.SetContentState,
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Sets the content state of the content specified and creates a new version (publishes the content without changing
-   * the body) of the content with the new status. The desired type of status must be allowed. There are space suggested
-   * statuses and custom statuses. To specify the desired new status, one can use the id of the status or the name and
-   * color of the status. If contentStateId is defined, then name and color are ignored. If contentStateId is not
-   * defined, name and color will be used if provided. Firstly, we will determine if a status of this name and color
-   * exists, and if it does, that this status is used. If it does not exist, and custom statuses are allowed, a custom
-   * status with this name and color will be created. Color can be specified in traditional english colors (teal,
-   * magenta, lavender, etc.) or as a hex string ex: #0ff0Fd.
+   * @deprecated Sets the content state of the content specified and creates a new version (publishes the content
+   *   without changing the body) of the content with the new status. The desired type of status must be allowed. There
+   *   are space suggested statuses and custom statuses. To specify the desired new status, one can use the id of the
+   *   status or the name and color of the status. If contentStateId is defined, then name and color are ignored. If
+   *   contentStateId is not defined, name and color will be used if provided. Firstly, we will determine if a status of
+   *   this name and color exists, and if it does, that this status is used. If it does not exist, and custom statuses
+   *   are allowed, a custom status with this name and color will be created. Color can be specified in traditional
+   *   english colors (teal, magenta, lavender, etc.) or as a hex string ex: #0ff0Fd.
    */
   async setContentState<T = Models.ContentStateContainer>(
     parameters: Parameters.SetContentState,
@@ -84,16 +86,16 @@ export class ContentContentState {
   }
 
   /**
-   * Removes the content state of the content specified and creates a new version (publishes the content without
-   * changing the body) of the content with the new status.
+   * @deprecated Removes the content state of the content specified and creates a new version (publishes the content
+   *   without changing the body) of the content with the new status.
    */
   async removeContentState<T = Models.ContentStateContainer>(
     parameters: Parameters.RemoveContentState,
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Removes the content state of the content specified and creates a new version (publishes the content without
-   * changing the body) of the content with the new status.
+   * @deprecated Removes the content state of the content specified and creates a new version (publishes the content
+   *   without changing the body) of the content with the new status.
    */
   async removeContentState<T = Models.ContentStateContainer>(
     parameters: Parameters.RemoveContentState,
@@ -111,12 +113,12 @@ export class ContentContentState {
     return this.client.sendRequest(config, callback);
   }
 
-  /** Gets a Global Timestamp of the last time the content state was updated */
+  /** @deprecated Gets a Global Timestamp of the last time the content state was updated */
   async getContentStateLastUpdated<T = unknown>(
     parameters: Parameters.GetContentStateLastUpdated,
     callback: Callback<T>
   ): Promise<void>;
-  /** Gets a Global Timestamp of the last time the content state was updated */
+  /** @deprecated Gets a Global Timestamp of the last time the content state was updated */
   async getContentStateLastUpdated<T = unknown>(
     parameters: Parameters.GetContentStateLastUpdated,
     callback?: never
@@ -133,12 +135,12 @@ export class ContentContentState {
     return this.client.sendRequest(config, callback);
   }
 
-  /** Gets content states that are available for the content to be set as. */
+  /** @deprecated Gets content states that are available for the content to be set as. */
   async getAvailableContentStates<T = Models.AvailableContentStates>(
     parameters: Parameters.GetAvailableContentStates,
     callback: Callback<T>
   ): Promise<void>;
-  /** Gets content states that are available for the content to be set as. */
+  /** @deprecated Gets content states that are available for the content to be set as. */
   async getAvailableContentStates<T = Models.AvailableContentStates>(
     parameters: Parameters.GetAvailableContentStates,
     callback?: never