confluence.js 1.1.3 → 1.2.0

package/out/api/search.js

@@ -7,6 +7,11 @@ class Search {
         this.client = client;
     }
     search(parameters, callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            return this.searchByCQL(parameters, callback);
+        });
+    }
+    searchByCQL(parameters, callback) {
         return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/search',
@@ -15,14 +20,26 @@ class Search {
                     cql: parameters.cql,
                     cqlcontext: parameters.cqlcontext,
                     cursor: parameters.cursor,
+                    next: parameters.next,
+                    prev: parameters.prev,
                     limit: parameters.limit,
+                    start: parameters.start,
                     includeArchivedSpaces: parameters.includeArchivedSpaces,
+                    excludeCurrentSpaces: parameters.excludeCurrentSpaces,
+                    excerpt: parameters.excerpt,
+                    sitePermissionTypeFilter: parameters.sitePermissionTypeFilter,
+                    expand: parameters.expand,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'search' });
+            return this.client.sendRequest(config, callback, { methodName: 'searchByCQL' });
         });
     }
     userSearch(parameters, callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            return this.searchUser(parameters, callback);
+        });
+    }
+    searchUser(parameters, callback) {
         return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/search/user',
@@ -33,7 +50,7 @@ class Search {
                     limit: parameters.limit,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'search' });
+            return this.client.sendRequest(config, callback, { methodName: 'searchUser' });
         });
     }
 }

package/out/api/settings.d.ts

