@doist/comms-sdk 0.1.0-alpha.1 → 0.2.0

package/dist/esm/clients/users-client.js

@@ -8,17 +8,45 @@ import { BaseClient } from './base-client.js';
  * `loginWithTodoist` are the available entry points.
  */
 export class UsersClient extends BaseClient {
-    /** Registers a new user via the Todoist-ID bridge. */
+    /**
+     * Registers a new user via the Todoist-ID bridge.
+     *
+     * @param args - Registration arguments.
+     * @param args.name - The new user's full name.
+     * @param args.email - The new user's email.
+     * @param args.password - The new user's password.
+     * @param args.lang - Optional preferred language.
+     * @param args.acceptTerms - Optional flag confirming the user accepts the terms of service.
+     * @returns The newly registered user object.
+     */
     register(args) {
         return this.post(`${ENDPOINT_USERS}/register`, args, UserSchema, { authed: false });
     }
-    /** Logs in an existing user. */
+    /**
+     * Logs in an existing user.
+     *
+     * @param args - Login credentials.
+     * @param args.email - The user's email.
+     * @param args.password - The user's password.
+     * @param args.setSessionCookie - Optional flag to set a session cookie (default: true).
+     * @returns The authenticated user object.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.users.login({
+     *   email: 'user@example.com',
+     *   password: 'secret',
+     * })
+     * ```
+     */
     login(args) {
         return this.post(`${ENDPOINT_USERS}/login`, args, UserSchema, { authed: false });
     }
     /**
      * Logs in using a valid token (sent via Authorization header). The SDK
      * client is already configured with the token, so no args are needed.
+     *
+     * @returns The authenticated user object.
      */
     loginWithToken() {
         return this.post(`${ENDPOINT_USERS}/login_with_token`, undefined, UserSchema);
@@ -27,17 +55,35 @@ export class UsersClient extends BaseClient {
      * Exchanges the browser's Todoist web-session cookie for a Comms session.
      * Only useful when running in a browser context on the shared Todoist
      * registrable domain — the cookie is sent automatically by the browser.
+     *
+     * @returns The authenticated user object.
      */
     loginWithTodoist() {
         return this.post(`${ENDPOINT_USERS}/login_with_todoist`, {}, UserSchema, { authed: false });
     }
-    /** Logs in (and auto-signs-up) via a Google ID token. */
+    /**
+     * Logs in (and auto-signs-up) via a Google ID token.
+     *
+     * @param args - Google login arguments.
+     * @param args.idToken - The Google ID token.
+     * @param args.nonce - The nonce that was sent to Google.
+     * @param args.timezone - Optional user timezone.
+     * @param args.lang - Optional preferred language.
+     * @param args.mfaToken - Optional MFA token from a prior `mfaChallenge` response.
+     * @returns The authenticated user object.
+     */
     loginWithGoogle(args) {
         return this.post(`${ENDPOINT_USERS}/login_with_google`, args, UserSchema, { authed: false });
     }
     /**
      * Completes an MFA challenge issued by `loginWithGoogle` (returns an MFA
      * token to pass back to `loginWithGoogle.mfaToken`).
+     *
+     * @param args - MFA challenge arguments.
+     * @param args.challengeId - The challenge ID from the prior login attempt.
+     * @param args.factor - The MFA factor identifier.
+     * @param args.methodType - The MFA method type.
+     * @returns The MFA token to forward to `loginWithGoogle`.
      */
     mfaChallenge(args) {
         return request({
@@ -60,7 +106,17 @@ export class UsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Returns the user associated with the current access token. */
+    /**
+     * Gets the user associated with the current access token.
+     *
+     * @returns The authenticated user's information.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.users.getSessionUser()
+     * console.log(user.fullName, user.email)
+     * ```
+     */
     getSessionUser() {
         return this.get(`${ENDPOINT_USERS}/get_session_user`, undefined, UserSchema);
     }
@@ -68,32 +124,74 @@ export class UsersClient extends BaseClient {
      * Fetches a single user. Defaults to the session user when no `id` is
      * passed. Cross-workspace lookups require that the caller and the target
      * share a workspace.
+     *
+     * @param args - Optional lookup arguments.
+     * @param args.id - The user ID. Defaults to the session user.
+     * @param args.workspaceId - Optional workspace ID for cross-workspace lookups.
+     * @param args.asList - Optional flag controlling list-style response.
+     * @returns The user object.
      */
     getUser(args) {
         return this.get(`${ENDPOINT_USERS}/getone`, args ?? {}, UserSchema);
     }
-    /** Looks up a user by their email address. */
+    /**
+     * Looks up a user by their email address.
+     *
+     * @param email - The email to look up.
+     * @returns The user object.
+     */
     getUserByEmail(email) {
         return this.get(`${ENDPOINT_USERS}/get_by_email`, { email }, UserSchema);
     }
     /**
      * Updates the logged-in user's profile. Most fields are proxied to
      * Todoist (full name, password, language, timezone, etc.).
+     *
+     * @param args - The user properties to update.
+     * @returns The updated user object.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.users.update({
+     *   name: 'John Doe',
+     *   timezone: 'America/New_York',
+     * })
+     * ```
      */
     update(args) {
         return this.post(`${ENDPOINT_USERS}/update`, args, UserSchema);
     }
-    /** Updates the user's password. Requires `currentPassword`. */
+    /**
+     * Updates the user's password.
+     *
+     * @param args - Password update arguments.
+     * @param args.newPassword - The new password.
+     * @param args.currentPassword - The user's existing password. Optional — sent for
+     *   re-authentication when the account has a password set.
+     * @returns The updated user object.
+     */
     updatePassword(args) {
         return this.post(`${ENDPOINT_USERS}/update_password`, args, UserSchema);
     }
-    /** Removes the user's avatar. */
+    /**
+     * Removes the user's avatar.
+     *
+     * @returns The updated user object.
+     */
     removeAvatar() {
         return this.post(`${ENDPOINT_USERS}/remove_avatar`, undefined, UserSchema);
     }
     /**
      * Invalidates the current API token and returns the user with a fresh
      * token.
+     *
+     * @returns The user object with the new token.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.users.invalidateToken()
+     * console.log('New token:', user.token)
+     * ```
      */
     invalidateToken() {
         return this.post(`${ENDPOINT_USERS}/invalidate_token`, undefined, UserSchema);
@@ -102,6 +200,8 @@ export class UsersClient extends BaseClient {
      * Validates that an arbitrary token is still active. Note this is sent
      * as a GET — the token is read from the query string, not the
      * Authorization header.
+     *
+     * @param token - The token to validate.
      */
     validateToken(token) {
         return request({
@@ -113,7 +213,18 @@ export class UsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Marks the user as active on a workspace (presence beacon). */
+    /**
+     * Marks the user as active on a workspace (presence beacon).
+     *
+     * @param args - Heartbeat arguments.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.platform - The platform identifier (e.g., 'mobile', 'desktop', 'api').
+     *
+     * @example
+     * ```typescript
+     * await api.users.heartbeat({ workspaceId: 123, platform: 'api' })
+     * ```
+     */
     heartbeat(args) {
         return request({
             httpMethod: 'GET',
@@ -124,7 +235,11 @@ export class UsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Resets the user's presence for a workspace. */
+    /**
+     * Resets the user's presence for a workspace (marks the user as inactive).
+     *
+     * @param workspaceId - The workspace ID.
+     */
     resetPresence(workspaceId) {
         return request({
             httpMethod: 'POST',
@@ -135,7 +250,12 @@ export class UsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Checks whether an email address is registered (and verified). */
+    /**
+     * Checks whether an email address is registered (and verified).
+     *
+     * @param email - The email to check.
+     * @returns Object indicating whether the email exists and is verified.
+     */
     checkEmail(email) {
         return request({
             httpMethod: 'POST',
@@ -149,6 +269,8 @@ export class UsersClient extends BaseClient {
     /**
      * Returns the current per-channel mail unsubscribe settings for the
      * caller's primary email.
+     *
+     * @returns Object mapping email-type keys to their opt-out flag.
      */
     getUnsubscribeSettings() {
         return request({
@@ -160,7 +282,12 @@ export class UsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
-    /** Toggles per-email-type opt-out settings. */
+    /**
+     * Toggles per-email-type opt-out settings.
+     *
+     * @param settings - Object mapping email-type keys to their opt-out flag.
+     * @returns Status object with `"ok"` status.
+     */
     updateUnsubscribeSettings(settings) {
         return request({
             httpMethod: 'POST',

package/dist/esm/clients/workspace-users-client.js

@@ -6,7 +6,20 @@ import { BaseClient } from './base-client.js';
  * rejects non-empty `name` and `channelIds` — set neither.
  */
 export class WorkspaceUsersClient extends BaseClient {
-    /** Returns workspace user objects for the given workspace id. */
+    /**
+     * Returns a list of workspace user objects for the given workspace id.
+     *
+     * @param args - The arguments for getting workspace users.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.archived - Optional flag to filter archived users.
+     * @returns An array of workspace user objects.
+     *
+     * @example
+     * ```typescript
+     * const users = await api.workspaceUsers.getWorkspaceUsers({ workspaceId: 123 })
+     * users.forEach(u => console.log(u.fullName, u.userType))
+     * ```
+     */
     getWorkspaceUsers(args) {
         return request({
             httpMethod: 'GET',
@@ -17,7 +30,12 @@ export class WorkspaceUsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data.map((user) => WorkspaceUserSchema.parse(user)));
     }
-    /** Returns workspace user IDs for the given workspace id. */
+    /**
+     * Returns a list of workspace user IDs for the given workspace id.
+     *
+     * @param workspaceId - The workspace ID.
+     * @returns An array of user IDs.
+     */
     getWorkspaceUserIds(workspaceId) {
         return request({
             httpMethod: 'GET',
@@ -28,7 +46,20 @@ export class WorkspaceUsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
-    /** Gets a user by id. */
+    /**
+     * Gets a user by id.
+     *
+     * @param args - The arguments for getting a user by ID.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userId - The user's ID.
+     * @returns The workspace user object.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.workspaceUsers.getUserById({ workspaceId: 123, userId: 456 })
+     * console.log(user.fullName, user.email)
+     * ```
+     */
     getUserById(args) {
         return request({
             httpMethod: 'GET',
@@ -39,7 +70,22 @@ export class WorkspaceUsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => WorkspaceUserSchema.parse(response.data));
     }
-    /** Gets a user by email. */
+    /**
+     * Gets a user by email.
+     *
+     * @param args - The arguments for getting a user by email.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.email - The user's email.
+     * @returns The workspace user object.
+     *
+     * @example
+     * ```typescript
+     * const user = await api.workspaceUsers.getUserByEmail({
+     *   workspaceId: 123,
+     *   email: 'user@example.com',
+     * })
+     * ```
+     */
     getUserByEmail(args) {
         return request({
             httpMethod: 'GET',
@@ -50,7 +96,14 @@ export class WorkspaceUsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => WorkspaceUserSchema.parse(response.data));
     }
-    /** Gets the user's info in the context of the workspace. */
+    /**
+     * Gets the user's info in the context of the workspace.
+     *
+     * @param args - The arguments for getting user info.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userId - The user's ID.
+     * @returns Information about the user in the workspace context.
+     */
     getUserInfo(args) {
         return request({
             httpMethod: 'GET',
@@ -61,7 +114,23 @@ export class WorkspaceUsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
-    /** Gets the user's local time (e.g., "2017-05-10 07:55:40"). */
+    /**
+     * Gets the user's local time (e.g., "2017-05-10 07:55:40").
+     *
+     * @param args - The arguments for getting user local time.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userId - The user's ID.
+     * @returns The user's local time as a string.
+     *
+     * @example
+     * ```typescript
+     * const localTime = await api.workspaceUsers.getUserLocalTime({
+     *   workspaceId: 123,
+     *   userId: 456,
+     * })
+     * console.log('User local time:', localTime)
+     * ```
+     */
     getUserLocalTime(args) {
         return request({
             httpMethod: 'GET',
@@ -72,7 +141,15 @@ export class WorkspaceUsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
-    /** Adds a person to a workspace. */
+    /**
+     * Adds a person to a workspace.
+     *
+     * @param args - The arguments for adding a user.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.email - The user's email.
+     * @param args.userType - Optional user type (USER, GUEST, or ADMIN).
+     * @returns The created workspace user object.
+     */
     addUser(args) {
         return request({
             httpMethod: 'POST',
@@ -87,7 +164,16 @@ export class WorkspaceUsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => WorkspaceUserSchema.parse(response.data));
     }
-    /** Updates a person in a workspace. */
+    /**
+     * Updates a person in a workspace.
+     *
+     * @param args - The arguments for updating a user.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userType - The user type (USER, GUEST, or ADMIN).
+     * @param args.email - Optional email of the user to update.
+     * @param args.userId - Optional user ID to update (use either email or userId).
+     * @returns The updated workspace user object.
+     */
     updateUser(args) {
         return request({
             httpMethod: 'POST',
@@ -103,7 +189,14 @@ export class WorkspaceUsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => WorkspaceUserSchema.parse(response.data));
     }
-    /** Removes a person from a workspace. */
+    /**
+     * Removes a person from a workspace.
+     *
+     * @param args - The arguments for removing a user.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.email - Optional email of the user to remove.
+     * @param args.userId - Optional user ID to remove (use either email or userId).
+     */
     removeUser(args) {
         return request({
             httpMethod: 'POST',
@@ -118,7 +211,14 @@ export class WorkspaceUsersClient extends BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Sends a new workspace invitation to the selected user. */
+    /**
+     * Sends a new workspace invitation to the selected user.
+     *
+     * @param args - The arguments for resending an invite.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.email - The user's email.
+     * @param args.userId - Optional user ID.
+     */
     resendInvite(args) {
         return request({
             httpMethod: 'POST',

package/dist/esm/clients/workspaces-client.js

@@ -9,7 +9,17 @@ export const ChannelListSchema = z.array(ChannelSchema);
  * currently rejects any `color` other than `1` on add/update.
  */
 export class WorkspacesClient extends BaseClient {
-    /** Gets all the user's workspaces. */
+    /**
+     * Gets all the user's workspaces.
+     *
+     * @returns An array of all workspaces the user belongs to.
+     *
+     * @example
+     * ```typescript
+     * const workspaces = await api.workspaces.getWorkspaces()
+     * workspaces.forEach(ws => console.log(ws.name))
+     * ```
+     */
     getWorkspaces() {
         return request({
             httpMethod: 'GET',
@@ -20,7 +30,18 @@ export class WorkspacesClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => response.data.map((workspace) => WorkspaceSchema.parse(workspace)));
     }
-    /** Gets a single workspace object by id. */
+    /**
+     * Gets a single workspace object by id.
+     *
+     * @param id - The workspace ID.
+     * @returns The workspace object.
+     *
+     * @example
+     * ```typescript
+     * const workspace = await api.workspaces.getWorkspace(123)
+     * console.log(workspace.name)
+     * ```
+     */
     getWorkspace(id) {
         return request({
             httpMethod: 'GET',
@@ -31,7 +52,17 @@ export class WorkspacesClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => WorkspaceSchema.parse(response.data));
     }
-    /** Gets the user's default workspace. */
+    /**
+     * Gets the user's default workspace.
+     *
+     * @returns The default workspace object.
+     *
+     * @example
+     * ```typescript
+     * const workspace = await api.workspaces.getDefaultWorkspace()
+     * console.log(workspace.name)
+     * ```
+     */
     getDefaultWorkspace() {
         return request({
             httpMethod: 'GET',
@@ -42,7 +73,18 @@ export class WorkspacesClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => WorkspaceSchema.parse(response.data));
     }
-    /** Creates a new workspace. */
+    /**
+     * Creates a new workspace.
+     *
+     * @param name - The name of the new workspace.
+     * @returns The created workspace object.
+     *
+     * @example
+     * ```typescript
+     * const workspace = await api.workspaces.createWorkspace('My Team')
+     * console.log('Created:', workspace.name)
+     * ```
+     */
     createWorkspace(name) {
         return request({
             httpMethod: 'POST',
@@ -53,7 +95,18 @@ export class WorkspacesClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => WorkspaceSchema.parse(response.data));
     }
-    /** Updates an existing workspace. */
+    /**
+     * Updates an existing workspace.
+     *
+     * @param id - The workspace ID.
+     * @param name - The new name for the workspace.
+     * @returns The updated workspace object.
+     *
+     * @example
+     * ```typescript
+     * const workspace = await api.workspaces.updateWorkspace(123, 'New Team Name')
+     * ```
+     */
     updateWorkspace(id, name) {
         return request({
             httpMethod: 'POST',
@@ -64,7 +117,16 @@ export class WorkspacesClient extends BaseClient {
             customFetch: this.customFetch,
         }).then((response) => WorkspaceSchema.parse(response.data));
     }
-    /** Removes a workspace and all its data (not recoverable). */
+    /**
+     * Removes a workspace and all its data (not recoverable).
+     *
+     * @param id - The workspace ID.
+     *
+     * @example
+     * ```typescript
+     * await api.workspaces.removeWorkspace(123)
+     * ```
+     */
     removeWorkspace(id) {
         return request({
             httpMethod: 'POST',
@@ -75,7 +137,18 @@ export class WorkspacesClient extends BaseClient {
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
-    /** Gets the public channels of a workspace. */
+    /**
+     * Gets the public channels of a workspace.
+     *
+     * @param id - The workspace ID.
+     * @returns An array of public channel objects.
+     *
+     * @example
+     * ```typescript
+     * const channels = await api.workspaces.getPublicChannels(123)
+     * channels.forEach(ch => console.log(ch.name))
+     * ```
+     */
     getPublicChannels(id) {
         return request({
             httpMethod: 'GET',

package/dist/esm/comms-api.js

@@ -33,6 +33,7 @@ export class CommsApi {
         const clientConfig = {
             apiToken: authToken,
             baseUrl: options?.baseUrl,
+            version: options?.version,
             customFetch: options?.customFetch,
         };
         this.users = new UsersClient(clientConfig);

package/dist/esm/consts/endpoints.js

@@ -1,13 +1,18 @@
+import { DEFAULT_API_VERSION } from '../types/api-version.js';
 const BASE_URI = 'https://comms.todoist.com';
-const API_VERSION = 'v1';
 /**
  * Gets the base URI for Comms API requests.
  *
+ * Preserves any path component on `domainBase` so callers can route through
+ * a proxy (e.g. `https://proxy.example.com/comms` → `.../comms/api/v1/`).
+ *
+ * @param version - API version. Defaults to 'v1'.
  * @param domainBase - Custom domain base URL. Defaults to Comms' API domain.
  * @returns Complete base URI with trailing slash (e.g., 'https://comms.todoist.com/api/v1/')
  */
-export function getCommsBaseUri(domainBase = BASE_URI) {
-    return new URL(`/api/${API_VERSION}/`, domainBase).toString();
+export function getCommsBaseUri(version = DEFAULT_API_VERSION, domainBase = BASE_URI) {
+    const base = domainBase.endsWith('/') ? domainBase : `${domainBase}/`;
+    return new URL(`api/${version}/`, base).toString();
 }
 export const ENDPOINT_USERS = 'users';
 export const ENDPOINT_WORKSPACES = 'workspaces';

package/dist/esm/testUtils/test-defaults.js

@@ -1,4 +1,6 @@
+import { getCommsBaseUri } from '../consts/endpoints.js';
 export const TEST_API_TOKEN = 'test-api-token';
+export const TEST_API_BASE_URL = getCommsBaseUri().replace(/\/$/, '');
 // Canonical test IDs — shaped so they pass SDK-side validation.
 export const TEST_CHANNEL_ID = '7YpL3oZ4kZ9vP7Q1tR2sX3y';
 export const TEST_THREAD_ID = '7YpL3oZ4kZ9vP7Q1tR2sX3z';

package/dist/esm/types/api-version.js

@@ -0,0 +1,5 @@
+/**
+ * Supported Comms API versions
+ */
+export const API_VERSIONS = ['v1'];
+export const DEFAULT_API_VERSION = 'v1';

package/dist/esm/types/index.js

@@ -1,3 +1,4 @@
+export * from './api-version.js';
 export * from './entities.js';
 export * from './enums.js';
 export * from './errors.js';

package/dist/esm/types/requests.js

@@ -94,7 +94,6 @@ export const GetThreadsArgsSchema = z.object({
 });
 export const GetCommentsArgsSchema = z.object({
     threadId: z.string(),
-    from: z.date().nullable().optional(),
     newerThan: z.date().nullable().optional(),
     olderThan: z.date().nullable().optional(),
     limit: z.number().nullable().optional(),

package/dist/types/clients/add-comment-helper.d.ts

@@ -6,6 +6,23 @@ type ClientContext = {
     apiToken: string;
     customFetch?: CustomFetch;
 };
+/**
+ * Internal helper that powers `comments.createComment`,
+ * `threads.closeThread`, and `threads.reopenThread`.
+ *
+ * Normalizes the `notifyAudience` flag into a sentinel `groups` entry,
+ * rejects sentinel IDs passed via `groups` / `directGroupMentions`, mints a
+ * UUIDv7 `id` when the caller omits one, and posts to `/comments/add`. When
+ * `threadAction` is set (`'close'` / `'reopen'`), it is forwarded on the
+ * wire so the same request both adds the comment and transitions the
+ * parent thread.
+ *
+ * @param context - Per-call client context (base URI, API token, optional `customFetch`).
+ * @param params - The comment payload (`{@link CreateCommentArgs}`).
+ * @param options - Optional configuration.
+ * @param options.threadAction - When set, also transitions the parent thread (`'close'` or `'reopen'`).
+ * @returns The parsed {@link Comment} returned by the API.
+ */
 export declare function addCommentRequest(context: ClientContext, params: CreateCommentArgs, options?: {
     threadAction?: ThreadAction;
 }): Promise<Comment>;

package/dist/types/clients/base-client.d.ts

@@ -1,9 +1,12 @@
+import type { ApiVersion } from '../types/api-version.js';
 import type { CustomFetch } from '../types/http.js';
 export type ClientConfig = {
     /** API token for authentication */
     apiToken: string;
     /** Optional custom base URL. If not provided, uses the default Comms API URL */
     baseUrl?: string;
+    /** Optional API version. Defaults to 'v1' */
+    version?: ApiVersion;
     /** Optional custom fetch implementation for cross-platform compatibility */
     customFetch?: CustomFetch;
 };
@@ -14,6 +17,7 @@ export type ClientConfig = {
 export declare class BaseClient {
     protected readonly apiToken: string;
     protected readonly baseUrl?: string;
+    protected readonly defaultVersion: ApiVersion;
     protected readonly customFetch?: CustomFetch;
     constructor(config: ClientConfig);
     /**