confluence.js 1.1.3 → 1.3.0

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/getTaskById.ts

@@ -0,0 +1,4 @@
+export interface GetTaskById {
+  /** Global ID of the inline task */
+  inlineTaskId: string;
+}

package/src/api/parameters/getViewers.ts

@@ -0,0 +1,6 @@
+export interface GetViewers {
+  /** The ID of the content to get the viewers for. */
+  contentId: string;
+  /** The number of views for the content since the date. */
+  fromDate?: string;
+}

package/src/api/parameters/getViews.ts

@@ -0,0 +1,6 @@
+export interface GetViews {
+  /** The ID of the content to get the views for. */
+  contentId: string;
+  /** The number of views for the content since the date. */
+  fromDate?: string;
+}

package/src/api/parameters/index.ts

@@ -1,140 +1,158 @@
-export * from './getAuditRecords';
+export * from './addContentWatcher';
+export * from './addCustomContentPermissions';
+export * from './addGroupToContentRestriction';
+export * from './addGroupToContentRestrictionByGroupId';
+export * from './addLabelsToContent';
+export * from './addLabelsToSpace';
+export * from './addLabelWatcher';
+export * from './addPermission';
+export * from './addPermissionToSpace';
+export * from './addRestrictions';
+export * from './addSpaceWatcher';
+export * from './addUserToContentRestriction';
+export * from './addUserToGroup';
+export * from './addUserToGroupByGroupId';
+export * from './archivePages';
+export * from './checkContentPermission';
+export * from './convertContentBody';
+export * from './copyPage';
+export * from './copyPageHierarchy';
+export * from './createAttachments';
 export * from './createAuditRecord';
+export * from './createContent';
+export * from './createContentProperty';
+export * from './createContentPropertyForKey';
+export * from './createContentTemplate';
+export * from './createGroup';
+export * from './createOrUpdateAttachments';
+export * from './createPrivateSpace';
+export * from './createRelationship';
+export * from './createSpace';
+export * from './createSpaceProperty';
+export * from './createSpacePropertyForKey';
+export * from './delete';
+export * from './deleteContent';
+export * from './deleteContentProperty';
+export * from './deleteContentVersion';
+export * from './deleteLabelFromSpace';
+export * from './deleteRelationship';
+export * from './deleteRestrictions';
+export * from './deleteSpace';
+export * from './deleteSpaceProperty';
+export * from './descendantsOfType';
+export * from './downloadAttachment';
 export * from './exportAuditRecords';
-export * from './setRetentionPeriod';
+export * from './findSourcesForTarget';
+export * from './findTargetFromSource';
+export * from './getAllLabelContent';
+export * from './getAnonymousUser';
+export * from './getAttachments';
+export * from './getAuditRecords';
 export * from './getAuditRecordsForTimePeriod';
+export * from './getBlueprintTemplates';
+export * from './getBulkUserLookup';
+export * from './getBulkUserMigration';
 export * from './getContent';
-export * from './createContent';
-export * from './publishLegacyDraft';
-export * from './publishSharedDraft';
-export * from './searchContentByCQL';
 export * from './getContentById';
-export * from './updateContent';
-export * from './deleteContent';
-export * from './getHistoryForContent';
+export * from './getContentByTypeForSpace';
 export * from './getContentChildren';
-export * from './movePage';
 export * from './getContentChildrenByType';
-export * from './getContentDescendants';
-export * from './descendantsOfType';
-export * from './copyPageHierarchy';
-export * from './copyPage';
-export * from './getAttachments';
-export * from './createAttachments';
-export * from './createOrUpdateAttachments';
-export * from './updateAttachmentProperties';
-export * from './updateAttachmentData';
 export * from './getContentComments';
-export * from './getMacroBodyByMacroId';
-export * from './getLabelsForContent';
-export * from './addLabelsToContent';
-export * from './removeLabelFromContentUsingQueryParameter';
-export * from './removeLabelFromContent';
-export * from './getWatchesForPage';
-export * from './getWatchesForSpace';
-export * from './getWatchersForSpace';
-export * from './getContentWatchStatus';
-export * from './addContentWatcher';
-export * from './removeContentWatcher';
-export * from './isWatchingLabel';
-export * from './addLabelWatcher';
-export * from './removeLabelWatcher';
-export * from './isWatchingSpace';
-export * from './addSpaceWatcher';
-export * from './removeSpaceWatch';
-export * from './permissionCheck';
+export * from './getContentDescendants';
+export * from './getContentForSpace';
 export * from './getContentProperties';
