confluence.js 1.5.3 → 1.6.0

package/src/api/parameters/getAndConvertMacroBodyByMacroId.ts

@@ -0,0 +1,104 @@
+export interface GetAndConvertMacroBodyByMacroId {
+  /** 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. This is usually passed by the app that the macro is in. 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. */
+  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;
+  /**
+   * 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?: 'current' | 'version-at-save' | string;
+  /** A multi-value parameter indicating which properties of the content to expand. */
+  expand?:
+  | 'childTypes.all'
+  | 'childTypes.attachment'
+  | 'childTypes.comment'
+  | 'childTypes.page'
+  | 'container'
+  | 'metadata.currentuser'
+  | 'metadata.properties'
+  | 'metadata.labels'
+  | 'metadata.frontend'
+  | 'operations'
+  | 'children.page'
+  | 'children.attachment'
+  | 'children.comment'
+  | 'restrictions.read.restrictions.user'
+  | 'restrictions.read.restrictions.group'
+  | 'restrictions.update.restrictions.user'
+  | 'restrictions.update.restrictions.group'
+  | 'history'
+  | 'history.lastUpdated'
+  | 'history.previousVersion'
+  | 'history.contributors'
+  | 'history.nextVersion'
+  | 'ancestors'
+  | 'body'
+  | 'body.storage'
+  | 'body.view'
+  | 'version'
+  | 'descendants.page'
+  | 'descendants.attachment'
+  | 'descendants.comment'
+  | 'space'
+  | 'extensions.inlineProperties'
+  | 'extensions.resolution'
+  | (
+    | 'childTypes.all'
+    | 'childTypes.attachment'
+    | 'childTypes.comment'
+    | 'childTypes.page'
+    | 'container'
+    | 'metadata.currentuser'
+    | 'metadata.properties'
+    | 'metadata.labels'
+    | 'metadata.frontend'
+    | 'operations'
+    | 'children.page'
+    | 'children.attachment'
+    | 'children.comment'
+    | 'restrictions.read.restrictions.user'
+    | 'restrictions.read.restrictions.group'
+    | 'restrictions.update.restrictions.user'
+    | 'restrictions.update.restrictions.group'
+    | 'history'
+    | 'history.lastUpdated'
+    | 'history.previousVersion'
+    | 'history.contributors'
+    | 'history.nextVersion'
+    | 'ancestors'
+    | 'body'
+    | 'body.storage'
+    | 'body.view'
+    | 'version'
+    | 'descendants.page'
+    | 'descendants.attachment'
+    | 'descendants.comment'
+    | 'space'
+    | 'extensions.inlineProperties'
+    | 'extensions.resolution'
+  )[]
+  | string
+  | string[];
+}

package/src/api/parameters/getAvailableContentStates.ts

@@ -1,4 +1,7 @@
 export interface GetAvailableContentStates {
-  /** Id of content to get available states for */
-  contentId: string;
+  /**id of content to get available states for*/
+  id?: string;
+
+  /** @deprecated Id of content to get available states for */
+  contentId?: string;
 }

package/src/api/parameters/getContentState.ts

@@ -1,6 +1,11 @@
 export interface GetContentState {
-  /** The Id of the page whose content state is of interest. */
-  contentId: string;
-  /** Set designation=DRAFT or designation=PUBLISHED. */
-  designation?: string;
+  /** The id of the content whose content state is of interest. */
+  id?: string;
+  /** Set status to one of [current,draft,archived]. */
+  status?: 'current' | 'draft' | 'archived' | string;
+
+  /** @deprecated The Id of the page whose content state is of interest. */
+  contentId?: string;
+  /** @deprecated Set designation=DRAFT or designation=PUBLISHED. */
+  designation?: 'DRAFT' | 'PUBLISHED' | string;
 }

package/src/api/parameters/getSpaceContentStates.ts

@@ -0,0 +1,4 @@
+export interface GetSpaceContentStates {
+  /** The key of the space to be queried for its content state settings. */
+  spaceKey: string;
+}

package/src/api/parameters/getUser.ts

