telnyx 7.21.0 → 7.23.0

package/src/resources/webhooks.ts

@@ -4320,6 +4320,30 @@ export interface InboundSipHeader {
   value: string;
 }
 
+export interface MessagingInboundMessage {
+  /**
+   * Identifies the type of resource.
+   */
+  id?: string;
+
+  /**
+   * The type of event being delivered.
+   */
+  event_type?: 'message.received';
+
+  /**
+   * ISO 8601 formatted date indicating when the resource was created.
+   */
+  occurred_at?: string;
+
+  payload?: MessagesAPI.MessagingInboundMessagePayload;
+
+  /**
+   * Identifies the type of the resource.
+   */
+  record_type?: 'event';
+}
+
 export interface NumberOrderStatusUpdate {
   data: NumberOrderStatusUpdate.Data;
 
@@ -4336,7 +4360,7 @@ export namespace NumberOrderStatusUpdate {
     /**
      * The type of event being sent
      */
-    event_type: string;
+    event_type: 'number_order.complete';
 
     /**
      * ISO 8601 timestamp of when the event occurred
@@ -4373,7 +4397,7 @@ export interface OutboundMessage {
   /**
    * The type of event being delivered.
    */
-  event_type?: 'message.sent' | 'message.finalized';
+  event_type?: 'message.sent' | 'message.finalized' | 'message.read';
 
   /**
    * ISO 8601 formatted date indicating when the resource was created.
@@ -4500,6 +4524,175 @@ export namespace Transcription {
   }
 }
 
+export interface WhatsappAccountUpdate {
+  data: WhatsappAccountUpdate.Data;
+}
+
+export namespace WhatsappAccountUpdate {
+  export interface Data {
+    id: string;
+
+    event_type: 'whatsapp.account.update';
+
+    occurred_at: string;
+
+    payload: Data.Payload;
+
+    record_type: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Account event reported by Meta. Coexistence lifecycle values include
+       * `ACCOUNT_OFFBOARDED`, `ACCOUNT_RECONNECTED`, and `PARTNER_REMOVED`. Preserve
+       * unknown values for forward compatibility.
+       */
+      event: string;
+
+      record_type: 'whatsapp_account';
+
+      /**
+       * Meta WhatsApp Business Account identifier.
+       */
+      waba_id: string;
+    }
+  }
+}
+
+export interface WhatsappMessageEcho {
+  data: WhatsappMessageEcho.Data;
+}
+
+export namespace WhatsappMessageEcho {
+  export interface Data {
+    id: string;
+
+    event_type: 'message.echo';
+
+    occurred_at: string;
+
+    payload: Data.Payload;
+
+    record_type: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Telnyx identifier for the mirrored message.
+       */
+      id: string;
+
+      /**
+       * Mirrored WhatsApp message content. The content property matches the value of
+       * `type`.
+       */
+      body: Payload.Body;
+
+      /**
+       * No charge is created for a Business app message echo.
+       */
+      cost: Payload.Cost;
+
+      /**
+       * Indicates that the business sent the message to the WhatsApp user.
+       */
+      direction: 'outbound';
+
+      errors: Array<MessagesAPI.MessagingError0b38e7044b>;
+
+      from: Payload.From;
+
+      messaging_profile_id: string;
+
+      organization_id: string;
+
+      /**
+       * Identifies the WhatsApp Business app as the source of the message.
+       */
+      origin: 'whatsapp_business_app';
+
+      record_type: 'message';
+
+      /**
+       * WhatsApp user who received the Business app message.
+       */
+      to: string;
+
+      type: 'WHATSAPP';
+
+      received_at?: string;
+
+      tags?: Array<string>;
+
+      webhook_failover_url?: string | null;
+
+      webhook_url?: string | null;
+    }
+
+    export namespace Payload {
+      /**
+       * Mirrored WhatsApp message content. The content property matches the value of
+       * `type`.
+       */
+      export interface Body {
+        /**
+         * Telnyx identifier for the mirrored message.
+         */
+        id: string;
+
+        /**
+         * Meta WhatsApp message identifier, also known as a wamid.
+         */
+        foreign_id: string;
+
+        /**
+         * Unix timestamp supplied by Meta.
+         */
+        timestamp: string;
+
+        /**
+         * WhatsApp message content type.
+         */
+        type: string;
+
+        /**
+         * WhatsApp user who received the message.
+         */
+        from?: string;
+
+        /**
+         * Opaque recipient identifier when Meta does not supply a phone number.
+         */
+        from_user_id?: string;
+
+        [k: string]: unknown;
+      }
+
+      /**
+       * No charge is created for a Business app message echo.
+       */
+      export interface Cost {
+        amount?: string | null;
+
+        currency?: string | null;
+      }
+
+      export interface From {
+        /**
+         * Coexistence-enabled business phone number in E.164 format.
+         */
+        phone_number: string;
+
+        carrier?: string;
+
+        line_type?: string;
+      }
+    }
+  }
+}
+
 export interface CallAIGatherEndedWebhookEvent {
   data?: CallAIGatherEnded;
 }
