@doist/comms-sdk 3.7.0 → 3.8.1

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

@@ -6,7 +6,7 @@ import { resolveCreateId } from '../utils/uuidv7.js';
 import { BaseClient } from './base-client.js';
 export const ChannelListSchema = z.array(ChannelSchema);
 /**
- * Client for `/api/v1/channels/`. The SDK auto-generates an `id` on
+ * Client for `/api/v1.0/channels/`. The SDK auto-generates an `id` on
  * `createChannel` when the caller doesn't supply one — pass your own `id`
  * to keep an optimistic-UI ID stable through the round-trip.
  */

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

@@ -6,7 +6,7 @@ import { addCommentRequest } from './add-comment-helper.js';
 import { BaseClient } from './base-client.js';
 export const CommentListSchema = z.array(CommentSchema);
 /**
- * Client for `/api/v1/comments/`. The SDK auto-generates the comment `id`
+ * Client for `/api/v1.0/comments/`. The SDK auto-generates the comment `id`
  * on `createComment` when the caller doesn't supply one.
  */
 export class CommentsClient extends BaseClient {

package/dist/esm/clients/conversation-messages-client.js

@@ -6,7 +6,7 @@ import { resolveCreateId } from '../utils/uuidv7.js';
 import { BaseClient } from './base-client.js';
 export const ConversationMessageListSchema = z.array(ConversationMessageSchema);
 /**
- * Client for `/api/v1/conversation_messages/`. The SDK auto-generates the
+ * Client for `/api/v1.0/conversation_messages/`. The SDK auto-generates the
  * message `id` on `createMessage` when the caller doesn't supply one.
  */
 export class ConversationMessagesClient extends BaseClient {

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

@@ -10,7 +10,7 @@ const GetUnreadResponseSchema = z.object({
     version: z.number().int(),
 });
 /**
- * Client for `/api/v1/conversations/`. `getOrCreate` requires an `id` (the
+ * Client for `/api/v1.0/conversations/`. `getOrCreate` requires an `id` (the
  * SDK auto-generates one for new conversations); the backend dedupes on
  * `userIds`, so an existing conversation will be returned with its own
  * already-assigned `id` and your generated one is silently dropped.

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

@@ -6,7 +6,7 @@ import { resolveCreateId } from '../utils/uuidv7.js';
 import { BaseClient } from './base-client.js';
 export const GroupListSchema = z.array(GroupSchema);
 /**
- * Client for `/api/v1/groups/`. The broadcast markers `EVERYONE` /
+ * Client for `/api/v1.0/groups/`. The broadcast markers `EVERYONE` /
  * `EVERYONE_IN_THREAD` are NOT addressable through these endpoints — they
  * only appear as members of `direct_group_mentions` / `groups` lists on
  * thread/comment writes.

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

@@ -3,7 +3,7 @@ import { request } from '../transport/http-client.js';
 import { HookSubscribeResponseSchema, StatusOkSchema, } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**
- * Client for `/api/v1/hooks/`. REST hooks require Todoist OAuth bearer tokens
+ * Client for `/api/v1.0/hooks/`. REST hooks require Todoist OAuth bearer tokens
  * that include Comms audience; session tokens are rejected by the backend.
  */
 export class HooksClient extends BaseClient {

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

@@ -4,7 +4,7 @@ import { request } from '../transport/http-client.js';
 import { createInboxThreadSchema, InboxThreadSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 export const InboxThreadListSchema = z.array(InboxThreadSchema);
-/** Client for `/api/v1/inbox/`. */
+/** Client for `/api/v1.0/inbox/`. */
 export class InboxClient extends BaseClient {
     constructor() {
         super(...arguments);

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

@@ -13,7 +13,7 @@ const GetUnreadResponseSchema = z.object({
     inboxUnread: z.number().int().nullable().optional(),
 });
 /**
- * Client for `/api/v1/threads/`. The SDK auto-generates the thread `id` on
+ * Client for `/api/v1.0/threads/`. The SDK auto-generates the thread `id` on
  * `createThread` when the caller doesn't supply one.
  */
 export class ThreadsClient extends BaseClient {

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

@@ -3,7 +3,7 @@ import { request } from '../transport/http-client.js';
 import { UserSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**
- * Client for the `/api/v1/users/` endpoints. Authentication flows through
+ * Client for the `/api/v1.0/users/` endpoints. Authentication flows through
  * Todoist-ID; `register` / `login` / `loginWithGoogle` / `loginWithToken` /
  * `loginWithTodoist` are the available entry points.
  */

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

@@ -2,7 +2,7 @@ import { request } from '../transport/http-client.js';
 import { VisibleWorkspaceUserSchema, WorkspaceUserSchema, } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**
- * Client for `/api/v1/workspace_users/`. The backend's `add` endpoint
+ * Client for `/api/v1.0/workspace_users/`. The backend's `add` endpoint
  * rejects non-empty `name` and `channelIds` — set neither.
  */
 export class WorkspaceUsersClient extends BaseClient {

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

@@ -5,7 +5,7 @@ import { ChannelSchema, createChannelSchema, WorkspaceSchema, } from '../types/e
 import { BaseClient } from './base-client.js';
 export const ChannelListSchema = z.array(ChannelSchema);
 /**
- * Client for `/api/v1/workspaces/`. Workspace IDs are integers. The backend
+ * Client for `/api/v1.0/workspaces/`. Workspace IDs are integers. The backend
  * currently rejects any `color` other than `1` on add/update.
  */
 export class WorkspacesClient extends BaseClient {

package/dist/esm/consts/endpoints.js

@@ -4,11 +4,11 @@ const BASE_URI = 'https://comms.todoist.com';
  * 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/`).
+ * a proxy (e.g. `https://proxy.example.com/comms` → `.../comms/api/v1.0/`).
  *
- * @param version - API version. Defaults to 'v1'.
+ * @param version - API version. Defaults to 'v1.0'.
  * @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/')
+ * @returns Complete base URI with trailing slash (e.g., 'https://comms.todoist.com/api/v1.0/')
  */
 export function getCommsBaseUri(version = DEFAULT_API_VERSION, domainBase = BASE_URI) {
     const base = domainBase.endsWith('/') ? domainBase : `${domainBase}/`;

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

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

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

@@ -5,7 +5,7 @@ export type ClientConfig = {
     apiToken: string;
     /** Optional custom base URL. If not provided, uses the default Comms API URL */
     baseUrl?: string;
-    /** Optional API version. Defaults to 'v1' */
+    /** Optional API version. Defaults to 'v1.0' */
     version?: ApiVersion;
     /** Optional custom fetch implementation for cross-platform compatibility */
     customFetch?: CustomFetch;

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

@@ -59,7 +59,7 @@ export declare const ChannelListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
     filters?: Record<string, string> | null | undefined;
 }>>>;
 /**
- * Client for `/api/v1/channels/`. The SDK auto-generates an `id` on
+ * Client for `/api/v1.0/channels/`. The SDK auto-generates an `id` on
  * `createChannel` when the caller doesn't supply one — pass your own `id`
  * to keep an optimistic-UI ID stable through the round-trip.
  */

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

@@ -130,7 +130,7 @@ export declare const CommentListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
     actions?: unknown[] | null | undefined;
 }>>>;
 /**
- * Client for `/api/v1/comments/`. The SDK auto-generates the comment `id`
+ * Client for `/api/v1.0/comments/`. The SDK auto-generates the comment `id`
  * on `createComment` when the caller doesn't supply one.
  */
 export declare class CommentsClient extends BaseClient {

package/dist/types/clients/conversation-messages-client.d.ts

@@ -109,7 +109,7 @@ export declare const ConversationMessageListSchema: z.ZodArray<z.ZodPipe<z.ZodOb
     version?: number | null | undefined;
 }>>>;
 /**
- * Client for `/api/v1/conversation_messages/`. The SDK auto-generates the
+ * Client for `/api/v1.0/conversation_messages/`. The SDK auto-generates the
  * message `id` on `createMessage` when the caller doesn't supply one.
  */
 export declare class ConversationMessagesClient extends BaseClient {

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

@@ -157,7 +157,7 @@ export declare const ConversationListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
     } | null | undefined;
 }>>>;
 /**
- * Client for `/api/v1/conversations/`. `getOrCreate` requires an `id` (the
+ * Client for `/api/v1.0/conversations/`. `getOrCreate` requires an `id` (the
  * SDK auto-generates one for new conversations); the backend dedupes on
  * `userIds`, so an existing conversation will be returned with its own
  * already-assigned `id` and your generated one is silently dropped.

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

@@ -11,7 +11,7 @@ export declare const GroupListSchema: z.ZodArray<z.ZodObject<{
     version: z.ZodNumber;
 }, z.core.$strip>>;
 /**
- * Client for `/api/v1/groups/`. The broadcast markers `EVERYONE` /
+ * Client for `/api/v1.0/groups/`. The broadcast markers `EVERYONE` /
  * `EVERYONE_IN_THREAD` are NOT addressable through these endpoints — they
  * only appear as members of `direct_group_mentions` / `groups` lists on
  * thread/comment writes.

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

@@ -2,7 +2,7 @@ import { type HookSubscribeResponse, type StatusOk } from '../types/entities.js'
 import type { SubscribeHookArgs, UnsubscribeHookArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
 /**
- * Client for `/api/v1/hooks/`. REST hooks require Todoist OAuth bearer tokens
+ * Client for `/api/v1.0/hooks/`. REST hooks require Todoist OAuth bearer tokens
  * that include Comms audience; session tokens are rejected by the backend.
  */
 export declare class HooksClient extends BaseClient {

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

@@ -380,7 +380,7 @@ export declare const InboxThreadListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
     toEmails?: string[] | null | undefined;
     version?: number | null | undefined;
 }>>>;
-/** Client for `/api/v1/inbox/`. */
+/** Client for `/api/v1.0/inbox/`. */
 export declare class InboxClient extends BaseClient {
     private readonly linkBaseUrl;
     private readonly inboxThreadSchema;

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

@@ -288,7 +288,7 @@ export declare const ThreadListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
     } | null | undefined;
 }>>>;
 /**
- * Client for `/api/v1/threads/`. The SDK auto-generates the thread `id` on
+ * Client for `/api/v1.0/threads/`. The SDK auto-generates the thread `id` on
  * `createThread` when the caller doesn't supply one.
  */
 export declare class ThreadsClient extends BaseClient {

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

@@ -33,7 +33,7 @@ type MfaChallengeArgs = {
     methodType: string;
 };
 /**
- * Client for the `/api/v1/users/` endpoints. Authentication flows through
+ * Client for the `/api/v1.0/users/` endpoints. Authentication flows through
  * Todoist-ID; `register` / `login` / `loginWithGoogle` / `loginWithToken` /
  * `loginWithTodoist` are the available entry points.
  */

package/dist/types/clients/workspace-users-client.d.ts

@@ -3,7 +3,7 @@ import { UserType } from '../types/enums.js';
 import type { GetUserByEmailArgs, GetUserByIdArgs, GetUserInfoArgs, GetUserLocalTimeArgs, GetWorkspaceUsersArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
 /**
- * Client for `/api/v1/workspace_users/`. The backend's `add` endpoint
+ * Client for `/api/v1.0/workspace_users/`. The backend's `add` endpoint
  * rejects non-empty `name` and `channelIds` — set neither.
  */
 export declare class WorkspaceUsersClient extends BaseClient {

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

@@ -58,7 +58,7 @@ export declare const ChannelListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
     filters?: Record<string, string> | null | undefined;
 }>>>;
 /**
- * Client for `/api/v1/workspaces/`. Workspace IDs are integers. The backend
+ * Client for `/api/v1.0/workspaces/`. Workspace IDs are integers. The backend
  * currently rejects any `color` other than `1` on add/update.
  */
 export declare class WorkspacesClient extends BaseClient {

package/dist/types/comms-api.d.ts

@@ -17,7 +17,7 @@ import type { CustomFetch, CustomHeaders } from './types/http.js';
 export type CommsApiOptions = {
     /** Optional custom API base URL. If not provided, defaults to Comms' standard API endpoint. */
     baseUrl?: string;
-    /** Optional API version. Defaults to 'v1'. */
+    /** Optional API version. Defaults to 'v1.0'. */
     version?: ApiVersion;
     /** Optional custom fetch implementation for cross-platform compatibility (e.g., Obsidian, React Native, Electron). */
     customFetch?: CustomFetch;

package/dist/types/consts/endpoints.d.ts

@@ -3,11 +3,11 @@ import type { ApiVersion } from '../types/api-version.js';
  * 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/`).
+ * a proxy (e.g. `https://proxy.example.com/comms` → `.../comms/api/v1.0/`).
  *
- * @param version - API version. Defaults to 'v1'.
+ * @param version - API version. Defaults to 'v1.0'.
  * @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/')
+ * @returns Complete base URI with trailing slash (e.g., 'https://comms.todoist.com/api/v1.0/')
  */
 export declare function getCommsBaseUri(version?: ApiVersion, domainBase?: string): string;
 export declare const ENDPOINT_USERS = "users";

package/dist/types/types/api-version.d.ts

@@ -1,6 +1,6 @@
 /**
  * Supported Comms API versions
  */
-export declare const API_VERSIONS: readonly ["v1"];
+export declare const API_VERSIONS: readonly ["v1.0"];
 export type ApiVersion = (typeof API_VERSIONS)[number];
 export declare const DEFAULT_API_VERSION: ApiVersion;

package/dist/types/utils/multipart-upload.d.ts

@@ -12,7 +12,7 @@ import type { CustomFetch, CustomHeaders } from '../types/http.js';
  */
 export type UploadFile = Blob | Uint8Array;
 type UploadMultipartFileArgs = {
-    /** Base API URI with trailing slash, e.g. `https://comms.todoist.com/api/v1/`. */
+    /** Base API URI with trailing slash, e.g. `https://comms.todoist.com/api/v1.0/`. */
     baseUrl: string;
     /** API token used for `Authorization: Bearer`. */
     authToken: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "3.7.0",
+    "version": "3.8.1",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",