@linqapp/sdk 0.67.0 → 0.69.0

package/src/resources/chats/chats.ts

@@ -87,6 +87,42 @@ export class Chats extends APIResource {
    * participants, iMessage recipients see the decorations and SMS/RCS recipients
    * receive the same message as plain text.
    *
+   * ## Inline Stickers (iMessage only)
+   *
+   * Use the `inline_stickers` array on a text part to place stickers inside the
+   * text. Each sticker replaces the characters in its `range: [start, end)` and
+   * takes its image from exactly one of `url` or `attachment_id` — an image uploaded
+   * with `POST /v3/attachments`.
+   *
+   * ```json
+   * {
+   *   "type": "text",
+   *   "value": "Happy birthday 🎂! 🎉🎉",
+   *   "inline_stickers": [
+   *     {
+   *       "range": [15, 17],
+   *       "attachment_id": "550e8400-e29b-41d4-a716-446655440000"
+   *     },
+   *     {
+   *       "range": [19, 21],
+   *       "attachment_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
+   *     },
+   *     {
+   *       "range": [21, 23],
+   *       "attachment_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
+   *     }
+   *   ]
+   * }
+   * ```
+   *
+   * **Note:** A sticker takes the place of the characters it covers, so they are
+   * hidden on iMessage: `"Sip cup"` with a sticker on `cup` reads "Sip [sticker]".
+   * Those characters are what SMS and RCS recipients receive (the stickers are
+   * dropped and `value` is sent as written) and what VoiceOver reads. To keep a word
+   * visible, give the sticker its own placeholder: `"Sip cup 🥤"` with the range on
+   * `🥤`. Up to 100 stickers and 10 different images per part; copies of one image
+   * count as one.
+   *
    * ## First-Message Link Restriction
    *
    * To protect sender deliverability, the **first outbound message** of a new chat
@@ -431,6 +467,38 @@ export namespace Chat {
   }
 }
 
