@doist/comms-sdk 0.0.1 → 0.2.0

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

@@ -0,0 +1,208 @@
+import { z } from 'zod';
+import { type Channel, type StatusOk } from '../types/entities.js';
+import type { AddChannelUserArgs, AddChannelUsersArgs, CreateChannelArgs, GetChannelsArgs, RemoveChannelUserArgs, RemoveChannelUsersArgs, UpdateChannelArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+export declare const ChannelListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    creator: z.ZodNumber;
+    userIds: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    color: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    public: z.ZodBoolean;
+    workspaceId: z.ZodNumber;
+    archived: z.ZodBoolean;
+    created: z.ZodDate;
+    useDefaultRecipients: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    defaultGroups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    defaultRecipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    isFavorited: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    icon: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    version: z.ZodNumber;
+    filters: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    name: string;
+    creator: number;
+    public: boolean;
+    workspaceId: number;
+    archived: boolean;
+    created: Date;
+    version: number;
+    description?: string | null | undefined;
+    userIds?: number[] | null | undefined;
+    color?: number | null | undefined;
+    useDefaultRecipients?: boolean | null | undefined;
+    defaultGroups?: string[] | null | undefined;
+    defaultRecipients?: number[] | null | undefined;
+    isFavorited?: boolean | null | undefined;
+    icon?: number | null | undefined;
+    filters?: Record<string, string> | null | undefined;
+}, {
+    id: string;
+    name: string;
+    creator: number;
+    public: boolean;
+    workspaceId: number;
+    archived: boolean;
+    created: Date;
+    version: number;
+    description?: string | null | undefined;
+    userIds?: number[] | null | undefined;
+    color?: number | null | undefined;
+    useDefaultRecipients?: boolean | null | undefined;
+    defaultGroups?: string[] | null | undefined;
+    defaultRecipients?: number[] | null | undefined;
+    isFavorited?: boolean | null | undefined;
+    icon?: number | null | undefined;
+    filters?: Record<string, string> | null | undefined;
+}>>>;
+/**
+ * Client for `/api/v1/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.
+ */
+export declare class ChannelsClient extends BaseClient {
+    /**
+     * Gets all channels for a given workspace.
+     *
+     * @param args - The arguments for getting channels.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.archived - Optional flag to include archived channels.
+     * @returns An array of channel objects.
+     *
+     * @example
+     * ```typescript
+     * const channels = await api.channels.getChannels({ workspaceId: 123 })
+     * channels.forEach(ch => console.log(ch.name))
+     * ```
+     */
+    getChannels(args: GetChannelsArgs): Promise<Channel[]>;
+    /**
+     * Gets a single channel object by id.
+     *
+     * @param id - The channel ID.
+     * @returns The channel object.
+     */
+    getChannel(id: string): Promise<Channel>;
+    /**
+     * Creates a new channel. `id` is auto-generated if not supplied — pass your
+     * own `id` to keep an optimistic-UI ID stable through the round-trip.
+     *
+     * @param args - The arguments for creating a channel.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.name - The channel name.
+     * @param args.description - Optional channel description.
+     * @param args.color - Optional channel color.
+     * @param args.userIds - Optional array of user IDs to add to the channel.
+     * @param args.public - Optional flag to make the channel public.
+     * @returns The created channel object.
+     *
+     * @example
+     * ```typescript
+     * const channel = await api.channels.createChannel({
+     *   workspaceId: 123,
+     *   name: 'Engineering',
+     *   description: 'Engineering team channel',
+     * })
+     * ```
+     */
+    createChannel(args: CreateChannelArgs): Promise<Channel>;
+    /**
+     * Partial update of an existing channel.
+     *
+     * @param args - The arguments for updating a channel.
+     * @param args.id - The channel ID.
+     * @param args.name - Optional new channel name.
+     * @param args.description - Optional new channel description.
+     * @param args.color - Optional new channel color.
+     * @param args.public - Optional flag to change channel visibility.
+     * @returns The updated channel object.
+     */
+    updateChannel(args: UpdateChannelArgs): Promise<Channel>;
+    /**
+     * Updates the channel's view filter (`only_open` / `all` / `only_closed`).
+     *
+     * @param args - The arguments for updating the channel filter.
+     * @param args.id - The channel ID.
+     * @param args.filterClosed - The new filter value.
+     */
+    updateFilters(args: {
+        id: string;
+        filterClosed: 'only_open' | 'all' | 'only_closed';
+    }): Promise<StatusOk>;
+    /**
+     * Permanently deletes a channel.
+     *
+     * @param id - The channel ID.
+     */
+    deleteChannel(id: string): Promise<StatusOk>;
+    /**
+     * Archives a channel.
+     *
+     * @param id - The channel ID.
+     */
+    archiveChannel(id: string): Promise<StatusOk>;
+    /**
+     * Unarchives a channel.
+     *
+     * @param id - The channel ID.
+     */
+    unarchiveChannel(id: string): Promise<StatusOk>;
+    /**
+     * Favorites a channel.
+     *
+     * @param id - The channel ID.
+     */
+    favoriteChannel(id: string): Promise<StatusOk>;
+    /**
+     * Unfavorites a channel.
+     *
+     * @param id - The channel ID.
+     */
+    unfavoriteChannel(id: string): Promise<StatusOk>;
+    /**
+     * Adds a user to a channel.
+     *
+     * @param args - The arguments for adding a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to add.
+     *
+     * @example
+     * ```typescript
+     * await api.channels.addUser({ id: '7YpL3oZ4kZ9vP7Q1tR2sX44', userId: 101 })
+     * ```
+     */
+    addUser(args: AddChannelUserArgs): Promise<Channel>;
+    /**
+     * Adds multiple users to a channel.
+     *
+     * @param args - The arguments for adding users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to add.
+     *
+     * @example
+     * ```typescript
+     * await api.channels.addUsers({ id: '7YpL3oZ4kZ9vP7Q1tR2sX44', userIds: [101, 202] })
+     * ```
+     */
+    addUsers(args: AddChannelUsersArgs): Promise<Channel>;
+    /**
+     * Removes a user from a channel.
+     *
+     * @param args - The arguments for removing a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to remove.
+     */
+    removeUser(args: RemoveChannelUserArgs): Promise<Channel>;
+    /**
+     * Removes multiple users from a channel.
+     *
+     * @param args - The arguments for removing users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to remove.
+     */
+    removeUsers(args: RemoveChannelUsersArgs): Promise<Channel>;
+    private simple;
+}

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

