confluence.js 1.1.3 → 1.3.0

package/out/api/template.d.ts

@@ -22,15 +22,15 @@ export declare class Template {
     /**
      * Updates a content template. Note, blueprint templates cannot be updated via the REST API.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to create a
-     * space template or 'Confluence Administrator' global permission to create a global template.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to update a
+     * space template or 'Confluence Administrator' global permission to update a global template.
      */
     updateContentTemplate<T = Models.ContentTemplate>(parameters: Parameters.UpdateContentTemplate | undefined, callback: Callback<T>): Promise<void>;
     /**
      * Updates a content template. Note, blueprint templates cannot be updated via the REST API.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to create a
-     * space template or 'Confluence Administrator' global permission to create a global template.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to update a
+     * space template or 'Confluence Administrator' global permission to update a global template.
      */
     updateContentTemplate<T = Models.ContentTemplate>(parameters?: Parameters.UpdateContentTemplate, callback?: never): Promise<T>;
     /**
@@ -40,8 +40,9 @@ export declare class Template {
      * Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the
      * global blueprints.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
-     * ('Can use' global permission).
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+     * blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global
+     * blueprints.
      */
     getBlueprintTemplates<T = Models.BlueprintTemplateArray>(parameters: Parameters.GetBlueprintTemplates | undefined, callback: Callback<T>): Promise<void>;
     /**
@@ -51,38 +52,39 @@ export declare class Template {
      * Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the
      * global blueprints.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
-     * ('Can use' global permission).
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+     * blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global
+     * blueprints.
      */
     getBlueprintTemplates<T = Models.BlueprintTemplateArray>(parameters?: Parameters.GetBlueprintTemplates, callback?: never): Promise<T>;
     /**
      * Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to view
-     * space templates and 'Confluence Administrator' global permission to view global templates.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+     * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
      */
     getContentTemplates<T = Models.ContentTemplateArray>(parameters: Parameters.GetContentTemplates | undefined, callback: Callback<T>): Promise<void>;
     /**
      * Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to view
-     * space templates and 'Confluence Administrator' global permission to view global templates.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+     * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
      */
     getContentTemplates<T = Models.ContentTemplateArray>(parameters?: Parameters.GetContentTemplates, callback?: never): Promise<T>;
     /**
      * Returns a content template. This includes information about template, like the name, the space or blueprint that
      * the template is in, the body of the template, and more.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to view
-     * space templates and 'Confluence Administrator' global permission to view global templates.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+     * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
      */
     getContentTemplate<T = Models.ContentTemplate>(parameters: Parameters.GetContentTemplate, callback: Callback<T>): Promise<void>;
     /**
      * Returns a content template. This includes information about template, like the name, the space or blueprint that
      * the template is in, the body of the template, and more.
      *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to view
-     * space templates and 'Confluence Administrator' global permission to view global templates.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+     * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
      */
     getContentTemplate<T = Models.ContentTemplate>(parameters: Parameters.GetContentTemplate, callback?: never): Promise<T>;
     /**
@@ -94,6 +96,9 @@ export declare class Template {
      * - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template.
      *
      * Note, unmodified blueprint templates cannot be deleted.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to delete a
+     * space template or 'Confluence Administrator' global permission to delete a global template.
      */
     removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback: Callback<T>): Promise<void>;
     /**
@@ -105,6 +110,9 @@ export declare class Template {
      * - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template.
      *
      * Note, unmodified blueprint templates cannot be deleted.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to delete a
+     * space template or 'Confluence Administrator' global permission to delete a global template.
      */
     removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback?: never): Promise<T>;
 }

package/out/clients/baseClient.d.ts

@@ -1,4 +1,3 @@
-import { Telemetry } from 'telemetry.confluence.js';
 import type { Client } from './client';
 import type { Callback } from '../callback';
 import type { Config } from '../config';