@@ -20,12 +20,22 @@ export interface GetUser {
    * - `operations` returns the operations that the user is allowed to do.
    * - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'. Note that
    *   these fields have been deprecated due to privacy changes. See the [migration
-   *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+   *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
+   *   details.
    * - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'. Note
    *   that these fields have been deprecated due to privacy changes. See the [migration
-   *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
-   * - PersonalSpace returns the user's personal space, if it exists.
+   *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
+   *   details.
+   * - `personalSpace` returns the user's personal space, if it exists.
    * - `isExternalCollaborator` returns whether the user is an external collaborator user
    */
-  expand?: string[];
+  expand?:
+  | 'operations'
+  | 'details.personal'
+  | 'details.business'
+  | 'personalSpace'
+  | 'isExternalCollaborator'
+  | ('operations' | 'details.personal' | 'details.business' | 'personalSpace' | 'isExternalCollaborator')[]
+  | string
+  | string[];
 }

package/src/api/parameters/index.ts

@@ -13,6 +13,8 @@ export * from './addUserToContentRestriction';
 export * from './addUserToGroup';
 export * from './addUserToGroupByGroupId';
 export * from './archivePages';
+export * from './asyncConvertContentBodyRequest';
+export * from './asyncConvertContentBodyResponse';
 export * from './checkContentPermission';
 export * from './convertContentBody';
 export * from './copyPage';
@@ -48,6 +50,8 @@ export * from './exportAuditRecords';
 export * from './findSourcesForTarget';
 export * from './findTargetFromSource';
 export * from './getAllLabelContent';
+export * from './getAndAsyncConvertMacroBodyByMacroId';
+export * from './getAndConvertMacroBodyByMacroId';
 export * from './getAnonymousUser';
 export * from './getAttachments';
 export * from './getAuditRecords';
@@ -101,6 +105,7 @@ export * from './getRestrictions';
 export * from './getRestrictionsByOperation';
 export * from './getRestrictionsForOperation';
 export * from './getSpace';
+export * from './getSpaceContentStates';
 export * from './getSpaceProperties';
 export * from './getSpaceProperty';
 export * from './getSpaces';

package/src/api/parameters/movePage.ts

@@ -1,12 +1,16 @@
 export interface MovePage {
   /** The ID of the page to be moved */
-  id: string;
+  pageId?: string;
+  /** @deprecated The ID of the page to be moved */
+  id?: string;
   /**
-   * The position to move the page to relative to the target page: `before` - move the page under the same parent as the
-   * target, before the target in the list of children `after` - move the page under the same parent as the target,
-   * after the target in the list of children `append` - move the page to be a child of the target
+   * The position to move the page to relative to the target page:
+   *
+   * - `before` - move the page under the same parent as the target, before the target in the list of children
+   * - `after` - move the page under the same parent as the target, after the target in the list of children
+   * - `append` - move the page to be a child of the target
    */
-  position: string;
+  position: 'before' | 'after' | 'append' | string;
   /** The ID of the target page for this operation */
   targetId: string;
 }

package/src/api/parameters/removeContentState.ts

@@ -1,4 +1,9 @@
 export interface RemoveContentState {
   /** The Id of the content whose content state is to be set. */
-  contentId: string;
+  id?: string;
+  /** Status of content state from which to delete state. Can be draft or archived */
+  status?: string;
+
+  /** @deprecated The Id of the content whose content state is to be set. */
+  contentId?: string;
 }

package/src/api/parameters/setContentState.ts

@@ -1,8 +1,16 @@
-export interface SetContentState {
+import { ContentStateRestInput } from '../models';
+
+export interface SetContentState extends ContentStateRestInput {
   /** The Id of the content whose content state is to be set. */
-  contentId: string;
-  /** The Id of the content */
+  id?: string;
+  /**
+   * Status of content onto which state will be placed. If draft, then draft state will change. If current, state will
+   * be placed onto a new version of the content with same body as previous version.
+   */
+  status?: 'current' | 'draft' | string;
+
+  /** @deprecated The Id of the content whose content state is to be set. */
+  contentId?: string;
+  /** @deprecated The Id of the content */
   contentStateId?: number;
-  name?: string;
-  color?: string;
 }

package/src/api/settings.ts

@@ -233,12 +233,12 @@ export class Settings {
     return this.client.sendRequest(config, callback);
   }
 
-  /** Gets Content State settings for a space */
+  /** @deprecated Gets Content State settings for a space */
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,
     callback: Callback<T>
   ): Promise<void>;
-  /** Gets Content State settings for a space */
+  /** @deprecated Gets Content State settings for a space */
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,
     callback?: never

package/src/api/space.ts

@@ -181,7 +181,7 @@ export class Space {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async deleteSpace<T = Models.DeletedSpace>(parameters: Parameters.DeleteSpace, callback: Callback<T>): Promise<void>;
+  async deleteSpace<T = Models.LongTask>(parameters: Parameters.DeleteSpace, callback: Callback<T>): Promise<void>;
   /**
    * Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted
    * yet when this method has returned. Clients should poll the status link that is returned in the response until the
@@ -189,8 +189,8 @@ export class Space {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async deleteSpace<T = Models.DeletedSpace>(parameters: Parameters.DeleteSpace, callback?: never): Promise<T>;
-  async deleteSpace<T = Models.DeletedSpace>(
+  async deleteSpace<T = Models.LongTask>(parameters: Parameters.DeleteSpace, callback?: never): Promise<T>;
+  async deleteSpace<T = Models.LongTask>(
     parameters: Parameters.DeleteSpace,
     callback?: Callback<T>,
   ): Promise<void | T> {

package/src/api/spaceProperties.ts

@@ -111,8 +111,8 @@ export class SpaceProperties {
   }
 
   /**
-   * Creates a new space property. This is the same as `POST /wiki/rest/api/space/{spaceKey}/property` but the key for
-   * the property is passed as a path parameter, rather than in the request body.
+   * Creates a new space property. This is the same as `POST /api/space/{spaceKey}/property` but the key for the
+   * property is passed as a path parameter, rather than in the request body.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
    */
@@ -121,8 +121,8 @@ export class SpaceProperties {
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Creates a new space property. This is the same as `POST /wiki/rest/api/space/{spaceKey}/property` but the key for
-   * the property is passed as a path parameter, rather than in the request body.
+   * Creates a new space property. This is the same as `POST /api/space/{spaceKey}/property` but the key for the
+   * property is passed as a path parameter, rather than in the request body.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
    */

package/src/clients/confluenceClient.ts

@@ -13,6 +13,7 @@ import {
   ContentPermissions,
   ContentProperties,
   ContentRestrictions,
+  ContentStates,
   ContentVersions,
   ContentWatches,
   DynamicModules,
@@ -47,6 +48,7 @@ export class ConfluenceClient extends BaseClient {
   contentPermissions = new ContentPermissions(this);
   contentProperties = new ContentProperties(this);
   contentRestrictions = new ContentRestrictions(this);
+  contentStates = new ContentStates(this);
   contentVersions = new ContentVersions(this);
   contentWatches = new ContentWatches(this);
   dynamicModules = new DynamicModules(this);