confluence.js 1.5.1 → 1.6.0

package/src/api/contentMacroBody.ts

@@ -20,7 +20,8 @@ export class ContentMacroBody {
    * macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and
    * transparently propagate out to all instances.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the macro is in.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
+   * macro is in.
    */
   async getMacroBodyByMacroId<T = Models.MacroInstance>(
     parameters: Parameters.GetMacroBodyByMacroId,
@@ -39,7 +40,8 @@ export class ContentMacroBody {
    * macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and
    * transparently propagate out to all instances.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the macro is in.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
+   * macro is in.
    */
   async getMacroBodyByMacroId<T = Models.MacroInstance>(
     parameters: Parameters.GetMacroBodyByMacroId,
@@ -56,4 +58,119 @@ export class ContentMacroBody {
 
     return this.client.sendRequest(config, callback);
   }
+
+  /**
+   * Returns the body of a macro in format specified in path, for the given macro ID. This includes information like the
+   * name of the macro, the body of the macro, and any macro parameters.
+   *
+   * About the macro ID: When a macro is created in a new version of content, Confluence will generate a random ID for
+   * it, unless an ID is specified (by an app). The macro ID will look similar to this:
+   * '50884bd9-0cb8-41d5-98be-f80943c14f96'. The ID is then persisted as new versions of content are created, and is
+   * only modified by Confluence if there are conflicting IDs.
+   *
+   * Note, to preserve backwards compatibility this resource will also match on the hash of the macro body, even if a
+   * macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and
+   * transparently propagate out to all instances.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
+   * macro is in.
+   */
+  async getAndConvertMacroBodyByMacroId<T = Models.ContentBody>(
+    parameters: Parameters.GetAndConvertMacroBodyByMacroId,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns the body of a macro in format specified in path, for the given macro ID. This includes information like the
+   * name of the macro, the body of the macro, and any macro parameters.
+   *
+   * About the macro ID: When a macro is created in a new version of content, Confluence will generate a random ID for
+   * it, unless an ID is specified (by an app). The macro ID will look similar to this:
+   * '50884bd9-0cb8-41d5-98be-f80943c14f96'. The ID is then persisted as new versions of content are created, and is
+   * only modified by Confluence if there are conflicting IDs.
+   *
+   * Note, to preserve backwards compatibility this resource will also match on the hash of the macro body, even if a
+   * macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and
+   * transparently propagate out to all instances.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
+   * macro is in.
+   */
+  async getAndConvertMacroBodyByMacroId<T = Models.ContentBody>(
+    parameters: Parameters.GetAndConvertMacroBodyByMacroId,
+    callback?: never
+  ): Promise<T>;
+  async getAndConvertMacroBodyByMacroId<T = Models.ContentBody>(
+    parameters: Parameters.GetAndConvertMacroBodyByMacroId,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.id}/history/${parameters.version}/macro/id/${parameters.macroId}/convert/${parameters.to}`,
+      method: 'GET',
+      params: {
+        spaceKeyContext: parameters.spaceKeyContext,
+        embeddedContentRender: parameters.embeddedContentRender,
+        expand: parameters.expand,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Returns Async Id of the conversion task which will convert the macro into a content body of the desired format. The
+   * result will be available for 5 minutes after completion of the conversion.
+   *
+   * About the macro ID: When a macro is created in a new version of content, Confluence will generate a random ID for
+   * it, unless an ID is specified (by an app). The macro ID will look similar to this:
+   * '884bd9-0cb8-41d5-98be-f80943c14f96'. The ID is then persisted as new versions of content are created, and is only
+   * modified by Confluence if there are conflicting IDs.
+   *
+   * Note, to preserve backwards compatibility this resource will also match on the hash of the macro body, even if a
+   * macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and
+   * transparently propagate out to all instances.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
+   * macro is in.
+   */
+  async getAndAsyncConvertMacroBodyByMacroId<T = Models.AsyncId>(
+    parameters: Parameters.GetAndAsyncConvertMacroBodyByMacroId,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns Async Id of the conversion task which will convert the macro into a content body of the desired format. The
+   * result will be available for 5 minutes after completion of the conversion.
+   *
+   * About the macro ID: When a macro is created in a new version of content, Confluence will generate a random ID for
+   * it, unless an ID is specified (by an app). The macro ID will look similar to this:
+   * '884bd9-0cb8-41d5-98be-f80943c14f96'. The ID is then persisted as new versions of content are created, and is only
+   * modified by Confluence if there are conflicting IDs.
+   *
+   * Note, to preserve backwards compatibility this resource will also match on the hash of the macro body, even if a
+   * macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and
+   * transparently propagate out to all instances.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the
+   * macro is in.
+   */
+  async getAndAsyncConvertMacroBodyByMacroId<T = Models.AsyncId>(
+    parameters: Parameters.GetAndAsyncConvertMacroBodyByMacroId,
+    callback?: never
+  ): Promise<T>;
+  async getAndAsyncConvertMacroBodyByMacroId<T = Models.AsyncId>(
+    parameters: Parameters.GetAndAsyncConvertMacroBodyByMacroId,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.id}/history/${parameters.version}/macro/id/${parameters.macroId}/convert/async/${parameters.to}`,
+      method: 'GET',
+      params: {
+        allowCache: parameters.allowCache,
+        spaceKeyContext: parameters.spaceKeyContext,
+        embeddedContentRender: parameters.embeddedContentRender,
+        expand: parameters.expand,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
 }

package/src/api/contentRestrictions.ts

@@ -262,7 +262,8 @@ export class ContentRestrictions {
   }
 
   /**
-   * Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of content.
+   * Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of
+   * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
    */
@@ -271,7 +272,8 @@ export class ContentRestrictions {
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of content.
+   * Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of
+   * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
    */
@@ -292,13 +294,15 @@ export class ContentRestrictions {
   }
 
   /**
-   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.
+   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of
+   * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
    */
   async removeGroupByName<T = unknown>(parameters: Parameters.RemoveGroupByName, callback: Callback<T>): Promise<void>;
   /**
-   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.
+   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of
+   * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
    */
@@ -392,13 +396,15 @@ export class ContentRestrictions {
   }
 
   /**
-   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.
+   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of
+   * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
    */
   async removeGroupById<T = unknown>(parameters: Parameters.RemoveGroupById, callback: Callback<T>): Promise<void>;
   /**
-   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.
+   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of
+   * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
    */
@@ -502,7 +508,8 @@ export class ContentRestrictions {
   }
 
   /**
-   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.
+   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of
+   * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
    */
@@ -511,7 +518,8 @@ export class ContentRestrictions {
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.
+   * Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of
+   * content.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
    */

package/src/api/contentStates.ts

@@ -0,0 +1,252 @@
+import * as Models from './models';
+import * as Parameters from './parameters';
+import { Callback } from '../callback';
+import { Client } from '../clients';
+import { RequestConfig } from '../requestConfig';
+
+export class ContentStates {
+  constructor(private client: Client) {}
+
+  /**
+   * Gets the current content state of the draft or current version of content. To specify the draft version, set the
+   * parameter status to draft, otherwise archived or current will get the relevant published state.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
+   */
+  async getContentState<T = Models.ContentStateResponse>(
+    parameters: Parameters.GetContentState,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Gets the current content state of the draft or current version of content. To specify the draft version, set the
+   * parameter status to draft, otherwise archived or current will get the relevant published state.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
+   */
+  async getContentState<T = Models.ContentStateResponse>(
+    parameters: Parameters.GetContentState,
+    callback?: never
+  ): Promise<T>;
+  async getContentState<T = Models.ContentStateResponse>(
+    parameters: Parameters.GetContentState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.id}/state`,
+      method: 'GET',
+      params: {
+        status: parameters.status,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * 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 state.
+   *
+   * You may pass in either an id of a state, or the name and color of a desired new state. If all 3 are passed in, id
+   * will be used. If the name and color passed in already exist under the current user's existing custom states, the
+   * existing state will be reused. If custom states are disabled in the space of the content (which can be determined
+   * by getting the content state space settings of the content's space) then this set will fail.
+   *
+   * You may not remove a content state via this PUT request. You must use the DELETE method. A specified state is
+   * required in the body of this request.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   */
+  async setContentState<T = Models.ContentStateResponse>(
+    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 state.
+   *
+   * You may pass in either an id of a state, or the name and color of a desired new state. If all 3 are passed in, id
+   * will be used. If the name and color passed in already exist under the current user's existing custom states, the
+   * existing state will be reused. If custom states are disabled in the space of the content (which can be determined
+   * by getting the content state space settings of the content's space) then this set will fail.
+   *
+   * You may not remove a content state via this PUT request. You must use the DELETE method. A specified state is
+   * required in the body of this request.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   */
+  async setContentState<T = Models.ContentStateResponse>(
+    parameters: Parameters.SetContentState,
+    callback?: never
+  ): Promise<T>;
+  async setContentState<T = Models.ContentStateResponse>(
+    parameters: Parameters.SetContentState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.id}/state`,
+      method: 'PUT',
+      params: {
+        status: parameters.status,
+      },
+      data: {
+        name: parameters.name,
+        color: parameters.color,
+        id: parameters.stateId,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * 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.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   */
+  async removeContentState<T = Models.ContentStateResponse>(
+    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.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   */
+  async removeContentState<T = Models.ContentStateResponse>(
+    parameters: Parameters.RemoveContentState,
+    callback?: never
+  ): Promise<T>;
+  async removeContentState<T = Models.ContentStateResponse>(
+    parameters: Parameters.RemoveContentState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.id}/state`,
+      method: 'DELETE',
+      params: {
+        status: parameters.status,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Gets content states that are available for the content to be set as. Will return all enabled Space Content States.
+   * Will only return most the 3 most recently published custom content states to match UI editor list. To get all
+   * custom content states, use the /content-states endpoint.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   */
+  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. Will return all enabled Space Content States.
+   * Will only return most the 3 most recently published custom content states to match UI editor list. To get all
+   * custom content states, use the /content-states endpoint.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
+   */
+  async getAvailableContentStates<T = Models.AvailableContentStates>(
+    parameters: Parameters.GetAvailableContentStates,
+    callback?: never
+  ): Promise<T>;
+  async getAvailableContentStates<T = Models.AvailableContentStates>(
+    parameters: Parameters.GetAvailableContentStates,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.id}/state/available`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Get custom content states that authenticated user has created.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required** Must have user authentication.
+   */
+  async getCustomContentStates<T = Models.ContentState[]>(callback: Callback<T>): Promise<void>;
+  /**
+   * Get custom content states that authenticated user has created.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required** Must have user authentication.
+   */
+  async getCustomContentStates<T = Models.ContentState[]>(callback?: never): Promise<T>;
+  async getCustomContentStates<T = Models.ContentState[]>(callback?: Callback<T>): Promise<void | T> {
+    const config: RequestConfig = {
+      url: '/api/content-states',
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Get content states that are suggested in the space.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Space view permission
+   */
+  async 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
+   */
+  async getSpaceContentStates<T = Models.ContentState[]>(
+    parameters: Parameters.GetSpaceContentStates,
+    callback?: never
+  ): Promise<T>;
+  async getSpaceContentStates<T = Models.ContentState[]>(
+    parameters: Parameters.GetSpaceContentStates,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/state`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * 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
+   */
+  async 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
+   */
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback?: never
+  ): Promise<T>;
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/state/settings`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+}

package/src/api/contentWatches.ts

@@ -8,7 +8,8 @@ export class ContentWatches {
   constructor(private client: Client) {}
 
   /**
-   * Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated.
+   * Returns the watches for a page. A user that watches a page will receive receive notifications when the page is
+   * updated.
    *
    * If you want to manage watches for a page, use the following `user` methods:
    *
@@ -24,7 +25,8 @@ export class ContentWatches {
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated.
+   * Returns the watches for a page. A user that watches a page will receive receive notifications when the page is
+   * updated.
    *
    * If you want to manage watches for a page, use the following `user` methods:
    *
@@ -180,7 +182,8 @@ export class ContentWatches {
    * - Specify a user via a query parameter: Use the `accountId` to identify the user.
    * - Do not specify a user: The currently logged-in user will be used.
    *
-   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF protection.
+   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF
+   * protection.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission
    * if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
@@ -192,7 +195,8 @@ export class ContentWatches {
    * - Specify a user via a query parameter: Use the `accountId` to identify the user.
    * - Do not specify a user: The currently logged-in user will be used.
    *
-   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF protection.
+   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF
+   * protection.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission
    * if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
@@ -304,7 +308,8 @@ export class ContentWatches {
    * - Specify a user via a query parameter: Use the `accountId` to identify the user.
    * - Do not specify a user: The currently logged-in user will be used.
    *
-   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF protection.
+   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF
+   * protection.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission
    * if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
@@ -316,7 +321,8 @@ export class ContentWatches {
    * - Specify a user via a query parameter: Use the `accountId` to identify the user.
    * - Do not specify a user: The currently logged-in user will be used.
    *
-   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF protection.
+   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF
+   * protection.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission
    * if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
@@ -422,7 +428,8 @@ export class ContentWatches {
    * - Specify a user via a query parameter: Use the `accountId` to identify the user.
    * - Do not specify a user: The currently logged-in user will be used.
    *
-   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF protection.
+   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF
+   * protection.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission
    * if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
@@ -434,7 +441,8 @@ export class ContentWatches {
    * - Specify a user via a query parameter: Use the `accountId` to identify the user.
    * - Do not specify a user: The currently logged-in user will be used.
    *
-   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF protection.
+   * Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF
+   * protection.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission
    * if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

package/src/api/dynamicModules.ts

@@ -51,6 +51,7 @@ export class DynamicModules {
     const config: RequestConfig = {
       url: '/atlassian-connect/1/app/module/dynamic',
       method: 'POST',
+      data: parameters,
     };
 
     return this.client.sendRequest(config, callback);

package/src/api/experimental.ts

@@ -319,9 +319,9 @@ export class Experimental {
     return this.client.sendRequest(config, callback);
   }
 
-  /** Get the total number of distinct viewers a piece of content has. */
+  /** @deprecated Get the total number of distinct viewers a piece of content has. */
   async getViewers<T = Models.GetViewers>(parameters: Parameters.GetViewers, callback: Callback<T>): Promise<void>;
-  /** Get the total number of distinct viewers a piece of content has. */
+  /** @deprecated Get the total number of distinct viewers a piece of content has. */
   async getViewers<T = Models.GetViewers>(parameters: Parameters.GetViewers, callback?: never): Promise<T>;
   async getViewers<T = Models.GetViewers>(
     parameters: Parameters.GetViewers,

package/src/api/index.ts

@@ -11,6 +11,7 @@ export * from './contentMacroBody';
 export * from './contentPermissions';
 export * from './contentProperties';
 export * from './contentRestrictions';
+export * from './contentStates';
 export * from './contentVersions';
 export * from './contentWatches';
 export * from './dynamicModules';

package/src/api/models/asyncContentBody.ts

@@ -0,0 +1,31 @@
+import { EmbeddedContent } from './embeddedContent';
+import { GenericLinks } from './genericLinks';
+import { WebResourceDependencies } from './webResourceDependencies';
+
+export interface AsyncContentBody {
+  value?: string;
+  representation?: string;
+  renderTaskId?: string;
+  error?: string;
+  /**
+   * Rerunning is reserved for when the job is working, but there is a previous run's value in the cache. You may
+   * choose to continue polling, or use the cached value.
+   */
+  status?: string;
+  embeddedContent?: EmbeddedContent[];
+  webresource?: WebResourceDependencies;
+  mediaToken?: {
+    collectionIds?: string[];
+    contentId?: string;
+    expiryDateTime?: string;
+    fileIds?: string[];
+    token?: string;
+  };
+  Expandable?: {
+    content?: string;
+    embeddedContent?: string;
+    webresource?: string;
+    mediaToken?: string;
+  };
+  Links?: GenericLinks;
+}

package/src/api/models/asyncId.ts

@@ -0,0 +1,3 @@
+export interface AsyncId {
+  asyncId: string;
+}

package/src/api/models/contentBodyCreate.ts

@@ -4,4 +4,5 @@ export interface ContentBodyCreate {
   value: string;
   /** The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. */
   representation: string;
+  additionalProperties?: any;
 }

package/src/api/models/contentStateResponse.ts

@@ -0,0 +1,8 @@
+import { ContentState } from './contentState';
+
+export interface ContentStateResponse {
+  /** Null or content state */
+  contentState?: ContentState;
+  /** Timestamp of last publish event where content state changed */
+  lastUpdated?: string;
+}

package/src/api/models/contentStateRestInput.ts

@@ -0,0 +1,11 @@
+export interface ContentStateRestInput {
+  /** Name of content state. Maximum 20 characters. */
+  name?: string;
+  /**
+   * Color of state. Must be in 6 digit hex form (#FFFFFF). The default colors offered in the UI are: #ff7452 (red),
+   * #2684ff (blue), #ffc400 (yellow), #57d9a3 (green), and #8777d9 (purple)
+   */
+  color?: string;
+  /** Id of state. This can be 0,1, or 2 if you wish to specify a default space state. */
+  stateId?: string;
+}