@@ -0,0 +1,224 @@
+import { z } from 'zod';
+import { type Comment, type StatusOk } from '../types/entities.js';
+import type { CreateCommentArgs, GetCommentsArgs, MarkCommentPositionArgs, UpdateCommentArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+export declare const CommentListSchema: z.ZodArray<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;
+}>>>;
+/**
+ * Client for `/api/v1/comments/`. The SDK auto-generates the comment `id`
+ * on `createComment` when the caller doesn't supply one.
+ */
+export declare class CommentsClient extends BaseClient {
+    /**
+     * Gets all comments for a thread. `newerThan` / `olderThan` (`Date`) are
+     * converted to `newer_than_ts` / `older_than_ts` epoch seconds on the
+     * wire.
+     *
+     * @param args - The arguments for getting comments.
+     * @param args.threadId - The thread ID.
+     * @param args.newerThan - Optional date to get comments newer than.
+     * @param args.olderThan - Optional date to get comments older than.
+     * @param args.limit - Optional limit on number of comments returned.
+     * @returns An array of comment objects.
+     *
+     * @example
+     * ```typescript
+     * const comments = await api.comments.getComments({
+     *   threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   newerThan: new Date('2024-01-01'),
+     * })
+     * comments.forEach(c => console.log(c.content))
+     * ```
+     */
+    getComments(args: GetCommentsArgs): Promise<Comment[]>;
+    /**
+     * Gets a single comment object by id. The API wraps it in `{comment: ...}`.
+     *
+     * @param id - The comment ID.
+     * @returns The comment object.
+     */
+    getComment(id: string): Promise<Comment>;
+    /**
+     * Creates a new comment on a thread. `id` is auto-generated if not supplied.
+     *
+     * @param args - The arguments for creating a comment.
+     * @param args.threadId - The thread ID.
+     * @param args.content - The comment content.
+     * @param args.recipients - Optional array of user IDs to notify directly.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @param args.directMentions - Optional array of user IDs that were @-mentioned in
+     *   `content`.
+     * @param args.notifyAudience - Optional broader audience to notify in addition to
+     *   `recipients` and `groups`. `'channel'` notifies everyone in the channel;
+     *   `'thread'` notifies everyone who has interacted with the thread.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * // Notify everyone who has interacted with the thread, plus two extra users.
+     * const comment = await api.comments.createComment({
+     *   threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   content: 'Great idea! Let\'s proceed.',
+     *   notifyAudience: 'thread',
+     *   recipients: [101, 202],
+     * })
+     * ```
+     */
+    createComment(args: CreateCommentArgs): Promise<Comment>;
+    /**
+     * Updates a comment's properties.
+     *
+     * @param args - The arguments for updating a comment.
+     * @param args.id - The comment ID.
+     * @param args.content - The new comment content.
+     * @returns The updated comment object.
+     */
+    updateComment(args: UpdateCommentArgs): Promise<Comment>;
+    /**
+     * Permanently deletes a comment.
+     *
+     * @param id - The comment ID.
+     */
+    deleteComment(id: string): Promise<StatusOk>;
+    /**
+     * Marks the user's read position in a thread. Used to track where the user has read up to,
+     * so clients can scroll to this position and show a visual indicator (blue line).
+     * Comment IDs are strings.
+     *
+     * @param args - The arguments for marking read position.
+     * @param args.threadId - The thread ID.
+     * @param args.commentId - The comment ID to mark as the last read position.
+     *
+     * @example
+     * ```typescript
+     * await api.comments.markPosition({ threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z', commentId: '7YpL3oZ4kZ9vP7Q1tR2sX41' })
+     * ```
+     */
+    markPosition(args: MarkCommentPositionArgs): Promise<StatusOk>;
+}

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

