@linqapp/sdk 0.28.0 → 0.28.2

package/resources/messages.mjs

@@ -22,8 +22,117 @@ import { path } from "../internal/utils/path.mjs";
  * **Limitations:**
  * - A `link` part cannot be combined with other parts in the same message.
  * - Maximum URL length: 2,048 characters.
+ *
+ * ## Ephemeral Messages (Privacy Tier)
+ *
+ * For regulated or sensitive conversations, opt in to the **ephemeral messages** tier by contacting your Linq support contact. When enabled, every message on the covered phone numbers is automatically given a fixed **24-hour retention window** — after that window the platform permanently deletes the message from Linq storage. There is no per-message flag; ephemerality is applied automatically based on your configuration.
+ *
+ * You can request it at two scopes:
+ *
+ * | Scope | Effect |
+ * |---|---|
+ * | **Partner-wide** | Every outbound and inbound message on every phone number under your account is retained for 24 hours, then deleted. |
+ * | **Per phone number** | Only the specified phone numbers have their messages auto-deleted. The rest follow the standard message-retention policy. |
+ *
+ * **Behavioral differences vs the standard default:**
+ *
+ * | Aspect | Standard | Ephemeral |
+ * |---|---|---|
+ * | Retention | Retained per the standard message-retention policy | **Hard backstop: 24 hours** from when the message is created |
+ * | After expiry | Message stays retrievable | Message is permanently deleted — `GET /v3/messages/{messageId}` returns `404` and it no longer appears in `GET /v3/chats/{chatId}/messages` |
+ * | Content on expiry | N/A | Text, formatting, and attachment references are scrubbed; the message is gone, not blanked out |
+ * | Cross-partner isolation | Enforced | Enforced |
+ *
+ * **How the 24-hour window works:**
+ *
+ * - The window is fixed at **24 hours from message creation** (`created_at`) and cannot be configured per message.
+ * - It mirrors the ephemeral *attachments* 1-day backstop, so a message and any media it carries expire together.
+ * - Expiry is delivery-independent — the clock starts when the message is created, not when it is delivered or read.
+ *
+ * **What you observe:**
+ *
+ * - **No expiry timestamp is exposed.** API responses and webhook payloads do not include the deletion time. If you need it, compute `created_at + 24h` yourself.
+ * - **No deletion webhook is sent.** There is no `message.deleted` event — a message simply stops being retrievable once its window passes.
+ * - **Delivery is unaffected.** Ephemeral messages send, deliver, and fire the usual `message.sent` / `message.received` and status webhooks exactly like standard messages. Only retention changes.
+ *
+ * **When to choose ephemeral:**
+ *
+ * - You have a compliance requirement that the platform must not retain message content beyond a short window.
+ * - The conversation is high-sensitivity (PHI, financial, identity verification) and you do not want it sitting in storage long-term.
+ * - Your application is the system of record — you capture what you need from the delivery webhook in real time and do not rely on reading message history back from Linq later.
+ *
+ * **Important:** ephemeral applies in *both directions* — messages you send **and** messages received by the phone numbers in that scope. Because Linq can no longer return the message after 24 hours, persist anything you need to keep from the webhook payload at the time it is delivered.
  */
 export class Messages extends APIResource {
+    /**
+     * Send a message to one or more recipients **without supplying a `from` number**.
+     * Linq resolves both the sending line and the target chat for you, then returns
+     * exactly which line was used, which chat the message landed in, whether a new
+     * chat was created, and every resulting message id.
+     *
+     * This fuses "create chat" and "send message" behind a single message-centric
+     * resource. Provide only the recipients (`to`) and the `message`; the platform
+     * decides the rest.
+     *
+     * ## How the from-number and chat are chosen
+     *
+     * - **Reuse** — if a chat with exactly these recipients already exists and the
+     *   line it lives on is healthy, the message is sent into that chat on its
+     *   existing line (`from_selection.reason = reused_active_chat`).
+     * - **New** — if no such chat exists, a new chat is created on the best available
+     *   line (`from_selection.reason = new_best_number`).
+     * - **Failover** — if a matching chat exists but its line has been flagged, a
+     *   **new** chat is created on a fresh best line and the flagged chat is abandoned
+     *   (`from_selection.reason = failover_flagged`, `previous_chat_id` set). If you
+     *   supply `continuation_message`, that text is sent as the single message INSTEAD
+     *   of `message` (useful as a fresh-number-appropriate opener). Exactly one
+     *   message is sent either way.
+     *
+     * Recipients (`to`) are an order-independent set: a single handle is a direct
+     * chat, multiple handles a group chat.
+     *
+     * ## Differences from POST /v3/chats
+     *
+     * - The first message **may contain a link** (including for a newly created chat).
+     *   Note: sending a link as the very first message on a freshly selected line can
+     *   elevate that line's flagging risk — it is allowed, not recommended.
+     * - 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
+     *
+     * Set `message.preferred_service` (`iMessage` | `RCS` | `SMS`), `message.effect`,
+     * and per-part `text_decorations` exactly as on the other send endpoints.
+     *
+     * Always responds `202 Accepted` — chat creation is incidental to the send.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.create({
+     *   message: {
+     *     parts: [
+     *       {
+     *         type: 'text',
+     *         value:
+     *           'Hi! Thanks for reaching out — how can we help?',
+     *       },
+     *     ],
+     *   },
+     *   to: ['+14155559876'],
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+        return this._client.post('/v3/messages', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
     /**
      * Retrieve all messages in a conversation thread. Given any message ID in the
      * thread, returns the originator message and all replies in chronological order.
@@ -121,5 +230,44 @@ export class Messages extends APIResource {
     update(messageID, body, options) {
         return this._client.patch(path `/v3/messages/${messageID}`, { body, ...options });
     }
+    /**
+     * Replaces a previously delivered `imessage_app` card on the recipient's screen
+     * with new content, instead of posting a new bubble (like a game move redrawing
+     * the board).
+     *
+     * The update is delivered as a **new message** with its own id and delivery
+     * lifecycle (`message.sent` / `message.delivered` / `message.failed` webhooks fire
+     * for the new id). To update the card again, reference the message id returned by
+     * this call.
+     *
+     * Constraints:
+     *
+     * - The referenced message must be an `imessage_app` card sent by you (`400`
+     *   otherwise — inbound cards cannot be updated).
+     * - The referenced card must already be delivered (`409` otherwise — retry after
+     *   the `message.delivered` webhook for it).
+     * - The app identity (`team_id`, `bundle_id`, name) is inherited from the original
+     *   card and cannot change; only `url`, `fallback_text`, and `layout` are
+     *   replaced.
+     * - iMessage-only, like all app cards.
+     * - Concurrent updates against the same card are not serialized server-side; the
+     *   last one delivered wins on the recipient's screen. Serialize updates by always
+     *   referencing the message id returned by the previous call.
+     *
+     * @example
+     * ```ts
+     * const response = await client.messages.updateAppCard(
+     *   '69a37c7d-af4f-4b5e-af42-e28e98ce873a',
+     *   {
+     *     layout: { caption: 'Score: 2 – 1' },
+     *     fallback_text: 'Score update',
+     *     url: 'https://app.example.com/card?game=7f3a&move=2',
+     *   },
+     * );
+     * ```
+     */
+    updateAppCard(messageID, body, options) {
+        return this._client.post(path `/v3/messages/${messageID}/update`, { body, ...options });
+    }
 }
 //# sourceMappingURL=messages.mjs.map