@@ -48,7 +48,7 @@ export declare class Settings {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      */
-    updateLookAndFeelSettings<T = Models.LookAndFeelUpdated>(parameters: Parameters.UpdateLookAndFeelSettings | undefined, callback: Callback<T>): Promise<void>;
+    updateLookAndFeelSettings<T = Models.LookAndFeel>(parameters: Parameters.UpdateLookAndFeelSettings | undefined, callback: Callback<T>): Promise<void>;
     /**
      * Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated.
      * If no custom settings exist, then a set of custom settings is created.
@@ -58,7 +58,7 @@ export declare class Settings {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      */
-    updateLookAndFeelSettings<T = Models.LookAndFeelUpdated>(parameters?: Parameters.UpdateLookAndFeelSettings, callback?: never): Promise<T>;
+    updateLookAndFeelSettings<T = Models.LookAndFeel>(parameters?: Parameters.UpdateLookAndFeelSettings, callback?: never): Promise<T>;
     /**
      * Resets the custom look and feel settings for the site or a single space. This changes the values of the custom
      * settings to be the same as the default settings. It does not change which settings (default or custom) are

package/out/api/settings.js

@@ -44,8 +44,11 @@ class Settings {
                     links: parameters === null || parameters === void 0 ? void 0 : parameters.links,
                     menus: parameters === null || parameters === void 0 ? void 0 : parameters.menus,
                     header: parameters === null || parameters === void 0 ? void 0 : parameters.header,
+                    horizontalHeader: parameters === null || parameters === void 0 ? void 0 : parameters.horizontalHeader,
                     content: parameters === null || parameters === void 0 ? void 0 : parameters.content,
                     bordersAndDividers: parameters === null || parameters === void 0 ? void 0 : parameters.bordersAndDividers,
+                    spaceReference: parameters === null || parameters === void 0 ? void 0 : parameters.spaceReference,
+                    _links: parameters === null || parameters === void 0 ? void 0 : parameters.links,
                 },
             };
             return this.client.sendRequest(config, callback, { methodName: 'updateLookAndFeelSettings' });

package/out/api/space.js

@@ -50,6 +50,7 @@ class Space {
                     key: parameters === null || parameters === void 0 ? void 0 : parameters.key,
                     name: parameters === null || parameters === void 0 ? void 0 : parameters.name,
                     description: parameters === null || parameters === void 0 ? void 0 : parameters.description,
+                    permissions: parameters === null || parameters === void 0 ? void 0 : parameters.permissions,
                 },
             };
             return this.client.sendRequest(config, callback, { methodName: 'createPrivateSpace' });
@@ -73,6 +74,8 @@ class Space {
                     name: parameters.name,
                     description: parameters.description,
                     homepage: parameters.homepage,
+                    type: parameters.type,
+                    status: parameters.status,
                 },
             };
             return this.client.sendRequest(config, callback, { methodName: 'updateSpace' });

package/out/api/spacePermissions.d.ts

@@ -5,6 +5,10 @@ import { Callback } from '../callback';
 export declare class SpacePermissions {
     private client;
     constructor(client: Client);
+    /** @deprecated Will be removed in the next major version. Use `addPermissionToSpace` instead. */
+    addPermission<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermission, callback: Callback<T>): Promise<void>;
+    /** @deprecated Will be removed in the next major version. Use `addPermissionToSpace` instead. */
+    addPermission<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermission, callback?: never): Promise<T>;
     /**
      * Adds new permission to space.
      *
@@ -14,7 +18,7 @@ export declare class SpacePermissions {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      */
-    addPermission<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermission, callback: Callback<T>): Promise<void>;
+    addPermissionToSpace<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermissionToSpace, callback: Callback<T>): Promise<void>;
     /**
      * Adds new permission to space.
      *
@@ -24,7 +28,27 @@ export declare class SpacePermissions {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      */
-    addPermission<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermission, callback?: never): Promise<T>;
+    addPermissionToSpace<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermissionToSpace, callback?: never): Promise<T>;
+    /**
+     * Adds new custom content permission to space.
+     *
+     * If the permission to be added is a group permission, the group can be identified by its group name or group id.
+     *
+     * Note: Only apps can access this REST resource and only make changes to the respective app permissions.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
+     */
+    addCustomContentPermissions<T = unknown>(parameters: Parameters.AddCustomContentPermissions, callback: Callback<T>): Promise<void>;
+    /**
+     * Adds new custom content permission to space.
+     *
+     * If the permission to be added is a group permission, the group can be identified by its group name or group id.
+     *
+     * Note: Only apps can access this REST resource and only make changes to the respective app permissions.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
+     */
+    addCustomContentPermissions<T = unknown>(parameters: Parameters.AddCustomContentPermissions, callback?: never): Promise<T>;
     /**
      * Removes a space permission. Note that removing Read Space permission for a user or group will remove all the space
      * permissions for that user or group.

package/out/api/spacePermissions.js

@@ -7,18 +7,35 @@ class SpacePermissions {
         this.client = client;
     }
     addPermission(parameters, callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            return this.addPermissionToSpace(parameters, callback);
+        });
+    }
+    addPermissionToSpace(parameters, callback) {
         return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/space/${parameters.spaceKey}/permission`,
                 method: 'POST',
                 data: {
-                    id: parameters.id,
                     subject: parameters.subject,
                     operation: parameters.operation,
-                    _links: parameters._links,
+                    _links: parameters.links,
+                },
+            };
+            return this.client.sendRequest(config, callback, { methodName: 'addPermissionToSpace' });
+        });
+    }
+    addCustomContentPermissions(parameters, callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            const config = {
+                url: `/api/space/${parameters.spaceKey}/permission/custom-content`,
+                method: 'POST',
+                data: {
+                    subject: parameters.subject,
+                    operations: parameters.operations,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'addPermission' });
+            return this.client.sendRequest(config, callback, { methodName: 'addCustomContentPermissions' });
         });
     }
     removePermission(parameters, callback) {

package/out/api/spaceProperties.d.ts

@@ -42,15 +42,15 @@ export declare class SpaceProperties {
      */
     getSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.GetSpaceProperty, callback?: never): Promise<T>;
     /**
-     * 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.
+     * 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.
      *
      * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
      */
     createSpacePropertyForKey<T = Models.SpaceProperty>(parameters: Parameters.CreateSpacePropertyForKey, callback: Callback<T>): Promise<void>;
     /**
-     * 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.
+     * 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.
      *
      * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
      */

package/out/api/spaceProperties.js

@@ -28,6 +28,7 @@ class SpaceProperties {
                 data: {
                     key: parameters.key,
                     value: parameters.value,
+                    space: parameters.space,
                 },
             };
             return this.client.sendRequest(config, callback, { methodName: 'createSpaceProperty' });

package/out/clients/baseClient.js

