@doist/comms-sdk 3.4.1 → 3.6.0

package/dist/esm/clients/add-comment-helper.js

@@ -35,6 +35,7 @@ export function addCommentRequest(context, params, options) {
         relativePath: `${ENDPOINT_COMMENTS}/add`,
         apiToken: context.apiToken,
         payload,
+        headers: context.headers,
         customFetch: context.customFetch,
     }).then((response) => context.schema.parse(response.data));
 }

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

@@ -47,6 +47,7 @@ export class AttachmentsClient extends BaseClient {
             baseUri: this.getBaseUri(),
             relativePath: `${ENDPOINT_FILES}/image/${checkedThreadId}/${id}`,
             apiToken: this.apiToken,
+            headers: this.headers,
             customFetch: this.customFetch,
         });
         return ImageReadResultSchema.parse(response.data);
@@ -88,6 +89,7 @@ export class AttachmentsClient extends BaseClient {
             additionalFields: {
                 attachment_id: resolveAttachmentId(args.attachmentId),
             },
+            headers: this.headers,
             customFetch: this.customFetch,
         });
         return AttachmentSchema.parse(data);

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

@@ -10,6 +10,7 @@ export class BaseClient {
         this.baseUrl = config.baseUrl;
         this.defaultVersion = config.version || DEFAULT_API_VERSION;
         this.customFetch = config.customFetch;
+        this.headers = config.headers;
     }
     /**
      * Returns the base URI for an API request, with a guaranteed trailing

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

@@ -43,6 +43,7 @@ export class ChannelsClient extends BaseClient {
             relativePath: `${ENDPOINT_CHANNELS}/get`,
             apiToken: this.apiToken,
             payload: args,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => this.channelListSchema.parse(response.data));
     }
@@ -201,6 +202,7 @@ export class ChannelsClient extends BaseClient {
             relativePath: `${ENDPOINT_CHANNELS}/${suffix}`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => schema.parse(response.data));
     }

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

@@ -56,6 +56,7 @@ export class CommentsClient extends BaseClient {
             relativePath: `${ENDPOINT_COMMENTS}/get`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => this.commentListSchema.parse(response.data));
     }
@@ -73,6 +74,7 @@ export class CommentsClient extends BaseClient {
             relativePath: `${ENDPOINT_COMMENTS}/getone`,
             apiToken: this.apiToken,
             payload: { id },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => this.commentSchema.parse(response.data));
     }
@@ -107,6 +109,7 @@ export class CommentsClient extends BaseClient {
         return addCommentRequest({
             baseUri: this.getBaseUri(),
             apiToken: this.apiToken,
+            headers: this.headers,
             customFetch: this.customFetch,
             schema: this.commentSchema,
         }, args);
@@ -126,6 +129,7 @@ export class CommentsClient extends BaseClient {
             relativePath: `${ENDPOINT_COMMENTS}/update`,
             apiToken: this.apiToken,
             payload: { ...args },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => this.commentSchema.parse(response.data));
     }
@@ -141,6 +145,7 @@ export class CommentsClient extends BaseClient {
             relativePath: `${ENDPOINT_COMMENTS}/remove`,
             apiToken: this.apiToken,
             payload: { id },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => StatusOkSchema.parse(response.data));
     }
@@ -165,6 +170,7 @@ export class CommentsClient extends BaseClient {
             relativePath: `${ENDPOINT_COMMENTS}/mark_position`,
             apiToken: this.apiToken,
             payload: { threadId: args.threadId, commentId: args.commentId },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => StatusOkSchema.parse(response.data));
     }

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

@@ -56,6 +56,7 @@ export class ConversationMessagesClient extends BaseClient {
             relativePath: `${ENDPOINT_CONVERSATION_MESSAGES}/get`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => this.messageListSchema.parse(response.data));
     }
@@ -159,6 +160,7 @@ export class ConversationMessagesClient extends BaseClient {
             relativePath: `${ENDPOINT_CONVERSATION_MESSAGES}/${suffix}`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => schema.parse(response.data));
     }

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

@@ -77,6 +77,7 @@ export class ConversationsClient extends BaseClient {
             relativePath: `${ENDPOINT_CONVERSATIONS}/get`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => this.conversationListSchema.parse(response.data));
     }
@@ -273,6 +274,7 @@ export class ConversationsClient extends BaseClient {
             relativePath: `${ENDPOINT_CONVERSATIONS}/${suffix}`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => schema.parse(response.data));
     }

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

@@ -34,6 +34,7 @@ export class GroupsClient extends BaseClient {
             relativePath: `${ENDPOINT_GROUPS}/get`,
             apiToken: this.apiToken,
             payload: { workspaceId },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => GroupListSchema.parse(response.data));
     }
@@ -162,6 +163,7 @@ export class GroupsClient extends BaseClient {
             relativePath: `${ENDPOINT_GROUPS}/${suffix}`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => schema.parse(response.data));
     }

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

@@ -26,6 +26,7 @@ export class HooksClient extends BaseClient {
             relativePath: `${ENDPOINT_HOOKS}/subscribe`,
             apiToken: this.apiToken,
             payload: args,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => HookSubscribeResponseSchema.parse(response.data));
     }
@@ -42,6 +43,7 @@ export class HooksClient extends BaseClient {
             relativePath: `${ENDPOINT_HOOKS}/unsubscribe`,
             apiToken: this.apiToken,
             payload: args,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => StatusOkSchema.parse(response.data));
     }

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

@@ -61,6 +61,7 @@ export class InboxClient extends BaseClient {
             relativePath: `${ENDPOINT_INBOX}/get`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => this.inboxThreadListSchema.parse(response.data));
     }
@@ -83,6 +84,7 @@ export class InboxClient extends BaseClient {
             relativePath: `${ENDPOINT_INBOX}/get_count`,
             apiToken: this.apiToken,
             payload: { workspace_id: workspaceId },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data.data);
     }
@@ -103,6 +105,7 @@ export class InboxClient extends BaseClient {
             relativePath: `${ENDPOINT_INBOX}/archive`,
             apiToken: this.apiToken,
             payload: { id },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -123,6 +126,7 @@ export class InboxClient extends BaseClient {
             relativePath: `${ENDPOINT_INBOX}/unarchive`,
             apiToken: this.apiToken,
             payload: { id },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -143,6 +147,7 @@ export class InboxClient extends BaseClient {
             relativePath: `${ENDPOINT_INBOX}/mark_all_read`,
             apiToken: this.apiToken,
             payload: { workspace_id: workspaceId },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -174,6 +179,7 @@ export class InboxClient extends BaseClient {
             relativePath: `${ENDPOINT_INBOX}/archive_all`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }

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

@@ -35,6 +35,7 @@ export class ReactionsClient extends BaseClient {
             relativePath: `${ENDPOINT_REACTIONS}/add`,
             apiToken: this.apiToken,
             payload: { ...reactionTarget(args), reaction: args.reaction },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -63,6 +64,7 @@ export class ReactionsClient extends BaseClient {
             relativePath: `${ENDPOINT_REACTIONS}/get`,
             apiToken: this.apiToken,
             payload: reactionTarget(args),
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
@@ -87,6 +89,7 @@ export class ReactionsClient extends BaseClient {
             relativePath: `${ENDPOINT_REACTIONS}/remove`,
             apiToken: this.apiToken,
             payload: { ...reactionTarget(args), reaction: args.reaction },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }

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

@@ -53,6 +53,7 @@ export class SearchClient extends BaseClient {
             relativePath: ENDPOINT_SEARCH,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => ({
             ...response.data,
@@ -92,6 +93,7 @@ export class SearchClient extends BaseClient {
             relativePath: `${ENDPOINT_SEARCH}/thread`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
@@ -128,6 +130,7 @@ export class SearchClient extends BaseClient {
             relativePath: `${ENDPOINT_SEARCH}/conversation`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }

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

@@ -72,6 +72,7 @@ export class ThreadsClient extends BaseClient {
             relativePath: `${ENDPOINT_THREADS}/get`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => this.threadListSchema.parse(response.data));
     }
@@ -343,6 +344,7 @@ export class ThreadsClient extends BaseClient {
         return addCommentRequest({
             baseUri: this.getBaseUri(),
             apiToken: this.apiToken,
+            headers: this.headers,
             customFetch: this.customFetch,
             schema: this.commentSchema,
         }, { threadId: resolveReferenceId(id, 'id'), ...rest }, { threadAction });
@@ -354,6 +356,7 @@ export class ThreadsClient extends BaseClient {
             relativePath: `${ENDPOINT_THREADS}/${suffix}`,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => schema.parse(response.data));
     }

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

@@ -92,6 +92,7 @@ export class UsersClient extends BaseClient {
             relativePath: `${ENDPOINT_USERS}/mfa/challenge`,
             apiToken: undefined,
             payload: args,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
@@ -103,6 +104,7 @@ export class UsersClient extends BaseClient {
             relativePath: `${ENDPOINT_USERS}/logout`,
             apiToken: this.apiToken,
             payload: undefined,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -246,6 +248,7 @@ export class UsersClient extends BaseClient {
             relativePath: `${ENDPOINT_USERS}/validate_token`,
             apiToken: undefined,
             payload: { token },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -268,6 +271,7 @@ export class UsersClient extends BaseClient {
             relativePath: `${ENDPOINT_USERS}/heartbeat`,
             apiToken: this.apiToken,
             payload: args,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -283,6 +287,7 @@ export class UsersClient extends BaseClient {
             relativePath: `${ENDPOINT_USERS}/reset_presence`,
             apiToken: this.apiToken,
             payload: { workspaceId },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -299,6 +304,7 @@ export class UsersClient extends BaseClient {
             relativePath: `${ENDPOINT_USERS}/check_email`,
             apiToken: undefined,
             payload: { email },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
@@ -315,6 +321,7 @@ export class UsersClient extends BaseClient {
             relativePath: `${ENDPOINT_USERS}/get_unsubscribe_settings`,
             apiToken: this.apiToken,
             payload: undefined,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
@@ -331,6 +338,7 @@ export class UsersClient extends BaseClient {
             relativePath: `${ENDPOINT_USERS}/update_unsubscribe_settings`,
             apiToken: this.apiToken,
             payload: settings,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
@@ -341,6 +349,7 @@ export class UsersClient extends BaseClient {
             relativePath: url,
             apiToken: this.apiToken,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => schema.parse(response.data));
     }
@@ -352,6 +361,7 @@ export class UsersClient extends BaseClient {
             relativePath: url,
             apiToken: authed ? this.apiToken : undefined,
             payload: params,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => schema.parse(response.data));
     }

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

@@ -32,6 +32,7 @@ export class WorkspaceUsersClient extends BaseClient {
             relativePath: 'workspace_users/get',
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, archived: args.archived },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => {
             const rawUsers = includeRemoved
@@ -53,6 +54,7 @@ export class WorkspaceUsersClient extends BaseClient {
             relativePath: 'workspace_users/get_ids',
             apiToken: this.apiToken,
             payload: { id: workspaceId },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
@@ -78,6 +80,7 @@ export class WorkspaceUsersClient extends BaseClient {
             relativePath: 'workspace_users/getone',
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, user_id: args.userId },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => VisibleWorkspaceUserSchema.parse(response.data));
     }
@@ -105,6 +108,7 @@ export class WorkspaceUsersClient extends BaseClient {
             relativePath: 'workspace_users/get_by_email',
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, email: args.email },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => VisibleWorkspaceUserSchema.parse(response.data));
     }
@@ -123,6 +127,7 @@ export class WorkspaceUsersClient extends BaseClient {
             relativePath: 'workspace_users/get_info',
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, user_id: args.userId },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
@@ -150,6 +155,7 @@ export class WorkspaceUsersClient extends BaseClient {
             relativePath: 'workspace_users/get_local_time',
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, user_id: args.userId },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data);
     }
@@ -173,6 +179,7 @@ export class WorkspaceUsersClient extends BaseClient {
                 email: args.email,
                 userType: args.userType,
             },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => WorkspaceUserSchema.parse(response.data));
     }
@@ -198,6 +205,7 @@ export class WorkspaceUsersClient extends BaseClient {
                 email: args.email,
                 userId: args.userId,
             },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => WorkspaceUserSchema.parse(response.data));
     }
@@ -220,6 +228,7 @@ export class WorkspaceUsersClient extends BaseClient {
                 email: args.email,
                 userId: args.userId,
             },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -242,6 +251,7 @@ export class WorkspaceUsersClient extends BaseClient {
                 email: args.email,
                 userId: args.userId,
             },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }

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

@@ -35,6 +35,7 @@ export class WorkspacesClient extends BaseClient {
             relativePath: `${ENDPOINT_WORKSPACES}/get`,
             apiToken: this.apiToken,
             payload: undefined,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => response.data.map((workspace) => WorkspaceSchema.parse(workspace)));
     }
@@ -57,6 +58,7 @@ export class WorkspacesClient extends BaseClient {
             relativePath: `${ENDPOINT_WORKSPACES}/getone`,
             apiToken: this.apiToken,
             payload: { id },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => WorkspaceSchema.parse(response.data));
     }
@@ -78,6 +80,7 @@ export class WorkspacesClient extends BaseClient {
             relativePath: `${ENDPOINT_WORKSPACES}/get_default`,
             apiToken: this.apiToken,
             payload: undefined,
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => WorkspaceSchema.parse(response.data));
     }
@@ -100,6 +103,7 @@ export class WorkspacesClient extends BaseClient {
             relativePath: `${ENDPOINT_WORKSPACES}/add`,
             apiToken: this.apiToken,
             payload: { name },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => WorkspaceSchema.parse(response.data));
     }
@@ -122,6 +126,7 @@ export class WorkspacesClient extends BaseClient {
             relativePath: `${ENDPOINT_WORKSPACES}/update`,
             apiToken: this.apiToken,
             payload: { id, name },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => WorkspaceSchema.parse(response.data));
     }
@@ -142,6 +147,7 @@ export class WorkspacesClient extends BaseClient {
             relativePath: `${ENDPOINT_WORKSPACES}/remove`,
             apiToken: this.apiToken,
             payload: { id },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then(() => undefined);
     }
@@ -164,6 +170,7 @@ export class WorkspacesClient extends BaseClient {
             relativePath: `${ENDPOINT_WORKSPACES}/get_public_channels`,
             apiToken: this.apiToken,
             payload: { id },
+            headers: this.headers,
             customFetch: this.customFetch,
         }).then((response) => this.channelListSchema.parse(response.data));
     }

package/dist/esm/comms-api.js

@@ -37,6 +37,7 @@ export class CommsApi {
             baseUrl: options?.baseUrl,
             version: options?.version,
             customFetch: options?.customFetch,
+            headers: options?.headers,
         };
         this.users = new UsersClient(clientConfig);
         this.workspaces = new WorkspacesClient(clientConfig);

package/dist/esm/transport/http-client.js

@@ -21,15 +21,16 @@ const defaultHeaders = {
 function getAuthHeader(apiToken) {
     return `Bearer ${apiToken}`;
 }
-function getRequestConfiguration(baseURL, apiToken, requestId) {
+function getRequestConfiguration(baseURL, apiToken, requestId, customHeaders) {
     const authHeader = apiToken ? { Authorization: getAuthHeader(apiToken) } : undefined;
     const requestIdHeader = requestId ? { 'X-Request-Id': requestId } : undefined;
-    const headers = { ...defaultHeaders, ...authHeader, ...requestIdHeader };
+    // Custom headers sit below auth and request id so they can never clobber them.
+    const headers = { ...defaultHeaders, ...customHeaders, ...authHeader, ...requestIdHeader };
     return { baseURL, headers, timeout: 30000 };
 }
 export async function request(args) {
-    const { httpMethod, baseUri, relativePath, apiToken, payload, requestId, customFetch } = args;
-    const config = getRequestConfiguration(baseUri, apiToken, requestId);
+    const { httpMethod, baseUri, relativePath, apiToken, payload, requestId, headers, customFetch, } = args;
+    const config = getRequestConfiguration(baseUri, apiToken, requestId, headers);
     const url = new URL(relativePath, config.baseURL).toString();
     const options = {
         method: httpMethod,

package/dist/esm/types/entities.js

@@ -49,6 +49,10 @@ export const AttachmentSchema = z.object(attachmentShape).loose();
 // this strips unknown keys so caller typos / off-spec fields are dropped instead
 // of being forwarded on the wire. Use this for `*Args` request schemas.
 export const RequestAttachmentSchema = z.object(attachmentShape);
+// Clients that don't model `scope` can store `{}`, and the backend omits unset fields.
+export const StatusEffectSchema = z.object({
+    scope: z.object({ mode: z.string().optional() }).optional(),
+});
 // Shared user status. It lives on the Todoist account, so Comms, Todoist and
 // automations all see the same one. `activeUntil` is an RFC 3339 string, and an
 // expired status is returned as `null` rather than as an expired object.
@@ -58,10 +62,8 @@ export const UserStatusSchema = z.object({
     activeUntil: z.string().nullable().optional(),
     effects: z
         .object({
-        // Clients that don't model `scope` can store `{}`, and the backend omits unset fields.
-        pauseNotifications: z
-            .object({ scope: z.object({ mode: z.string().optional() }).optional() })
-            .optional(),
+        pauseNotifications: StatusEffectSchema.optional(),
+        pauseActivity: StatusEffectSchema.optional(),
     })
         .optional(),
 });

package/dist/esm/utils/multipart-upload.js

@@ -164,7 +164,7 @@ function buildMultipartBody(args) {
  * the returned shape with the appropriate schema.
  */
 export async function uploadMultipartFile(args) {
-    const { baseUrl, authToken, endpoint, file, fileName, contentType, additionalFields, maxRetries = 0, requestId, customFetch, } = args;
+    const { baseUrl, authToken, endpoint, file, fileName, contentType, additionalFields, maxRetries = 0, requestId, headers: customHeaders, customFetch, } = args;
     const { blob, fileName: resolvedFileName, contentType: resolvedType, } = toBlob(file, fileName, contentType);
     const fields = {
         file_name: resolvedFileName,
@@ -179,6 +179,7 @@ export async function uploadMultipartFile(args) {
         fields,
     });
     const headers = {
+        ...customHeaders,
         Authorization: `Bearer ${authToken}`,
         // The boundary is ours, so this has to be declared explicitly — `fetch`
         // only fills it in for a `FormData` body.

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

@@ -5,6 +5,7 @@ type ClientContext = {
     baseUri: string;
     apiToken: string;
     customFetch?: CustomFetch;
+    headers?: Record<string, string>;
     /** Per-client Comment schema, base-bound for the returned comment's web `url`. */
     schema: ReturnType<typeof createCommentSchema>;
 };

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

@@ -9,6 +9,8 @@ export type ClientConfig = {
     version?: ApiVersion;
     /** Optional custom fetch implementation for cross-platform compatibility */
     customFetch?: CustomFetch;
+    /** Optional headers sent with every request */
+    headers?: Record<string, string>;
 };
 /**
  * Base class for every Comms API client. Centralizes URL handling and
@@ -19,6 +21,7 @@ export declare class BaseClient {
     protected readonly baseUrl?: string;
     protected readonly defaultVersion: ApiVersion;
     protected readonly customFetch?: CustomFetch;
+    protected readonly headers?: Record<string, string>;
     constructor(config: ClientConfig);
     /**
      * Returns the base URI for an API request, with a guaranteed trailing

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

@@ -21,6 +21,8 @@ export type CommsApiOptions = {
     version?: ApiVersion;
     /** Optional custom fetch implementation for cross-platform compatibility (e.g., Obsidian, React Native, Electron). */
     customFetch?: CustomFetch;
+    /** Optional headers sent with every request, e.g. `{ 'Doist-Platform': 'cli' }` for client attribution. Cannot override `Authorization` or `X-Request-Id`. */
+    headers?: Record<string, string>;
 };
 /**
  * The main API client for interacting with the Comms REST API.

package/dist/types/transport/http-client.d.ts

@@ -7,6 +7,7 @@ export type RequestArgs = {
     apiToken?: string;
     payload?: Record<string, unknown>;
     requestId?: string;
+    headers?: Record<string, string>;
     customFetch?: CustomFetch;
 };
 export declare function request<T>(args: RequestArgs): Promise<HttpResponse<T>>;

package/dist/types/types/entities.d.ts

@@ -54,6 +54,11 @@ export declare const RequestAttachmentSchema: z.ZodObject<{
     videoAutoPlay: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
 }, z.core.$strip>;
 export type RequestAttachment = z.infer<typeof RequestAttachmentSchema>;
+export declare const StatusEffectSchema: z.ZodObject<{
+    scope: z.ZodOptional<z.ZodObject<{
+        mode: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export declare const UserStatusSchema: z.ZodObject<{
     message: z.ZodString;
     emoji: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -64,6 +69,11 @@ export declare const UserStatusSchema: z.ZodObject<{
                 mode: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>;
         }, z.core.$strip>>;
+        pauseActivity: z.ZodOptional<z.ZodObject<{
+            scope: z.ZodOptional<z.ZodObject<{
+                mode: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type UserStatus = z.infer<typeof UserStatusSchema>;
@@ -93,6 +103,11 @@ export declare const BaseUserSchema: z.ZodObject<{
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
@@ -122,6 +137,11 @@ export declare const UserSchema: z.ZodObject<{
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     email: z.ZodEmail;
@@ -1638,6 +1658,11 @@ export declare const WorkspaceUserSchema: z.ZodObject<{
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1663,6 +1688,11 @@ export declare const RestrictedWorkspaceUserSchema: z.ZodObject<{
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     id: z.ZodNumber;
@@ -1708,6 +1738,11 @@ export declare const VisibleWorkspaceUserSchema: z.ZodUnion<readonly [z.ZodObjec
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1731,6 +1766,11 @@ export declare const VisibleWorkspaceUserSchema: z.ZodUnion<readonly [z.ZodObjec
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     id: z.ZodNumber;

package/dist/types/types/requests.d.ts

@@ -185,6 +185,11 @@ export type UpdateUserArgs = {
     /** Theme ID (0-12). String aliases like `'dark'` are also accepted. */
     theme?: number | string;
 };
+type StatusEffectArgs = {
+    scope?: {
+        mode: 'all';
+    };
+};
 export type SetStatusArgs = {
     /** 1 to 80 characters once trimmed. */
     message: string;
@@ -193,11 +198,9 @@ export type SetStatusArgs = {
     activeUntil?: Date | string | null;
     effects?: {
         /** Holds back Comms notifications while the status is active. They are not sent later. */
-        pauseNotifications?: {
-            scope?: {
-                mode: 'all';
-            };
-        };
+        pauseNotifications?: StatusEffectArgs;
+        /** Meant to pause Karma and streaks while the status is active. Comms drops it until Doist/comms-backend#1081 ships. */
+        pauseActivity?: StatusEffectArgs;
     };
 };
 type SearchArgsCommon = {

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

@@ -33,6 +33,8 @@ type UploadMultipartFileArgs = {
     maxRetries?: number;
     /** Optional request ID for tracing. */
     requestId?: string;
+    /** Optional headers sent with the request. Cannot override `Authorization` or `Content-Type`. */
+    headers?: Record<string, string>;
     /** Optional custom fetch implementation. */
     customFetch?: CustomFetch;
 };

package/package.json

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