@linqapp/sdk 0.1.5 → 0.4.0

package/src/resources/chats/chats.ts

@@ -4,14 +4,7 @@ import { APIResource } from '../../core/resource';
 import * as MessagesAPI from '../messages';
 import * as Shared from '../shared';
 import * as ChatsMessagesAPI from './messages';
-import {
-  MessageListParams,
-  MessageListResponse,
-  MessageSendParams,
-  MessageSendResponse,
-  Messages,
-  SentMessage,
-} from './messages';
+import { MessageListParams, MessageSendParams, MessageSendResponse, Messages, SentMessage } from './messages';
 import * as ParticipantsAPI from './participants';
 import {
   ParticipantAddParams,
@@ -23,6 +16,7 @@ import {
 import * as TypingAPI from './typing';
 import { Typing } from './typing';
 import { APIPromise } from '../../core/api-promise';
+import { ListChatsPagination, type ListChatsPaginationParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -120,13 +114,19 @@ export class Chats extends APIResource {
    *
    * @example
    * ```ts
-   * const chats = await client.chats.list({
+   * // Automatically fetches more pages as needed.
+   * for await (const chat of client.chats.listChats({
    *   from: '+13343284472',
-   * });
+   * })) {
+   *   // ...
+   * }
    * ```
    */
-  list(query: ChatListParams, options?: RequestOptions): APIPromise<ChatListResponse> {
-    return this._client.get('/v3/chats', { query, ...options });
+  listChats(
+    query: ChatListChatsParams,
+    options?: RequestOptions,
+  ): PagePromise<ChatsListChatsPagination, Chat> {
+    return this._client.getAPIList('/v3/chats', ListChatsPagination<Chat>, { query, ...options });
   }
 
   /**
@@ -203,6 +203,8 @@ export class Chats extends APIResource {
   }
 }
 
+export type ChatsListChatsPagination = ListChatsPagination<Chat>;
+
 export interface Chat {
   /**
    * Unique identifier for the chat
@@ -247,6 +249,54 @@ export interface Chat {
   service?: Shared.ServiceType | null;
 }
 
+export 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;
+
+  /**
+   * 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;
+}
+
 /**
  * Message content container. Groups all message-related fields together,
  * separating the "what" (message content) from the "where" (routing fields like
@@ -273,11 +323,17 @@ export interface MessageContent {
    * - 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.
+   * **Validation Rules:**
+   *
+   * - 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.
+   * - Maximum of **100 parts** total.
+   * - Media parts using a public `url` (downloaded by the server on send) are capped
+   *   at **40**. Parts using `attachment_id` or presigned URLs are exempt from this
+   *   sub-limit. For bulk media sends exceeding 40 files, pre-upload via
+   *   `POST /v3/attachments` and reference by `attachment_id` or `download_url`.
    */
-  parts: Array<MessageContent.TextPart | MessageContent.MediaPart>;
+  parts: Array<TextPart | MediaPart>;
 
   /**
    * iMessage effect to apply to this message (screen or bubble effect)
@@ -301,78 +357,16 @@ export interface MessageContent {
   reply_to?: MessagesAPI.ReplyTo;
 }
 
-export namespace MessageContent {
-  export 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;
-  }
-
-  export 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;
+export interface TextPart {
+  /**
+   * Indicates this is a text message part
+   */
+  type: 'text';
 
-    /**
-     * 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;
-  }
+  /**
+   * The text content
+   */
+  value: string;
 }
 
 /**
@@ -418,19 +412,6 @@ export namespace ChatCreateResponse {
   }
 }
 
-export interface ChatListResponse {
-  /**
-   * List of chats
-   */
-  chats: Array<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;
-}
-
 /**
  * Response for sending a voice memo to a chat
  */
@@ -570,24 +551,13 @@ export interface ChatUpdateParams {
   group_chat_icon?: string;
 }
 
-export interface ChatListParams {
+export interface ChatListChatsParams extends ListChatsPaginationParams {
   /**
    * 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 {
@@ -609,13 +579,15 @@ Chats.Messages = Messages;
 export declare namespace Chats {
   export {
     type Chat as Chat,
+    type MediaPart as MediaPart,
     type MessageContent as MessageContent,
+    type TextPart as TextPart,
     type ChatCreateResponse as ChatCreateResponse,
-    type ChatListResponse as ChatListResponse,
     type ChatSendVoicememoResponse as ChatSendVoicememoResponse,
+    type ChatsListChatsPagination as ChatsListChatsPagination,
     type ChatCreateParams as ChatCreateParams,
     type ChatUpdateParams as ChatUpdateParams,
-    type ChatListParams as ChatListParams,
+    type ChatListChatsParams as ChatListChatsParams,
     type ChatSendVoicememoParams as ChatSendVoicememoParams,
   };
 
@@ -632,7 +604,6 @@ export declare namespace Chats {
   export {
     Messages as Messages,
     type SentMessage as SentMessage,
-    type MessageListResponse as MessageListResponse,
     type MessageSendResponse as MessageSendResponse,
     type MessageListParams as MessageListParams,
     type MessageSendParams as MessageSendParams,

package/src/resources/chats/index.ts

@@ -3,19 +3,20 @@
 export {
   Chats,
   type Chat,
+  type MediaPart,
   type MessageContent,
+  type TextPart,
   type ChatCreateResponse,
-  type ChatListResponse,
   type ChatSendVoicememoResponse,
   type ChatCreateParams,
   type ChatUpdateParams,
-  type ChatListParams,
+  type ChatListChatsParams,
   type ChatSendVoicememoParams,
+  type ChatsListChatsPagination,
 } from './chats';
 export {
   Messages,
   type SentMessage,
-  type MessageListResponse,
   type MessageSendResponse,
   type MessageListParams,
   type MessageSendParams,

package/src/resources/chats/messages.ts

@@ -2,29 +2,51 @@
 
 import { APIResource } from '../../core/resource';
 import * as MessagesAPI from '../messages';
+import { MessagesListMessagesPagination } from '../messages';
 import * as Shared from '../shared';
 import * as ChatsAPI from './chats';
 import { APIPromise } from '../../core/api-promise';
+import {
+  ListMessagesPagination,
+  type ListMessagesPaginationParams,
+  PagePromise,
+} from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Messages are individual text or multimedia communications within a chat thread.
+ *
+ * Messages can include text, attachments, special effects (like confetti or fireworks),
+ * and reactions. All messages are associated with a specific chat and sent from a
+ * phone number you own.
+ *
+ * Messages support delivery status tracking, read receipts, and editing capabilities.
+ */
 export class Messages extends APIResource {
   /**
    * Retrieve messages from a specific chat with pagination support.
    *
    * @example
    * ```ts
-   * const messages = await client.chats.messages.list(
+   * // Automatically fetches more pages as needed.
+   * for await (const message of client.chats.messages.list(
    *   '550e8400-e29b-41d4-a716-446655440000',
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   list(
     chatID: string,
     query: MessageListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<MessageListResponse> {
-    return this._client.get(path`/v3/chats/${chatID}/messages`, { query, ...options });
+  ): PagePromise<MessagesListMessagesPagination, MessagesAPI.Message> {
+    return this._client.getAPIList(
+      path`/v3/chats/${chatID}/messages`,
+      ListMessagesPagination<MessagesAPI.Message>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -84,7 +106,7 @@ export interface SentMessage {
   /**
    * Message parts in order (text and media)
    */
-  parts: Array<MessagesAPI.TextPart | MessagesAPI.MediaPart>;
+  parts: Array<Shared.TextPartResponse | Shared.MediaPartResponse>;
 
   /**
    * When the message was sent
@@ -122,19 +144,6 @@ export interface SentMessage {
   service?: Shared.ServiceType | null;
 }
 
-export interface MessageListResponse {
-  /**
-   * List of messages
-   */
-  messages: Array<MessagesAPI.Message>;
-
-  /**
-   * 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;
-}
-
 /**
  * Response for sending a message to a chat
  */
@@ -150,17 +159,7 @@ export interface MessageSendResponse {
   message: SentMessage;
 }
 
-export interface MessageListParams {
-  /**
-   * Pagination cursor from previous next_cursor response
-   */
-  cursor?: string;
-
-  /**
-   * Maximum number of messages to return
-   */
-  limit?: number;
-}
+export interface MessageListParams extends ListMessagesPaginationParams {}
 
 export interface MessageSendParams {
   /**
@@ -174,9 +173,10 @@ export interface MessageSendParams {
 export declare namespace Messages {
   export {
     type SentMessage as SentMessage,
-    type MessageListResponse as MessageListResponse,
     type MessageSendResponse as MessageSendResponse,
     type MessageListParams as MessageListParams,
     type MessageSendParams as MessageSendParams,
   };
 }
+
+export { type MessagesListMessagesPagination };

package/src/resources/chats/participants.ts

@@ -5,6 +5,24 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * A Chat is a conversation thread with one or more participants.
+ *
+ * To begin a chat, you must create a Chat with at least one recipient handle.
+ * Including multiple handles creates a group chat.
+ *
+ * When creating a chat, the `from` field specifies which of your
+ * authorized phone numbers the message originates from. Your authentication token grants
+ * access to one or more phone numbers, but the `from` field determines the actual sender.
+ *
+ * **Handle Format:**
+ * - Handles can be phone numbers or email addresses
+ * - Phone numbers MUST be in E.164 format (starting with +)
+ * - Phone format: `+[country code][subscriber number]`
+ * - Example phone: `+12223334444` (US), `+442071234567` (UK), `+81312345678` (Japan)
+ * - Example email: `user@example.com`
+ * - No spaces, dashes, or parentheses in phone numbers
+ */
 export class Participants extends APIResource {
   /**
    * Add a new participant to an existing group chat.

package/src/resources/chats/typing.ts

@@ -6,6 +6,24 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * A Chat is a conversation thread with one or more participants.
+ *
+ * To begin a chat, you must create a Chat with at least one recipient handle.
+ * Including multiple handles creates a group chat.
+ *
+ * When creating a chat, the `from` field specifies which of your
+ * authorized phone numbers the message originates from. Your authentication token grants
+ * access to one or more phone numbers, but the `from` field determines the actual sender.
+ *
+ * **Handle Format:**
+ * - Handles can be phone numbers or email addresses
+ * - Phone numbers MUST be in E.164 format (starting with +)
+ * - Phone format: `+[country code][subscriber number]`
+ * - Example phone: `+12223334444` (US), `+442071234567` (UK), `+81312345678` (Japan)
+ * - Example email: `user@example.com`
+ * - No spaces, dashes, or parentheses in phone numbers
+ */
 export class Typing extends APIResource {
   /**
    * Send a typing indicator to show that someone is typing in the chat.

package/src/resources/index.ts

@@ -10,38 +10,39 @@ export {
 } from './attachments';
 export {
   Capability,
-  type CapabilityCheckImessageResponse,
-  type CapabilityCheckRcsResponse,
-  type CapabilityCheckImessageParams,
-  type CapabilityCheckRcsParams,
+  type CapabilityCheckiMessageResponse,
+  type CapabilityCheckRCSResponse,
+  type CapabilityCheckiMessageParams,
+  type CapabilityCheckRCSParams,
 } from './capability';
 export {
   Chats,
   type Chat,
+  type MediaPart,
   type MessageContent,
+  type TextPart,
   type ChatCreateResponse,
-  type ChatListResponse,
   type ChatSendVoicememoResponse,
   type ChatCreateParams,
   type ChatUpdateParams,
-  type ChatListParams,
+  type ChatListChatsParams,
   type ChatSendVoicememoParams,
+  type ChatsListChatsPagination,
 } from './chats/chats';
 export {
   Messages,
   type ChatHandle,
-  type MediaPart,
   type Message,
   type MessageEffect,
   type Reaction,
   type ReactionType,
   type ReplyTo,
-  type TextPart,
   type MessageAddReactionResponse,
-  type MessageRetrieveThreadResponse,
+  type MessageUpdateParams,
   type MessageDeleteParams,
   type MessageAddReactionParams,
-  type MessageRetrieveThreadParams,
+  type MessageListMessagesThreadParams,
+  type MessagesListMessagesPagination,
 } from './messages';
 export { PhoneNumbers, type PhoneNumberListResponse } from './phone-numbers';
 export { Phonenumbers, type PhonenumberListResponse } from './phonenumbers';
@@ -54,3 +55,47 @@ export {
   type WebhookSubscriptionCreateParams,
   type WebhookSubscriptionUpdateParams,
 } from './webhook-subscriptions';
+export {
+  Webhooks,
+  type MessageEventV2,
+  type MessagePayload,
+  type ReactionEventBase,
+  type SchemasMediaPartResponse,
+  type SchemasMessageEffect,
+  type SchemasTextPartResponse,
+  type MessageSentV2026WebhookEvent,
+  type MessageReceivedV2026WebhookEvent,
+  type MessageReadV2026WebhookEvent,
+  type MessageDeliveredV2026WebhookEvent,
+  type MessageFailedV2026WebhookEvent,
+  type ReactionAddedV2026WebhookEvent,
+  type ReactionRemovedV2026WebhookEvent,
+  type ParticipantAddedV2026WebhookEvent,
+  type ParticipantRemovedV2026WebhookEvent,
+  type ChatGroupNameUpdatedV2026WebhookEvent,
+  type ChatGroupIconUpdatedV2026WebhookEvent,
+  type ChatGroupNameUpdateFailedV2026WebhookEvent,
+  type ChatGroupIconUpdateFailedV2026WebhookEvent,
+  type ChatCreatedV2026WebhookEvent,
+  type ChatTypingIndicatorStartedV2026WebhookEvent,
+  type ChatTypingIndicatorStoppedV2026WebhookEvent,
+  type PhoneNumberStatusUpdatedV2026WebhookEvent,
+  type MessageSentV2025WebhookEvent,
+  type MessageReceivedV2025WebhookEvent,
+  type MessageReadV2025WebhookEvent,
+  type MessageDeliveredV2025WebhookEvent,
+  type MessageFailedV2025WebhookEvent,
+  type ReactionAddedV2025WebhookEvent,
+  type ReactionRemovedV2025WebhookEvent,
+  type ParticipantAddedV2025WebhookEvent,
+  type ParticipantRemovedV2025WebhookEvent,
+  type ChatGroupNameUpdatedV2025WebhookEvent,
+  type ChatGroupIconUpdatedV2025WebhookEvent,
+  type ChatGroupNameUpdateFailedV2025WebhookEvent,
+  type ChatGroupIconUpdateFailedV2025WebhookEvent,
+  type ChatCreatedV2025WebhookEvent,
+  type ChatTypingIndicatorStartedV2025WebhookEvent,
+  type ChatTypingIndicatorStoppedV2025WebhookEvent,
+  type PhoneNumberStatusUpdatedV2025WebhookEvent,
+  type EventsWebhookEvent,
+} from './webhooks';