@linqapp/sdk 0.1.0-alpha.1

package/resources/chats/chats.d.ts

@@ -0,0 +1,1040 @@
+import { APIResource } from "../../core/resource.js";
+import * as MessagesAPI from "./messages.js";
+import { MessageListParams, MessageListResponse, MessageSendParams, MessageSendResponse, Messages } from "./messages.js";
+import * as ParticipantsAPI from "./participants.js";
+import { ParticipantAddParams, ParticipantAddResponse, ParticipantRemoveParams, ParticipantRemoveResponse, Participants } from "./participants.js";
+import * as TypingAPI from "./typing.js";
+import { Typing } from "./typing.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Chats extends APIResource {
+    participants: ParticipantsAPI.Participants;
+    typing: TypingAPI.Typing;
+    messages: MessagesAPI.Messages;
+    /**
+     * Create a new chat with specified participants and send an initial message. The
+     * initial message is required when creating a chat.
+     *
+     * ## Message Effects
+     *
+     * You can add iMessage effects to make your messages more expressive. Effects are
+     * optional and can be either screen effects (full-screen animations) or bubble
+     * effects (message bubble animations).
+     *
+     * **Screen Effects:** `confetti`, `fireworks`, `lasers`, `sparkles`,
+     * `celebration`, `hearts`, `love`, `balloons`, `happy_birthday`, `echo`,
+     * `spotlight`
+     *
+     * **Bubble Effects:** `slam`, `loud`, `gentle`, `invisible`
+     *
+     * Only one effect type can be applied per message.
+     *
+     * @example
+     * ```ts
+     * const chat = await client.chats.create({
+     *   from: '+12052535597',
+     *   message: {
+     *     parts: [
+     *       {
+     *         type: 'text',
+     *         value: 'Hello! How can I help you today?',
+     *       },
+     *     ],
+     *   },
+     *   to: ['+12052532136'],
+     * });
+     * ```
+     */
+    create(body: ChatCreateParams, options?: RequestOptions): APIPromise<ChatCreateResponse>;
+    /**
+     * Retrieve a chat by its unique identifier.
+     *
+     * @example
+     * ```ts
+     * const chat = await client.chats.retrieve(
+     *   '550e8400-e29b-41d4-a716-446655440000',
+     * );
+     * ```
+     */
+    retrieve(chatID: string, options?: RequestOptions): APIPromise<ChatRetrieveResponse>;
+    /**
+     * Update chat properties such as display name and group chat icon.
+     *
+     * @example
+     * ```ts
+     * const chat = await client.chats.update(
+     *   '550e8400-e29b-41d4-a716-446655440000',
+     *   { display_name: 'Team Discussion' },
+     * );
+     * ```
+     */
+    update(chatID: string, body: ChatUpdateParams, options?: RequestOptions): APIPromise<ChatUpdateResponse>;
+    /**
+     * Retrieves a paginated list of chats for the authenticated partner filtered by
+     * phone number. Returns all chats involving the specified phone number with their
+     * participants and recent activity.
+     *
+     * **Pagination:**
+     *
+     * - Use `limit` to control page size (default: 20, max: 100)
+     * - The response includes `next_cursor` for fetching the next page
+     * - When `next_cursor` is `null`, there are no more results to fetch
+     * - Pass the `next_cursor` value as the `cursor` parameter for the next request
+     *
+     * **Example pagination flow:**
+     *
+     * 1. First request: `GET /v3/chats?from=%2B12223334444&limit=20`
+     * 2. Response includes `next_cursor: "20"` (more results exist)
+     * 3. Next request: `GET /v3/chats?from=%2B12223334444&limit=20&cursor=20`
+     * 4. Response includes `next_cursor: null` (no more results)
+     *
+     * @example
+     * ```ts
+     * const chats = await client.chats.list({
+     *   from: '+13343284472',
+     * });
+     * ```
+     */
+    list(query: ChatListParams, options?: RequestOptions): APIPromise<ChatListResponse>;
+    /**
+     * Mark all messages in a chat as read.
+     *
+     * @example
+     * ```ts
+     * await client.chats.markAsRead(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    markAsRead(chatID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Send an audio file as an **iMessage voice memo bubble** to all participants in a
+     * chat. Voice memos appear with iMessage's native inline playback UI, unlike
+     * regular audio attachments sent via media parts which appear as downloadable
+     * files.
+     *
+     * **Supported audio formats:**
+     *
+     * - MP3 (audio/mpeg)
+     * - M4A (audio/x-m4a, audio/mp4)
+     * - AAC (audio/aac)
+     * - CAF (audio/x-caf) - Core Audio Format
+     * - WAV (audio/wav)
+     * - AIFF (audio/aiff, audio/x-aiff)
+     * - AMR (audio/amr)
+     *
+     * @example
+     * ```ts
+     * const response = await client.chats.sendVoicememo(
+     *   'f19ee7b8-8533-4c5c-83ec-4ef8d6d1ddbd',
+     *   {
+     *     from: '+12052535597',
+     *     voice_memo_url: 'https://example.com/voice-memo.m4a',
+     *   },
+     * );
+     * ```
+     */
+    sendVoicememo(chatID: string, body: ChatSendVoicememoParams, options?: RequestOptions): APIPromise<ChatSendVoicememoResponse>;
+    /**
+     * Share your contact information (Name and Photo Sharing) with a chat.
+     *
+     * @example
+     * ```ts
+     * await client.chats.shareContactCard(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    shareContactCard(chatID: string, options?: RequestOptions): APIPromise<void>;
+}
+/**
+ * Response for creating a new chat with an initial message
+ */
+export interface ChatCreateResponse {
+    chat: ChatCreateResponse.Chat;
+}
+export declare namespace ChatCreateResponse {
+    interface Chat {
+        /**
+         * Unique identifier for the created chat (UUID)
+         */
+        id: string;
+        /**
+         * Display name for the chat. Defaults to a comma-separated list of recipient
+         * handles. Can be updated for group chats.
+         */
+        display_name: string | null;
+        /**
+         * List of participants in the chat. Always contains at least two handles (your
+         * phone number and the other participant).
+         */
+        handles: Array<Chat.Handle>;
+        /**
+         * Whether this is a group chat
+         */
+        is_group: boolean;
+        /**
+         * A message that was sent (used in CreateChat and SendMessage responses)
+         */
+        message: Chat.Message;
+        /**
+         * Messaging service used
+         */
+        service: string;
+    }
+    namespace Chat {
+        interface Handle {
+            /**
+             * Unique identifier for this handle
+             */
+            id: string;
+            /**
+             * Phone number (E.164) or email address of the participant
+             */
+            handle: string;
+            /**
+             * When this participant joined the chat
+             */
+            joined_at: string;
+            /**
+             * Service type (iMessage, SMS, RCS, etc.)
+             */
+            service: 'iMessage' | 'SMS' | 'RCS';
+            /**
+             * Whether this handle belongs to the sender (your phone number)
+             */
+            is_me?: boolean | null;
+            /**
+             * When they left (if applicable)
+             */
+            left_at?: string | null;
+            /**
+             * Participant status
+             */
+            status?: 'active' | 'left' | 'removed' | null;
+        }
+        /**
+         * A message that was sent (used in CreateChat and SendMessage responses)
+         */
+        interface Message {
+            /**
+             * Message identifier (UUID)
+             */
+            id: string;
+            /**
+             * Current delivery status of a message
+             */
+            delivery_status: 'pending' | 'queued' | 'sent' | 'delivered' | 'failed';
+            /**
+             * Whether the message has been read
+             */
+            is_read: boolean;
+            /**
+             * Message parts in order (text and media)
+             */
+            parts: Array<Message.TextPartResponse | Message.MediaPartResponse>;
+            /**
+             * When the message was sent
+             */
+            sent_at: string;
+            /**
+             * When the message was delivered
+             */
+            delivered_at?: string | null;
+            /**
+             * iMessage effect applied to a message (screen or bubble effect)
+             */
+            effect?: Message.Effect | null;
+            /**
+             * The sender of this message as a full handle object
+             */
+            from_handle?: Message.FromHandle | null;
+            /**
+             * Preferred service for sending this message
+             */
+            preferred_service?: 'iMessage' | 'SMS' | 'RCS' | null;
+            /**
+             * Indicates this message is a threaded reply to another message
+             */
+            reply_to?: Message.ReplyTo | null;
+            /**
+             * Service used to send this message
+             */
+            service?: 'iMessage' | 'SMS' | 'RCS' | null;
+        }
+        namespace Message {
+            /**
+             * A text message part
+             */
+            interface TextPartResponse {
+                /**
+                 * Reactions on this message part
+                 */
+                reactions: Array<TextPartResponse.Reaction> | null;
+                /**
+                 * Indicates this is a text message part
+                 */
+                type: 'text';
+                /**
+                 * The text content
+                 */
+                value: string;
+            }
+            namespace TextPartResponse {
+                interface Reaction {
+                    handle: Reaction.Handle;
+                    /**
+                     * Whether this reaction is from the current user
+                     */
+                    is_me: boolean;
+                    /**
+                     * Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh,
+                     * emphasize, question. Custom emoji reactions have type "custom" with the actual
+                     * emoji in the custom_emoji field.
+                     */
+                    type: 'love' | 'like' | 'dislike' | 'laugh' | 'emphasize' | 'question' | 'custom';
+                    /**
+                     * Custom emoji if type is "custom", null otherwise
+                     */
+                    custom_emoji?: string | null;
+                }
+                namespace Reaction {
+                    interface Handle {
+                        /**
+                         * Unique identifier for this handle
+                         */
+                        id: string;
+                        /**
+                         * Phone number (E.164) or email address of the participant
+                         */
+                        handle: string;
+                        /**
+                         * When this participant joined the chat
+                         */
+                        joined_at: string;
+                        /**
+                         * Service type (iMessage, SMS, RCS, etc.)
+                         */
+                        service: 'iMessage' | 'SMS' | 'RCS';
+                        /**
+                         * Whether this handle belongs to the sender (your phone number)
+                         */
+                        is_me?: boolean | null;
+                        /**
+                         * When they left (if applicable)
+                         */
+                        left_at?: string | null;
+                        /**
+                         * Participant status
+                         */
+                        status?: 'active' | 'left' | 'removed' | null;
+                    }
+                }
+            }
+            /**
+             * A media attachment part
+             */
+            interface MediaPartResponse {
+                /**
+                 * Unique attachment identifier
+                 */
+                id: string;
+                /**
+                 * Original filename
+                 */
+                filename: string;
+                /**
+                 * MIME type of the file
+                 */
+                mime_type: string;
+                /**
+                 * Reactions on this message part
+                 */
+                reactions: Array<MediaPartResponse.Reaction> | null;
+                /**
+                 * File size in bytes
+                 */
+                size_bytes: number;
+                /**
+                 * Indicates this is a media attachment part
+                 */
+                type: 'media';
+                /**
+                 * Presigned URL for downloading the attachment (expires in 1 hour).
+                 */
+                url: string;
+            }
+            namespace MediaPartResponse {
+                interface Reaction {
+                    handle: Reaction.Handle;
+                    /**
+                     * Whether this reaction is from the current user
+                     */
+                    is_me: boolean;
+                    /**
+                     * Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh,
+                     * emphasize, question. Custom emoji reactions have type "custom" with the actual
+                     * emoji in the custom_emoji field.
+                     */
+                    type: 'love' | 'like' | 'dislike' | 'laugh' | 'emphasize' | 'question' | 'custom';
+                    /**
+                     * Custom emoji if type is "custom", null otherwise
+                     */
+                    custom_emoji?: string | null;
+                }
+                namespace Reaction {
+                    interface Handle {
+                        /**
+                         * Unique identifier for this handle
+                         */
+                        id: string;
+                        /**
+                         * Phone number (E.164) or email address of the participant
+                         */
+                        handle: string;
+                        /**
+                         * When this participant joined the chat
+                         */
+                        joined_at: string;
+                        /**
+                         * Service type (iMessage, SMS, RCS, etc.)
+                         */
+                        service: 'iMessage' | 'SMS' | 'RCS';
+                        /**
+                         * Whether this handle belongs to the sender (your phone number)
+                         */
+                        is_me?: boolean | null;
+                        /**
+                         * When they left (if applicable)
+                         */
+                        left_at?: string | null;
+                        /**
+                         * Participant status
+                         */
+                        status?: 'active' | 'left' | 'removed' | null;
+                    }
+                }
+            }
+            /**
+             * iMessage effect applied to a message (screen or bubble effect)
+             */
+            interface Effect {
+                /**
+                 * Name of the effect. Common values:
+                 *
+                 * - Screen effects: confetti, fireworks, lasers, sparkles, celebration, hearts,
+                 *   love, balloons, happy_birthday, echo, spotlight
+                 * - Bubble effects: slam, loud, gentle, invisible
+                 */
+                name?: string;
+                /**
+                 * Type of effect
+                 */
+                type?: 'screen' | 'bubble';
+            }
+            /**
+             * The sender of this message as a full handle object
+             */
+            interface FromHandle {
+                /**
+                 * Unique identifier for this handle
+                 */
+                id: string;
+                /**
+                 * Phone number (E.164) or email address of the participant
+                 */
+                handle: string;
+                /**
+                 * When this participant joined the chat
+                 */
+                joined_at: string;
+                /**
+                 * Service type (iMessage, SMS, RCS, etc.)
+                 */
+                service: 'iMessage' | 'SMS' | 'RCS';
+                /**
+                 * Whether this handle belongs to the sender (your phone number)
+                 */
+                is_me?: boolean | null;
+                /**
+                 * When they left (if applicable)
+                 */
+                left_at?: string | null;
+                /**
+                 * Participant status
+                 */
+                status?: 'active' | 'left' | 'removed' | null;
+            }
+            /**
+             * Indicates this message is a threaded reply to another message
+             */
+            interface ReplyTo {
+                /**
+                 * The ID of the message to reply to
+                 */
+                message_id: string;
+                /**
+                 * The specific message part to reply to (0-based index). Defaults to 0 (first
+                 * part) if not provided. Use this when replying to a specific part of a multipart
+                 * message.
+                 */
+                part_index?: number;
+            }
+        }
+    }
+}
+export interface ChatRetrieveResponse {
+    /**
+     * Unique identifier for the chat
+     */
+    id: string;
+    /**
+     * When the chat was created
+     */
+    created_at: string;
+    /**
+     * Display name for the chat. Defaults to a comma-separated list of recipient
+     * handles. Can be updated for group chats.
+     */
+    display_name: string | null;
+    /**
+     * List of chat participants with full handle details. Always contains at least two
+     * handles (your phone number and the other participant).
+     */
+    handles: Array<ChatRetrieveResponse.Handle>;
+    /**
+     * Whether the chat is archived
+     */
+    is_archived: boolean;
+    /**
+     * Whether this is a group chat
+     */
+    is_group: boolean;
+    /**
+     * When the chat was last updated
+     */
+    updated_at: string;
+    /**
+     * Service type for the chat
+     */
+    service?: 'iMessage' | 'SMS' | 'RCS' | null;
+}
+export declare namespace ChatRetrieveResponse {
+    interface Handle {
+        /**
+         * Unique identifier for this handle
+         */
+        id: string;
+        /**
+         * Phone number (E.164) or email address of the participant
+         */
+        handle: string;
+        /**
+         * When this participant joined the chat
+         */
+        joined_at: string;
+        /**
+         * Service type (iMessage, SMS, RCS, etc.)
+         */
+        service: 'iMessage' | 'SMS' | 'RCS';
+        /**
+         * Whether this handle belongs to the sender (your phone number)
+         */
+        is_me?: boolean | null;
+        /**
+         * When they left (if applicable)
+         */
+        left_at?: string | null;
+        /**
+         * Participant status
+         */
+        status?: 'active' | 'left' | 'removed' | null;
+    }
+}
+export interface ChatUpdateResponse {
+    /**
+     * Unique identifier for the chat
+     */
+    id: string;
+    /**
+     * When the chat was created
+     */
+    created_at: string;
+    /**
+     * Display name for the chat. Defaults to a comma-separated list of recipient
+     * handles. Can be updated for group chats.
+     */
+    display_name: string | null;
+    /**
+     * List of chat participants with full handle details. Always contains at least two
+     * handles (your phone number and the other participant).
+     */
+    handles: Array<ChatUpdateResponse.Handle>;
+    /**
+     * Whether the chat is archived
+     */
+    is_archived: boolean;
+    /**
+     * Whether this is a group chat
+     */
+    is_group: boolean;
+    /**
+     * When the chat was last updated
+     */
+    updated_at: string;
+    /**
+     * Service type for the chat
+     */
+    service?: 'iMessage' | 'SMS' | 'RCS' | null;
+}
+export declare namespace ChatUpdateResponse {
+    interface Handle {
+        /**
+         * Unique identifier for this handle
+         */
+        id: string;
+        /**
+         * Phone number (E.164) or email address of the participant
+         */
+        handle: string;
+        /**
+         * When this participant joined the chat
+         */
+        joined_at: string;
+        /**
+         * Service type (iMessage, SMS, RCS, etc.)
+         */
+        service: 'iMessage' | 'SMS' | 'RCS';
+        /**
+         * Whether this handle belongs to the sender (your phone number)
+         */
+        is_me?: boolean | null;
+        /**
+         * When they left (if applicable)
+         */
+        left_at?: string | null;
+        /**
+         * Participant status
+         */
+        status?: 'active' | 'left' | 'removed' | null;
+    }
+}
+export interface ChatListResponse {
+    /**
+     * List of chats
+     */
+    chats: Array<ChatListResponse.Chat>;
+    /**
+     * Cursor for fetching the next page of results. Null if there are no more results
+     * to fetch. Pass this value as the `cursor` parameter in the next request.
+     */
+    next_cursor?: string | null;
+}
+export declare namespace ChatListResponse {
+    interface Chat {
+        /**
+         * Unique identifier for the chat
+         */
+        id: string;
+        /**
+         * When the chat was created
+         */
+        created_at: string;
+        /**
+         * Display name for the chat. Defaults to a comma-separated list of recipient
+         * handles. Can be updated for group chats.
+         */
+        display_name: string | null;
+        /**
+         * List of chat participants with full handle details. Always contains at least two
+         * handles (your phone number and the other participant).
+         */
+        handles: Array<Chat.Handle>;
+        /**
+         * Whether the chat is archived
+         */
+        is_archived: boolean;
+        /**
+         * Whether this is a group chat
+         */
+        is_group: boolean;
+        /**
+         * When the chat was last updated
+         */
+        updated_at: string;
+        /**
+         * Service type for the chat
+         */
+        service?: 'iMessage' | 'SMS' | 'RCS' | null;
+    }
+    namespace Chat {
+        interface Handle {
+            /**
+             * Unique identifier for this handle
+             */
+            id: string;
+            /**
+             * Phone number (E.164) or email address of the participant
+             */
+            handle: string;
+            /**
+             * When this participant joined the chat
+             */
+            joined_at: string;
+            /**
+             * Service type (iMessage, SMS, RCS, etc.)
+             */
+            service: 'iMessage' | 'SMS' | 'RCS';
+            /**
+             * Whether this handle belongs to the sender (your phone number)
+             */
+            is_me?: boolean | null;
+            /**
+             * When they left (if applicable)
+             */
+            left_at?: string | null;
+            /**
+             * Participant status
+             */
+            status?: 'active' | 'left' | 'removed' | null;
+        }
+    }
+}
+/**
+ * Response for sending a voice memo to a chat
+ */
+export interface ChatSendVoicememoResponse {
+    voice_memo: ChatSendVoicememoResponse.VoiceMemo;
+}
+export declare namespace ChatSendVoicememoResponse {
+    interface VoiceMemo {
+        /**
+         * Message identifier
+         */
+        id: string;
+        chat: VoiceMemo.Chat;
+        /**
+         * When the voice memo was created
+         */
+        created_at: string;
+        /**
+         * Sender phone number
+         */
+        from: string;
+        /**
+         * Current delivery status
+         */
+        status: string;
+        /**
+         * Recipient handles (phone numbers or email addresses)
+         */
+        to: Array<string>;
+        voice_memo: VoiceMemo.VoiceMemo;
+        /**
+         * Service used to send this voice memo
+         */
+        service?: 'iMessage' | 'SMS' | 'RCS' | null;
+    }
+    namespace VoiceMemo {
+        interface Chat {
+            /**
+             * Chat identifier
+             */
+            id: string;
+            /**
+             * Chat participants
+             */
+            handles: Array<Chat.Handle>;
+            /**
+             * Whether the chat is active
+             */
+            is_active: boolean;
+            /**
+             * Whether this is a group chat
+             */
+            is_group: boolean;
+            /**
+             * Messaging service
+             */
+            service: string;
+        }
+        namespace Chat {
+            interface Handle {
+                /**
+                 * Unique identifier for this handle
+                 */
+                id: string;
+                /**
+                 * Phone number (E.164) or email address of the participant
+                 */
+                handle: string;
+                /**
+                 * When this participant joined the chat
+                 */
+                joined_at: string;
+                /**
+                 * Service type (iMessage, SMS, RCS, etc.)
+                 */
+                service: 'iMessage' | 'SMS' | 'RCS';
+                /**
+                 * Whether this handle belongs to the sender (your phone number)
+                 */
+                is_me?: boolean | null;
+                /**
+                 * When they left (if applicable)
+                 */
+                left_at?: string | null;
+                /**
+                 * Participant status
+                 */
+                status?: 'active' | 'left' | 'removed' | null;
+            }
+        }
+        interface VoiceMemo {
+            /**
+             * Attachment identifier
+             */
+            id: string;
+            /**
+             * Original filename
+             */
+            filename: string;
+            /**
+             * Audio MIME type
+             */
+            mime_type: string;
+            /**
+             * File size in bytes
+             */
+            size_bytes: number;
+            /**
+             * CDN URL for downloading the voice memo
+             */
+            url: string;
+            /**
+             * Duration in milliseconds
+             */
+            duration_ms?: number | null;
+        }
+    }
+}
+export interface ChatCreateParams {
+    /**
+     * Sender phone number in E.164 format. Must be a phone number that the
+     * authenticated partner has permission to send from.
+     */
+    from: string;
+    /**
+     * Message content container. Groups all message-related fields together,
+     * separating the "what" (message content) from the "where" (routing fields like
+     * from/to).
+     */
+    message: ChatCreateParams.Message;
+    /**
+     * Array of recipient handles (phone numbers in E.164 format or email addresses).
+     * For individual chats, provide one recipient. For group chats, provide multiple.
+     */
+    to: Array<string>;
+}
+export declare namespace ChatCreateParams {
+    /**
+     * Message content container. Groups all message-related fields together,
+     * separating the "what" (message content) from the "where" (routing fields like
+     * from/to).
+     */
+    interface Message {
+        /**
+         * Array of message parts. Each part can be either text or media. Parts are
+         * displayed in order. Text and media can be mixed.
+         *
+         * **Supported Media:**
+         *
+         * - Images: .jpg, .jpeg, .png, .gif, .heic, .heif, .tif, .tiff, .bmp
+         * - Videos: .mp4, .mov, .m4v, .mpeg, .mpg, .3gp
+         * - Audio: .m4a, .mp3, .aac, .caf, .wav, .aiff, .amr
+         * - Documents: .pdf, .txt, .rtf, .csv, .doc, .docx, .xls, .xlsx, .ppt, .pptx,
+         *   .pages, .numbers, .key, .epub, .zip, .html, .htm
+         * - Contact & Calendar: .vcf, .ics
+         *
+         * **Audio:**
+         *
+         * - Audio files (.m4a, .mp3, .aac, .caf, .wav, .aiff, .amr) are fully supported as
+         *   media parts
+         * - To send audio as an **iMessage voice memo bubble** (inline playback UI), use
+         *   the dedicated `/v3/chats/{chatId}/voicememo` endpoint instead
+         *
+         * **Validation Rule:** Consecutive text parts are not allowed. Text parts must be
+         * separated by media parts. For example, [text, text] is invalid, but [text,
+         * media, text] is valid.
+         */
+        parts: Array<Message.TextPart | Message.MediaPart>;
+        /**
+         * iMessage effect to apply to this message (screen or bubble effect)
+         */
+        effect?: Message.Effect;
+        /**
+         * Optional idempotency key for this message. Use this to prevent duplicate sends
+         * of the same message.
+         */
+        idempotency_key?: string;
+        /**
+         * Preferred messaging service to use for this message. If not specified, uses
+         * default fallback chain: iMessage → RCS → SMS.
+         *
+         * - iMessage: Enforces iMessage without fallback to RCS or SMS. Message fails if
+         *   recipient doesn't support iMessage.
+         * - RCS: Enforces RCS or SMS (no iMessage). Uses RCS if recipient supports it,
+         *   otherwise falls back to SMS.
+         * - SMS: Enforces SMS (no iMessage). Uses RCS if recipient supports it, otherwise
+         *   falls back to SMS.
+         */
+        preferred_service?: 'iMessage' | 'RCS' | 'SMS';
+        /**
+         * Reply to another message to create a threaded conversation
+         */
+        reply_to?: Message.ReplyTo;
+    }
+    namespace Message {
+        interface TextPart {
+            /**
+             * Indicates this is a text message part
+             */
+            type: 'text';
+            /**
+             * The text content
+             */
+            value: string;
+            /**
+             * Optional idempotency key for this specific message part. Use this to prevent
+             * duplicate sends of the same part.
+             */
+            idempotency_key?: string;
+        }
+        interface MediaPart {
+            /**
+             * Indicates this is a media attachment part
+             */
+            type: 'media';
+            /**
+             * Reference to a file pre-uploaded via `POST /v3/attachments` (optional). The file
+             * is already stored, so sends using this ID skip the download step — useful when
+             * sending the same file to many recipients.
+             *
+             * Either `url` or `attachment_id` must be provided, but not both.
+             */
+            attachment_id?: string;
+            /**
+             * Optional idempotency key for this specific message part. Use this to prevent
+             * duplicate sends of the same part.
+             */
+            idempotency_key?: string;
+            /**
+             * Any publicly accessible HTTPS URL to the media file. The server downloads and
+             * sends the file automatically — no pre-upload step required.
+             *
+             * **Size limit:** 10MB maximum for URL-based downloads. For larger files (up to
+             * 100MB), use the pre-upload flow: `POST /v3/attachments` to get a presigned URL,
+             * upload directly, then reference by `attachment_id`.
+             *
+             * **Requirements:**
+             *
+             * - URL must use HTTPS
+             * - File content must be a supported format (the server validates the actual file
+             *   content)
+             *
+             * **Supported formats:**
+             *
+             * - Images: .jpg, .jpeg, .png, .gif, .heic, .heif, .tif, .tiff, .bmp
+             * - Videos: .mp4, .mov, .m4v, .mpeg, .mpg, .3gp
+             * - Audio: .m4a, .mp3, .aac, .caf, .wav, .aiff, .amr
+             * - Documents: .pdf, .txt, .rtf, .csv, .doc, .docx, .xls, .xlsx, .ppt, .pptx,
+             *   .pages, .numbers, .key, .epub, .zip, .html, .htm
+             * - Contact & Calendar: .vcf, .ics
+             *
+             * **Tip:** Audio sent here appears as a regular file attachment. To send audio as
+             * an iMessage voice memo bubble (with inline playback), use
+             * `/v3/chats/{chatId}/voicememo`. For repeated sends of the same file, use
+             * `attachment_id` to avoid redundant downloads.
+             *
+             * Either `url` or `attachment_id` must be provided, but not both.
+             */
+            url?: string;
+        }
+        /**
+         * iMessage effect to apply to this message (screen or bubble effect)
+         */
+        interface Effect {
+            /**
+             * Name of the effect. Common values:
+             *
+             * - Screen effects: confetti, fireworks, lasers, sparkles, celebration, hearts,
+             *   love, balloons, happy_birthday, echo, spotlight
+             * - Bubble effects: slam, loud, gentle, invisible
+             */
+            name?: string;
+            /**
+             * Type of effect
+             */
+            type?: 'screen' | 'bubble';
+        }
+        /**
+         * Reply to another message to create a threaded conversation
+         */
+        interface ReplyTo {
+            /**
+             * The ID of the message to reply to
+             */
+            message_id: string;
+            /**
+             * The specific message part to reply to (0-based index). Defaults to 0 (first
+             * part) if not provided. Use this when replying to a specific part of a multipart
+             * message.
+             */
+            part_index?: number;
+        }
+    }
+}
+export interface ChatUpdateParams {
+    /**
+     * New display name for the chat (group chats only)
+     */
+    display_name?: string;
+    /**
+     * URL of an image to set as the group chat icon (group chats only)
+     */
+    group_chat_icon?: string;
+}
+export interface ChatListParams {
+    /**
+     * Phone number to filter chats by. Returns all chats made from this phone number.
+     * Must be in E.164 format (e.g., `+13343284472`). The `+` is automatically
+     * URL-encoded by HTTP clients.
+     */
+    from: string;
+    /**
+     * Pagination cursor from the previous response's `next_cursor` field. Omit this
+     * parameter for the first page of results.
+     */
+    cursor?: string;
+    /**
+     * Maximum number of chats to return per page
+     */
+    limit?: number;
+}
+export interface ChatSendVoicememoParams {
+    /**
+     * Sender phone number in E.164 format
+     */
+    from: string;
+    /**
+     * URL of the voice memo audio file. Must be a publicly accessible HTTPS URL.
+     */
+    voice_memo_url: string;
+}
+export declare namespace Chats {
+    export { type ChatCreateResponse as ChatCreateResponse, type ChatRetrieveResponse as ChatRetrieveResponse, type ChatUpdateResponse as ChatUpdateResponse, type ChatListResponse as ChatListResponse, type ChatSendVoicememoResponse as ChatSendVoicememoResponse, type ChatCreateParams as ChatCreateParams, type ChatUpdateParams as ChatUpdateParams, type ChatListParams as ChatListParams, type ChatSendVoicememoParams as ChatSendVoicememoParams, };
+    export { Participants as Participants, type ParticipantAddResponse as ParticipantAddResponse, type ParticipantRemoveResponse as ParticipantRemoveResponse, type ParticipantAddParams as ParticipantAddParams, type ParticipantRemoveParams as ParticipantRemoveParams, };
+    export { Typing as Typing };
+    export { Messages as Messages, type MessageListResponse as MessageListResponse, type MessageSendResponse as MessageSendResponse, type MessageListParams as MessageListParams, type MessageSendParams as MessageSendParams, };
+}
+//# sourceMappingURL=chats.d.ts.map