confluence.js 1.2.0 → 1.3.1

package/src/api/longRunningTask.ts

@@ -39,7 +39,7 @@ export class LongRunningTask {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getTasks' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -70,6 +70,6 @@ export class LongRunningTask {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getTask' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/parameters/addLabelsToSpace.ts

@@ -0,0 +1,4 @@
+export interface AddLabelsToSpace {
+  /** The key of the space to add labels to. */
+  spaceKey: string;
+}

package/src/api/parameters/deleteLabelFromSpace.ts

@@ -0,0 +1,8 @@
+export interface DeleteLabelFromSpace {
+  /** The key of the space to remove a labels from. */
+  spaceKey: string;
+  /** The name of the label to remove */
+  name: string;
+  /** The prefix of the label to remove. If not provided defaults to global. */
+  prefix?: string;
+}

package/src/api/parameters/getBulkUserLookup.ts

@@ -5,12 +5,6 @@ export interface GetBulkUserLookup {
    * A multi-value parameter indicating which properties of the user to expand.
    *
    * - `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.
-   * - `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.
    */
   expand?: string[];

package/src/api/parameters/getContentById.ts

@@ -19,10 +19,95 @@ export interface GetContentById {
    */
   embeddedContentRender?: string;
   /** A multi-value parameter indicating which properties of the content to expand. */
-  expand?: string[];
+  expand?: string | string[] | GetContentById.Expand | GetContentById.Expand[];
   /**
    * If set to `viewed`, the request will trigger a 'viewed' event for the content. When this event is triggered, the
    * page/blogpost will appear on the 'Recently visited' tab of the user's Confluence dashboard.
    */
   trigger?: string;
 }
+
+export namespace GetContentById {
+  export enum Expand {
+    /**
+     * Returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether
+     * the content has children of a particular type.
+     */
+    AllChildTypes = 'childTypes.all',
+    /** Returns whether the content has attachments. */
+    AttachmentChildType = 'childTypes.attachment',
+    /** Returns whether the content has comments. */
+    CommentChildType = 'childTypes.comment',
+    /** Returns whether the content has child pages. */
+    PageChildType = 'childTypes.page',
+    /**
+     * Returns the space that the content is in. This is the same as the information returned by [Get
+     * space](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/).
+     */
+    Container = 'container',
+    /**
+     * Returns information about the current user in relation to the content, including when they last viewed it,
+     * modified it, contributed to it, or added it as a favorite.
+     */
+    CurrentUserMetadata = 'metadata.currentuser',
+    /** Returns content properties that have been set via the Confluence REST API. */
+    PropertiesMetadata = 'metadata.properties',
+    /** Returns the labels that have been added to the content. */
+    LabelsMetadata = 'metadata.labels',
+    /** This property is only used by Atlassian. */
+    FrontendMetadata = 'metadata.frontend',
+    /** Returns the operations for the content, which are used when setting permissions. */
+    Operations = 'operations',
+    /** Returns pages that are descendants at the level immediately below the content. */
+    PageChildren = 'children.page',
+    /** Returns all attachments for the content. */
+    AttachmentChildren = 'children.attachment',
+    /** Returns all comments on the content. */
+    CommentChildren = 'children.comment',
+    /** Returns the users that have permission to read the content. */
+    ReadUserRestriction = 'restrictions.read.restrictions.user',
+    /**
+     * Returns the groups that have permission to read the content. Note that this may return deleted groups, because
+     * deleting a group doesn't remove associated restrictions.
+     */
+    ReadGroupRestriction = 'restrictions.read.restrictions.group',
+    /** Returns the users that have permission to update the content. */
+    UpdateUserRestriction = 'restrictions.update.restrictions.user',
+    /**
+     * Returns the groups that have permission to update the content. Note that this may return deleted groups because
+     * deleting a group doesn't remove associated restrictions.
+     */
+    UpdateGroupRestriction = 'restrictions.update.restrictions.group',
+    /** Returns the history of the content, including the date it was created. */
+    History = 'history',
+    /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+    LastUpdated = 'history.lastUpdated',
+    /** Returns information about the update prior to the current content update. */
+    PreviousVersion = 'history.previousVersion',
+    /** Returns all of the users who have contributed to the content. */
+    Contributors = 'history.contributors',
+    /** Returns information about the update after to the current content update. */
+    NextVersion = 'history.nextVersion',
+    /** Returns the parent page, if the content is a page. */
+    Ancestors = 'ancestors',
+    /** Returns the body of the content in different formats, including the editor format, view format, and export format. */
+    Body = 'body',
+    /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+    Version = 'version',
+    /** Returns pages that are descendants at any level below the content. */
+    PageDescendant = 'descendants.page',
+    /** Returns all attachments for the content, same as `children.attachment`. */
+    AttachmentDescendant = 'descendants.attachment',
+    /** Returns all comments on the content, same as `children.comment`. */
+    CommentDescendant = 'descendants.comment',
+    /**
+     * Returns the space that the content is in. This is the same as the information returned by [Get
+     * space](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/).
+     */
+    Space = 'space',
+    /** Returns inline comment-specific properties. */
+    InlineProperties = 'extensions.inlineProperties',
+    /** Returns the resolution status of each comment. */
+    Resolution = 'extensions.resolution',
+  }
+}

package/src/api/parameters/getContentChildren.ts

@@ -7,6 +7,7 @@ export interface GetContentChildren {
    * - `attachment` returns all attachments for the content.
    * - `comments` returns all comments for the content.
    * - `page` returns all child pages of the content.
+   * - Custom content types that are provided by apps are also supported.
    */
   expand?: string[];
   /** The version of the parent content to retrieve children for. Currently, this only works for the latest version. */

package/src/api/parameters/getContentProperties.ts

@@ -1,7 +1,7 @@
 export interface GetContentProperties {
   /** The ID of the content to be queried for its properties. */
   id: string;
-  /**The key of the content property.*/
+  /** The key of the content property. */
   key?: string[];
   /**
    * A multi-value parameter indicating which properties of the content to expand. By default, the `version` object is expanded.

package/src/api/parameters/getContentProperty.ts

@@ -10,4 +10,16 @@ export interface GetContentProperty {
    * - `version` returns information about the version of the property, such as the version number, when it was created, etc.
    */
   expand?: string[];
+  /**
+   * Filter the results to a set of content based on their status. If set to `any`, content with any status is returned.
+   * By default it will fetch current and archived statuses `?status=current&status=archived`. All supported statuses
+   *
+   * - any
+   * - archived
+   * - current
+   * - deleted
+   * - draft
+   * - trashed
+   */
+  status?: string[];
 }

package/src/api/parameters/getContentVersions.ts

@@ -6,7 +6,7 @@ export interface GetContentVersions {
   /** The maximum number of versions to return per page. Note, this may be restricted by fixed system limits. */
   limit?: number;
   /**
-   * A multi-value parameter indicating which properties of the content to expand.
+   * A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is expanded.
    *
    * - `collaborators` returns the users that collaborated on the version.
    * - `content` returns the content for the version.

package/src/api/parameters/getCurrentUser.ts

@@ -3,13 +3,8 @@ export interface GetCurrentUser {
    * A multi-value parameter indicating which properties of the user to expand.
    *
    * - `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.
-   * - `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.
+   * - `isExternalCollaborator` returns whether the user is an external collaborator user
    */
   expand?: string[];
 }

package/src/api/parameters/getHistoryForContent.ts

@@ -2,7 +2,7 @@ export interface GetHistoryForContent {
   /** The ID of the content to be queried for its history. */
   id: string;
   /**
-   * A multi-value parameter indicating which properties of the content history to expand.
+   * A multi-value parameter indicating which properties of the content history to expand. Maximum sub-expansions allowed is `8`.
    *
    * - `lastUpdated` returns information about the most recent update of the content, including who updated it and when it
    *   was updated.

package/src/api/parameters/getLabelsForSpace.ts

@@ -0,0 +1,18 @@
+export interface GetLabelsForSpace {
+  /** The key of the space to get labels for. */
+  spaceKey: string;
+  /**
+   * Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any
+   * prefix will be returned.
+   *
+   *     - `global` prefix is used by labels that are on content within the provided space.
+   *     - `my` prefix can be explicitly added by a user when adding a label
+   *     via the UI, e.g. 'my:example-label'.
+   *     - `team` prefix is used for labels applied to the space.
+   */
+  prefix?: string;
+  /** The starting index of the returned labels. */
+  start?: number;
+  /** The maximum number of labels to return per page. Note, this may be restricted by fixed system limits. */
+  limit?: number;
+}

package/src/api/parameters/index.ts

@@ -3,6 +3,7 @@ export * from './addCustomContentPermissions';
 export * from './addGroupToContentRestriction';
 export * from './addGroupToContentRestrictionByGroupId';
 export * from './addLabelsToContent';
+export * from './addLabelsToSpace';
 export * from './addLabelWatcher';
 export * from './addPermission';
 export * from './addPermissionToSpace';
@@ -33,6 +34,7 @@ export * from './delete';
 export * from './deleteContent';
 export * from './deleteContentProperty';
 export * from './deleteContentVersion';
+export * from './deleteLabelFromSpace';
 export * from './deleteRelationship';
 export * from './deleteRestrictions';
 export * from './deleteSpace';
@@ -81,6 +83,7 @@ export * from './getGroupsSearch';
 export * from './getHistoryForContent';
 export * from './getIndividualGroupRestrictionStatusByGroupId';
 export * from './getLabelsForContent';
+export * from './getLabelsForSpace';
 export * from './getLookAndFeelSettings';
 export * from './getMacroBodyByMacroId';
 export * from './getMembersByQueryParam';

package/src/api/parameters/restoreContentVersion.ts

@@ -4,7 +4,7 @@ export interface RestoreContentVersion extends VersionRestore {
   /** The ID of the content for which the history will be restored. */
   id: string;
   /**
-   * A multi-value parameter indicating which properties of the returned content to expand.
+   * A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is expanded.
    *
    * - `collaborators` returns the users that collaborated on the version.
    * - `content` returns the content for the version.

package/src/api/parameters/searchUser.ts

@@ -17,4 +17,11 @@ export interface SearchUser {
   start?: number;
   /** The maximum number of user objects to return per page. Note, this may be restricted by fixed system limits. */
   limit?: number;
+  /**
+   * A multi-value parameter indicating which properties of the user to expand.
+   *
+   * - `operations` returns the operations for the user, which are used when setting permissions.
+   * - `personalSpace` returns the personal space of the user.
+   */
+  expand?: string[];
 }

package/src/api/relation.ts

@@ -53,7 +53,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'findTargetFromSource' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
@@ -113,7 +113,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getRelationship' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -159,7 +159,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createRelationship' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated Will be removed in the next major version. Use `deleteRelationship` instead. */
@@ -201,7 +201,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteRelationship' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -252,6 +252,6 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'findSourcesForTarget' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/search.ts

@@ -74,7 +74,7 @@ export class Search {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchByCQL' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
@@ -93,12 +93,13 @@ export class Search {
   ): Promise<void | T> {
     return this.searchUser(parameters, callback!);
   }
+
   /**
    * Searches for users using user-specific queries from the [Confluence Query Language
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
-   * profilePicture, and displayName.
+   * profilePicture, displayName, and timeZone.
    */
   async searchUser<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchUser,
@@ -109,7 +110,7 @@ export class Search {
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
-   * profilePicture, and displayName.
+   * profilePicture, displayName, and timeZone.
    */
   async searchUser<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchUser,
@@ -126,9 +127,10 @@ export class Search {
         cql: parameters.cql,
         start: parameters.start,
         limit: parameters.limit,
+        expand: parameters.expand,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchUser' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/settings.ts

@@ -43,7 +43,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -81,7 +81,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateLookAndFeel' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -133,7 +133,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -170,7 +170,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'resetLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -205,7 +205,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'setLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -228,6 +228,6 @@ export class Settings {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSystemInfo' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/space.ts

@@ -31,7 +31,7 @@ export class Space {
       url: '/api/space',
       method: 'GET',
       params: {
-        spaceKey: parameters?.spaceKey,
+        spaceKey: () => parameters?.spaceKey?.map((key) => `spaceKey=${key}`).join('&'),
         spaceId: parameters?.spaceId,
         type: parameters?.type,
         status: parameters?.status,
@@ -43,7 +43,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaces' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -73,7 +73,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -110,7 +110,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createPrivateSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -131,7 +131,7 @@ export class Space {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -165,7 +165,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -193,7 +193,7 @@ export class Space {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -232,7 +232,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -269,6 +269,6 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentByTypeForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/spacePermissions.ts

@@ -61,7 +61,7 @@ export class SpacePermissions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addPermissionToSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -103,7 +103,7 @@ export class SpacePermissions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addCustomContentPermissions' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -130,6 +130,6 @@ export class SpacePermissions {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removePermission' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/spaceProperties.ts

@@ -39,7 +39,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceProperties' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -74,7 +74,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -107,7 +107,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -142,7 +142,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createSpacePropertyForKey' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -176,7 +176,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -200,6 +200,6 @@ export class SpaceProperties {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/spaceSettings.ts

@@ -34,7 +34,7 @@ export class SpaceSettings {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -67,6 +67,6 @@ export class SpaceSettings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateSpaceSettings' });
+    return this.client.sendRequest(config, callback);
   }
 }