sendblue 3.10.1 → 3.12.0

package/resources/messages.d.mts

@@ -55,18 +55,30 @@ export declare class Messages extends APIResource {
      */
     getStatus(query: MessageGetStatusParams, options?: RequestOptions): APIPromise<MessageResponse>;
     /**
-     * Send an iMessage, SMS, or MMS to a single recipient
+     * Send an iMessage, SMS, MMS, or Sendblue App Card to a single recipient
      *
      * @example
      * ```ts
      * const messageResponse = await client.messages.send({
-     *   content: 'Hello, World!',
      *   from_number: '+19998887777',
      *   number: '+19998887777',
      * });
      * ```
      */
     send(body: MessageSendParams, options?: RequestOptions): APIPromise<MessageResponse>;
+    /**
+     * Continues an existing App Card by sending a new Apple message in the same
+     * iMessage session, from the same sender line and inline-reply context. The
+     * continuation receives its own message handle and delivery/read status updates.
+     *
+     * @example
+     * ```ts
+     * const messageResponse = await client.messages.updateAppCard(
+     *   'message_handle',
+     * );
+     * ```
+     */
+    updateAppCard(messageHandle: string, body: MessageUpdateAppCardParams, options?: RequestOptions): APIPromise<MessageResponse>;
 }
 export interface MessageContent {
     /**
@@ -105,6 +117,11 @@ export interface MessageContent {
      * Unique message identifier
      */
     message_handle?: string;
+    /**
+     * Immediate parent of an iMessage inline reply. The target must belong to the same
+     * account, conversation, and sending line.
+     */
+    reply_to?: MessageContent.ReplyTo;
     /**
      * UUID of the seat that sent the message. Present when `seat_id` was provided on
      * send, or for dashboard-originated group messages.
@@ -117,16 +134,57 @@ export interface MessageContent {
      */
     sender_email?: string | null;
     status?: 'QUEUED' | 'SENT' | 'DELIVERED' | 'ERROR' | 'RECEIVED';
+    /**
+     * Message that originated an iMessage inline-reply thread.
+     */
+    thread_originator?: MessageContent.ThreadOriginator;
     /**
      * Recipient phone number
      */
     to_number?: string;
 }
