confluence.js 1.1.3 → 1.3.0

package/src/api/search.ts

@@ -7,95 +7,52 @@ import { RequestConfig } from '../requestConfig';
 export class Search {
   constructor(private client: Client) {}
 
+  /** @deprecated Will be removed in the next major version. Use `searchByCQL` instead. */
+  async search<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.Search,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `searchByCQL` instead. */
+  async search<T = Models.SearchPageResponseSearchResult>(parameters: Parameters.Search, callback?: never): Promise<T>;
+  async search<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.Search,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    return this.searchByCQL(parameters, callback!);
+  }
+
   /**
    * Searches for content using the [Confluence Query Language
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)
    *
-   * Example initial call:
-   *
-   *     https://your-domain.atlassian.net/wiki/rest/api/search?cql=type=page&limit=25
-   *
-   * Example response:
-   *
-   *     {
-   *       "results": [
-   *         { ... },
-   *         { ... },
-   *         ...
-   *         { ... }
-   *       ],
-   *       "limit": 25,
-   *       "size": 25,
-   *       ...
-   *       "_links": {
-   *         "base": "<url>",
-   *         "context": "<url>",
-   *         "next": "/rest/api/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):
-   *
-   *     https://your-domain.atlassian.net/wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
-   *
-   * The response to this will have a `prev` URL similar to the `next` in the example response.
-   *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the entities. Note, only
    * entities that the user has permission to view will be returned.
    */
-  async search<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.Search,
+  async searchByCQL<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchByCQL,
     callback: Callback<T>
   ): Promise<void>;
   /**
    * Searches for content using the [Confluence Query Language
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)
    *
-   * Example initial call:
-   *
-   *     https://your-domain.atlassian.net/wiki/rest/api/search?cql=type=page&limit=25
-   *
-   * Example response:
-   *
-   *     {
-   *       "results": [
-   *         { ... },
-   *         { ... },
-   *         ...
-   *         { ... }
-   *       ],
-   *       "limit": 25,
-   *       "size": 25,
-   *       ...
-   *       "_links": {
-   *         "base": "<url>",
-   *         "context": "<url>",
-   *         "next": "/rest/api/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):
-   *
-   *     https://your-domain.atlassian.net/wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
-   *
-   * The response to this will have a `prev` URL similar to the `next` in the example response.
-   *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the entities. Note, only
    * entities that the user has permission to view will be returned.
    */
-  async search<T = Models.SearchPageResponseSearchResult>(parameters: Parameters.Search, callback?: never): Promise<T>;
-  async search<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.Search,
+  async searchByCQL<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchByCQL,
+    callback?: never
+  ): Promise<T>;
+  async searchByCQL<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchByCQL,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
@@ -105,14 +62,37 @@ export 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' });
   }
 
+  /** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
+  async userSearch<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.UserSearch,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
+  async userSearch<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.UserSearch,
+    callback?: never
+  ): Promise<T>;
+  async userSearch<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.UserSearch,
+    callback?: Callback<T>,
+  ): 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/).
@@ -120,8 +100,8 @@ export class Search {
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
    * profilePicture, and displayName.
    */
-  async userSearch<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.UserSearch,
+  async searchUser<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchUser,
     callback: Callback<T>
   ): Promise<void>;
   /**
@@ -131,12 +111,12 @@ export class Search {
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
    * profilePicture, and displayName.
    */
-  async userSearch<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.UserSearch,
+  async searchUser<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchUser,
     callback?: never
   ): Promise<T>;
-  async userSearch<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.UserSearch,
+  async searchUser<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchUser,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
@@ -149,6 +129,6 @@ export class Search {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'search' });
+    return this.client.sendRequest(config, callback, { methodName: 'searchUser' });
   }
 }

package/src/api/settings.ts

@@ -93,7 +93,7 @@ export class Settings {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async updateLookAndFeelSettings<T = Models.LookAndFeelUpdated>(
+  async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters: Parameters.UpdateLookAndFeelSettings | undefined,
     callback: Callback<T>
   ): Promise<void>;
@@ -106,11 +106,11 @@ export class Settings {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async updateLookAndFeelSettings<T = Models.LookAndFeelUpdated>(
+  async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters?: Parameters.UpdateLookAndFeelSettings,
     callback?: never
   ): Promise<T>;
-  async updateLookAndFeelSettings<T = Models.LookAndFeelUpdated>(
+  async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters?: Parameters.UpdateLookAndFeelSettings,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -125,8 +125,11 @@ export class Settings {
         links: parameters?.links,
         menus: parameters?.menus,
         header: parameters?.header,
+        horizontalHeader: parameters?.horizontalHeader,
         content: parameters?.content,
         bordersAndDividers: parameters?.bordersAndDividers,
+        spaceReference: parameters?.spaceReference,
+        _links: parameters?.links,
       },
     };
 

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, index) => index ? `&spaceKey=${key}` : key),
         spaceId: parameters?.spaceId,
         type: parameters?.type,
         status: parameters?.status,
