confluence.js 1.6.3 → 1.7.0

package/src/api/settings.ts

@@ -18,7 +18,7 @@ export class Settings {
    */
   async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(
     parameters: Parameters.GetLookAndFeelSettings | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the look and feel settings for the site or a single space. This includes attributes such as the color
@@ -31,7 +31,7 @@ export class Settings {
    */
   async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(
     parameters?: Parameters.GetLookAndFeelSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(
     parameters?: Parameters.GetLookAndFeelSettings,
@@ -57,7 +57,7 @@ export class Settings {
    */
   async updateLookAndFeel<T = Models.LookAndFeelSelection>(
     parameters: Parameters.UpdateLookAndFeel | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's
@@ -68,7 +68,7 @@ export class Settings {
    */
   async updateLookAndFeel<T = Models.LookAndFeelSelection>(
     parameters?: Parameters.UpdateLookAndFeel,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateLookAndFeel<T = Models.LookAndFeelSelection>(
     parameters?: Parameters.UpdateLookAndFeel,
@@ -97,7 +97,7 @@ export class Settings {
    */
   async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters: Parameters.UpdateLookAndFeelSettings | undefined,
-    callback: Callback<T>
+    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.
@@ -110,7 +110,7 @@ export class Settings {
    */
   async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters?: Parameters.UpdateLookAndFeelSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters?: Parameters.UpdateLookAndFeelSettings,
@@ -147,7 +147,7 @@ export class Settings {
    */
   async resetLookAndFeelSettings<T = void>(
     parameters: Parameters.ResetLookAndFeelSettings | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Resets the custom look and feel settings for the site or a single space. This changes the values of the custom
@@ -158,7 +158,7 @@ export class Settings {
    */
   async resetLookAndFeelSettings<T = void>(
     parameters?: Parameters.ResetLookAndFeelSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async resetLookAndFeelSettings<T = void>(
     parameters?: Parameters.ResetLookAndFeelSettings,
@@ -183,7 +183,7 @@ export class Settings {
    */
   async setLookAndFeelSettings<T = unknown>(
     parameters: Parameters.SetLookAndFeelSettings | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Sets the look and feel settings to either the default settings or the custom settings, for the site or a single
@@ -193,7 +193,7 @@ export class Settings {
    */
   async setLookAndFeelSettings<T = unknown>(
     parameters?: Parameters.SetLookAndFeelSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async setLookAndFeelSettings<T = unknown>(
     parameters?: Parameters.SetLookAndFeelSettings,
@@ -236,12 +236,12 @@ export class Settings {
   /** @deprecated Gets Content State settings for a space */
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** @deprecated Gets Content State settings for a space */
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,

package/src/api/space.ts

@@ -17,7 +17,7 @@ export class Space {
    */
   async getSpaces<T = Models.SpaceArray>(
     parameters: Parameters.GetSpaces | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all spaces. The returned spaces are ordered alphabetically in ascending order by space key.
@@ -55,7 +55,7 @@ export class Space {
    */
   async createSpace<T = Models.Space>(
     parameters: Parameters.CreateSpace | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a new space. Note, currently you cannot set space labels when creating a space.
@@ -87,7 +87,7 @@ export class Space {
    */
   async createPrivateSpace<T = Models.Space>(
     parameters: Parameters.CreatePrivateSpace | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a new space that is only visible to the creator. This method is the same as the [Create
@@ -212,7 +212,7 @@ export class Space {
    */
   async getContentForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentForSpace,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all content in a space. The returned content is grouped by type (pages then blogposts), then ordered by
@@ -223,7 +223,7 @@ export class Space {
    */
   async getContentForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentForSpace,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentForSpace,
@@ -250,7 +250,7 @@ export class Space {
    */
   async getContentByTypeForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentByTypeForSpace,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all content of a given type, in a space. The returned content is ordered by content ID in ascending order.
@@ -260,7 +260,7 @@ export class Space {
    */
   async getContentByTypeForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentByTypeForSpace,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentByTypeForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentByTypeForSpace,

package/src/api/spacePermissions.ts

@@ -10,7 +10,7 @@ export class SpacePermissions {
   /** @deprecated Will be removed in the next major version. Use `addPermissionToSpace` instead. */
   async addPermission<T = Models.SpacePermissionV2>(
     parameters: Parameters.AddPermission,
-    callback: Callback<T>
+    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>;
@@ -32,7 +32,7 @@ export class SpacePermissions {
    */
   async addPermissionToSpace<T = Models.SpacePermissionV2>(
     parameters: Parameters.AddPermissionToSpace,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Adds new permission to space.
@@ -45,7 +45,7 @@ export class SpacePermissions {
    */
   async addPermissionToSpace<T = Models.SpacePermissionV2>(
     parameters: Parameters.AddPermissionToSpace,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async addPermissionToSpace<T = Models.SpacePermissionV2>(
     parameters: Parameters.AddPermissionToSpace,
@@ -75,7 +75,7 @@ export class SpacePermissions {
    */
   async addCustomContentPermissions<T = unknown>(
     parameters: Parameters.AddCustomContentPermissions,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Adds new custom content permission to space.
@@ -88,7 +88,7 @@ export class SpacePermissions {
    */
   async addCustomContentPermissions<T = unknown>(
     parameters: Parameters.AddCustomContentPermissions,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async addCustomContentPermissions<T = unknown>(
     parameters: Parameters.AddCustomContentPermissions,

package/src/api/spaceProperties.ts

@@ -14,7 +14,7 @@ export class SpaceProperties {
    */
   async getSpaceProperties<T = Models.SpacePropertyArray>(
     parameters: Parameters.GetSpaceProperties,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all properties for the given space. Space properties are a key-value storage associated with a space.
@@ -23,7 +23,7 @@ export class SpaceProperties {
    */
   async getSpaceProperties<T = Models.SpacePropertyArray>(
     parameters: Parameters.GetSpaceProperties,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getSpaceProperties<T = Models.SpacePropertyArray>(
     parameters: Parameters.GetSpaceProperties,
@@ -49,7 +49,7 @@ export class SpaceProperties {
    */
   async createSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpaceProperty,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a new space property.
@@ -58,7 +58,7 @@ export class SpaceProperties {
    */
   async createSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpaceProperty,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async createSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpaceProperty,
@@ -84,7 +84,7 @@ export class SpaceProperties {
    */
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns a space property.
@@ -93,7 +93,7 @@ export class SpaceProperties {
    */
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
@@ -118,7 +118,7 @@ export class SpaceProperties {
    */
   async createSpacePropertyForKey<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpacePropertyForKey,
-    callback: Callback<T>
+    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
@@ -128,7 +128,7 @@ export class SpaceProperties {
    */
   async createSpacePropertyForKey<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpacePropertyForKey,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async createSpacePropertyForKey<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpacePropertyForKey,
@@ -152,7 +152,7 @@ export class SpaceProperties {
    */
   async updateSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.UpdateSpaceProperty,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Updates a space property. Note, you cannot update the key of a space property, only the value.
@@ -161,7 +161,7 @@ export class SpaceProperties {
    */
   async updateSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.UpdateSpaceProperty,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.UpdateSpaceProperty,

package/src/api/spaceSettings.ts

@@ -14,7 +14,7 @@ export class SpaceSettings {
    */
   async getSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.GetSpaceSettings,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the settings of a space. Currently only the `routeOverrideEnabled` setting can be returned.
@@ -23,7 +23,7 @@ export class SpaceSettings {
    */
   async getSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.GetSpaceSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.GetSpaceSettings,
@@ -44,7 +44,7 @@ export class SpaceSettings {
    */
   async updateSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.UpdateSpaceSettings,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Updates the settings for a space. Currently only the `routeOverrideEnabled` setting can be updated.
@@ -53,7 +53,7 @@ export class SpaceSettings {
    */
   async updateSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.UpdateSpaceSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.UpdateSpaceSettings,

package/src/api/template.ts

@@ -15,7 +15,7 @@ export class Template {
    */
   async createContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.CreateContentTemplate | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a new content template. Note, blueprint templates cannot be created via the REST API.
@@ -25,7 +25,7 @@ export class Template {
    */
   async createContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.CreateContentTemplate,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async createContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.CreateContentTemplate,
@@ -55,7 +55,7 @@ export class Template {
    */
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.UpdateContentTemplate | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Updates a content template. Note, blueprint templates cannot be updated via the REST API.
@@ -65,7 +65,7 @@ export class Template {
    */
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.UpdateContentTemplate,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.UpdateContentTemplate,
@@ -101,7 +101,7 @@ export class Template {
    */
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters: Parameters.GetBlueprintTemplates | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all
@@ -116,7 +116,7 @@ export class Template {
    */
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters?: Parameters.GetBlueprintTemplates,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters?: Parameters.GetBlueprintTemplates,
@@ -146,7 +146,7 @@ export class Template {
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters: Parameters.GetContentTemplates | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all content templates. Use this method to retrieve all global content templates or all content templates in
@@ -158,7 +158,7 @@ export class Template {
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters?: Parameters.GetContentTemplates,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters?: Parameters.GetContentTemplates,
@@ -188,7 +188,7 @@ export class Template {
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns a content template. This includes information about template, like the name, the space or blueprint that
@@ -200,7 +200,7 @@ export class Template {
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,

package/src/api/themes.ts

@@ -14,7 +14,7 @@ export class Themes {
    */
   async getThemes<T = Models.ThemeArray>(
     parameters: Parameters.GetThemes | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all themes, not including the default theme.

package/src/api/users.ts

@@ -52,7 +52,7 @@ export class Users {
    */
   async getAnonymousUser<T = Models.UserAnonymous>(
     parameters: Parameters.GetAnonymousUser | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns information about how anonymous users are represented, like the profile picture and display name.
@@ -62,7 +62,7 @@ export class Users {
    */
   async getAnonymousUser<T = Models.UserAnonymous>(
     parameters?: Parameters.GetAnonymousUser,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getAnonymousUser<T = Models.UserAnonymous>(
     parameters?: Parameters.GetAnonymousUser,
@@ -88,7 +88,7 @@ export class Users {
    */
   async getCurrentUser<T = Models.User>(
     parameters: Parameters.GetCurrentUser | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the currently logged-in user. This includes information about the user, like the display name, userKey,
@@ -121,7 +121,7 @@ export class Users {
    */
   async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the groups that a user is a member of.
@@ -131,7 +131,7 @@ export class Users {
    */
   async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
@@ -160,7 +160,7 @@ export class Users {
    */
   async getBulkUserLookup<T = Models.BulkUserLookupArray>(
     parameters: Parameters.GetBulkUserLookup,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns user details for the ids provided in request.
@@ -170,7 +170,7 @@ export class Users {
    */
   async getBulkUserLookup<T = Models.BulkUserLookupArray>(
     parameters: Parameters.GetBulkUserLookup,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getBulkUserLookup<T = Models.BulkUserLookupArray>(
     parameters: Parameters.GetBulkUserLookup,
@@ -198,7 +198,7 @@ export class Users {
    */
   async getPrivacyUnsafeUserEmail<T = Models.AccountIdEmailRecord>(
     parameters: Parameters.GetPrivacyUnsafeUserEmail,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns a user's email address. This API is only available to apps approved by Atlassian, according to these
@@ -209,7 +209,7 @@ export class Users {
    */
   async getPrivacyUnsafeUserEmail<T = Models.AccountIdEmailRecord>(
     parameters: Parameters.GetPrivacyUnsafeUserEmail,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getPrivacyUnsafeUserEmail<T = Models.AccountIdEmailRecord>(
     parameters: Parameters.GetPrivacyUnsafeUserEmail,
@@ -238,7 +238,7 @@ export class Users {
    */
   async getPrivacyUnsafeUserEmailBulk<T = Models.AccountIdEmailRecordArray>(
     parameters: Parameters.GetPrivacyUnsafeUserEmailBulk,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns user email addresses for a set of accountIds. This API is only available to apps approved by Atlassian,
@@ -252,7 +252,7 @@ export class Users {
    */
   async getPrivacyUnsafeUserEmailBulk<T = Models.AccountIdEmailRecordArray>(
     parameters: Parameters.GetPrivacyUnsafeUserEmailBulk,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getPrivacyUnsafeUserEmailBulk<T = Models.AccountIdEmailRecordArray>(
     parameters: Parameters.GetPrivacyUnsafeUserEmailBulk,
@@ -278,7 +278,7 @@ export class Users {
    */
   async getBulkUserMigration<T = Models.MigratedUserArray>(
     parameters: Parameters.GetBulkUserMigration,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the accountIds for the users specified in the key or username parameters. Note that multiple key and
@@ -289,7 +289,7 @@ export class Users {
    */
   async getBulkUserMigration<T = Models.MigratedUserArray>(
     parameters: Parameters.GetBulkUserMigration,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getBulkUserMigration<T = Models.MigratedUserArray>(
     parameters: Parameters.GetBulkUserMigration,

package/src/clients/baseClient.ts

@@ -11,9 +11,9 @@ const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
 export class BaseClient implements Client {
   #instance: AxiosInstance | undefined;
 
-  protected urlSuffix = '/wiki/rest/';
-
-  constructor(protected readonly config: Config) {}
+  constructor(protected readonly config: Config) {
+    this.config.apiPrefix = this.config.apiPrefix || '/wiki/rest/';
+  }
 
   protected paramSerializer(parameters: Record<string, any>): string {
     const parts: string[] = [];
@@ -72,7 +72,7 @@ export class BaseClient implements Client {
     this.#instance = axios.create({
       paramsSerializer: this.paramSerializer.bind(this),
       ...this.config.baseRequestConfig,
-      baseURL: `${this.config.host}${this.urlSuffix}`,
+      baseURL: `${this.config.host}${this.config.apiPrefix}`,
       headers: this.removeUndefinedProperties({
         [ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken
           ? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE

package/src/clients/confluenceClient.ts

@@ -1,4 +1,5 @@
 import { BaseClient } from './baseClient';
+import { Config } from '../config';
 import {
   Analytics,
   Audit,
@@ -35,6 +36,13 @@ import {
 } from '../api';
 
 export class ConfluenceClient extends BaseClient {
+  constructor(config: Config) {
+    super({
+      ...config,
+      apiPrefix: config.apiPrefix ?? '/wiki/rest',
+    });
+  }
+
   analytics = new Analytics(this);
   audit = new Audit(this);
   content = new Content(this);

package/src/clients/serverClient.ts

@@ -1,8 +1,14 @@
 import { BaseClient } from './baseClient';
+import { Config } from '../config';
 import { Audit, Content, ContentBody, Group, LongTask, Search, Space, User } from '../server';
 
 export class ServerClient extends BaseClient {
-  urlSuffix = '/';
+  constructor(config: Config) {
+    super({
+      ...config,
+      apiPrefix: config.apiPrefix ?? '/',
+    });
+  }
 
   audit = new Audit(this);
   content = new Content(this);

package/src/config.ts

@@ -9,12 +9,12 @@ export interface Config {
   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
-   */
+  /** Adds `'X-Atlassian-Token': 'no-check'` to each request header */
   noCheckAtlassianToken?: boolean;
   /** Enable new API error handling. `false` by default. */
   newErrorHandling?: boolean;
+  /** Prefix for all API routes. */
+  apiPrefix?: string;
 }
 
 export namespace Config {
@@ -23,15 +23,20 @@ export namespace Config {
   /** @deprecated Disabled. Will be removed in the next major version. */
   export type Telemetry = boolean | any;
 
-  export type Authentication = UtilityTypes.XOR<{
+  export type Authentication = UtilityTypes.XOR4<
+  {
     jwt: Authentication.JWT;
-  }, UtilityTypes.XOR<{
+  },
+  {
     personalAccessToken: Authentication.PersonalAccessToken;
-  }, UtilityTypes.XOR<{
+  },
+  {
     basic: Authentication.Basic;
-  }, {
+  },
+  {
     oauth2: Authentication.OAuth2;
-  }>>>;
+  }
+  >;
 
   export interface Middlewares {
     onError?: Config.Middlewares.OnErrorHandler;
@@ -55,13 +60,16 @@ export namespace Config {
       expiryTimeSeconds?: number;
     };
 
-    export type Basic = UtilityTypes.XOR<{
+    export type Basic = UtilityTypes.XOR<
+    {
       email: string;
       apiToken: string;
-    }, {
+    },
+    {
       username: string;
       password: string;
-    }>;
+    }
+    >;
 
     export type OAuth2 = {
       accessToken: string;