+export declare namespace MessageContent {
+    /**
+     * Immediate parent of an iMessage inline reply. The target must belong to the same
+     * account, conversation, and sending line.
+     */
+    interface ReplyTo {
+        /**
+         * Public handle of the immediate parent message
+         */
+        message_handle: string;
+        /**
+         * Advanced override for a known part of a multipart target. Omit this in normal
+         * reply requests and never guess it; requests default to 0. When replying to an
+         * attachment represented by its own webhook, use that webhook's `message_handle`
+         * and omit `part_index` so Sendblue can use the stored authoritative part.
+         * Responses omit it when no authoritative immediate-parent part is available.
+         */
+        part_index?: number;
+    }
+    /**
+     * Message that originated an iMessage inline-reply thread.
+     */
+    interface ThreadOriginator {
+        /**
+         * Public handle of the thread's root message
+         */
+        message_handle: string;
+        /**
+         * Opaque Apple thread-originator part descriptor
+         */
+        part?: string;
+    }
+}
 export interface MessageResponse {
     /**
      * Email of the account that sent the message
      */
     account_email?: string;
+    /**
+     * App Card data sent or received with this message.
+     */
+    app_card?: MessageResponse.AppCard | MessageResponse.InboundAppCard;
     /**
      * Message content
      */
@@ -155,6 +213,10 @@ export interface MessageResponse {
      * Whether this is an outbound message
      */
     is_outbound?: boolean;
+    /**
+     * Decoded Find My location share coordinates.
+     */
+    location?: MessageResponse.Location;
     /**
      * URL of attached media
      */
@@ -163,10 +225,16 @@ export interface MessageResponse {
      * Unique identifier for tracking the message
      */
     message_handle?: string;
+    message_type?: 'message' | 'group' | 'location';
     /**
      * Recipient phone number
      */
     number?: string;
+    /**
+     * Immediate parent of an iMessage inline reply. The target must belong to the same
+     * account, conversation, and sending line.
+     */
+    reply_to?: MessageResponse.ReplyTo;
     /**
      * UUID of the seat that sent the message. Present when `seat_id` was provided on
      * send, or for dashboard-originated group messages.
@@ -182,6 +250,151 @@ export interface MessageResponse {
      */
     sender_email?: string | null;
     status?: 'QUEUED' | 'SENT' | 'DELIVERED' | 'ERROR';
+    /**
+     * Message that originated an iMessage inline-reply thread.
+     */
+    thread_originator?: MessageResponse.ThreadOriginator;
+}
+export declare namespace MessageResponse {
+    /**
+     * A Sendblue App Card rendered with Apple's Messages framework. App Cards require
+     * a V2 Mac line and an iMessage-capable recipient; they never fall back to SMS.
+     * The URL is delivered to the identified Messages extension when the recipient
+     * taps the card. An initial App Card may include `reply_to` to create an inline
+     * reply. Later state changes use the update endpoint, which sends a new Apple
+     * message in the same App Card session. The feature is unavailable on the free
+     * plan.
+     */
+    interface AppCard {
+        appName: string;
+        extensionBundleId: string;
+        /**
+         * Visible card fields mirroring Apple's MSMessageTemplateLayout.
+         */
+        layout: AppCard.Layout;
+        teamId: string;
+        /**
+         * URL delivered to the iMessage extension on tap. HTTPS URLs are limited to 2048
+         * characters; data URLs carrying inline app state are limited to 16384.
+         */
+        url: string;
+        /**
+         * Optional numeric App Store ID for recipients without the extension.
+         */
+        appStoreId?: number;
+        /**
+         * Fallback text for notifications and surfaces that cannot render the card.
+         */
+        fallbackText?: string;
+        /**
+         * Use Apple's live layout when the extension is installed; false always sends the
+         * static template layout.
+         */
+        interactive?: boolean;
+        /**
+         * Optional caller-supplied App Card session UUID. Generated automatically when
+         * omitted.
+         */
+        sessionIdentifier?: string;
+        /**
+         * Original message handle for an App Card continuation returned by the update
+         * endpoint.
+         */
+        updateMessageHandle?: string;
+    }
+    namespace AppCard {
+        /**
+         * Visible card fields mirroring Apple's MSMessageTemplateLayout.
+         */
+        interface Layout {
+            caption?: string;
+            /**
+             * Secondary text overlaid on the preview image. Requires imageUrl.
+             */
+            imageSubtitle?: string;
+            /**
+             * Text overlaid on the preview image. Requires imageUrl.
+             */
+            imageTitle?: string;
+            /**
+             * HTTPS preview image fetched by the worker and sent as a hidden card attachment.
+             * JPEG, PNG, HEIC, HEIF, and WebP are supported up to 10 MB.
+             */
+            imageUrl?: string;
+            subcaption?: string;
+            /**
+             * Fallback text used in notifications and non-rendering surfaces.
+             */
+            summary?: string;
+            trailingCaption?: string;
+            trailingSubcaption?: string;
+        }
+    }
+    /**
+     * App Card session metadata received from an iMessage contact.
+     */
+    interface InboundAppCard {
+        balloonBundleId: string;
+        extensionBundleId: string;
+        /**
+         * Retry-stable occurrence revision assigned to this inbound App Card state.
+         */
+        revision: number;
+        sessionIdentifier: string;
+        teamId: string;
+        url: string;
+    }
+    /**
+     * Decoded Find My location share coordinates.
+     */
+    interface Location {
+        latitude: number;
+        longitude: number;
+        /**
+         * Horizontal accuracy in meters
+         */
+        accuracy?: number;
+        /**
+         * Altitude in meters
+         */
+        altitude?: number;
+        /**
+         * Share duration selected by the recipient
+         */
+        duration?: string;
+        timestamp?: string;
+    }
+    /**
+     * Immediate parent of an iMessage inline reply. The target must belong to the same
+     * account, conversation, and sending line.
+     */
+    interface ReplyTo {
+        /**
+         * Public handle of the immediate parent message
+         */
+        message_handle: string;
+        /**
+         * Advanced override for a known part of a multipart target. Omit this in normal
+         * reply requests and never guess it; requests default to 0. When replying to an
+         * attachment represented by its own webhook, use that webhook's `message_handle`
+         * and omit `part_index` so Sendblue can use the stored authoritative part.
+         * Responses omit it when no authoritative immediate-parent part is available.
+         */
+        part_index?: number;
+    }
+    /**
+     * Message that originated an iMessage inline-reply thread.
+     */
+    interface ThreadOriginator {
+        /**
+         * Public handle of the thread's root message
+         */
+        message_handle: string;
+        /**
+         * Opaque Apple thread-originator part descriptor
+         */
+        part?: string;
+    }
 }
 export interface MessageRetrieveResponse {
     data?: MessageRetrieveResponse.Data;
@@ -237,6 +450,10 @@ export declare namespace MessageRetrieveResponse {
          * Whether this is an outbound message
          */
         is_outbound?: boolean;
+        /**
+         * Decoded Find My location share coordinates.
+         */
+        location?: Data.Location;
         /**
          * URL of attached media
          */
@@ -245,7 +462,7 @@ export declare namespace MessageRetrieveResponse {
          * Unique message identifier
          */
         message_handle?: string;
-        message_type?: 'message' | 'group';
+        message_type?: 'message' | 'group' | 'location';
         /**
          * Primary phone number (to_number for outbound, from_number for inbound)
          */
@@ -262,6 +479,11 @@ export declare namespace MessageRetrieveResponse {
          * Account plan used for this message
          */
         plan?: string;
+        /**
+         * Immediate parent of an iMessage inline reply. The target must belong to the same
+         * account, conversation, and sending line.
+         */
+        reply_to?: Data.ReplyTo;
         /**
          * UUID of the seat that sent the message. Present when `seat_id` was provided on
          * send, or for dashboard-originated group messages.
@@ -285,6 +507,10 @@ export declare namespace MessageRetrieveResponse {
          */
         service?: 'iMessage' | 'SMS' | 'RCS';
         status?: 'REGISTERED' | 'PENDING' | 'SENT' | 'DELIVERED' | 'RECEIVED' | 'QUEUED' | 'ERROR' | 'DECLINED' | 'ACCEPTED' | 'SUCCESS';
+        /**
+         * Message that originated an iMessage inline-reply thread.
+         */
+        thread_originator?: Data.ThreadOriginator;
         /**
          * Recipient phone number
          */
@@ -294,6 +520,59 @@ export declare namespace MessageRetrieveResponse {
          */
         was_downgraded?: boolean;
     }
+    namespace Data {
+        /**
+         * Decoded Find My location share coordinates.
+         */
+        interface Location {
+            latitude: number;
+            longitude: number;
+            /**
+             * Horizontal accuracy in meters
+             */
+            accuracy?: number;
+            /**
+             * Altitude in meters
+             */
+            altitude?: number;
+            /**
+             * Share duration selected by the recipient
+             */
+            duration?: string;
+            timestamp?: string;
+        }
+        /**
+         * Immediate parent of an iMessage inline reply. The target must belong to the same
+         * account, conversation, and sending line.
+         */
+        interface ReplyTo {
+            /**
+             * Public handle of the immediate parent message
+             */
+            message_handle: string;
+            /**
+             * Advanced override for a known part of a multipart target. Omit this in normal
+             * reply requests and never guess it; requests default to 0. When replying to an
+             * attachment represented by its own webhook, use that webhook's `message_handle`
+             * and omit `part_index` so Sendblue can use the stored authoritative part.
+             * Responses omit it when no authoritative immediate-parent part is available.
+             */
+            part_index?: number;
+        }
+        /**
+         * Message that originated an iMessage inline-reply thread.
+         */
+        interface ThreadOriginator {
+            /**
+             * Public handle of the thread's root message
+             */
+            message_handle: string;
+            /**
+             * Opaque Apple thread-originator part descriptor
+             */
+            part?: string;
+        }
+    }
 }
 export interface MessageListResponse {
     data?: Array<MessageListResponse.Data>;
@@ -350,6 +629,10 @@ export declare namespace MessageListResponse {
          * Whether this is an outbound message
          */
         is_outbound?: boolean;
+        /**
+         * Decoded Find My location share coordinates.
+         */
+        location?: Data.Location;
         /**
          * URL of attached media
          */
@@ -358,7 +641,7 @@ export declare namespace MessageListResponse {
          * Unique message identifier
          */
         message_handle?: string;
-        message_type?: 'message' | 'group';
+        message_type?: 'message' | 'group' | 'location';
         /**
          * Primary phone number (to_number for outbound, from_number for inbound)
          */
@@ -375,6 +658,11 @@ export declare namespace MessageListResponse {
          * Account plan used for this message
          */
         plan?: string;
+        /**
+         * Immediate parent of an iMessage inline reply. The target must belong to the same
+         * account, conversation, and sending line.
+         */
+        reply_to?: Data.ReplyTo;
         /**
          * UUID of the seat that sent the message. Present when `seat_id` was provided on
          * send, or for dashboard-originated group messages.
@@ -398,6 +686,10 @@ export declare namespace MessageListResponse {
          */
         service?: 'iMessage' | 'SMS' | 'RCS';
         status?: 'REGISTERED' | 'PENDING' | 'SENT' | 'DELIVERED' | 'RECEIVED' | 'QUEUED' | 'ERROR' | 'DECLINED' | 'ACCEPTED' | 'SUCCESS';
+        /**
+         * Message that originated an iMessage inline-reply thread.
+         */
+        thread_originator?: Data.ThreadOriginator;
         /**
          * Recipient phone number
          */
@@ -407,6 +699,59 @@ export declare namespace MessageListResponse {
          */
         was_downgraded?: boolean;
     }
+    namespace Data {
+        /**
+         * Decoded Find My location share coordinates.
+         */
+        interface Location {
+            latitude: number;
+            longitude: number;
+            /**
+             * Horizontal accuracy in meters
+             */
+            accuracy?: number;
+            /**
+             * Altitude in meters
+             */
+            altitude?: number;
+            /**
+             * Share duration selected by the recipient
+             */
+            duration?: string;
+            timestamp?: string;
+        }
+        /**
+         * Immediate parent of an iMessage inline reply. The target must belong to the same
+         * account, conversation, and sending line.
+         */
+        interface ReplyTo {
+            /**
+             * Public handle of the immediate parent message
+             */
+            message_handle: string;
+            /**
+             * Advanced override for a known part of a multipart target. Omit this in normal
+             * reply requests and never guess it; requests default to 0. When replying to an
+             * attachment represented by its own webhook, use that webhook's `message_handle`
+             * and omit `part_index` so Sendblue can use the stored authoritative part.
+             * Responses omit it when no authoritative immediate-parent part is available.
+             */
+            part_index?: number;
+        }
+        /**
+         * Message that originated an iMessage inline-reply thread.
+         */
+        interface ThreadOriginator {
+            /**
+             * Public handle of the thread's root message
+             */
+            message_handle: string;
+            /**
+             * Opaque Apple thread-originator part descriptor
+             */
+            part?: string;
+        }
+    }
     interface Pagination {
         /**
          * Whether there are more messages available
@@ -529,10 +874,6 @@ export interface MessageGetStatusParams {
     handle: string;
 }
 export interface MessageSendParams {
-    /**
-     * Message text content
-     */
-    content: string;
     /**
      * **REQUIRED** - The phone number to send from. Must be one of your registered
      * Sendblue phone numbers in E.164 format. Without this parameter, the message will
@@ -543,10 +884,29 @@ export interface MessageSendParams {
      * Recipient phone number in E.164 format
      */
     number: string;
+    /**
+     * A Sendblue App Card rendered with Apple's Messages framework. App Cards require
+     * a V2 Mac line and an iMessage-capable recipient; they never fall back to SMS.
+     * The URL is delivered to the identified Messages extension when the recipient
+     * taps the card. An initial App Card may include `reply_to` to create an inline
+     * reply. Later state changes use the update endpoint, which sends a new Apple
+     * message in the same App Card session. The feature is unavailable on the free
+     * plan.
+     */
+    app_card?: MessageSendParams.AppCard;
+    /**
+     * Message text content. Optional when `media_url` or `app_card` is provided.
+     */
+    content?: string;
     /**
      * URL of media file to send (images, videos, etc.)
      */
     media_url?: string;
+    /**
+     * Optional inline-reply target. This may be combined with `app_card`; the
+     * resulting App Card is sent as an inline reply to the target.
+     */
+    reply_to?: MessageSendParams.ReplyTo;
     /**
      * Optional. Identifies the seat (user) sending the message so the message is
      * attributed to a specific rep. Accepts either the seat UUID or the Firebase Auth
@@ -563,7 +923,145 @@ export interface MessageSendParams {
      */
     status_callback?: string;
 }
+export declare namespace MessageSendParams {
+    /**
+     * A Sendblue App Card rendered with Apple's Messages framework. App Cards require
+     * a V2 Mac line and an iMessage-capable recipient; they never fall back to SMS.
+     * The URL is delivered to the identified Messages extension when the recipient
+     * taps the card. An initial App Card may include `reply_to` to create an inline
+     * reply. Later state changes use the update endpoint, which sends a new Apple
+     * message in the same App Card session. The feature is unavailable on the free
+     * plan.
+     */
+    interface AppCard {
+        appName: string;
+        extensionBundleId: string;
+        /**
+         * Visible card fields mirroring Apple's MSMessageTemplateLayout.
+         */
+        layout: AppCard.Layout;
+        teamId: string;
+        /**
+         * URL delivered to the iMessage extension on tap. HTTPS URLs are limited to 2048
+         * characters; data URLs carrying inline app state are limited to 16384.
+         */
+        url: string;
+        /**
+         * Optional numeric App Store ID for recipients without the extension.
+         */
+        appStoreId?: number;
+        /**
+         * Fallback text for notifications and surfaces that cannot render the card.
+         */
+        fallbackText?: string;
+        /**
+         * Use Apple's live layout when the extension is installed; false always sends the
+         * static template layout.
+         */
+        interactive?: boolean;
+        /**
+         * Optional caller-supplied App Card session UUID. Generated automatically when
+         * omitted.
+         */
+        sessionIdentifier?: string;
+    }
+    namespace AppCard {
+        /**
+         * Visible card fields mirroring Apple's MSMessageTemplateLayout.
+         */
+        interface Layout {
+            caption?: string;
+            /**
+             * Secondary text overlaid on the preview image. Requires imageUrl.
+             */
+            imageSubtitle?: string;
+            /**
+             * Text overlaid on the preview image. Requires imageUrl.
+             */
+            imageTitle?: string;
+            /**
+             * HTTPS preview image fetched by the worker and sent as a hidden card attachment.
+             * JPEG, PNG, HEIC, HEIF, and WebP are supported up to 10 MB.
+             */
+            imageUrl?: string;
+            subcaption?: string;
+            /**
+             * Fallback text used in notifications and non-rendering surfaces.
+             */
+            summary?: string;
+            trailingCaption?: string;
+            trailingSubcaption?: string;
+        }
+    }
+    /**
+     * Optional inline-reply target. This may be combined with `app_card`; the
+     * resulting App Card is sent as an inline reply to the target.
+     */
+    interface ReplyTo {
+        /**
+         * Public handle of the immediate parent message
+         */
+        message_handle: string;
+        /**
+         * Advanced override for a known part of a multipart target. Omit this in normal
+         * reply requests and never guess it; requests default to 0. When replying to an
+         * attachment represented by its own webhook, use that webhook's `message_handle`
+         * and omit `part_index` so Sendblue can use the stored authoritative part.
+         * Responses omit it when no authoritative immediate-parent part is available.
+         */
+        part_index?: number;
+    }
+}
+export interface MessageUpdateAppCardParams {
+    /**
+     * Replacement fallback text for notifications and non-rendering surfaces.
+     */
+    fallback_text?: string;
+    /**
+     * Reusing this key for the same App Card target returns the original update
+     * instead of sending again.
+     */
+    idempotency_key?: string;
+    interactive?: boolean;
+    /**
+     * Visible card fields mirroring Apple's MSMessageTemplateLayout.
+     */
+    layout?: MessageUpdateAppCardParams.Layout;
+    /**
+     * The iMessage expressive message style for this update.
+     */
+    send_style?: 'celebration' | 'shooting_star' | 'fireworks' | 'lasers' | 'love' | 'confetti' | 'balloons' | 'spotlight' | 'echo' | 'invisible' | 'gentle' | 'loud' | 'slam';
+    url?: string;
+}
+export declare namespace MessageUpdateAppCardParams {
+    /**
+     * Visible card fields mirroring Apple's MSMessageTemplateLayout.
+     */
+    interface Layout {
+        caption?: string;
+        /**
+         * Secondary text overlaid on the preview image. Requires imageUrl.
+         */
+        imageSubtitle?: string;
+        /**
+         * Text overlaid on the preview image. Requires imageUrl.
+         */
+        imageTitle?: string;
+        /**
+         * HTTPS preview image fetched by the worker and sent as a hidden card attachment.
+         * JPEG, PNG, HEIC, HEIF, and WebP are supported up to 10 MB.
+         */
+        imageUrl?: string;
+        subcaption?: string;
+        /**
+         * Fallback text used in notifications and non-rendering surfaces.
+         */
+        summary?: string;
+        trailingCaption?: string;
+        trailingSubcaption?: string;
+    }
+}
 export declare namespace Messages {
-    export { type MessageContent as MessageContent, type MessageResponse as MessageResponse, type MessageRetrieveResponse as MessageRetrieveResponse, type MessageListResponse as MessageListResponse, type MessageListParams as MessageListParams, type MessageGetStatusParams as MessageGetStatusParams, type MessageSendParams as MessageSendParams, };
+    export { type MessageContent as MessageContent, type MessageResponse as MessageResponse, type MessageRetrieveResponse as MessageRetrieveResponse, type MessageListResponse as MessageListResponse, type MessageListParams as MessageListParams, type MessageGetStatusParams as MessageGetStatusParams, type MessageSendParams as MessageSendParams, type MessageUpdateAppCardParams as MessageUpdateAppCardParams, };
 }
 //# sourceMappingURL=messages.d.mts.map