package/resources/messages.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,sBAAsB,EAAkD,+BAA2B;AAC5G,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;OAiBG;IACH,kBAAkB,CAChB,SAAiB,EACjB,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,gBAAgB,SAAS,SAAS,EAAE,CAAA,sBAA+B,CAAA,EAAE;YACtG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,CACT,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF"}
+{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAK/C,OAAO,EAAE,sBAAsB,EAAkD,+BAA2B;AAC5G,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,kBAAkB,CAChB,SAAiB,EACjB,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,gBAAgB,SAAS,SAAS,EAAE,CAAA,sBAA+B,CAAA,EAAE;YACtG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,CACT,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,aAAa,CACX,SAAiB,EACjB,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;CACF"}

package/resources/phone-numbers.d.mts

@@ -15,8 +15,42 @@ export declare class PhoneNumbers extends APIResource {
      * Returns all phone numbers assigned to the authenticated partner. Use this
      * endpoint to discover which phone numbers are available for use as the `from`
      * field when creating a chat, listing chats, or sending a voice memo.
+     *
+     * @example
+     * ```ts
+     * const phoneNumbers = await client.phoneNumbers.list();
+     * ```
      */
     list(options?: RequestOptions): APIPromise<PhoneNumberListResponse>;
+    /**
+     * Updates the forwarding number for a phone number. The forwarding number is where
+     * inbound calls will be forwarded to.
+     *
+     * Pass an empty string to clear the forwarding number.
+     *
+     * @example
+     * ```ts
+     * const phoneNumber = await client.phoneNumbers.update(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { forwarding_number: '+12025559999' },
+     * );
+     * ```
+     */
+    update(phoneNumberID: string, body: PhoneNumberUpdateParams, options?: RequestOptions): APIPromise<PhoneNumberUpdateResponse>;
+}
+export interface PhoneNumberUpdateResponse {
+    /**
+     * Unique identifier for the phone number
+     */
+    id: string;
+    /**
+     * The forwarding number after the update. Null when cleared.
+     */
+    forwarding_number: string | null;
+    /**
+     * Phone number in E.164 format
+     */
+    phone_number: string;
 }
 export interface PhoneNumberListResponse {
     /**
@@ -38,8 +72,8 @@ export declare namespace PhoneNumberListResponse {
          * Unlike chat health, line reputation does not include `opted_out` — opt-out
          * applies to individual recipients, not the whole line.
          *
-         * See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
-         * status means and how to react.
+         * See the [Phone Reputation guide](/guides/phone-numbers/phone-reputation) for
+         * what each status means and how to react.
          */
         health_status: PhoneNumber.HealthStatus;
         /**
@@ -54,10 +88,15 @@ export declare namespace PhoneNumberListResponse {
          * Unlike chat health, line reputation does not include `opted_out` — opt-out
          * applies to individual recipients, not the whole line.
          *
-         * See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
-         * status means and how to react.
+         * See the [Phone Reputation guide](/guides/phone-numbers/phone-reputation) for
+         * what each status means and how to react.
          */
         reputation: PhoneNumber.Reputation;
+        /**
+         * The forwarding number associated with this phone number, in E.164 format. Null
+         * when no forwarding number is configured.
+         */
+        forwarding_number?: string | null;
     }
     namespace PhoneNumber {
         /**
@@ -68,22 +107,22 @@ export declare namespace PhoneNumberListResponse {
          * Unlike chat health, line reputation does not include `opted_out` — opt-out
          * applies to individual recipients, not the whole line.
          *
-         * See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
-         * status means and how to react.
+         * See the [Phone Reputation guide](/guides/phone-numbers/phone-reputation) for
+         * what each status means and how to react.
          */
         interface HealthStatus {
             /**
-             * Deep-link to the relevant section of the Phone Health guide for this status.
+             * Deep-link to the relevant section of the Phone Reputation guide for this status.
              */
             doc_url: string;
             /**
-             * Current reputation of this phone line as assessed by risk-service.
+             * Current reputation of this phone line.
              *
-             * - `HEALTHY` — No elevated risk detected.
-             * - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
-             *   reviewing messaging patterns.
-             * - `CRITICAL` — High risk; further sending may result in line flagging or
-             *   restriction.
+             * - `HEALTHY` — The line is in good standing. Send normally.
+             * - `AT_RISK` — The line's overall engagement is trending down. Slow the line's
+             *   send pace and review your messaging patterns.
+             * - `CRITICAL` — Strong signals that messages from this line aren't landing well.
+             *   Pause outbound on the line until it recovers.
              *
              * Defaults to `HEALTHY` for lines that have not yet been scored.
              */
@@ -97,22 +136,22 @@ export declare namespace PhoneNumberListResponse {
          * Unlike chat health, line reputation does not include `opted_out` — opt-out
          * applies to individual recipients, not the whole line.
          *
-         * See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
-         * status means and how to react.
+         * See the [Phone Reputation guide](/guides/phone-numbers/phone-reputation) for
+         * what each status means and how to react.
          */
         interface Reputation {
             /**
-             * Deep-link to the relevant section of the Phone Health guide for this status.
+             * Deep-link to the relevant section of the Phone Reputation guide for this status.
              */
             doc_url: string;
             /**
-             * Current reputation of this phone line as assessed by risk-service.
+             * Current reputation of this phone line.
              *
-             * - `HEALTHY` — No elevated risk detected.
-             * - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
-             *   reviewing messaging patterns.
-             * - `CRITICAL` — High risk; further sending may result in line flagging or
-             *   restriction.
+             * - `HEALTHY` — The line is in good standing. Send normally.
+             * - `AT_RISK` — The line's overall engagement is trending down. Slow the line's
+             *   send pace and review your messaging patterns.
+             * - `CRITICAL` — Strong signals that messages from this line aren't landing well.
+             *   Pause outbound on the line until it recovers.
              *
              * Defaults to `HEALTHY` for lines that have not yet been scored.
              */
@@ -120,7 +159,13 @@ export declare namespace PhoneNumberListResponse {
         }
     }
 }
+export interface PhoneNumberUpdateParams {
+    /**
+     * The forwarding number in E.164 format. Set to null or empty string to clear.
+     */
+    forwarding_number: string | null;
+}
 export declare namespace PhoneNumbers {
-    export { type PhoneNumberListResponse as PhoneNumberListResponse };
+    export { type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberListResponse as PhoneNumberListResponse, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, };
 }
 //# sourceMappingURL=phone-numbers.d.mts.map

package/resources/phone-numbers.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"phone-numbers.d.mts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;;;;;;;GAQG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGpE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC3D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;;;;;;;WAUG;QACH,aAAa,EAAE,WAAW,CAAC,YAAY,CAAC;QAExC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;;;;;;;;WAUG;QACH,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC;KACpC;IAED,UAAiB,WAAW,CAAC;QAC3B;;;;;;;;;;WAUG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;eAUG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;QAED;;;;;;;;;;WAUG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;eAUG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;CACpE"}
+{"version":3,"file":"phone-numbers.d.mts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;;;;;GAQG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInE;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC3D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;;;;;;;WAUG;QACH,aAAa,EAAE,WAAW,CAAC,YAAY,CAAC;QAExC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;;;;;;;;WAUG;QACH,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC;QAEnC;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,WAAW,CAAC;QAC3B;;;;;;;;;;WAUG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;eAUG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;QAED;;;;;;;;;;WAUG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;eAUG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/phone-numbers.d.ts

@@ -15,8 +15,42 @@ export declare class PhoneNumbers extends APIResource {
      * Returns all phone numbers assigned to the authenticated partner. Use this
      * endpoint to discover which phone numbers are available for use as the `from`
      * field when creating a chat, listing chats, or sending a voice memo.
+     *
+     * @example
+     * ```ts
+     * const phoneNumbers = await client.phoneNumbers.list();
+     * ```
      */
     list(options?: RequestOptions): APIPromise<PhoneNumberListResponse>;
+    /**
+     * Updates the forwarding number for a phone number. The forwarding number is where
+     * inbound calls will be forwarded to.
+     *
+     * Pass an empty string to clear the forwarding number.
+     *
+     * @example
+     * ```ts
+     * const phoneNumber = await client.phoneNumbers.update(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { forwarding_number: '+12025559999' },
+     * );
+     * ```
+     */
+    update(phoneNumberID: string, body: PhoneNumberUpdateParams, options?: RequestOptions): APIPromise<PhoneNumberUpdateResponse>;
+}
+export interface PhoneNumberUpdateResponse {
+    /**
+     * Unique identifier for the phone number
+     */
+    id: string;
+    /**
+     * The forwarding number after the update. Null when cleared.
+     */
+    forwarding_number: string | null;
+    /**
+     * Phone number in E.164 format
+     */
+    phone_number: string;
 }
 export interface PhoneNumberListResponse {
     /**
@@ -38,8 +72,8 @@ export declare namespace PhoneNumberListResponse {
          * Unlike chat health, line reputation does not include `opted_out` — opt-out
          * applies to individual recipients, not the whole line.
          *
-         * See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
-         * status means and how to react.
+         * See the [Phone Reputation guide](/guides/phone-numbers/phone-reputation) for
+         * what each status means and how to react.
          */
         health_status: PhoneNumber.HealthStatus;
         /**
@@ -54,10 +88,15 @@ export declare namespace PhoneNumberListResponse {
          * Unlike chat health, line reputation does not include `opted_out` — opt-out
          * applies to individual recipients, not the whole line.
          *
-         * See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
-         * status means and how to react.
+         * See the [Phone Reputation guide](/guides/phone-numbers/phone-reputation) for
+         * what each status means and how to react.
          */
         reputation: PhoneNumber.Reputation;
+        /**
+         * The forwarding number associated with this phone number, in E.164 format. Null
+         * when no forwarding number is configured.
+         */
+        forwarding_number?: string | null;
     }
     namespace PhoneNumber {
         /**
@@ -68,22 +107,22 @@ export declare namespace PhoneNumberListResponse {
          * Unlike chat health, line reputation does not include `opted_out` — opt-out
          * applies to individual recipients, not the whole line.
          *
-         * See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
-         * status means and how to react.
+         * See the [Phone Reputation guide](/guides/phone-numbers/phone-reputation) for
+         * what each status means and how to react.
          */
         interface HealthStatus {
             /**
-             * Deep-link to the relevant section of the Phone Health guide for this status.
+             * Deep-link to the relevant section of the Phone Reputation guide for this status.
              */
             doc_url: string;
             /**
-             * Current reputation of this phone line as assessed by risk-service.
+             * Current reputation of this phone line.
              *
-             * - `HEALTHY` — No elevated risk detected.
-             * - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
-             *   reviewing messaging patterns.
-             * - `CRITICAL` — High risk; further sending may result in line flagging or
-             *   restriction.
+             * - `HEALTHY` — The line is in good standing. Send normally.
+             * - `AT_RISK` — The line's overall engagement is trending down. Slow the line's
+             *   send pace and review your messaging patterns.
+             * - `CRITICAL` — Strong signals that messages from this line aren't landing well.
+             *   Pause outbound on the line until it recovers.
              *
              * Defaults to `HEALTHY` for lines that have not yet been scored.
              */
@@ -97,22 +136,22 @@ export declare namespace PhoneNumberListResponse {
          * Unlike chat health, line reputation does not include `opted_out` — opt-out
          * applies to individual recipients, not the whole line.
          *
-         * See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
-         * status means and how to react.
+         * See the [Phone Reputation guide](/guides/phone-numbers/phone-reputation) for
+         * what each status means and how to react.
          */
         interface Reputation {
             /**
-             * Deep-link to the relevant section of the Phone Health guide for this status.
+             * Deep-link to the relevant section of the Phone Reputation guide for this status.
              */
             doc_url: string;
             /**
-             * Current reputation of this phone line as assessed by risk-service.
+             * Current reputation of this phone line.
              *
-             * - `HEALTHY` — No elevated risk detected.
-             * - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
-             *   reviewing messaging patterns.
-             * - `CRITICAL` — High risk; further sending may result in line flagging or
-             *   restriction.
+             * - `HEALTHY` — The line is in good standing. Send normally.
+             * - `AT_RISK` — The line's overall engagement is trending down. Slow the line's
+             *   send pace and review your messaging patterns.
+             * - `CRITICAL` — Strong signals that messages from this line aren't landing well.
+             *   Pause outbound on the line until it recovers.
              *
              * Defaults to `HEALTHY` for lines that have not yet been scored.
              */
@@ -120,7 +159,13 @@ export declare namespace PhoneNumberListResponse {
         }
     }
 }
+export interface PhoneNumberUpdateParams {
+    /**
+     * The forwarding number in E.164 format. Set to null or empty string to clear.
+     */
+    forwarding_number: string | null;
+}
 export declare namespace PhoneNumbers {
-    export { type PhoneNumberListResponse as PhoneNumberListResponse };
+    export { type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberListResponse as PhoneNumberListResponse, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, };
 }
 //# sourceMappingURL=phone-numbers.d.ts.map

package/resources/phone-numbers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;;;;;;;GAQG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGpE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC3D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;;;;;;;WAUG;QACH,aAAa,EAAE,WAAW,CAAC,YAAY,CAAC;QAExC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;;;;;;;;WAUG;QACH,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC;KACpC;IAED,UAAiB,WAAW,CAAC;QAC3B;;;;;;;;;;WAUG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;eAUG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;QAED;;;;;;;;;;WAUG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;eAUG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;CACpE"}
+{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;;;;GAQG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInE;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC3D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;;;;;;;WAUG;QACH,aAAa,EAAE,WAAW,CAAC,YAAY,CAAC;QAExC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;;;;;;;;WAUG;QACH,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC;QAEnC;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,WAAW,CAAC;QAC3B;;;;;;;;;;WAUG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;eAUG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;QAED;;;;;;;;;;WAUG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;;;;;;;;;eAUG;YACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;SAC5C;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/phone-numbers.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PhoneNumbers = void 0;
 const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
 /**
  * Phone Numbers represent the phone numbers assigned to your partner account.
  *
@@ -17,10 +18,32 @@ class PhoneNumbers extends resource_1.APIResource {
      * Returns all phone numbers assigned to the authenticated partner. Use this
      * endpoint to discover which phone numbers are available for use as the `from`
      * field when creating a chat, listing chats, or sending a voice memo.
+     *
+     * @example
+     * ```ts
+     * const phoneNumbers = await client.phoneNumbers.list();
+     * ```
      */
     list(options) {
         return this._client.get('/v3/phone_numbers', options);
     }
+    /**
+     * Updates the forwarding number for a phone number. The forwarding number is where
+     * inbound calls will be forwarded to.
+     *
+     * Pass an empty string to clear the forwarding number.
+     *
+     * @example
+     * ```ts
+     * const phoneNumber = await client.phoneNumbers.update(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { forwarding_number: '+12025559999' },
+     * );
+     * ```
+     */
+    update(phoneNumberID, body, options) {
+        return this._client.put((0, path_1.path) `/v3/phone_numbers/${phoneNumberID}`, { body, ...options });
+    }
 }
 exports.PhoneNumbers = PhoneNumbers;
 //# sourceMappingURL=phone-numbers.js.map

package/resources/phone-numbers.js.map

@@ -1 +1 @@
-{"version":3,"file":"phone-numbers.js","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;;;;;;;GAQG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;OAIG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AATD,oCASC"}
+{"version":3,"file":"phone-numbers.js","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C;;;;;;;;GAQG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AApCD,oCAoCC"}

package/resources/phone-numbers.mjs

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
 /**
  * Phone Numbers represent the phone numbers assigned to your partner account.
  *
@@ -14,9 +15,31 @@ export class PhoneNumbers extends APIResource {
      * Returns all phone numbers assigned to the authenticated partner. Use this
      * endpoint to discover which phone numbers are available for use as the `from`
      * field when creating a chat, listing chats, or sending a voice memo.
+     *
+     * @example
+     * ```ts
+     * const phoneNumbers = await client.phoneNumbers.list();
+     * ```
      */
     list(options) {
         return this._client.get('/v3/phone_numbers', options);
     }
+    /**
+     * Updates the forwarding number for a phone number. The forwarding number is where
+     * inbound calls will be forwarded to.
+     *
+     * Pass an empty string to clear the forwarding number.
+     *
+     * @example
+     * ```ts
+     * const phoneNumber = await client.phoneNumbers.update(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { forwarding_number: '+12025559999' },
+     * );
+     * ```
+     */
+    update(phoneNumberID, body, options) {
+        return this._client.put(path `/v3/phone_numbers/${phoneNumberID}`, { body, ...options });
+    }
 }
 //# sourceMappingURL=phone-numbers.mjs.map

package/resources/phone-numbers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"phone-numbers.mjs","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;;;;;;;GAQG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF"}
+{"version":3,"file":"phone-numbers.mjs","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;GAQG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF"}

package/resources/webhooks.d.mts

@@ -175,7 +175,7 @@ export declare namespace MessageEventV2 {
          */
         type: 'imessage_app';
         /**
-         * The URL delivered to the iMessage app on tap.
+         * The URL the recipient's app opens when the user taps the card.
          */
         url: string;
         /**
@@ -321,7 +321,7 @@ export declare namespace MessagePayload {
          */
         type: 'imessage_app';
         /**
-         * The URL delivered to the iMessage app on tap.
+         * The URL the recipient's app opens when the user taps the card.
          */
         url: string;
         /**
@@ -1777,13 +1777,13 @@ export declare namespace PhoneNumberStatusUpdatedWebhookEvent {
          */
         changed_at: string;
         /**
-         * @deprecated Current reputation of this phone line as assessed by risk-service.
+         * @deprecated Current reputation of this phone line.
          *
-         * - `HEALTHY` — No elevated risk detected.
-         * - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
-         *   reviewing messaging patterns.
-         * - `CRITICAL` — High risk; further sending may result in line flagging or
-         *   restriction.
+         * - `HEALTHY` — The line is in good standing. Send normally.
+         * - `AT_RISK` — The line's overall engagement is trending down. Slow the line's
+         *   send pace and review your messaging patterns.
+         * - `CRITICAL` — Strong signals that messages from this line aren't landing well.
+         *   Pause outbound on the line until it recovers.
          *
          * Defaults to `HEALTHY` for lines that have not yet been scored.
          */
@@ -1801,13 +1801,13 @@ export declare namespace PhoneNumberStatusUpdatedWebhookEvent {
          */
         phone_number: string;
         /**
-         * @deprecated Current reputation of this phone line as assessed by risk-service.
+         * @deprecated Current reputation of this phone line.
          *
-         * - `HEALTHY` — No elevated risk detected.
-         * - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
-         *   reviewing messaging patterns.
-         * - `CRITICAL` — High risk; further sending may result in line flagging or
-         *   restriction.
+         * - `HEALTHY` — The line is in good standing. Send normally.
+         * - `AT_RISK` — The line's overall engagement is trending down. Slow the line's
+         *   send pace and review your messaging patterns.
+         * - `CRITICAL` — Strong signals that messages from this line aren't landing well.
+         *   Pause outbound on the line until it recovers.
          *
          * Defaults to `HEALTHY` for lines that have not yet been scored.
          */