@@ -106,6 +106,7 @@ export class Space {
         key: parameters?.key,
         name: parameters?.name,
         description: parameters?.description,
+        permissions: parameters?.permissions,
       },
     };
 
@@ -159,6 +160,8 @@ export class Space {
         name: parameters.name,
         description: parameters.description,
         homepage: parameters.homepage,
+        type: parameters.type,
+        status: parameters.status,
       },
     };
 

package/src/api/spacePermissions.ts

@@ -7,6 +7,20 @@ import { RequestConfig } from '../requestConfig';
 export class SpacePermissions {
   constructor(private client: Client) {}
 
+  /** @deprecated Will be removed in the next major version. Use `addPermissionToSpace` instead. */
+  async addPermission<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermission,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `addPermissionToSpace` instead. */
+  async addPermission<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermission, callback?: never): Promise<T>;
+  async addPermission<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermission,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    return this.addPermissionToSpace(parameters, callback!);
+  }
+
   /**
    * Adds new permission to space.
    *
@@ -16,8 +30,8 @@ export class SpacePermissions {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async addPermission<T = Models.SpacePermissionV2>(
-    parameters: Parameters.AddPermission,
+  async addPermissionToSpace<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermissionToSpace,
     callback: Callback<T>
   ): Promise<void>;
   /**
@@ -29,23 +43,67 @@ export class SpacePermissions {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async addPermission<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermission, callback?: never): Promise<T>;
-  async addPermission<T = Models.SpacePermissionV2>(
-    parameters: Parameters.AddPermission,
+  async addPermissionToSpace<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermissionToSpace,
+    callback?: never
+  ): Promise<T>;
+  async addPermissionToSpace<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermissionToSpace,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
       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' });
+  }
+
+  /**
+   * 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.
+   */
+  async 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.
+   */
+  async addCustomContentPermissions<T = unknown>(
+    parameters: Parameters.AddCustomContentPermissions,
+    callback?: never
+  ): Promise<T>;
+  async addCustomContentPermissions<T = unknown>(
+    parameters: Parameters.AddCustomContentPermissions,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      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' });
   }
 
   /**

package/src/api/spaceProperties.ts

@@ -70,6 +70,7 @@ export class SpaceProperties {
       data: {
         key: parameters.key,
         value: parameters.value,
+        space: parameters.space,
       },
     };
 
@@ -110,8 +111,8 @@ export class SpaceProperties {
   }
 
   /**
-   * 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.
    */
