@linqapp/sdk 0.1.0 → 0.1.4

package/src/resources/messages.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
@@ -18,7 +19,7 @@ export class Messages extends APIResource {
    * );
    * ```
    */
-  retrieve(messageID: string, options?: RequestOptions): APIPromise<MessageRetrieveResponse> {
+  retrieve(messageID: string, options?: RequestOptions): APIPromise<Message> {
     return this._client.get(path`/v3/messages/${messageID}`, options);
   }
 
@@ -61,7 +62,7 @@ export class Messages extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.messages.addReaction(
+   * const reaction = await client.messages.addReaction(
    *   '69a37c7d-af4f-4b5e-af42-e28e98ce873a',
    *   { operation: 'add', type: 'love' },
    * );
@@ -71,7 +72,7 @@ export class Messages extends APIResource {
     messageID: string,
     body: MessageAddReactionParams,
     options?: RequestOptions,
-  ): APIPromise<MessageAddReactionResponse> {
+  ): APIPromise<Reaction> {
     return this._client.post(path`/v3/messages/${messageID}/reactions`, { body, ...options });
   }
 
@@ -99,7 +100,84 @@ export class Messages extends APIResource {
   }
 }
 
-export interface MessageRetrieveResponse {
+export interface ChatHandle {
+  /**
+   * 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;
+
+  /**
+   * Messaging service type
+   */
+  service: Shared.ServiceType;
+
+  /**
+   * 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
+ */
+export interface MediaPart {
+  /**
+   * Unique attachment identifier
+   */
+  id: string;
+
+  /**
+   * Original filename
+   */
+  filename: string;
+
+  /**
+   * MIME type of the file
+   */
+  mime_type: string;
+
+  /**
+   * Reactions on this message part
+   */
+  reactions: Array<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;
+}
+
+export interface Message {
   /**
    * Unique identifier for the message
    */
@@ -143,7 +221,7 @@ export interface MessageRetrieveResponse {
   /**
    * iMessage effect applied to a message (screen or bubble effect)
    */
-  effect?: MessageRetrieveResponse.Effect | null;
+  effect?: MessageEffect | null;
 
   /**
    * @deprecated DEPRECATED: Use from_handle instead. Phone number of the message
@@ -154,17 +232,17 @@ export interface MessageRetrieveResponse {
   /**
    * The sender of this message as a full handle object
    */
-  from_handle?: MessageRetrieveResponse.FromHandle | null;
+  from_handle?: ChatHandle | null;
 
   /**
    * Message parts in order (text and media)
    */
-  parts?: Array<MessageRetrieveResponse.TextPartResponse | MessageRetrieveResponse.MediaPartResponse> | null;
+  parts?: Array<TextPart | MediaPart> | null;
 
   /**
    * Messaging service type
    */
-  preferred_service?: 'iMessage' | 'SMS' | 'RCS' | null;
+  preferred_service?: Shared.ServiceType | null;
 
   /**
    * When the message was read
@@ -174,7 +252,7 @@ export interface MessageRetrieveResponse {
   /**
    * Indicates this message is a threaded reply to another message
    */
-  reply_to?: MessageRetrieveResponse.ReplyTo | null;
+  reply_to?: ReplyTo | null;
 
   /**
    * When the message was sent
@@ -184,329 +262,140 @@ export interface MessageRetrieveResponse {
   /**
    * Messaging service type
    */
-  service?: 'iMessage' | 'SMS' | 'RCS' | null;
+  service?: Shared.ServiceType | null;
 }
 
-export namespace MessageRetrieveResponse {
+/**
+ * iMessage effect applied to a message (screen or bubble effect)
+ */
+export interface MessageEffect {
   /**
-   * iMessage effect applied to a message (screen or bubble 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
    */
-  export 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';
-  }
+  name?: string;
 
   /**
-   * The sender of this message as a full handle object
+   * Type of effect
    */
-  export 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;
-
-    /**
-     * Messaging service type
-     */
-    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;
+  type?: 'screen' | 'bubble';
+}
 
-    /**
-     * Participant status
-     */
-    status?: 'active' | 'left' | 'removed' | null;
-  }
+export interface Reaction {
+  handle: ChatHandle;
 
   /**
-   * A text message part
+   * Whether this reaction is from the current user
    */
-  export 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;
-  }
+  is_me: boolean;
 
-  export namespace TextPartResponse {
-    export 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;
-    }
-
-    export namespace Reaction {
-      export 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;
-
-        /**
-         * Messaging service type
-         */
-        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;
-      }
-    }
-  }
+  /**
+   * 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. Sticker reactions have type "sticker" with
+   * sticker attachment details in the sticker field.
+   */
+  type: ReactionType;
 
   /**
-   * A media attachment part
+   * Custom emoji if type is "custom", null otherwise
    */
-  export interface MediaPartResponse {
-    /**
-     * Unique attachment identifier
-     */
-    id: string;
+  custom_emoji?: string | null;
 
-    /**
-     * Original filename
-     */
-    filename: string;
+  /**
+   * Sticker attachment details when reaction_type is "sticker". Null for non-sticker
+   * reactions.
+   */
+  sticker?: Reaction.Sticker | null;
+}
 
+export namespace Reaction {
+  /**
+   * Sticker attachment details when reaction_type is "sticker". Null for non-sticker
+   * reactions.
+   */
+  export interface Sticker {
     /**
-     * MIME type of the file
+     * Filename of the sticker
      */
-    mime_type: string;
+    file_name?: string;
 
     /**
-     * Reactions on this message part
+     * Sticker image height in pixels
      */
-    reactions: Array<MediaPartResponse.Reaction> | null;
+    height?: number;
 
     /**
-     * File size in bytes
+     * MIME type of the sticker image
      */
-    size_bytes: number;
+    mime_type?: string;
 
     /**
-     * Indicates this is a media attachment part
+     * Presigned URL for downloading the sticker image (expires in 1 hour).
      */
-    type: 'media';
+    url?: string;
 
     /**
-     * Presigned URL for downloading the attachment (expires in 1 hour).
+     * Sticker image width in pixels
      */
-    url: string;
+    width?: number;
   }
+}
 
-  export namespace MediaPartResponse {
-    export 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;
-    }
-
-    export namespace Reaction {
-      export 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;
-
-        /**
-         * Messaging service type
-         */
-        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;
-      }
-    }
-  }
+/**
+ * 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. Sticker reactions have type "sticker" with
+ * sticker attachment details in the sticker field.
+ */
+export type ReactionType =
+  | 'love'
+  | 'like'
+  | 'dislike'
+  | 'laugh'
+  | 'emphasize'
+  | 'question'
+  | 'custom'
+  | 'sticker';
 
+/**
+ * Indicates this message is a threaded reply to another message
+ */
+export interface ReplyTo {
   /**
-   * Indicates this message is a threaded reply to another message
+   * The ID of the message to reply to
    */
-  export interface ReplyTo {
-    /**
-     * The ID of the message to reply to
-     */
-    message_id: string;
+  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;
-  }
+  /**
+   * 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 MessageAddReactionResponse {
-  handle: MessageAddReactionResponse.Handle;
-
+/**
+ * A text message part
+ */
+export interface TextPart {
   /**
-   * Whether this reaction is from the current user
+   * Reactions on this message part
    */
-  is_me: boolean;
+  reactions: Array<Reaction> | null;
 
   /**
-   * 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.
+   * Indicates this is a text message part
    */
-  type: 'love' | 'like' | 'dislike' | 'laugh' | 'emphasize' | 'question' | 'custom';
+  type: 'text';
 
   /**
-   * Custom emoji if type is "custom", null otherwise
+   * The text content
    */
-  custom_emoji?: string | null;
-}
-
-export namespace MessageAddReactionResponse {
-  export 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;
-
-    /**
-     * Messaging service type
-     */
-    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;
-  }
+  value: string;
 }
 
 /**
@@ -516,7 +405,7 @@ export interface MessageRetrieveThreadResponse {
   /**
    * Messages in the thread, ordered by the specified order parameter
    */
-  messages: Array<MessageRetrieveThreadResponse.Message>;
+  messages: Array<Message>;
 
   /**
    * Cursor for fetching the next page of results (null if no more results)
@@ -524,358 +413,6 @@ export interface MessageRetrieveThreadResponse {
   next_cursor?: string | null;
 }
 
-export namespace MessageRetrieveThreadResponse {
-  export interface Message {
-    /**
-     * Unique identifier for the message
-     */
-    id: string;
-
-    /**
-     * ID of the chat this message belongs to
-     */
-    chat_id: string;
-
-    /**
-     * When the message was created
-     */
-    created_at: string;
-
-    /**
-     * Whether the message has been delivered
-     */
-    is_delivered: boolean;
-
-    /**
-     * Whether this message was sent by the authenticated user
-     */
-    is_from_me: boolean;
-
-    /**
-     * Whether the message has been read
-     */
-    is_read: boolean;
-
-    /**
-     * When the message was last updated
-     */
-    updated_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;
-
-    /**
-     * @deprecated DEPRECATED: Use from_handle instead. Phone number of the message
-     * sender.
-     */
-    from?: string | null;
-
-    /**
-     * The sender of this message as a full handle object
-     */
-    from_handle?: Message.FromHandle | null;
-
-    /**
-     * Message parts in order (text and media)
-     */
-    parts?: Array<Message.TextPartResponse | Message.MediaPartResponse> | null;
-
-    /**
-     * Messaging service type
-     */
-    preferred_service?: 'iMessage' | 'SMS' | 'RCS' | null;
-
-    /**
-     * When the message was read
-     */
-    read_at?: string | null;
-
-    /**
-     * Indicates this message is a threaded reply to another message
-     */
-    reply_to?: Message.ReplyTo | null;
-
-    /**
-     * When the message was sent
-     */
-    sent_at?: string | null;
-
-    /**
-     * Messaging service type
-     */
-    service?: 'iMessage' | 'SMS' | 'RCS' | null;
-  }
-
-  export namespace Message {
-    /**
-     * iMessage effect applied to a message (screen or bubble effect)
-     */
-    export 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
-     */
-    export 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;
-
-      /**
-       * Messaging service type
-       */
-      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 text message part
-     */
-    export 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;
-    }
-
-    export namespace TextPartResponse {
-      export 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;
-      }
-
-      export namespace Reaction {
-        export 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;
-
-          /**
-           * Messaging service type
-           */
-          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
-     */
-    export 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;
-    }
-
-    export namespace MediaPartResponse {
-      export 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;
-      }
-
-      export namespace Reaction {
-        export 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;
-
-          /**
-           * Messaging service type
-           */
-          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
-     */
-    export 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 MessageDeleteParams {
   /**
    * ID of the chat containing the message to delete
@@ -892,9 +429,10 @@ export interface MessageAddReactionParams {
   /**
    * 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.
+   * emoji in the custom_emoji field. Sticker reactions have type "sticker" with
+   * sticker attachment details in the sticker field.
    */
-  type: 'love' | 'like' | 'dislike' | 'laugh' | 'emphasize' | 'question' | 'custom';
+  type: ReactionType;
 
   /**
    * Custom emoji string. Required when type is "custom".
@@ -927,8 +465,14 @@ export interface MessageRetrieveThreadParams {
 
 export declare namespace Messages {
   export {
-    type MessageRetrieveResponse as MessageRetrieveResponse,
-    type MessageAddReactionResponse as MessageAddReactionResponse,
+    type ChatHandle as ChatHandle,
+    type MediaPart as MediaPart,
+    type Message as Message,
+    type MessageEffect as MessageEffect,
+    type Reaction as Reaction,
+    type ReactionType as ReactionType,
+    type ReplyTo as ReplyTo,
+    type TextPart as TextPart,
     type MessageRetrieveThreadResponse as MessageRetrieveThreadResponse,
     type MessageDeleteParams as MessageDeleteParams,
     type MessageAddReactionParams as MessageAddReactionParams,