+/**
+ * A sticker image placed inside the text of a part, replacing the characters in
+ * `range`. Provide exactly one of `url` or `attachment_id`.
+ */
+export interface InlineSticker {
+  /**
+   * Character range `[start, end)` in the `value` string that the sticker replaces.
+   * `start` is inclusive, `end` is exclusive. Those characters are hidden on
+   * iMessage and sent as written on SMS and RCS. _Characters are measured as UTF-16
+   * code units. Most characters count as 1; some emoji count as 2._
+   */
+  range: Array<number>;
+
+  /**
+   * Reference to a sticker image pre-uploaded via `POST /v3/attachments`.
+   *
+   * Exactly one of `url` or `attachment_id` is required.
+   */
+  attachment_id?: string;
+
+  /**
+   * Linq attachment URL of the sticker image — the `download_url` returned by
+   * `POST /v3/attachments`.
+   *
+   * The image must already be stored with us. To use an image from elsewhere, upload
+   * it with `POST /v3/attachments` first and pass `attachment_id`.
+   *
+   * Exactly one of `url` or `attachment_id` is required.
+   */
+  url?: string;
+}
+
 export interface LinkPart {
   /**
    * Indicates this is a rich link preview part
@@ -843,6 +911,33 @@ export interface TextPart {
    */
   value: string;
 
+  /**
+   * Optional stickers placed inside the text, in the line with the words (iMessage
+   * only).
+   *
+   * Each sticker replaces the characters in its `range` `[start, end)` of `value`,
+   * and takes its image from exactly one of `url` or `attachment_id` — an image
+   * uploaded with `POST /v3/attachments`. The characters a sticker covers are hidden
+   * on iMessage and are what SMS and RCS recipients receive and VoiceOver reads, so
+   * cover something that stands in for the sticker (`"🎂"`, `"[cake]"`). To keep a
+   * word visible, give the sticker its own placeholder: `"Sip cup 🥤"` with the
+   * range on `🥤`.
+   *
+   * Up to 100 stickers and 10 different images per part. Copies of one image count
+   * as one: twenty copies of one sticker use one of the 10. An animated image
+   * arrives as a still.
+   *
+   * Stickers cannot overlap each other or a `text_decorations` range, cannot split a
+   * character, and cannot be combined with `mention`.
+   *
+   * _Characters are measured as UTF-16 code units. Most characters count as 1; some
+   * emoji count as 2._
+   *
+   * **Note:** on SMS and RCS the stickers are dropped and `value` is sent as plain
+   * text.
+   */
+  inline_stickers?: Array<InlineSticker>;
+
   /**
    * Mention a chat participant. Group chats only — sending a mention to a direct
    * chat is rejected with `409` / `2023`. The chat's service is not a constraint: a
@@ -1235,6 +1330,7 @@ Chats.Background = Background;
 export declare namespace Chats {
   export {
     type Chat as Chat,
+    type InlineSticker as InlineSticker,
     type LinkPart as LinkPart,
     type MediaPart as MediaPart,
     type MessageContent as MessageContent,

package/src/resources/chats/index.ts

@@ -4,6 +4,7 @@ export { Background, type BackgroundSetParams } from './background';
 export {
   Chats,
   type Chat,
+  type InlineSticker,
   type LinkPart,
   type MediaPart,
   type MessageContent,

package/src/resources/chats/messages.ts

@@ -159,6 +159,42 @@ export class Messages extends APIResource {
    * participants, iMessage recipients see the decorations and SMS/RCS recipients
    * receive the same message as plain text.
    *
+   * ## Inline Stickers (iMessage only)
+   *
+   * Use the `inline_stickers` array on a text part to place stickers inside the
+   * text. Each sticker replaces the characters in its `range: [start, end)` and
+   * takes its image from exactly one of `url` or `attachment_id` — an image uploaded
+   * with `POST /v3/attachments`.
+   *
+   * ```json
+   * {
+   *   "type": "text",
+   *   "value": "Happy birthday 🎂! 🎉🎉",
+   *   "inline_stickers": [
+   *     {
+   *       "range": [15, 17],
+   *       "attachment_id": "550e8400-e29b-41d4-a716-446655440000"
+   *     },
+   *     {
+   *       "range": [19, 21],
+   *       "attachment_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
+   *     },
+   *     {
+   *       "range": [21, 23],
+   *       "attachment_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
+   *     }
+   *   ]
+   * }
+   * ```
+   *
+   * **Note:** A sticker takes the place of the characters it covers, so they are
+   * hidden on iMessage: `"Sip cup"` with a sticker on `cup` reads "Sip [sticker]".
+   * Those characters are what SMS and RCS recipients receive (the stickers are
+   * dropped and `value` is sent as written) and what VoiceOver reads. To keep a word
+   * visible, give the sticker its own placeholder: `"Sip cup 🥤"` with the range on
+   * `🥤`. Up to 100 stickers and 10 different images per part; copies of one image
+   * count as one.
+   *
    * @example
    * ```ts
    * const response = await client.chats.messages.send(

package/src/resources/index.ts

@@ -31,6 +31,7 @@ export {
 export {
   Chats,
   type Chat,
+  type InlineSticker,
   type LinkPart,
   type MediaPart,
   type MessageContent,
@@ -161,6 +162,8 @@ export {
   type ChatBackgroundUpdateFailedWebhookEvent,
   type ContactCardReceivedWebhookEvent,
   type PhoneNumberStatusUpdatedWebhookEvent,
+  type PhoneNumberAssignedWebhookEvent,
+  type PhoneNumberReleasedWebhookEvent,
   type ConnectionCreatedWebhookEvent,
   type ConnectionRevokedWebhookEvent,
   type LocationSharingStartedWebhookEvent,

package/src/resources/messages/messages.ts

@@ -138,10 +138,11 @@ export class Messages extends APIResource {
    * - Voice memos are **not** supported here. To send an iMessage voice-memo bubble,
    *   use `POST /v3/chats/{chatId}/voicememo` with a known chat id.
    *
-   * ## Service preference, effects, decorations
+   * ## Service preference, effects, decorations, inline stickers
    *
    * Set `message.preferred_service` (`iMessage` | `RCS` | `SMS`), `message.effect`,
-   * and per-part `text_decorations` exactly as on the other send endpoints.
+   * and per-part `text_decorations` and `inline_stickers` exactly as on the other
+   * send endpoints.
    *
    * Always responds `202 Accepted` — chat creation is incidental to the send.
    *

package/src/resources/shared.ts

@@ -39,6 +39,41 @@ export interface ChatHandle {
   status?: 'active' | 'left' | 'removed' | null;
 }
 
+/**
+ * One sticker image placed inside the text of a part: `id`, `url` and the image
+ * details.
+ */
+export interface InlineStickerResponse {
+  /**
+   * Character range `[start, end)` in `value` that the sticker replaces. Those
+   * characters are hidden on iMessage and sent as written on SMS and RCS.
+   * _Characters are measured as UTF-16 code units. Most characters count as 1; some
+   * emoji count as 2._
+   */
+  range: Array<number>;
+
+  /**
+   * Attachment ID of the sticker image.
+   */
+  id?: string | null;
+
+  /**
+   * Filename of the sticker
+   */
+  file_name?: string | null;
+
+  /**
+   * MIME type of the sticker image
+   */
+  mime_type?: string | null;
+
+  /**
+   * URL for downloading the sticker image. Permanent for a normal upload; a
+   * time-limited signed URL when the image is an ephemeral attachment.
+   */
+  url?: string | null;
+}
+
 /**
  * A rich link preview part
  */
@@ -231,6 +266,15 @@ export interface TextPartResponse {
    */
   value: string;
 
+  /**
+   * Stickers placed inside the text, in the order they appear in `value`. `null`
+   * when the part has none.
+   *
+   * Set on messages sent with `inline_stickers`. An inline sticker received over
+   * iMessage currently arrives as a separate media part.
+   */
+  inline_stickers?: Array<InlineStickerResponse> | null;
+
   /**
    * @deprecated DEPRECATED: Use `mentions` instead. Handle (E.164 phone number or
    * Apple ID email) of the **first** mention on this part. A part may carry several

package/src/resources/webhook-events.ts

@@ -180,6 +180,8 @@ export type WebhookEventType =
   | 'chat.typing_indicator.started'
   | 'chat.typing_indicator.stopped'
   | 'phone_number.status_updated'
+  | 'phone_number.assigned'
+  | 'phone_number.released'
   | 'contact_card.received'
   | 'call.initiated'
   | 'call.ringing'

package/src/resources/webhooks.ts

@@ -767,6 +767,15 @@ export interface SchemasTextPartResponse {
    */
   value: string;
 
+  /**
+   * Stickers placed inside the text, in the order they appear in `value`. `null`
+   * when the part has none.
+   *
+   * Set on messages sent with `inline_stickers`. An inline sticker received over
+   * iMessage currently arrives as a separate media part.
+   */
+  inline_stickers?: Array<Shared.InlineStickerResponse> | null;
+
   /**
    * @deprecated DEPRECATED: Use `mentions` instead. Handle (E.164 phone number or
    * Apple ID email) of the **first** mention on this part. A part may carry several
@@ -3800,6 +3809,8 @@ export interface PhoneNumberStatusUpdatedWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -3873,6 +3884,230 @@ export namespace PhoneNumberStatusUpdatedWebhookEvent {
   }
 }
 
+/**
+ * Complete webhook payload for phone_number.assigned events
+ */
+export interface PhoneNumberAssignedWebhookEvent {
+  /**
+   * API version for the webhook payload format
+   */
+  api_version: string;
+
+  /**
+   * When the event was created
+   */
+  created_at: string;
+
+  /**
+   * Payload for phone_number.assigned and phone_number.released webhook events
+   */
+  data: PhoneNumberAssignedWebhookEvent.Data;
+
+  /**
+   * Unique identifier for this event (for deduplication)
+   */
+  event_id: string;
+
+  /**
+   * The type of event
+   */
+  event_type:
+    | 'message.sent'
+    | 'message.received'
+    | 'message.read'
+    | 'message.delivered'
+    | 'message.failed'
+    | 'message.edited'
+    | 'reaction.added'
+    | 'reaction.removed'
+    | 'poll.received'
+    | 'poll.failed'
+    | 'poll.sent'
+    | 'poll.delivered'
+    | 'poll.read'
+    | 'poll.updated'
+    | 'poll.vote.added'
+    | 'poll.vote.removed'
+    | 'poll.reaction.added'
+    | 'participant.added'
+    | 'participant.removed'
+    | 'chat.created'
+    | 'chat.group_name_updated'
+    | 'chat.group_icon_updated'
+    | 'chat.group_name_update_failed'
+    | 'chat.group_icon_update_failed'
+    | 'chat.background_updated'
+    | 'chat.background_update_failed'
+    | 'chat.typing_indicator.started'
+    | 'chat.typing_indicator.stopped'
+    | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
+    | 'contact_card.received'
+    | 'call.initiated'
+    | 'call.ringing'
+    | 'call.answered'
+    | 'call.ended'
+    | 'call.failed'
+    | 'call.declined'
+    | 'call.no_answer'
+    | 'location.sharing.started'
+    | 'location.sharing.stopped'
+    | 'payment.succeeded'
+    | 'payment.canceled'
+    | 'payment.expired'
+    | 'payment.declined'
+    | 'payment.authorized'
+    | 'connection.created'
+    | 'connection.revoked';
+
+  /**
+   * Partner identifier. Present on all webhooks for cross-referencing.
+   */
+  partner_id: string;
+
+  /**
+   * Trace ID for debugging and correlation across systems.
+   */
+  trace_id: string;
+
+  /**
+   * Date-based webhook payload version. Determined by the `?version=` query
+   * parameter in your webhook subscription URL. If no version parameter is
+   * specified, defaults based on subscription creation date.
+   */
+  webhook_version: string;
+}
+
+export namespace PhoneNumberAssignedWebhookEvent {
+  /**
+   * Payload for phone_number.assigned and phone_number.released webhook events
+   */
+  export interface Data {
+    /**
+     * When the ownership change occurred
+     */
+    changed_at: string;
+
+    /**
+     * Phone number in E.164 format
+     */
+    phone_number: string;
+  }
+}
+
+/**
+ * Complete webhook payload for phone_number.released events
+ */
+export interface PhoneNumberReleasedWebhookEvent {
+  /**
+   * API version for the webhook payload format
+   */
+  api_version: string;
+
+  /**
+   * When the event was created
+   */
+  created_at: string;
+
+  /**
+   * Payload for phone_number.assigned and phone_number.released webhook events
+   */
+  data: PhoneNumberReleasedWebhookEvent.Data;
+
+  /**
+   * Unique identifier for this event (for deduplication)
+   */
+  event_id: string;
+
+  /**
+   * The type of event
+   */
+  event_type:
+    | 'message.sent'
+    | 'message.received'
+    | 'message.read'
+    | 'message.delivered'
+    | 'message.failed'
+    | 'message.edited'
+    | 'reaction.added'
+    | 'reaction.removed'
+    | 'poll.received'
+    | 'poll.failed'
+    | 'poll.sent'
+    | 'poll.delivered'
+    | 'poll.read'
+    | 'poll.updated'
+    | 'poll.vote.added'
+    | 'poll.vote.removed'
+    | 'poll.reaction.added'
+    | 'participant.added'
+    | 'participant.removed'
+    | 'chat.created'
+    | 'chat.group_name_updated'
+    | 'chat.group_icon_updated'
+    | 'chat.group_name_update_failed'
+    | 'chat.group_icon_update_failed'
+    | 'chat.background_updated'
+    | 'chat.background_update_failed'
+    | 'chat.typing_indicator.started'
+    | 'chat.typing_indicator.stopped'
+    | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
+    | 'contact_card.received'
+    | 'call.initiated'
+    | 'call.ringing'
+    | 'call.answered'
+    | 'call.ended'
+    | 'call.failed'
+    | 'call.declined'
+    | 'call.no_answer'
+    | 'location.sharing.started'
+    | 'location.sharing.stopped'
+    | 'payment.succeeded'
+    | 'payment.canceled'
+    | 'payment.expired'
+    | 'payment.declined'
+    | 'payment.authorized'
+    | 'connection.created'
+    | 'connection.revoked';
+
+  /**
+   * Partner identifier. Present on all webhooks for cross-referencing.
+   */
+  partner_id: string;
+
+  /**
+   * Trace ID for debugging and correlation across systems.
+   */
+  trace_id: string;
+
+  /**
+   * Date-based webhook payload version. Determined by the `?version=` query
+   * parameter in your webhook subscription URL. If no version parameter is
+   * specified, defaults based on subscription creation date.
+   */
+  webhook_version: string;
+}
+
+export namespace PhoneNumberReleasedWebhookEvent {
+  /**
+   * Payload for phone_number.assigned and phone_number.released webhook events
+   */
+  export interface Data {
+    /**
+     * When the ownership change occurred
+     */
+    changed_at: string;
+
+    /**
+     * Phone number in E.164 format
+     */
+    phone_number: string;
+  }
+}
+
 export interface ConnectionCreatedWebhookEvent {
   /**
    * API version for the webhook payload format
@@ -3928,6 +4163,8 @@ export interface ConnectionCreatedWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -4167,6 +4404,8 @@ export interface ConnectionRevokedWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -4400,6 +4639,8 @@ export interface LocationSharingStartedWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -4518,6 +4759,8 @@ export interface LocationSharingStoppedWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -4641,6 +4884,8 @@ export interface PaymentAuthorizedWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -4880,6 +5125,8 @@ export interface PaymentCanceledWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -5119,6 +5366,8 @@ export interface PaymentDeclinedWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -5358,6 +5607,8 @@ export interface PaymentExpiredWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -5597,6 +5848,8 @@ export interface PaymentSucceededWebhookEvent {
     | 'chat.typing_indicator.started'
     | 'chat.typing_indicator.stopped'
     | 'phone_number.status_updated'
+    | 'phone_number.assigned'
+    | 'phone_number.released'
     | 'contact_card.received'
     | 'call.initiated'
     | 'call.ringing'
@@ -5815,6 +6068,8 @@ export type UnwrapWebhookEvent =
   | ChatBackgroundUpdateFailedWebhookEvent
   | ContactCardReceivedWebhookEvent
   | PhoneNumberStatusUpdatedWebhookEvent
+  | PhoneNumberAssignedWebhookEvent
+  | PhoneNumberReleasedWebhookEvent
   | ConnectionCreatedWebhookEvent
   | ConnectionRevokedWebhookEvent
   | LocationSharingStartedWebhookEvent
@@ -5863,6 +6118,8 @@ export declare namespace Webhooks {
     type ChatBackgroundUpdateFailedWebhookEvent as ChatBackgroundUpdateFailedWebhookEvent,
     type ContactCardReceivedWebhookEvent as ContactCardReceivedWebhookEvent,
     type PhoneNumberStatusUpdatedWebhookEvent as PhoneNumberStatusUpdatedWebhookEvent,
+    type PhoneNumberAssignedWebhookEvent as PhoneNumberAssignedWebhookEvent,
+    type PhoneNumberReleasedWebhookEvent as PhoneNumberReleasedWebhookEvent,
     type ConnectionCreatedWebhookEvent as ConnectionCreatedWebhookEvent,
     type ConnectionRevokedWebhookEvent as ConnectionRevokedWebhookEvent,
     type LocationSharingStartedWebhookEvent as LocationSharingStartedWebhookEvent,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.67.0'; // x-release-please-version
+export const VERSION = '0.69.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.67.0";
+export declare const VERSION = "0.69.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.67.0";
+export declare const VERSION = "0.69.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.67.0'; // x-release-please-version
+exports.VERSION = '0.69.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.67.0'; // x-release-please-version
+export const VERSION = '0.69.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map