confluence.js 1.5.3 → 1.6.0

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

package/src/api/models/index.ts

@@ -4,14 +4,17 @@ export * from './accountIdEmailRecordArray';
 export * from './addContentRestriction';
 export * from './addContentRestrictionUpdateArray';
 export * from './affectedObject';
+export * from './appDescriptor';
+export * from './asyncContentBody';
+export * from './asyncId';
+export * from './attachment';
 export * from './attachmentContainer';
+export * from './attachmentMetadata';
 export * from './attachmentUpdate';
 export * from './auditRecord';
 export * from './auditRecordArray';
 export * from './auditRecordCreate';
-export * from './appDescriptor';
-export * from './attachment';
-export * from './attachmentMetadata';
+export * from './availableContentStates';
 export * from './blueprintTemplate';
 export * from './blueprintTemplateArray';
 export * from './breadcrumb';
@@ -51,6 +54,11 @@ export * from './contentRestriction';
 export * from './contentRestrictionArray';
 export * from './contentRestrictionUpdate';
 export * from './contentRestrictionUpdateArray';
+export * from './contentState';
+export * from './contentStateContainer';
+export * from './contentStateResponse';
+export * from './contentStateRestInput';
+export * from './contentStateSettings';
 export * from './contentTemplate';
 export * from './contentTemplateArray';
 export * from './contentTemplateBodyCreate';
@@ -87,16 +95,9 @@ export * from './labelCreateArray';
 export * from './labelDetails';
 export * from './labeledContent';
 export * from './labeledContentPageResponse';
-export * from './contentStateSettings';
 export * from './labeledContentType';
+export * from './lifecycle';
 export * from './longTask';
-export * from './contentState';
-export * from './userPropertyCreate';
-export * from './userPropertyUpdate';
-export * from './contentStateContainer';
-export * from './availableContentStates';
-export * from './userPropertyKeyArray';
-export * from './userProperty';
 export * from './longTaskStatus';
 export * from './longTaskStatusArray';
 export * from './longTaskStatusWithLinks';
@@ -106,7 +107,6 @@ export * from './lookAndFeelSettings';
 export * from './lookAndFeelUpdated';
 export * from './macroInstance';
 export * from './menusLookAndFeel';
-export * from './lifecycle';
 export * from './message';
 export * from './migratedUser';
 export * from './migratedUserArray';
@@ -162,6 +162,10 @@ export * from './userAnonymous';
 export * from './userArray';
 export * from './userArrayWithLinks';
 export * from './userDetails';
+export * from './userProperty';
+export * from './userPropertyCreate';
+export * from './userPropertyKeyArray';
+export * from './userPropertyUpdate';
 export * from './usersUserKeys';
 export * from './userWatch';
 export * from './version';

package/src/api/parameters/asyncConvertContentBodyRequest.ts

@@ -0,0 +1,81 @@
+import { ContentBodyCreate } from '../models';
+
+export interface AsyncConvertContentBodyRequest extends ContentBodyCreate {
+  /** The name of the target format for the content body. */
+  to: string;
+  /**
+   * The space key used for resolving embedded content (page includes, files, and links) in the content body. For
+   * example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>`
+   * and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted to a link to the "Example
+   * page" page in the "TEST" space.
+   */
+  spaceKeyContext?: string;
+  /**
+   * The content ID used to find the space for resolving embedded content (page includes, files, and links) in the
+   * content body. For example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example
+   * page" /><ac:link>` and the `contentIdContext=123` parameter is provided, then the link will be converted to a link
+   * to the "Example page" page in the same space that has the content with ID=123. Note, `spaceKeyContext` will be
+   * ignored if this parameter is provided.
+   */
+  contentIdContext?: string;
+  /**
+   * If this field is false, the cache will erase its current value and begin a new conversion. If this field is true,
+   * the cache will not erase its current value, and will set the status of the async conversion to RERUNNING. Once the
+   * data is updated, the status will change to COMPLETED. Large macros that take long to convert, and whose data need
+   * not immediately up to date (same as previous conversion's result within last 5 minutes) should set this fields to
+   * true. Cache values are stored per user per content body and expansions.
+   */
+  allowCache?: boolean;
+  /**
+   * Mode used for rendering embedded content, like attachments.
+   *
+   *     - `current` renders the embedded content using the latest version.
+   *     - `version-at-save` renders the embedded content using the version at
+   *     the time of save.
+   */
+  embeddedContentRender?: string;
+  /** A multi-value parameter indicating which properties of the content to expand and populate. */
+  expand?:
+  | 'embeddedContent'
+  | 'mediaToken'
+  | 'webresource.superbatch.metatags'
+  | 'webresource.superbatch.tags.all'
+  | 'webresource.superbatch.tags.css'
+  | 'webresource.superbatch.tags.data'
+  | 'webresource.superbatch.tags.js'
+  | 'webresource.superbatch.uris.all'
+  | 'webresource.superbatch.uris.css'
+  | 'webresource.superbatch.uris.data'
+  | 'webresource.superbatch.uris.js'
+  | 'webresource.tags.all'
+  | 'webresource.tags.css'
+  | 'webresource.tags.data'
+  | 'webresource.tags.js'
+  | 'webresource.uris.all'
+  | 'webresource.uris.css'
+  | 'webresource.uris.data'
+  | 'webresource.uris.js'
+  | (
+    | 'embeddedContent'
+    | 'mediaToken'
+    | 'webresource.superbatch.metatags'
+    | 'webresource.superbatch.tags.all'
+    | 'webresource.superbatch.tags.css'
+    | 'webresource.superbatch.tags.data'
+    | 'webresource.superbatch.tags.js'
+    | 'webresource.superbatch.uris.all'
+    | 'webresource.superbatch.uris.css'
+    | 'webresource.superbatch.uris.data'
+    | 'webresource.superbatch.uris.js'
+    | 'webresource.tags.all'
+    | 'webresource.tags.css'
+    | 'webresource.tags.data'
+    | 'webresource.tags.js'
+    | 'webresource.uris.all'
+    | 'webresource.uris.css'
+    | 'webresource.uris.data'
+    | 'webresource.uris.js'
+  )[]
+  | string
+  | string[];
+}

