@linqapp/sdk 0.20.0 → 0.22.0

package/src/resources/chats/chats.ts

@@ -296,6 +296,21 @@ export interface Chat {
    */
   handles: Array<Shared.ChatHandle>;
 
+  /**
+   * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+   * and may shift based on engagement and delivery signals on the conversation. Many
+   * `at_risk` or `critical` chats on a single line increase the risk of line
+   * flagging.
+   *
+   * Switch on `status` to gate sends or surface line health in your UI — the enum is
+   * the long-term contract. Each status carries a `doc_url` that deep-links to the
+   * relevant section of the Chat Health guide.
+   *
+   * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+   * means and how to react.
+   */
+  health_status: Chat.HealthStatus;
+
   /**
    * Whether the chat is archived
    */
@@ -311,11 +326,6 @@ export interface Chat {
    */
   updated_at: string;
 
-  /**
-   * **[BETA]** Health assessment for a chat. Higher `score` means a healthier chat.
-   */
-  health_score?: Chat.HealthScore | null;
-
   /**
    * Messaging service type
    */
@@ -324,18 +334,35 @@ export interface Chat {
 
 export namespace Chat {
   /**
-   * **[BETA]** Health assessment for a chat. Higher `score` means a healthier chat.
+   * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+   * and may shift based on engagement and delivery signals on the conversation. Many
+   * `at_risk` or `critical` chats on a single line increase the risk of line
+   * flagging.
+   *
+   * Switch on `status` to gate sends or surface line health in your UI — the enum is
+   * the long-term contract. Each status carries a `doc_url` that deep-links to the
+   * relevant section of the Chat Health guide.
+   *
+   * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+   * means and how to react.
    */
-  export interface HealthScore {
+  export interface HealthStatus {
+    /**
+     * Deep-link to the relevant section of the Chat Health guide for this status.
+     */
+    doc_url: string;
+
     /**
-     * Short summary of what's affecting the score. Empty when the score is 100.
+     * Current health bucket for the chat. See the
+     * [Chat Health guide](/guides/chats/chat-health) for what each value means and how
+     * to react. `doc_url` deep-links to the relevant section.
      */
-    reason: string;
+    status: 'healthy' | 'at_risk' | 'critical' | 'opted_out';
 
     /**
-     * Health score from 0 to 100. Higher is healthier.
+     * When this status last changed.
      */
-    score: number;
+    updated_at: string;
   }
 }
 
@@ -533,6 +560,21 @@ export namespace ChatCreateResponse {
      */
     handles: Array<Shared.ChatHandle>;
 
+    /**
+     * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+     * and may shift based on engagement and delivery signals on the conversation. Many
+     * `at_risk` or `critical` chats on a single line increase the risk of line
+     * flagging.
+     *
+     * Switch on `status` to gate sends or surface line health in your UI — the enum is
+     * the long-term contract. Each status carries a `doc_url` that deep-links to the
+     * relevant section of the Chat Health guide.
+     *
+     * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+     * means and how to react.
+     */
+    health_status: Chat.HealthStatus;
+
     /**
      * Whether this is a group chat
      */
@@ -547,27 +589,39 @@ export namespace ChatCreateResponse {
      * Messaging service type
      */
     service: Shared.ServiceType;
-
-    /**
-     * **[BETA]** Health assessment for a chat. Higher `score` means a healthier chat.
-     */
-    health_score?: Chat.HealthScore | null;
   }
 
   export namespace Chat {
     /**
-     * **[BETA]** Health assessment for a chat. Higher `score` means a healthier chat.
+     * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+     * and may shift based on engagement and delivery signals on the conversation. Many
+     * `at_risk` or `critical` chats on a single line increase the risk of line
+     * flagging.
+     *
+     * Switch on `status` to gate sends or surface line health in your UI — the enum is
+     * the long-term contract. Each status carries a `doc_url` that deep-links to the
+     * relevant section of the Chat Health guide.
+     *
+     * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+     * means and how to react.
      */
-    export interface HealthScore {
+    export interface HealthStatus {
+      /**
+       * Deep-link to the relevant section of the Chat Health guide for this status.
+       */
+      doc_url: string;
+
       /**
-       * Short summary of what's affecting the score. Empty when the score is 100.
+       * Current health bucket for the chat. See the
+       * [Chat Health guide](/guides/chats/chat-health) for what each value means and how
+       * to react. `doc_url` deep-links to the relevant section.
        */
-      reason: string;
+      status: 'healthy' | 'at_risk' | 'critical' | 'opted_out';
 
       /**
-       * Health score from 0 to 100. Higher is healthier.
+       * When this status last changed.
        */
-      score: number;
+      updated_at: string;
     }
   }
 }

package/src/resources/contact-card.ts

@@ -28,11 +28,11 @@ export class ContactCard extends APIResource {
    * @example
    * ```ts
    * const setContactCard = await client.contactCard.create({
-   *   first_name: 'John',
+   *   first_name: 'Acme',
    *   phone_number: '+15551234567',
    *   image_url:
    *     'https://cdn.linqapp.com/contact-card/example.jpg',
-   *   last_name: 'Doe',
+   *   last_name: 'Support',
    * });
    * ```
    */

package/src/resources/webhook-events.ts

@@ -118,8 +118,6 @@ export type WebhookEventType =
   | 'message.delivered'
   | 'message.failed'
   | 'message.edited'
-  | 'message.opt_out'
-  | 'message.opt_in'
   | 'reaction.added'
   | 'reaction.removed'
   | 'participant.added'

package/src/resources/webhooks.ts

@@ -108,6 +108,21 @@ export namespace MessageEventV2 {
      */
     id: string;
 
+    /**
+     * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+     * and may shift based on engagement and delivery signals on the conversation. Many
+     * `at_risk` or `critical` chats on a single line increase the risk of line
+     * flagging.
+     *
+     * Switch on `status` to gate sends or surface line health in your UI — the enum is
+     * the long-term contract. Each status carries a `doc_url` that deep-links to the
+     * relevant section of the Chat Health guide.
+     *
+     * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+     * means and how to react.
+     */
+    health_status: Chat.HealthStatus;
+
     /**
      * Whether this is a group chat
      */
@@ -119,6 +134,40 @@ export namespace MessageEventV2 {
     owner_handle?: Shared.ChatHandle | null;
   }
 
+  export namespace Chat {
+    /**
+     * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+     * and may shift based on engagement and delivery signals on the conversation. Many
+     * `at_risk` or `critical` chats on a single line increase the risk of line
+     * flagging.
+     *
+     * Switch on `status` to gate sends or surface line health in your UI — the enum is
+     * the long-term contract. Each status carries a `doc_url` that deep-links to the
+     * relevant section of the Chat Health guide.
+     *
+     * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+     * means and how to react.
+     */
+    export interface HealthStatus {
+      /**
+       * Deep-link to the relevant section of the Chat Health guide for this status.
+       */
+      doc_url: string;
+
+      /**
+       * Current health bucket for the chat. See the
+       * [Chat Health guide](/guides/chats/chat-health) for what each value means and how
+       * to react. `doc_url` deep-links to the relevant section.
+       */
+      status: 'healthy' | 'at_risk' | 'critical' | 'opted_out';
+
+      /**
+       * When this status last changed.
+       */
+      updated_at: string;
+    }
+  }
+
   /**
    * A rich link preview part
    */
@@ -874,6 +923,21 @@ export namespace MessageEditedWebhookEvent {
        */
       id: string;
 
+      /**
+       * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+       * and may shift based on engagement and delivery signals on the conversation. Many
+       * `at_risk` or `critical` chats on a single line increase the risk of line
+       * flagging.
+       *
+       * Switch on `status` to gate sends or surface line health in your UI — the enum is
+       * the long-term contract. Each status carries a `doc_url` that deep-links to the
+       * relevant section of the Chat Health guide.
+       *
+       * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+       * means and how to react.
+       */
+      health_status: Chat.HealthStatus;
+
       /**
        * Whether this is a group chat
        */
@@ -885,6 +949,40 @@ export namespace MessageEditedWebhookEvent {
       owner_handle: Shared.ChatHandle;
     }
 
+    export namespace Chat {
+      /**
+       * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+       * and may shift based on engagement and delivery signals on the conversation. Many
+       * `at_risk` or `critical` chats on a single line increase the risk of line
+       * flagging.
+       *
+       * Switch on `status` to gate sends or surface line health in your UI — the enum is
+       * the long-term contract. Each status carries a `doc_url` that deep-links to the
+       * relevant section of the Chat Health guide.
+       *
+       * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+       * means and how to react.
+       */
+      export interface HealthStatus {
+        /**
+         * Deep-link to the relevant section of the Chat Health guide for this status.
+         */
+        doc_url: string;
+
+        /**
+         * Current health bucket for the chat. See the
+         * [Chat Health guide](/guides/chats/chat-health) for what each value means and how
+         * to react. `doc_url` deep-links to the relevant section.
+         */
+        status: 'healthy' | 'at_risk' | 'critical' | 'opted_out';
+
+        /**
+         * When this status last changed.
+         */
+        updated_at: string;
+      }
+    }
+
     /**
      * The edited part
      */
@@ -1242,6 +1340,21 @@ export namespace ChatCreatedWebhookEvent {
      */
     handles: Array<Shared.ChatHandle>;
 
+    /**
+     * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+     * and may shift based on engagement and delivery signals on the conversation. Many
+     * `at_risk` or `critical` chats on a single line increase the risk of line
+     * flagging.
+     *
+     * Switch on `status` to gate sends or surface line health in your UI — the enum is
+     * the long-term contract. Each status carries a `doc_url` that deep-links to the
+     * relevant section of the Chat Health guide.
+     *
+     * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+     * means and how to react.
+     */
+    health_status: Data.HealthStatus;
+
     /**
      * Whether this is a group chat
      */
@@ -1257,6 +1370,40 @@ export namespace ChatCreatedWebhookEvent {
      */
     service?: Shared.ServiceType | null;
   }
+
+  export namespace Data {
+    /**
+     * **[BETA]** Current health for a chat. Always present — chats start at `healthy`
+     * and may shift based on engagement and delivery signals on the conversation. Many
+     * `at_risk` or `critical` chats on a single line increase the risk of line
+     * flagging.
+     *
+     * Switch on `status` to gate sends or surface line health in your UI — the enum is
+     * the long-term contract. Each status carries a `doc_url` that deep-links to the
+     * relevant section of the Chat Health guide.
+     *
+     * See the [Chat Health guide](/guides/chats/chat-health) for what each status
+     * means and how to react.
+     */
+    export interface HealthStatus {
+      /**
+       * Deep-link to the relevant section of the Chat Health guide for this status.
+       */
+      doc_url: string;
+
+      /**
+       * Current health bucket for the chat. See the
+       * [Chat Health guide](/guides/chats/chat-health) for what each value means and how
+       * to react. `doc_url` deep-links to the relevant section.
+       */
+      status: 'healthy' | 'at_risk' | 'critical' | 'opted_out';
+
+      /**
+       * When this status last changed.
+       */
+      updated_at: string;
+    }
+  }
 }
 
 /**
@@ -1739,8 +1886,6 @@ export interface PhoneNumberStatusUpdatedWebhookEvent {
     | 'message.delivered'
     | 'message.failed'
     | 'message.edited'
-    | 'message.opt_out'
-    | 'message.opt_in'
     | 'reaction.added'
     | 'reaction.removed'
     | 'participant.added'

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.20.0'; // x-release-please-version
+export const VERSION = '0.22.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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