@@ -64,7 +64,7 @@ class BaseClient {
         var _a, _b, _c, _d, _e, _f, _g, _h;
         return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
             const startDateTime = new Date();
-            const telemetry = Object.assign({ authentication: this.authenticationType, baseRequestConfigUsed: !!this.config.baseRequestConfig, bodyExists: !!requestConfig.data, callbackUsed: !!callback, headersExists: !!requestConfig.headers, libVersion: '1.1.3', libVersionHash: '6d8c23a768aec9eefc52917e68aa3926', methodName: (telemetryData === null || telemetryData === void 0 ? void 0 : telemetryData.methodName) || 'sendRequest', onErrorMiddlewareUsed: !!((_a = this.config.middlewares) === null || _a === void 0 ? void 0 : _a.onError), onResponseMiddlewareUsed: !!((_b = this.config.middlewares) === null || _b === void 0 ? void 0 : _b.onResponse), queryExists: !!requestConfig.params, requestEndTime: new Date(), requestStartTime: startDateTime, requestStatusCode: 0, noCheckAtlassianToken: !!this.config.noCheckAtlassianToken }, telemetryData);
+            const telemetry = Object.assign({ authentication: this.authenticationType, baseRequestConfigUsed: !!this.config.baseRequestConfig, bodyExists: !!requestConfig.data, callbackUsed: !!callback, headersExists: !!requestConfig.headers, libVersion: '1.2.0', libVersionHash: '0ba4439ee9a46d9d9f14c60f88f45f87', methodName: (telemetryData === null || telemetryData === void 0 ? void 0 : telemetryData.methodName) || 'sendRequest', onErrorMiddlewareUsed: !!((_a = this.config.middlewares) === null || _a === void 0 ? void 0 : _a.onError), onResponseMiddlewareUsed: !!((_b = this.config.middlewares) === null || _b === void 0 ? void 0 : _b.onResponse), queryExists: !!requestConfig.params, requestEndTime: new Date(), requestStartTime: startDateTime, requestStatusCode: 0, noCheckAtlassianToken: !!this.config.noCheckAtlassianToken }, telemetryData);
             try {
                 const modifiedRequestConfig = Object.assign(Object.assign({}, requestConfig), { headers: this.removeUndefinedProperties(Object.assign({ Authorization: yield authenticationService_1.AuthenticationService.getAuthenticationToken(this.config.authentication, {
                             baseURL: this.config.host,

package/out/clients/confluenceClient.d.ts

@@ -1,5 +1,5 @@
 import { BaseClient } from './baseClient';
-import { Audit, Content, ContentAttachments, ContentBody, ContentChildrenAndDescendants, ContentComments, ContentLabels, ContentMacroBody, ContentPermissions, ContentProperties, ContentRestrictions, ContentVersions, ContentWatches, DynamicModules, Group, InlineTasks, LabelInfo, LongRunningTask, Relation, Search, Settings, Space, SpacePermissions, SpaceProperties, SpaceSettings, Template, Themes, Users } from '../api';
+import { Audit, Content, ContentAttachments, ContentBody, ContentChildrenAndDescendants, ContentComments, ContentLabels, ContentMacroBody, ContentPermissions, ContentProperties, ContentRestrictions, ContentVersions, ContentWatches, DynamicModules, Experimental, Group, InlineTasks, LabelInfo, LongRunningTask, Relation, Search, Settings, Space, SpacePermissions, SpaceProperties, SpaceSettings, Template, Themes, Users } from '../api';
 export declare class ConfluenceClient extends BaseClient {
     audit: Audit;
     content: Content;
@@ -15,6 +15,7 @@ export declare class ConfluenceClient extends BaseClient {
     contentVersions: ContentVersions;
     contentWatches: ContentWatches;
     dynamicModules: DynamicModules;
+    experimental: Experimental;
     group: Group;
     inlineTasks: InlineTasks;
     labelInfo: LabelInfo;

package/out/clients/confluenceClient.js

@@ -20,6 +20,7 @@ class ConfluenceClient extends baseClient_1.BaseClient {
         this.contentVersions = new api_1.ContentVersions(this);
         this.contentWatches = new api_1.ContentWatches(this);
         this.dynamicModules = new api_1.DynamicModules(this);
+        this.experimental = new api_1.Experimental(this);
         this.group = new api_1.Group(this);
         this.inlineTasks = new api_1.InlineTasks(this);
         this.labelInfo = new api_1.LabelInfo(this);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "confluence.js",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "confluence.js is a powerful Node.JS/Browser module that allows you to interact with the Confluence API very easily",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -36,9 +36,9 @@
     "@types/express": "^4.17.13",
     "@types/jest": "^26.0.24",
     "@types/oauth": "^0.9.1",
-    "@types/sinon": "^10.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.31.1",
-    "@typescript-eslint/parser": "^4.31.1",
+    "@types/sinon": "^10.0.4",
+    "@typescript-eslint/eslint-plugin": "^4.32.0",
+    "@typescript-eslint/parser": "^4.32.0",
     "dotenv": "^10.0.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb": "^18.2.1",
@@ -46,11 +46,11 @@
     "eslint-import-resolver-typescript": "^2.5.0",
     "eslint-plugin-import": "^2.24.2",
     "jest": "^26.6.3",
-    "prettier": "^2.4.0",
+    "prettier": "^2.4.1",
     "prettier-plugin-jsdoc": "^0.3.24",
     "sinon": "^11.1.2",
     "ts-jest": "^26.5.6",
-    "typedoc": "^0.22.3",
+    "typedoc": "^0.22.4",
     "typescript": "^4.4.3"
   },
   "dependencies": {

package/src/api/content.ts

@@ -102,6 +102,45 @@ export class Content {
     return this.client.sendRequest(config, callback, { methodName: 'createContent' });
   }
 
+  /**
+   * Archives a list of pages. The pages to be archived are specified as a list of content IDs. This API accepts the
+   * archival request and returns a task ID. The archival process happens asynchronously. Use the /longtask/<taskId>
+   * REST API to get the copy task status.
+   *
+   * Each content ID needs to resolve to page objects that are not already in an archived state. The content IDs need
+   * not belong to the same space.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Archive' permission for each of the pages
+   * in the corresponding space it belongs to.
+   */
+  async archivePages<T = unknown>(
+    parameters: Parameters.ArchivePages,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Archives a list of pages. The pages to be archived are specified as a list of content IDs. This API accepts the
+   * archival request and returns a task ID. The archival process happens asynchronously. Use the /longtask/<taskId>
+   * REST API to get the copy task status.
+   *
+   * Each content ID needs to resolve to page objects that are not already in an archived state. The content IDs need
+   * not belong to the same space.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Archive' permission for each of the pages
+   * in the corresponding space it belongs to.
+   */
+  async archivePages<T = unknown>(parameters: Parameters.ArchivePages, callback?: never): Promise<T>;
+  async archivePages<T = unknown>(parameters: Parameters.ArchivePages, callback?: Callback<T>): Promise<void | T> {
+    const config: RequestConfig = {
+      url: '/api/content/archive',
+      method: 'POST',
+      data: {
+        pages: parameters.pages,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'archivePages' });
+  }
+
   /**
    * Publishes a legacy draft of a page created from a blueprint. Legacy drafts will eventually be removed in favor of
    * shared drafts. For now, this method works the same as [Publish shared draft](#api-content-blueprint-instance-draftId-put).
@@ -135,6 +174,15 @@ export class Content {
       params: {
         status: parameters.status,
       },
+      data: {
+        ...parameters,
+        version: parameters.version,
+        title: parameters.title,
+        type: parameters.type,
+        status: parameters.bodyStatus,
+        space: parameters.space,
+        ancestors: parameters.ancestors,
+      },
     };
 
     return this.client.sendRequest(config, callback, { methodName: 'publishLegacyDraft' });
@@ -171,6 +219,15 @@ export class Content {
       params: {
         status: parameters.status,
       },
+      data: {
+        ...parameters,
+        version: parameters.version,
+        title: parameters.title,
+        type: parameters.type,
+        status: parameters.bodyStatus,
+        space: parameters.space,
+        ancestors: parameters.ancestors,
+      },
     };
 
     return this.client.sendRequest(config, callback, { methodName: 'publishSharedDraft' });
@@ -180,32 +237,6 @@ export class Content {
    * Returns the list of content that matches a Confluence Query Language (CQL) query. For information on CQL, see:
    * [Advanced searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
-   * Example initial call:
-   * ```
-   * https://your-domain.atlassian.net/wiki/rest/api/content/search?cql=type=page&limit=25
-   * ```
-   *
-   * Example response:
-   * ```
-   * {
-   *   "results": [
-   *     { ... },
-   *     { ... },
-   *     ...
-   *     { ... }
-   *   ],
-   *   "limit": 25,
-   *   "size": 25,
-   *   ...
-   *   "_links": {
-   *     "base": "<url>",
-   *     "context": "<url>",
-   *     "next": "/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
-   *     "self": "<url>"
-   *   }
-   * }
-   * ```
-   *
    * When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The
    * URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of
    * results returned in each call. Example subsequent call (taken from example response):
@@ -225,32 +256,6 @@ export class Content {
    * Returns the list of content that matches a Confluence Query Language (CQL) query. For information on CQL, see:
    * [Advanced searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
-   * Example initial call:
-   * ```
-   * https://your-domain.atlassian.net/wiki/rest/api/content/search?cql=type=page&limit=25
-   * ```
-   *
-   * Example response:
-   * ```
-   * {
-   *   "results": [
-   *     { ... },
-   *     { ... },
-   *     ...
-   *     { ... }
-   *   ],
-   *   "limit": 25,
-   *   "size": 25,
-   *   ...
-   *   "_links": {
-   *     "base": "<url>",
-   *     "context": "<url>",
-   *     "next": "/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
-   *     "self": "<url>"
-   *   }
-   * }
-   * ```
-   *
    * When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The
    * URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of
    * results returned in each call. Example subsequent call (taken from example response):

package/src/api/contentAttachments.ts

@@ -56,7 +56,7 @@ export class ContentAttachments {
    *
    * The media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt). Most client
    * libraries have classes that make it easier to implement multipart posts, like the
-   * [MultipartEntityBuilder](http://hc.apache.org/httpcomponents-client-5.0.x/current/httpclient5/apidocs/) Java class
+   * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/) Java class
    * provided by Apache HTTP Components.
    *
    * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5), in the case where the form data is
@@ -92,7 +92,7 @@ export class ContentAttachments {
    *
    * The media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt). Most client
    * libraries have classes that make it easier to implement multipart posts, like the
-   * [MultipartEntityBuilder](http://hc.apache.org/httpcomponents-client-5.0.x/current/httpclient5/apidocs/) Java class
+   * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/) Java class
    * provided by Apache HTTP Components.
    *
    * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5), in the case where the form data is
@@ -148,7 +148,7 @@ export class ContentAttachments {
    *
    * The media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt). Most client
    * libraries have classes that make it easier to implement multipart posts, like the
-   * [MultipartEntityBuilder](http://hc.apache.org/httpcomponents-client-5.0.x/current/httpclient5/apidocs/) Java class
+   * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/) Java class
    * provided by Apache HTTP Components.
    *
    * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5), in the case where the form data is
@@ -185,7 +185,7 @@ export class ContentAttachments {
    *
    * The media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt). Most client
    * libraries have classes that make it easier to implement multipart posts, like the
-   * [MultipartEntityBuilder](http://hc.apache.org/httpcomponents-client-5.0.x/current/httpclient5/apidocs/) Java class
+   * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/) Java class
    * provided by Apache HTTP Components.
    *
    * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5), in the case where the form data is
@@ -277,7 +277,7 @@ export class ContentAttachments {
    *
    * The media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt). Most client
    * libraries have classes that make it easier to implement multipart posts, like the
-   * [MultipartEntityBuilder](http://hc.apache.org/httpcomponents-client-5.0.x/current/httpclient5/apidocs/) Java class
+   * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/) Java class
    * provided by Apache HTTP Components.
    *
    * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5), in the case where the form data is
@@ -316,7 +316,7 @@ export class ContentAttachments {
    *
    * The media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt). Most client
    * libraries have classes that make it easier to implement multipart posts, like the
-   * [MultipartEntityBuilder](http://hc.apache.org/httpcomponents-client-5.0.x/current/httpclient5/apidocs/) Java class
+   * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/) Java class
    * provided by Apache HTTP Components.
    *
    * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5), in the case where the form data is
@@ -360,4 +360,26 @@ export class ContentAttachments {
 
     return this.client.sendRequest(config, callback, { methodName: 'updateAttachmentData' });
   }
+
+  /** Redirects the client to a URL that serves an attachment's binary data. */
+  async downloadAttachment<T = unknown>(
+    parameters: Parameters.DownloadAttachment,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Redirects the client to a URL that serves an attachment's binary data. */
+  async downloadAttachment<T = unknown>(parameters: Parameters.DownloadAttachment, callback?: never): Promise<T>;
+  async downloadAttachment<T = unknown>(
+    parameters: Parameters.DownloadAttachment,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.id}/child/attachment/${parameters.attachmentId}/download`,
+      method: 'GET',
+      params: {
+        version: parameters.version,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'downloadAttachment' });
+  }
 }

package/src/api/contentChildrenAndDescendants.ts

@@ -218,6 +218,23 @@ export class ContentChildrenAndDescendants {
     return this.client.sendRequest(config, callback, { methodName: 'getContentDescendants' });
   }
 
+  /** @deprecated This API will be removed in the next major version. Use `getDescendantsOfType` method instead. */
+  async descendantsOfType<T = Models.ContentArray>(
+    parameters: Parameters.DescendantsOfType,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated This API will be removed in the next major version. Use `getDescendantsOfType` method instead. */
+  async descendantsOfType<T = Models.ContentArray>(
+    parameters: Parameters.DescendantsOfType,
+    callback?: never
+  ): Promise<T>;
+  async descendantsOfType<T = Models.ContentArray>(
+    parameters: Parameters.DescendantsOfType,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    return this.getDescendantsOfType(parameters, callback!);
+  }
+
   /**
    * Returns all descendants of a given type, for a piece of content. This is similar to [Get content children by
    * type](#api-content-id-child-type-get), except that this method returns child pages at all levels, rather than just
@@ -235,8 +252,8 @@ export class ContentChildrenAndDescendants {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
    * permission to view the content if it is a page.
    */
-  async descendantsOfType<T = Models.ContentArray>(
-    parameters: Parameters.DescendantsOfType,
+  async getDescendantsOfType<T = Models.ContentArray>(
+    parameters: Parameters.GetDescendantsOfType,
     callback: Callback<T>
   ): Promise<void>;
   /**
@@ -256,12 +273,12 @@ export class ContentChildrenAndDescendants {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
    * permission to view the content if it is a page.
    */
-  async descendantsOfType<T = Models.ContentArray>(
-    parameters: Parameters.DescendantsOfType,
+  async getDescendantsOfType<T = Models.ContentArray>(
+    parameters: Parameters.GetDescendantsOfType,
     callback?: never
   ): Promise<T>;
-  async descendantsOfType<T = Models.ContentArray>(
-    parameters: Parameters.DescendantsOfType,
+  async getDescendantsOfType<T = Models.ContentArray>(
+    parameters: Parameters.GetDescendantsOfType,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
@@ -271,6 +288,7 @@ export class ContentChildrenAndDescendants {
         depth: parameters.depth,
         start: parameters.start,
         limit: parameters.limit,
+        expand: parameters.expand,
       },
     };
 
@@ -283,17 +301,6 @@ export class ContentChildrenAndDescendants {
    * copied page is defined using the destinationPageId in the request body. The titleOptions object defines the rules
    * of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the
    * copied page titles.
-   *
-   *  Response example:
-   *  <pre>
-   *  {
-   *       "id" : "1180606",
-   *       "links" : {
-   *            "status" : "/rest/api/longtask/1180606"
-   *       }
-   *  }
-   *  </pre>
-   *  Use the /longtask/<taskId> REST API to get the copy task status.
    */
   async copyPageHierarchy<T = unknown>(parameters: Parameters.CopyPageHierarchy, callback: Callback<T>): Promise<void>;
   /**
@@ -302,17 +309,6 @@ export class ContentChildrenAndDescendants {
    * copied page is defined using the destinationPageId in the request body. The titleOptions object defines the rules
    * of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the
    * copied page titles.
-   *
-   *  Response example:
-   *  <pre>
-   *  {
-   *       "id" : "1180606",
-   *       "links" : {
-   *            "status" : "/rest/api/longtask/1180606"
-   *       }
-   *  }
-   *  </pre>
-   *  Use the /longtask/<taskId> REST API to get the copy task status.
    */
   async copyPageHierarchy<T = unknown>(parameters: Parameters.CopyPageHierarchy, callback?: never): Promise<T>;
   async copyPageHierarchy<T = unknown>(