@@ -6,14 +5,12 @@ import type { RequestConfig } from '../requestConfig';
 export declare class BaseClient implements Client {
     #private;
     protected readonly config: Config;
-    private telemetryClient;
     protected urlSuffix: string;
     constructor(config: Config);
     protected paramSerializer(parameters: Record<string, any>): string;
     protected encode(value: string): string;
     protected removeUndefinedProperties(obj: Record<string, any>): Record<string, any>;
     private get instance();
-    sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: Partial<Telemetry>): Promise<T>;
-    sendRequest<T>(requestConfig: RequestConfig, callback: Callback<T>, telemetryData?: Partial<Telemetry>): Promise<void>;
-    private get authenticationType();
+    sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: any): Promise<T>;
+    sendRequest<T>(requestConfig: RequestConfig, callback: Callback<T>, telemetryData?: any): Promise<void>;
 }

package/out/clients/baseClient.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = void 0;
 const tslib_1 = require("tslib");
 const axios_1 = require("axios");
-const telemetry_confluence_js_1 = require("telemetry.confluence.js");
 const authenticationService_1 = require("../services/authenticationService");
 const ATLASSIAN_TOKEN_CHECK_FLAG = 'X-Atlassian-Token';
 const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
@@ -13,7 +12,6 @@ class BaseClient {
         this.config = config;
         _BaseClient_instance.set(this, void 0);
         this.urlSuffix = '/wiki/rest/';
-        this.telemetryClient = new telemetry_confluence_js_1.TelemetryClient(config.telemetry);
     }
     paramSerializer(parameters) {
         const parts = [];
@@ -60,11 +58,9 @@ class BaseClient {
         (0, tslib_1.__classPrivateFieldSet)(this, _BaseClient_instance, axios_1.default.create(Object.assign(Object.assign({ paramsSerializer: this.paramSerializer.bind(this) }, this.config.baseRequestConfig), { baseURL: `${this.config.host}${this.urlSuffix}`, headers: this.removeUndefinedProperties(Object.assign({ [ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken ? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE : undefined }, (_a = this.config.baseRequestConfig) === null || _a === void 0 ? void 0 : _a.headers)) })), "f");
         return (0, tslib_1.__classPrivateFieldGet)(this, _BaseClient_instance, "f");
     }
-    sendRequest(requestConfig, callback, telemetryData) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+    sendRequest(requestConfig, callback) {
+        var _a, _b, _c, _d;
         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);
             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,
@@ -75,8 +71,7 @@ class BaseClient {
                 const callbackResponseHandler = callback && ((data) => callback(null, data));
                 const defaultResponseHandler = (data) => data;
                 const responseHandler = callbackResponseHandler !== null && callbackResponseHandler !== void 0 ? callbackResponseHandler : defaultResponseHandler;
-                (_d = (_c = this.config.middlewares) === null || _c === void 0 ? void 0 : _c.onResponse) === null || _d === void 0 ? void 0 : _d.call(_c, response.data);
-                telemetry.requestStatusCode = response.status;
+                (_b = (_a = this.config.middlewares) === null || _a === void 0 ? void 0 : _a.onResponse) === null || _b === void 0 ? void 0 : _b.call(_a, response.data);
                 return responseHandler(response.data);
             }
             catch (e) {
@@ -85,32 +80,11 @@ class BaseClient {
                     throw error;
                 };
                 const errorHandler = callbackErrorHandler !== null && callbackErrorHandler !== void 0 ? callbackErrorHandler : defaultErrorHandler;
-                (_f = (_e = this.config.middlewares) === null || _e === void 0 ? void 0 : _e.onError) === null || _f === void 0 ? void 0 : _f.call(_e, e);
-                telemetry.requestStatusCode = e.isAxiosError ? (_h = (_g = e.response) === null || _g === void 0 ? void 0 : _g.status) !== null && _h !== void 0 ? _h : 0 : 418;
+                (_d = (_c = this.config.middlewares) === null || _c === void 0 ? void 0 : _c.onError) === null || _d === void 0 ? void 0 : _d.call(_c, e);
                 return errorHandler(e);
             }
-            finally {
-                telemetry.requestEndTime = new Date();
-                this.telemetryClient.sendTelemetry(telemetry);
-            }
         });
     }