package/src/api/parameters/asyncConvertContentBodyResponse.ts

@@ -0,0 +1,4 @@
+export interface AsyncConvertContentBodyResponse {
+  /** The asyncId of the macro task to get the converted body. */
+  id: string;
+}

package/src/api/parameters/getAndAsyncConvertMacroBodyByMacroId.ts

@@ -0,0 +1,88 @@
+export interface GetAndAsyncConvertMacroBodyByMacroId {
+  /** The ID for the content that contains the macro. */
+  id: string;
+  /**
+   * The version of the content that contains the macro. Specifying `0` as the `version` will return the macro body for
+   * the latest content version.
+   */
+  version: number;
+  /**
+   * The ID of the macro. For apps, this is passed to the macro by the Connect/Forge framework. Otherwise, find the
+   * macro ID by querying the desired content and version, then expanding the body in storage format. For example,
+   * '/content/196611/version/7?expand=content.body.storage'.
+   */
+  macroId: string;
+  /**
+   * The content representation to return the macro in. Currently, the following conversions are allowed:
+   *
+   *     -`export_view` - `styled_view` - `view`;
+   */
+  to: string;
+  /**
+   * If this field is false, the cache will erase its current value and begin a conversion. If this field is true, the
+   * cache will not erase its current value, and will set the status of the result in cache to RERUNNING. Once the data
+   * is updated, the status will change to COMPLETED. Large macros that take long to convert, and who want to show
+   * intermediate, but potentially stale data, immediately should set this field to true. Cache values are stored per
+   * macro per user per content and expansions.
+   */
+  allowCache?: boolean;
+  /**
+   * The space key used for resolving embedded content (page includes, files, and links) in the content body. For
+   * example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>`
+   * and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted to a link to the "Example
+   * page" page in the "TEST" space.
+   */
+  spaceKeyContext?: string;
+  /**
+   * Mode used for rendering embedded content, like attachments.
+   *
+   *     - `current` renders the embedded content using the latest version.
+   *     - `version-at-save` renders the embedded content using the version at
+   *     the time of save.
+   */
+  embeddedContentRender?: string;
+  /** A multi-value parameter indicating which properties of the content to expand and populate. */
+  expand?:
+  | 'embeddedContent'
+  | 'mediaToken'
+  | 'webresource.superbatch.metatags'
+  | 'webresource.superbatch.tags.all'
+  | 'webresource.superbatch.tags.css'
+  | 'webresource.superbatch.tags.data'
+  | 'webresource.superbatch.tags.js'
+  | 'webresource.superbatch.uris.all'
+  | 'webresource.superbatch.uris.css'
+  | 'webresource.superbatch.uris.data'
+  | 'webresource.superbatch.uris.js'
+  | 'webresource.tags.all'
+  | 'webresource.tags.css'
+  | 'webresource.tags.data'
+  | 'webresource.tags.js'
+  | 'webresource.uris.all'
+  | 'webresource.uris.css'
+  | 'webresource.uris.data'
+  | 'webresource.uris.js'
+  | (
+    | 'embeddedContent'
+    | 'mediaToken'
+    | 'webresource.superbatch.metatags'
+    | 'webresource.superbatch.tags.all'
+    | 'webresource.superbatch.tags.css'
+    | 'webresource.superbatch.tags.data'
+    | 'webresource.superbatch.tags.js'
+    | 'webresource.superbatch.uris.all'
+    | 'webresource.superbatch.uris.css'
+    | 'webresource.superbatch.uris.data'
+    | 'webresource.superbatch.uris.js'
+    | 'webresource.tags.all'
+    | 'webresource.tags.css'
+    | 'webresource.tags.data'
+    | 'webresource.tags.js'
+    | 'webresource.uris.all'
+    | 'webresource.uris.css'
+    | 'webresource.uris.data'
+    | 'webresource.uris.js'
+  )[]
+  | string
+  | string[];
+}