@@ -120,8 +121,8 @@ export class SpaceProperties {
     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/src/api/template.ts

@@ -50,8 +50,8 @@ export 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.
    */
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.UpdateContentTemplate | undefined,
@@ -60,8 +60,8 @@ export 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.
    */
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.UpdateContentTemplate,
@@ -95,8 +95,9 @@ export 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.
    */
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters: Parameters.GetBlueprintTemplates | undefined,
@@ -109,8 +110,9 @@ export 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.
    */
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters?: Parameters.GetBlueprintTemplates,
@@ -137,8 +139,8 @@ export class Template {
   /**
    * 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.
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters: Parameters.GetContentTemplates | undefined,
@@ -147,8 +149,8 @@ export class Template {
   /**
    * 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.
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters?: Parameters.GetContentTemplates,
@@ -176,8 +178,8 @@ export class Template {
    * 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.
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
@@ -187,8 +189,8 @@ export class Template {
    * 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.
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
@@ -215,6 +217,9 @@ export 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.
    */
   async removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback: Callback<T>): Promise<void>;
   /**
@@ -226,6 +231,9 @@ export 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.
    */
   async removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback?: never): Promise<T>;
   async removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback?: Callback<T>): Promise<void | T> {

package/src/clients/baseClient.ts

@@ -1,5 +1,4 @@
 import axios, { AxiosInstance } from 'axios';
-import { Authentication, Telemetry, TelemetryClient } from 'telemetry.confluence.js';
 import type { Client } from './client';
 import type { Callback } from '../callback';
 import type { Config } from '../config';
@@ -11,13 +10,10 @@ const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
 
 export class BaseClient implements Client {
   #instance: AxiosInstance | undefined;
-  private telemetryClient: TelemetryClient;
 
   protected urlSuffix = '/wiki/rest/';
 
-  constructor(protected readonly config: Config) {
-    this.telemetryClient = new TelemetryClient(config.telemetry);
-  }
+  constructor(protected readonly config: Config) {}
 
   protected paramSerializer(parameters: Record<string, any>): string {
     const parts: string[] = [];
@@ -82,38 +78,16 @@ export class BaseClient implements Client {
     return this.#instance;
   }
 
-  async sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: Partial<Telemetry>): Promise<T>;
+  async sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: any): Promise<T>;
   async sendRequest<T>(
     requestConfig: RequestConfig,
     callback: Callback<T>,
-    telemetryData?: Partial<Telemetry>
+    telemetryData?: any,
   ): Promise<void>;
   async sendRequest<T>(
     requestConfig: RequestConfig,
     callback: Callback<T> | never,
-    telemetryData?: Partial<Telemetry>,
   ): Promise<void | T> {
-    const startDateTime = new Date();
-
-    const telemetry: Telemetry = {
-      authentication: this.authenticationType,
-      baseRequestConfigUsed: !!this.config.baseRequestConfig,
-      bodyExists: !!requestConfig.data,
-      callbackUsed: !!callback,
-      headersExists: !!requestConfig.headers,
-      libVersion: '1.1.3',
-      libVersionHash: '6d8c23a768aec9eefc52917e68aa3926',
-      methodName: telemetryData?.methodName || 'sendRequest',
-      onErrorMiddlewareUsed: !!this.config.middlewares?.onError,
-      onResponseMiddlewareUsed: !!this.config.middlewares?.onResponse,
-      queryExists: !!requestConfig.params,
-      requestEndTime: new Date(),
-      requestStartTime: startDateTime,
-      requestStatusCode: 0,
-      noCheckAtlassianToken: !!this.config.noCheckAtlassianToken,
-      ...telemetryData,
-    };
-
     try {
       const modifiedRequestConfig = {
         ...requestConfig,
@@ -127,7 +101,7 @@ export class BaseClient implements Client {
         }),
       };
 
-      const response = await this.instance.request(modifiedRequestConfig);
+      const response = await this.instance.request<T>(modifiedRequestConfig);
 
       const callbackResponseHandler = callback && ((data: T): void => callback(null, data));
       const defaultResponseHandler = (data: T): T => data;
@@ -136,8 +110,6 @@ export class BaseClient implements Client {
 
       this.config.middlewares?.onResponse?.(response.data);
 
-      telemetry.requestStatusCode = response.status;
-
       return responseHandler(response.data);
     } catch (e: any) {
       const callbackErrorHandler = callback && ((error: Config.Error) => callback(error));
@@ -149,35 +121,7 @@ export class BaseClient implements Client {
 
       this.config.middlewares?.onError?.(e);
 
-      telemetry.requestStatusCode = e.isAxiosError ? e.response?.status ?? 0 : 418;
-
       return errorHandler(e);
-    } finally {
-      telemetry.requestEndTime = new Date();
-
-      this.telemetryClient.sendTelemetry(telemetry);
-    }
-  }
-
-  private get authenticationType(): Authentication {
-    const { authentication } = this.config;
-
-    if (!authentication) {
-      return Authentication.None;
-    }
-
-    if (authentication.basic) {
-      return Authentication.Basic;
-    }
-
-    if (authentication.oauth2) {
-      return Authentication.OAuth2;
-    }
-
-    if (authentication.jwt) {
-      return Authentication.JWT;
     }
-
-    return Authentication.NA;
   }
 }

package/src/clients/client.ts

@@ -1,12 +1,11 @@
-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?: never, telemetryData?: any): Promise<T>;
   sendRequest<T>(
     requestConfig: RequestConfig,
     callback?: Callback<T>,
-    telemetryData?: Partial<Telemetry>
+    telemetryData?: any,
   ): Promise<void>;
 }

package/src/clients/confluenceClient.ts

@@ -14,6 +14,7 @@ import {
   ContentVersions,
   ContentWatches,
   DynamicModules,
+  Experimental,
   Group,
   InlineTasks,
   LabelInfo,
@@ -45,6 +46,7 @@ export class ConfluenceClient extends BaseClient {
   contentVersions = new ContentVersions(this);
   contentWatches = new ContentWatches(this);
   dynamicModules = new DynamicModules(this);
+  experimental = new Experimental(this);
   group = new Group(this);
   inlineTasks = new InlineTasks(this);
   labelInfo = new LabelInfo(this);

package/src/config.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';
 
@@ -8,6 +7,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
@@ -18,7 +18,8 @@ export interface Config {
 export namespace Config {
   export type BaseRequestConfig = RequestConfig;
   export type Error = AxiosError;
-  export type Telemetry = boolean | TelemetryConfig;
+  /** @deprecated Disabled. Will be removed in the next major version. */
+  export type Telemetry = boolean | any;
 
   export type Authentication = UtilityTypes.XOR<{
     jwt: Authentication.JWT;