@@ -5714,33 +5907,7 @@ export namespace HostedNumberOrderEventWebhookEvent {
 }
 
 export interface InboundMessageWebhookEvent {
-  data?: InboundMessageWebhookEvent.Data;
-}
-
-export namespace InboundMessageWebhookEvent {
-  export interface Data {
-    /**
-     * Identifies the type of resource.
-     */
-    id?: string;
-
-    /**
-     * The type of event being delivered.
-     */
-    event_type?: 'message.received';
-
-    /**
-     * ISO 8601 formatted date indicating when the resource was created.
-     */
-    occurred_at?: string;
-
-    payload?: MessagesAPI.MessagingInboundMessagePayload;
-
-    /**
-     * Identifies the type of the resource.
-     */
-    record_type?: 'event';
-  }
+  data?: MessagingInboundMessage;
 }
 
 export interface NumberOrderStatusUpdateWebhookEvent {
@@ -5759,7 +5926,7 @@ export namespace NumberOrderStatusUpdateWebhookEvent {
     /**
      * The type of event being sent
      */
-    event_type: string;
+    event_type: 'number_order.complete';
 
     /**
      * ISO 8601 timestamp of when the event occurred
@@ -7303,33 +7470,7 @@ export namespace HostedNumberOrderEventWebhookEvent {
 }
 
 export interface InboundMessageWebhookEvent {
-  data?: InboundMessageWebhookEvent.Data;
-}
-
-export namespace InboundMessageWebhookEvent {
-  export interface Data {
-    /**
-     * Identifies the type of resource.
-     */
-    id?: string;
-
-    /**
-     * The type of event being delivered.
-     */
-    event_type?: 'message.received';
-
-    /**
-     * ISO 8601 formatted date indicating when the resource was created.
-     */
-    occurred_at?: string;
-
-    payload?: MessagesAPI.MessagingInboundMessagePayload;
-
-    /**
-     * Identifies the type of the resource.
-     */
-    record_type?: 'event';
-  }
+  data?: MessagingInboundMessage;
 }
 
 export interface NumberOrderStatusUpdateWebhookEvent {
@@ -7348,7 +7489,7 @@ export namespace NumberOrderStatusUpdateWebhookEvent {
     /**
      * The type of event being sent
      */
-    event_type: string;
+    event_type: 'number_order.complete';
 
     /**
      * ISO 8601 timestamp of when the event occurred
@@ -7751,7 +7892,9 @@ export type UnsafeUnwrapWebhookEvent =
   | ReplacedLinkClickWebhookEvent
   | SessionStatusChangedWebhookEvent
   | TranscriptCompletedWebhookEvent
-  | TranscriptionWebhookEvent;
+  | TranscriptionWebhookEvent
+  | WhatsappAccountUpdate
+  | WhatsappMessageEcho;
 
 export type UnwrapWebhookEvent =
   | CallAIGatherEndedWebhookEvent
@@ -7826,7 +7969,9 @@ export type UnwrapWebhookEvent =
   | ReplacedLinkClickWebhookEvent
   | SessionStatusChangedWebhookEvent
   | TranscriptCompletedWebhookEvent
-  | TranscriptionWebhookEvent;
+  | TranscriptionWebhookEvent
+  | WhatsappAccountUpdate
+  | WhatsappMessageEcho;
 
 export declare namespace Webhooks {
   export {
@@ -7887,10 +8032,13 @@ export declare namespace Webhooks {
     type FaxSendingStarted as FaxSendingStarted,
     type InboundMessage as InboundMessage,
     type InboundSipHeader as InboundSipHeader,
+    type MessagingInboundMessage as MessagingInboundMessage,
     type NumberOrderStatusUpdate as NumberOrderStatusUpdate,
     type OutboundMessage as OutboundMessage,
     type ReplacedLinkClick as ReplacedLinkClick,
     type Transcription as Transcription,
+    type WhatsappAccountUpdate as WhatsappAccountUpdate,
+    type WhatsappMessageEcho as WhatsappMessageEcho,
     type CallAIGatherEndedWebhookEvent as CallAIGatherEndedWebhookEvent,
     type CallAIGatherMessageHistoryUpdatedWebhookEvent as CallAIGatherMessageHistoryUpdatedWebhookEvent,
     type CallAIGatherPartialResultsWebhookEvent as CallAIGatherPartialResultsWebhookEvent,

package/src/resources/whatsapp/business-accounts/phone-numbers.ts

@@ -72,12 +72,34 @@ export type PhoneNumberListResponsesDefaultFlatPagination = DefaultFlatPaginatio
 export interface PhoneNumberListResponse {
   calling_enabled?: boolean;
 
+  /**
+   * Current lifecycle state for a coexistence number. This is null for a standard
+   * Cloud API number.
+   */
+  coexistence_state?:
+    | 'pending_onboarding'
+    | 'sync_pending'
+    | 'syncing'
+    | 'sync_complete'
+    | 'active'
+    | 'history_declined'
+    | 'sync_deadline_expired'
+    | 'offboarded'
+    | 'disconnected'
+    | null;
+
   created_at?: string;
 
   display_name?: string;
 
   enabled?: boolean;
 
+  /**
+   * Indicates whether the number is connected to both the WhatsApp Business app and
+   * Cloud API through WhatsApp Coexistence.
+   */
+  is_on_biz_app?: boolean;
+
   /**
    * Phone number in E164 format
    */
@@ -97,6 +119,18 @@ export interface PhoneNumberListResponse {
 
   status?: string;
 
+  /**
+   * Deadline for initiating the current coexistence synchronization cycle. This is
+   * null when no deadline applies.
+   */
+  sync_deadline?: string | null;
+
+  /**
+   * Synchronization progress. This object is returned only while a coexistence
+   * number is synchronizing.
+   */
+  sync_progress?: PhoneNumberListResponse.SyncProgress | null;
+
   /**
    * User ID
    */
@@ -108,6 +142,24 @@ export interface PhoneNumberListResponse {
   waba_id?: string;
 }
 
+export namespace PhoneNumberListResponse {
+  /**
+   * Synchronization progress. This object is returned only while a coexistence
+   * number is synchronizing.
+   */
+  export interface SyncProgress {
+    contacts_status?: string;
+
+    history_chunk_order?: number | null;
+
+    history_phase?: number | null;
+
+    history_progress?: number | null;
+
+    history_status?: string;
+  }
+}
+
 export interface PhoneNumberListParams extends DefaultFlatPaginationParams {}
 
 export interface PhoneNumberInitializeVerificationParams {

package/src/resources/whatsapp/index.ts

@@ -12,6 +12,7 @@ export {
   type PhoneNumberListResponse,
   type PhoneNumberGetResponse,
   type PhoneNumberRetrieveConversationWindowResponse,
+  type PhoneNumberRetrievePhoneNumberResponse,
   type PhoneNumberListParams,
   type PhoneNumberResendVerificationParams,
   type PhoneNumberVerifyParams,

package/src/resources/whatsapp/phone-numbers/index.ts

@@ -19,6 +19,7 @@ export {
   type PhoneNumberListResponse,
   type PhoneNumberGetResponse,
   type PhoneNumberRetrieveConversationWindowResponse,
+  type PhoneNumberRetrievePhoneNumberResponse,
   type PhoneNumberListParams,
   type PhoneNumberResendVerificationParams,
   type PhoneNumberVerifyParams,