-export * from './createContentProperty';
 export * from './getContentProperty';
-export * from './createContentPropertyForKey';
-export * from './updateContentProperty';
-export * from './deleteContentProperty';
-export * from './getRestrictions';
-export * from './addRestrictions';
-export * from './updateRestrictions';
-export * from './deleteRestrictions';
-export * from './getRestrictionsByOperation';
-export * from './getRestrictionsForOperation';
 export * from './getContentRestrictionStatusForGroup';
-export * from './addGroupToContentRestriction';
-export * from './getIndividualGroupRestrictionStatusByGroupId';
-export * from './addGroupToContentRestrictionByGroupId';
-export * from './removeGroupByName';
-export * from './removeGroupById';
 export * from './getContentRestrictionStatusForUser';
-export * from './addUserToContentRestriction';
-export * from './removeUserFromContentRestriction';
-export * from './getContentVersions';
-export * from './restoreContentVersion';
+export * from './getContentTemplate';
+export * from './getContentTemplates';
 export * from './getContentVersion';
-export * from './deleteContentVersion';
-export * from './convertContentBody';
-export * from './searchTasks';
-export * from './getAllLabelContent';
-export * from './getGroups';
-export * from './createGroup';
-export * from './removeGroup';
-export * from './getGroupByQueryParam';
-export * from './getGroupByGroupId';
+export * from './getContentVersions';
+export * from './getContentWatchStatus';
+export * from './getCurrentUser';
+export * from './getDescendantsOfType';
 export * from './getGroup';
-export * from './getMembersByQueryParam';
+export * from './getGroupByGroupId';
+export * from './getGroupByName';
+export * from './getGroupByQueryParam';
 export * from './getGroupMembers';
-export * from './getGroupsSearch';
-export * from './addUserToGroupByGroupId';
-export * from './removeMemberFromGroupByGroupId';
 export * from './getGroupMembersByGroupId';
-export * from './addUserToGroup';
-export * from './removeMemberFromGroup';
-export * from './getTasks';
-export * from './getTask';
-export * from './findTargetFromSource';
-export * from './getRelationship';
-export * from './createRelationship';
-export * from './delete';
-export * from './findSourcesForTarget';
-export * from './search';
-export * from './userSearch';
+export * from './getGroupMembershipsForUser';
+export * from './getGroups';
+export * from './getGroupsSearch';
+export * from './getHistoryForContent';
+export * from './getIndividualGroupRestrictionStatusByGroupId';
+export * from './getLabelsForContent';
+export * from './getLabelsForSpace';
 export * from './getLookAndFeelSettings';
-export * from './updateLookAndFeel';
-export * from './updateLookAndFeelSettings';
-export * from './resetLookAndFeelSettings';
-export * from './setLookAndFeelSettings';
-export * from './getThemes';
-export * from './getTheme';
-export * from './getSpaceTheme';
-export * from './setSpaceTheme';
-export * from './resetSpaceTheme';
-export * from './getSpaces';
-export * from './createSpace';
-export * from './createPrivateSpace';
+export * from './getMacroBodyByMacroId';
+export * from './getMembersByQueryParam';
+export * from './getPrivacyUnsafeUserEmail';
+export * from './getPrivacyUnsafeUserEmailBulk';
+export * from './getRelationship';
+export * from './getRestrictions';
+export * from './getRestrictionsByOperation';
+export * from './getRestrictionsForOperation';
 export * from './getSpace';
-export * from './updateSpace';
-export * from './deleteSpace';
-export * from './getContentForSpace';
-export * from './getContentByTypeForSpace';
-export * from './addPermission';
-export * from './removePermission';
 export * from './getSpaceProperties';
-export * from './createSpaceProperty';
 export * from './getSpaceProperty';
-export * from './createSpacePropertyForKey';
-export * from './updateSpaceProperty';
-export * from './deleteSpaceProperty';
+export * from './getSpaces';
 export * from './getSpaceSettings';
-export * from './updateSpaceSettings';
-export * from './createContentTemplate';
-export * from './updateContentTemplate';
-export * from './getBlueprintTemplates';
-export * from './getContentTemplates';
-export * from './getContentTemplate';
-export * from './removeTemplate';
+export * from './getSpaceTheme';
+export * from './getTask';
+export * from './getTaskById';
+export * from './getTasks';
+export * from './getTheme';
+export * from './getThemes';
 export * from './getUser';
