@doist/comms-sdk 0.2.0 → 0.3.0

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

@@ -113,6 +113,9 @@ export declare const ConversationMessageListSchema: z.ZodArray<z.ZodPipe<z.ZodOb
  * message `id` on `createMessage` when the caller doesn't supply one.
  */
 export declare class ConversationMessagesClient extends BaseClient {
+    private readonly linkBaseUrl;
+    private readonly messageSchema;
+    private readonly messageListSchema;
     /**
      * Gets all messages in a conversation.
      *

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

@@ -163,6 +163,9 @@ export declare const ConversationListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
  * already-assigned `id` and your generated one is silently dropped.
  */
 export declare class ConversationsClient extends BaseClient {
+    private readonly linkBaseUrl;
+    private readonly conversationSchema;
+    private readonly conversationListSchema;
     /**
      * Gets all conversations for a workspace.
      *

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

@@ -1,8 +1,390 @@
+import { z } from 'zod';
 import { type InboxThread } from '../types/entities.js';
 import type { ArchiveAllArgs, GetInboxArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
+export declare const InboxThreadListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    content: z.ZodString;
+    creator: z.ZodNumber;
+    creatorName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelId: z.ZodString;
+    workspaceId: z.ZodNumber;
+    actions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
+    attachments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        attachmentId: z.ZodString;
+        urlType: z.ZodString;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        underlyingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        duration: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        uploadState: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        video: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        videoType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        videoAutoPlay: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    }, z.core.$loose>>>>;
+    commentCount: z.ZodNumber;
+    directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    lastEdited: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    lastObjIndex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    lastUpdated: z.ZodDate;
+    mutedUntil: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    participants: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    pinned: z.ZodOptional<z.ZodBoolean>;
+    pinnedTs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    posted: z.ZodDate;
+    reactions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodNumber>>>>;
+    recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    snippet: z.ZodString;
+    snippetCreator: z.ZodNumber;
+    snippetMaskAvatarUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    snippetMaskPoster: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    systemMessage: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodUnknown]>>>;
+    isArchived: z.ZodBoolean;
+    inInbox: z.ZodBoolean;
+    isSaved: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    closed: z.ZodBoolean;
+    responders: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    lastComment: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        content: z.ZodString;
+        creator: z.ZodNumber;
+        threadId: z.ZodString;
+        workspaceId: z.ZodNumber;
+        conversationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        posted: z.ZodDate;
+        lastEdited: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+        directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+        directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        systemMessage: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodUnknown]>>>;
+        attachments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+            attachmentId: z.ZodString;
+            urlType: z.ZodString;
+            title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            underlyingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            duration: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            uploadState: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            video: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            videoType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            videoAutoPlay: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        }, z.core.$loose>>>>;
+        reactions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+        objIndex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        creatorName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        channelId: z.ZodString;
+        recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+        groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        toEmails: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        deleted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        deletedBy: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        version: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        actions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
+    }, z.core.$strip>, z.ZodTransform<{
+        url: string;
+        id: string;
+        content: string;
+        creator: number;
+        threadId: string;
+        workspaceId: number;
+        posted: Date;
+        channelId: string;
+        conversationId?: string | null | undefined;
+        lastEdited?: Date | null | undefined;
+        directMentions?: number[] | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        systemMessage?: unknown;
+        attachments?: {
+            [x: string]: unknown;
+            attachmentId: string;
+            urlType: string;
+            title?: string | null | undefined;
+            url?: string | null | undefined;
+            fileName?: string | null | undefined;
+            fileSize?: number | null | undefined;
+            underlyingType?: string | null | undefined;
+            description?: string | null | undefined;
+            image?: string | null | undefined;
+            imageWidth?: number | null | undefined;
+            imageHeight?: number | null | undefined;
+            duration?: string | null | undefined;
+            uploadState?: string | null | undefined;
+            video?: string | null | undefined;
+            videoType?: string | null | undefined;
+            videoAutoPlay?: boolean | null | undefined;
+        }[] | null | undefined;
+        reactions?: Record<string, unknown> | null | undefined;
+        objIndex?: number | null | undefined;
+        creatorName?: string | null | undefined;
+        recipients?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+        deleted?: boolean | null | undefined;
+        deletedBy?: number | null | undefined;
+        version?: number | null | undefined;
+        actions?: unknown[] | null | undefined;
+    }, {
+        id: string;
+        content: string;
+        creator: number;
+        threadId: string;
+        workspaceId: number;
+        posted: Date;
+        channelId: string;
+        conversationId?: string | null | undefined;
+        lastEdited?: Date | null | undefined;
+        directMentions?: number[] | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        systemMessage?: unknown;
+        attachments?: {
+            [x: string]: unknown;
+            attachmentId: string;
+            urlType: string;
+            title?: string | null | undefined;
+            url?: string | null | undefined;
+            fileName?: string | null | undefined;
+            fileSize?: number | null | undefined;
+            underlyingType?: string | null | undefined;
+            description?: string | null | undefined;
+            image?: string | null | undefined;
+            imageWidth?: number | null | undefined;
+            imageHeight?: number | null | undefined;
+            duration?: string | null | undefined;
+            uploadState?: string | null | undefined;
+            video?: string | null | undefined;
+            videoType?: string | null | undefined;
+            videoAutoPlay?: boolean | null | undefined;
+        }[] | null | undefined;
+        reactions?: Record<string, unknown> | null | undefined;
+        objIndex?: number | null | undefined;
+        creatorName?: string | null | undefined;
+        recipients?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+        deleted?: boolean | null | undefined;
+        deletedBy?: number | null | undefined;
+        version?: number | null | undefined;
+        actions?: unknown[] | null | undefined;
+    }>>>>;
+    toEmails: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    version: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    title: string;
+    content: string;
+    creator: number;
+    channelId: string;
+    workspaceId: number;
+    commentCount: number;
+    lastUpdated: Date;
+    posted: Date;
+    snippet: string;
+    snippetCreator: number;
+    isArchived: boolean;
+    inInbox: boolean;
+    closed: boolean;
+    creatorName?: string | null | undefined;
+    actions?: unknown[] | null | undefined;
+    attachments?: {
+        [x: string]: unknown;
+        attachmentId: string;
+        urlType: string;
+        title?: string | null | undefined;
+        url?: string | null | undefined;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        underlyingType?: string | null | undefined;
+        description?: string | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        duration?: string | null | undefined;
+        uploadState?: string | null | undefined;
+        video?: string | null | undefined;
+        videoType?: string | null | undefined;
+        videoAutoPlay?: boolean | null | undefined;
+    }[] | null | undefined;
+    directGroupMentions?: string[] | null | undefined;
+    directMentions?: number[] | null | undefined;
+    groups?: string[] | null | undefined;
+    lastEdited?: Date | null | undefined;
+    lastObjIndex?: number | null | undefined;
+    mutedUntil?: Date | null | undefined;
+    participants?: number[] | null | undefined;
+    pinned?: boolean | undefined;
+    pinnedTs?: number | null | undefined;
+    reactions?: Record<string, number[]> | null | undefined;
+    recipients?: number[] | null | undefined;
+    snippetMaskAvatarUrl?: string | null | undefined;
+    snippetMaskPoster?: string | null | undefined;
+    systemMessage?: unknown;
+    isSaved?: boolean | null | undefined;
+    responders?: number[] | null | undefined;
+    lastComment?: {
+        url: string;
+        id: string;
+        content: string;
+        creator: number;
+        threadId: string;
+        workspaceId: number;
+        posted: Date;
+        channelId: string;
+        conversationId?: string | null | undefined;
+        lastEdited?: Date | null | undefined;
+        directMentions?: number[] | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        systemMessage?: unknown;
+        attachments?: {
+            [x: string]: unknown;
+            attachmentId: string;
+            urlType: string;
+            title?: string | null | undefined;
+            url?: string | null | undefined;
+            fileName?: string | null | undefined;
+            fileSize?: number | null | undefined;
+            underlyingType?: string | null | undefined;
+            description?: string | null | undefined;
+            image?: string | null | undefined;
+            imageWidth?: number | null | undefined;
+            imageHeight?: number | null | undefined;
+            duration?: string | null | undefined;
+            uploadState?: string | null | undefined;
+            video?: string | null | undefined;
+            videoType?: string | null | undefined;
+            videoAutoPlay?: boolean | null | undefined;
+        }[] | null | undefined;
+        reactions?: Record<string, unknown> | null | undefined;
+        objIndex?: number | null | undefined;
+        creatorName?: string | null | undefined;
+        recipients?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+        deleted?: boolean | null | undefined;
+        deletedBy?: number | null | undefined;
+        version?: number | null | undefined;
+        actions?: unknown[] | null | undefined;
+    } | null | undefined;
+    toEmails?: string[] | null | undefined;
+    version?: number | null | undefined;
+}, {
+    id: string;
+    title: string;
+    content: string;
+    creator: number;
+    channelId: string;
+    workspaceId: number;
+    commentCount: number;
+    lastUpdated: Date;
+    posted: Date;
+    snippet: string;
+    snippetCreator: number;
+    isArchived: boolean;
+    inInbox: boolean;
+    closed: boolean;
+    creatorName?: string | null | undefined;
+    actions?: unknown[] | null | undefined;
+    attachments?: {
+        [x: string]: unknown;
+        attachmentId: string;
+        urlType: string;
+        title?: string | null | undefined;
+        url?: string | null | undefined;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        underlyingType?: string | null | undefined;
+        description?: string | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        duration?: string | null | undefined;
+        uploadState?: string | null | undefined;
+        video?: string | null | undefined;
+        videoType?: string | null | undefined;
+        videoAutoPlay?: boolean | null | undefined;
+    }[] | null | undefined;
+    directGroupMentions?: string[] | null | undefined;
+    directMentions?: number[] | null | undefined;
+    groups?: string[] | null | undefined;
+    lastEdited?: Date | null | undefined;
+    lastObjIndex?: number | null | undefined;
+    mutedUntil?: Date | null | undefined;
+    participants?: number[] | null | undefined;
+    pinned?: boolean | undefined;
+    pinnedTs?: number | null | undefined;
+    reactions?: Record<string, number[]> | null | undefined;
+    recipients?: number[] | null | undefined;
+    snippetMaskAvatarUrl?: string | null | undefined;
+    snippetMaskPoster?: string | null | undefined;
+    systemMessage?: unknown;
+    isSaved?: boolean | null | undefined;
+    responders?: number[] | null | undefined;
+    lastComment?: {
+        url: string;
+        id: string;
+        content: string;
+        creator: number;
+        threadId: string;
+        workspaceId: number;
+        posted: Date;
+        channelId: string;
+        conversationId?: string | null | undefined;
+        lastEdited?: Date | null | undefined;
+        directMentions?: number[] | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        systemMessage?: unknown;
+        attachments?: {
+            [x: string]: unknown;
+            attachmentId: string;
+            urlType: string;
+            title?: string | null | undefined;
+            url?: string | null | undefined;
+            fileName?: string | null | undefined;
+            fileSize?: number | null | undefined;
+            underlyingType?: string | null | undefined;
+            description?: string | null | undefined;
+            image?: string | null | undefined;
+            imageWidth?: number | null | undefined;
+            imageHeight?: number | null | undefined;
+            duration?: string | null | undefined;
+            uploadState?: string | null | undefined;
+            video?: string | null | undefined;
+            videoType?: string | null | undefined;
+            videoAutoPlay?: boolean | null | undefined;
+        }[] | null | undefined;
+        reactions?: Record<string, unknown> | null | undefined;
+        objIndex?: number | null | undefined;
+        creatorName?: string | null | undefined;
+        recipients?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+        deleted?: boolean | null | undefined;
+        deletedBy?: number | null | undefined;
+        version?: number | null | undefined;
+        actions?: unknown[] | null | undefined;
+    } | null | undefined;
+    toEmails?: string[] | null | undefined;
+    version?: number | null | undefined;
+}>>>;
 /** Client for `/api/v1/inbox/`. */
 export declare class InboxClient extends BaseClient {
+    private readonly linkBaseUrl;
+    private readonly inboxThreadSchema;
+    private readonly inboxThreadListSchema;
     /**
      * Gets inbox items (threads).
      *

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

@@ -292,6 +292,10 @@ export declare const ThreadListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
  * `createThread` when the caller doesn't supply one.
  */
 export declare class ThreadsClient extends BaseClient {
+    private readonly linkBaseUrl;
+    private readonly threadSchema;
+    private readonly threadListSchema;
+    private readonly commentSchema;
     /**
      * Gets threads. At least one of `channelId` / `workspaceId` is required.
      * `newerThan` / `olderThan` (`Date`) are converted to the

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

@@ -10,9 +10,13 @@ export declare class WorkspaceUsersClient extends BaseClient {
     /**
      * Returns a list of workspace user objects for the given workspace id.
      *
+     * Removed users are excluded by default; set `args.includeRemoved` to `true` to include them.
+     * The Comms API always returns removed users, so the filtering happens client-side.
+     *
      * @param args - The arguments for getting workspace users.
      * @param args.workspaceId - The workspace ID.
      * @param args.archived - Optional flag to filter archived users.
+     * @param args.includeRemoved - Include users removed from the workspace. Defaults to `false`.
      * @returns An array of workspace user objects.
      *
      * @example

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

@@ -62,6 +62,8 @@ export declare const ChannelListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
  * currently rejects any `color` other than `1` on add/update.
  */
 export declare class WorkspacesClient extends BaseClient {
+    private readonly linkBaseUrl;
+    private readonly channelListSchema;
     /**
      * Gets all the user's workspaces.
      *