-    get authenticationType() {
-        const { authentication } = this.config;
-        if (!authentication) {
-            return telemetry_confluence_js_1.Authentication.None;
-        }
-        if (authentication.basic) {
-            return telemetry_confluence_js_1.Authentication.Basic;
-        }
-        if (authentication.oauth2) {
-            return telemetry_confluence_js_1.Authentication.OAuth2;
-        }
-        if (authentication.jwt) {
-            return telemetry_confluence_js_1.Authentication.JWT;
-        }
-        return telemetry_confluence_js_1.Authentication.NA;
-    }
 }
 exports.BaseClient = BaseClient;
 _BaseClient_instance = new WeakMap();

package/out/clients/client.d.ts

@@ -1,7 +1,6 @@
-import type { Telemetry } from 'telemetry.confluence.js';
 import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 export interface Client {
-    sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: Partial<Telemetry>): Promise<T>;
-    sendRequest<T>(requestConfig: RequestConfig, callback?: Callback<T>, telemetryData?: Partial<Telemetry>): Promise<void>;
+    sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: any): Promise<T>;
+    sendRequest<T>(requestConfig: RequestConfig, callback?: Callback<T>, telemetryData?: any): Promise<void>;
 }

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/out/config.d.ts

@@ -1,5 +1,4 @@
 import { AxiosError } from 'axios';
