@linqapp/sdk 0.28.0 → 0.28.2

package/src/resources/phone-numbers.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 /**
  * Phone Numbers represent the phone numbers assigned to your partner account.
@@ -18,10 +19,54 @@ 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?: RequestOptions): APIPromise<PhoneNumberListResponse> {
     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: string,
+    body: PhoneNumberUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberUpdateResponse> {
+    return this._client.put(path`/v3/phone_numbers/${phoneNumberID}`, { body, ...options });
+  }
+}
+
+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 {
@@ -46,8 +91,8 @@ export 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;
 
@@ -64,10 +109,16 @@ export 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;
   }
 
   export namespace PhoneNumber {
@@ -79,23 +130,23 @@ export 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.
      */
     export 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.
        */
@@ -110,23 +161,23 @@ export 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.
      */
     export 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.
        */
@@ -135,6 +186,17 @@ export 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,
+  };
 }

package/src/resources/webhooks.ts

@@ -218,7 +218,7 @@ export 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;
 
@@ -397,7 +397,7 @@ export 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;
 
@@ -2121,13 +2121,13 @@ export 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.
      */
@@ -2149,13 +2149,13 @@ export 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.
      */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.28.0'; // x-release-please-version
+export const VERSION = '0.28.2'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.28.0";
+export declare const VERSION = "0.28.2";
 //# 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.28.0'; // x-release-please-version
+exports.VERSION = '0.28.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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