-export * from './getAnonymousUser';
-export * from './getCurrentUser';
-export * from './getGroupMembershipsForUser';
-export * from './getBulkUserLookup';
-export * from './getPrivacyUnsafeUserEmail';
-export * from './getPrivacyUnsafeUserEmailBulk';
-export * from './getBulkUserMigration';
+export * from './getViewers';
+export * from './getViews';
+export * from './getWatchersForSpace';
+export * from './getWatchesForPage';
+export * from './getWatchesForSpace';
+export * from './isWatchingLabel';
+export * from './isWatchingSpace';
+export * from './movePage';
+export * from './permissionCheck';
+export * from './publishLegacyDraft';
+export * from './publishSharedDraft';
 export * from './registerModules';
+export * from './removeContentWatcher';
+export * from './removeGroup';
+export * from './removeGroupById';
+export * from './removeGroupByName';
+export * from './removeLabelFromContent';
+export * from './removeLabelFromContentUsingQueryParameter';
+export * from './removeLabelWatcher';
+export * from './removeMemberFromGroup';
+export * from './removeMemberFromGroupByGroupId';
 export * from './removeModules';
+export * from './removePermission';
+export * from './removeSpaceWatch';
+export * from './removeTemplate';
+export * from './removeUserFromContentRestriction';
+export * from './resetLookAndFeelSettings';
+export * from './resetSpaceTheme';
+export * from './restoreContentVersion';
+export * from './search';
+export * from './searchByCQL';
+export * from './searchContentByCQL';
+export * from './searchGroups';
+export * from './searchTasks';
+export * from './searchUser';
+export * from './setLookAndFeelSettings';
+export * from './setRetentionPeriod';
+export * from './setSpaceTheme';
+export * from './updateAttachmentData';
+export * from './updateAttachmentProperties';
+export * from './updateContent';
+export * from './updateContentProperty';
+export * from './updateContentTemplate';
+export * from './updateLookAndFeel';
+export * from './updateLookAndFeelSettings';
+export * from './updateRestrictions';
+export * from './updateSpace';
+export * from './updateSpaceProperty';
+export * from './updateSpaceSettings';
+export * from './updateTaskById';
+export * from './userSearch';

package/src/api/parameters/publishLegacyDraft.ts