-import type { TelemetryConfig } from 'telemetry.confluence.js';
 import type { RequestConfig } from './requestConfig';
 import type { UtilityTypes } from './utilityTypes';
 export interface Config {
@@ -7,6 +6,7 @@ export interface Config {
     baseRequestConfig?: Config.BaseRequestConfig;
     authentication?: Config.Authentication;
     middlewares?: Config.Middlewares;
+    /** @deprecated Disabled. Will be removed in the next major version. */
     telemetry?: Config.Telemetry;
     /**
      * Adds `'X-Atlassian-Token': 'no-check'` to each request header
@@ -16,7 +16,8 @@ export interface Config {
 export declare namespace Config {
     type BaseRequestConfig = RequestConfig;
     type Error = AxiosError;
-    type Telemetry = boolean | TelemetryConfig;
+    /** @deprecated Disabled. Will be removed in the next major version. */
+    type Telemetry = boolean | any;
     type Authentication = UtilityTypes.XOR<{
         jwt: Authentication.JWT;
     }, UtilityTypes.XOR<{

package/out/index.d.ts

@@ -3,5 +3,6 @@ export * from './config';
 export * from './requestConfig';
 export * from './callback';
 export * as Api from './api';
+export * as Server from './server';
 export * as Models from './api/models';
 export * as Parameters from './api/parameters';

package/out/index.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Parameters = exports.Models = exports.Api = void 0;
+exports.Parameters = exports.Models = exports.Server = exports.Api = void 0;
 const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./clients"), exports);
 (0, tslib_1.__exportStar)(require("./config"), exports);
 (0, tslib_1.__exportStar)(require("./requestConfig"), exports);
 (0, tslib_1.__exportStar)(require("./callback"), exports);
 exports.Api = require("./api");
+exports.Server = require("./server");
 exports.Models = require("./api/models");
 exports.Parameters = require("./api/parameters");

package/package.json

@@ -1,17 +1,21 @@
 {
   "name": "confluence.js",
-  "version": "1.1.3",
+  "version": "1.3.0",
   "description": "confluence.js is a powerful Node.JS/Browser module that allows you to interact with the Confluence API very easily",
+  "author": "Vladislav Tupikin <mrrefactoring@yandex.ru>",
+  "license": "MIT",
+  "homepage": "https://mrrefactoring.github.io/confluence.js",
+  "repository": "https://github.com/MrRefactoring/confluence.js.git",
   "main": "out/index.js",
   "types": "out/index.d.ts",
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "npm run build && npm run test && npm run lint",
     "test": "npm run test:unit && npm run test:e2e",
-    "test:unit": "jest tests/unit",
+    "test:unit": "jest tests/unit --verbose",
     "test:e2e": "jest tests/e2e --setupFiles=./tests/setup.ts --runInBand",
     "prettier": "prettier --write src/**/*.ts",
-    "doc": "typedoc --name Confluence.js --out docs ./src",
+    "doc": "typedoc --name \"Confluence.js - Cloud and Server API library\" --out docs ./src/index.ts --plugin typedoc-plugin-extras --footerDate --footerTime --footerTypedocVersion --favicon https://svgshare.com/i/bVi.svg",
     "lint": "eslint src --ext .ts",
     "lint:fix": "npm run lint -- --fix"
   },
@@ -19,7 +23,6 @@
     "preset": "ts-jest",
     "testEnvironment": "node"
   },
-  "repository": "https://github.com/MrRefactoring/confluence.js.git",
   "keywords": [
     "confluence",
     "api",
@@ -29,35 +32,32 @@
     "wiki",
     "atlassian"
   ],
-  "author": "Vladislav Tupikin <mrrefactoring@yandex.ru>",
-  "license": "MIT",
-  "homepage": "https://github.com/MrRefactoring/confluence.js#readme",
   "devDependencies": {
     "@types/express": "^4.17.13",
-    "@types/jest": "^26.0.24",
+    "@types/jest": "^27.0.3",
     "@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.6",
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
+    "@typescript-eslint/parser": "^5.6.0",
     "dotenv": "^10.0.0",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb": "^18.2.1",
-    "eslint-config-airbnb-typescript": "^14.0.0",
+    "eslint": "^8.4.1",
+    "eslint-config-airbnb": "^19.0.2",
+    "eslint-config-airbnb-typescript": "^16.1.0",
     "eslint-import-resolver-typescript": "^2.5.0",
-    "eslint-plugin-import": "^2.24.2",
-    "jest": "^26.6.3",
-    "prettier": "^2.4.0",
-    "prettier-plugin-jsdoc": "^0.3.24",
-    "sinon": "^11.1.2",
-    "ts-jest": "^26.5.6",
-    "typedoc": "^0.22.3",
-    "typescript": "^4.4.3"
+    "eslint-plugin-import": "^2.25.3",
+    "jest": "^27.4.3",
+    "prettier": "^2.5.1",
+    "prettier-plugin-jsdoc": "^0.3.30",
+    "sinon": "^12.0.1",
+    "ts-jest": "^27.1.1",
+    "typedoc": "^0.22.10",
+    "typedoc-plugin-extras": "^2.2.1",
+    "typescript": "^4.5.2"
   },
   "dependencies": {
     "atlassian-jwt": "^2.0.2",
-    "axios": "^0.21.4",
+    "axios": "^0.24.0",
     "oauth": "^0.9.15",
-    "telemetry.confluence.js": "<2",
     "tslib": "^2.3.1"
   }
 }

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):
@@ -314,6 +319,7 @@ export class Content {
         version: parameters.version,
         embeddedContentRender: parameters.embeddedContentRender,
         trigger: parameters.trigger,
+        expand: parameters.expand,
       },
     };
 

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,27 @@ 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 = ArrayBuffer>(
+    parameters: Parameters.DownloadAttachment,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Redirects the client to a URL that serves an attachment's binary data. */
+  async downloadAttachment<T = ArrayBuffer>(parameters: Parameters.DownloadAttachment, callback?: never): Promise<T>;
+  async downloadAttachment<T = ArrayBuffer>(
+    parameters: Parameters.DownloadAttachment,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.id}/child/attachment/${parameters.attachmentId}/download`,
+      method: 'GET',
+      responseType: 'arraybuffer',
+      params: {
+        version: parameters.version,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'downloadAttachment' });
+  }
 }