@@ -0,0 +1,198 @@
+import { z } from 'zod';
+import { type ConversationMessage, type StatusOk } from '../types/entities.js';
+import type { CreateConversationMessageArgs, GetConversationMessagesArgs, UpdateConversationMessageArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+export declare const ConversationMessageListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    content: z.ZodString;
+    creator: z.ZodNumber;
+    conversationId: z.ZodString;
+    posted: z.ZodDate;
+    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.ZodArray<z.ZodNumber>>>>;
+    actions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
+    objIndex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    lastEdited: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    isDeleted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    version: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    workspaceId: z.ZodNumber;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    content: string;
+    creator: number;
+    conversationId: string;
+    posted: Date;
+    workspaceId: number;
+    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, number[]> | null | undefined;
+    actions?: unknown[] | null | undefined;
+    objIndex?: number | null | undefined;
+    lastEdited?: Date | null | undefined;
+    isDeleted?: boolean | null | undefined;
+    directGroupMentions?: string[] | null | undefined;
+    directMentions?: number[] | null | undefined;
+    version?: number | null | undefined;
+}, {
+    id: string;
+    content: string;
+    creator: number;
+    conversationId: string;
+    posted: Date;
+    workspaceId: number;
+    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, number[]> | null | undefined;
+    actions?: unknown[] | null | undefined;
+    objIndex?: number | null | undefined;
+    lastEdited?: Date | null | undefined;
+    isDeleted?: boolean | null | undefined;
+    directGroupMentions?: string[] | null | undefined;
+    directMentions?: number[] | null | undefined;
+    version?: number | null | undefined;
+}>>>;
+/**
+ * Client for `/api/v1/conversation_messages/`. The SDK auto-generates the
+ * message `id` on `createMessage` when the caller doesn't supply one.
+ */
+export declare class ConversationMessagesClient extends BaseClient {
+    /**
+     * Gets all messages in a conversation.
+     *
+     * @param args - The arguments for getting messages.
+     * @param args.conversationId - The conversation ID.
+     * @param args.newerThan - Optional date to get messages newer than.
+     * @param args.olderThan - Optional date to get messages older than.
+     * @param args.limit - Optional limit on number of messages returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @returns An array of message objects.
+     *
+     * @example
+     * ```typescript
+     * const messages = await api.conversationMessages.getMessages({
+     *   conversationId: '7YpL3oZ4kZ9vP7Q1tR2sX42',
+     *   newerThan: new Date('2024-01-01'),
+     * })
+     * ```
+     */
+    getMessages(args: GetConversationMessagesArgs): Promise<ConversationMessage[]>;
+    /**
+     * Gets a single conversation message by id.
+     *
+     * @param id - The message ID.
+     * @returns The conversation message object.
+     *
+     * @example
+     * ```typescript
+     * const message = await api.conversationMessages.getMessage('7YpL3oZ4kZ9vP7Q1tR2sX43')
+     * ```
+     */
+    getMessage(id: string): Promise<ConversationMessage>;
+    /**
+     * Creates a new message in a conversation. `id` is auto-generated if not
+     * supplied.
+     *
+     * @param args - The arguments for creating a message.
+     * @param args.conversationId - The conversation ID.
+     * @param args.content - The message content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @param args.actions - Optional array of action objects.
+     * @returns The created message object.
+     *
+     * @example
+     * ```typescript
+     * const message = await api.conversationMessages.createMessage({
+     *   conversationId: '7YpL3oZ4kZ9vP7Q1tR2sX42',
+     *   content: 'Thanks for the update!',
+     * })
+     * ```
+     */
+    createMessage(args: CreateConversationMessageArgs): Promise<ConversationMessage>;
+    /**
+     * Updates a conversation message.
+     *
+     * @param args - The arguments for updating a message.
+     * @param args.id - The message ID.
+     * @param args.content - The new message content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @returns The updated message object.
+     *
+     * @example
+     * ```typescript
+     * const message = await api.conversationMessages.updateMessage({
+     *   id: '7YpL3oZ4kZ9vP7Q1tR2sX43',
+     *   content: 'Updated message content',
+     * })
+     * ```
+     */
+    updateMessage(args: UpdateConversationMessageArgs): Promise<ConversationMessage>;
+    /**
+     * Permanently deletes a conversation message.
+     *
+     * @param id - The message ID.
+     *
+     * @example
+     * ```typescript
+     * await api.conversationMessages.deleteMessage('7YpL3oZ4kZ9vP7Q1tR2sX43')
+     * ```
+     */
+    deleteMessage(id: string): Promise<StatusOk>;
+    private simple;
+}