@@ -1,4 +1,6 @@
-export interface PublishLegacyDraft {
+import { ContentBlueprintDraft } from '../models';
+
+export interface PublishLegacyDraft extends ContentBlueprintDraft {
   /**
    * The ID of the draft page that was created from a blueprint. You can find the `draftId` in the Confluence
    * application by opening the draft page and checking the page URL.
@@ -11,4 +13,5 @@ export interface PublishLegacyDraft {
   status?: string;
   /** A multi-value parameter indicating which properties of the content to expand. */
   expand?: string[];
+  bodyStatus?: string;
 }

package/src/api/parameters/publishSharedDraft.ts

@@ -1,4 +1,6 @@
-export interface PublishSharedDraft {
+import { ContentBlueprintDraft } from '../models';
+
+export interface PublishSharedDraft extends ContentBlueprintDraft {
   /**
    * The ID of the draft page that was created from a blueprint. You can find the `draftId` in the Confluence
    * application by opening the draft page and checking the page URL.
@@ -11,4 +13,5 @@ export interface PublishSharedDraft {
   status?: string;
   /** A multi-value parameter indicating which properties of the content to expand. */
   expand?: string[];
+  bodyStatus?: string;
 }

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/searchByCQL.ts

@@ -0,0 +1,34 @@
+export interface SearchByCQL {
+  /**
+   * The CQL query to be used for the search. See [Advanced Searching using
+   * CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/) for instructions on how to
+   * build a CQL query.
+   */
+  cql: string;
+  /**
+   * The space, content, and content status to execute the search against.
+   *
+   * - `spaceKey` Key of the space to search against. Optional.
+   * - `contentId` ID of the content to search against. Optional. Must be in the space specified by `spaceKey`.
+   * - `contentStatuses` Content statuses to search against. Optional.
+   *
+   * Specify these values in an object. For example, `cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22}`
+   */
+  cqlcontext?: string;
+  /** Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call. */
+  cursor?: string;
+  next?: boolean;
+  prev?: boolean;
+  /** The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits. */
+  limit?: number;
+  /** The start point of the collection to return */
+  start?: number;
+  /** Whether to include content from archived spaces in the results. */
+  includeArchivedSpaces?: boolean;
+  /** Whether to exclude current spaces and only show archived spaces. */
+  excludeCurrentSpaces?: boolean;
+  /** The excerpt strategy to apply to the result */
+  excerpt?: string;
+  sitePermissionTypeFilter?: string;
+  expand?: string[];
+}

package/src/api/parameters/searchGroups.ts

@@ -0,0 +1,8 @@
+export interface SearchGroups {
+  /** The search term used to query results. */
+  query: string;
+  /** The starting index of the returned groups. */
+  start?: number;
+  /** The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups. */
+  limit?: number;
+}

package/src/api/parameters/searchUser.ts

@@ -0,0 +1,27 @@
+export interface SearchUser {
+  /**
+   * The CQL query to be used for the search. See [Advanced Searching using
+   * CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/) for instructions on how to
+   * build a CQL query.
+   *
+   *     Example queries:
+   *       - cql=type=user will return all users
+   *       - cql=user=“1234” will return user with accountId “1234”
+   *       - You can also use IN, NOT IN, != operators
+   *       - cql=user IN (“12”, “34") will return users with accountids “12” and “34”
+   *       - cql=user.fullname~jo will return users with nickname/full name starting with “jo”
+   *       - cql=user.accountid=“123” will return user with accountId “123”
+   */
+  cql: string;
+  /** The starting index of the returned users. */
+  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/parameters/updateTaskById.ts

@@ -0,0 +1,6 @@
+import { TaskStatusUpdate } from '../models';
+
+export interface UpdateTaskById extends TaskStatusUpdate {
+  /** Global ID of the inline task to update */
+  inlineTaskId: string;
+}

package/src/api/relation.ts

@@ -56,6 +56,20 @@ export class Relation {
     return this.client.sendRequest(config, callback, { methodName: 'findTargetFromSource' });
   }
 
+  /** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
+  async GetRelationship<T = Models.Relation>(
+    parameters: Parameters.GetRelationship,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
+  async GetRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;
+  async GetRelationship<T = Models.Relation>(
+    parameters: Parameters.GetRelationship,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    return this.getRelationship(parameters, callback!);
+  }
+
   /**
    * Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships
    * are one way.
@@ -67,7 +81,7 @@ export class Relation {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.
    */
-  async GetRelationship<T = Models.Relation>(
+  async getRelationship<T = Models.Relation>(
     parameters: Parameters.GetRelationship,
     callback: Callback<T>
   ): Promise<void>;
@@ -82,8 +96,8 @@ export class Relation {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.
    */
-  async GetRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;
-  async GetRelationship<T = Models.Relation>(
+  async getRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;
+  async getRelationship<T = Models.Relation>(
     parameters: Parameters.GetRelationship,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -99,7 +113,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'GetRelationship' });
+    return this.client.sendRequest(config, callback, { methodName: 'getRelationship' });
   }
 
   /**
@@ -148,6 +162,14 @@ export class Relation {
     return this.client.sendRequest(config, callback, { methodName: 'createRelationship' });
   }
 
+  /** @deprecated Will be removed in the next major version. Use `deleteRelationship` instead. */
+  async delete<T = void>(parameters: Parameters.Delete, callback: Callback<T>): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `deleteRelationship` instead. */
+  async delete<T = void>(parameters: Parameters.Delete, callback?: never): Promise<T>;
+  async delete<T = void>(parameters: Parameters.Delete, callback?: Callback<T>): Promise<void | T> {
+    return this.deleteRelationship(parameters, callback!);
+  }
+
   /**
    * Deletes a relationship between two entities (user, space, content).
    *
@@ -155,7 +177,7 @@ export class Relation {
    * ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite
    * relationships. A space administrator can delete favourite relationships for any user.
    */
-  async delete<T = void>(parameters: Parameters.Delete, callback: Callback<T>): Promise<void>;
+  async deleteRelationship<T = void>(parameters: Parameters.DeleteRelationship, callback: Callback<T>): Promise<void>;
   /**
    * Deletes a relationship between two entities (user, space, content).
    *
@@ -163,8 +185,11 @@ export class Relation {
    * ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite
    * relationships. A space administrator can delete favourite relationships for any user.
    */
-  async delete<T = void>(parameters: Parameters.Delete, callback?: never): Promise<T>;
-  async delete<T = void>(parameters: Parameters.Delete, callback?: Callback<T>): Promise<void | T> {
+  async deleteRelationship<T = void>(parameters: Parameters.DeleteRelationship, callback?: never): Promise<T>;
+  async deleteRelationship<T = void>(
+    parameters: Parameters.DeleteRelationship,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
     const config: RequestConfig = {
       url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}/${parameters.targetKey}`,
       method: 'DELETE',
@@ -176,7 +201,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'delete' });
+    return this.client.sendRequest(config, callback, { methodName: 'deleteRelationship' });
   }
 
   /**