telnyx 7.24.0 → 7.25.0

package/src/resources/webhooks.ts

@@ -1645,9 +1645,11 @@ export namespace CallMachinePremiumGreetingEnded {
     from?: string;
 
     /**
-     * Premium Answering Machine Greeting Ended result.
+     * Premium Answering Machine Greeting Ended result. `prompt_ended` is only sent
+     * when `answering_machine_detection` is `premium_ios_call_screening_detection` and
+     * the iOS call-screening prompt ends without a beep.
      */
-    result?: 'beep_detected' | 'no_beep_detected';
+    result?: 'beep_detected' | 'no_beep_detected' | 'prompt_ended';
 
     /**
      * Destination number or SIP URI of the call.
@@ -4848,6 +4850,98 @@ export interface CallBridgedWebhookEvent {
   data?: CallBridged;
 }
 
+export interface CallConversationCreatedWebhookEvent {
+  /**
+   * A conversation has been created for the call. Use the conversation ID to
+   * correlate subsequent conversation events.
+   */
+  data?: CallConversationCreatedWebhookEvent.Data;
+}
+
+export namespace CallConversationCreatedWebhookEvent {
+  /**
+   * A conversation has been created for the call. Use the conversation ID to
+   * correlate subsequent conversation events.
+   */
+  export interface Data {
+    /**
+     * Unique identifier for the event.
+     */
+    id?: string;
+
+    /**
+     * Timestamp when the event was created in the system.
+     */
+    created_at?: string;
+
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'call.conversation.created';
+
+    /**
+     * ISO 8601 datetime of when the event occurred.
+     */
+    occurred_at?: string;
+
+    payload?: Data.Payload;
+
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Call ID used to issue commands via Call Control API.
+       */
+      call_control_id?: string;
+
+      /**
+       * ID that is unique to the call leg.
+       */
+      call_leg_id?: string;
+
+      /**
+       * ID that is unique to the call session (group of related call legs).
+       */
+      call_session_id?: string;
+
+      /**
+       * The type of calling party connection.
+       */
+      calling_party_type?: 'pstn' | 'sip';
+
+      /**
+       * Base64-encoded state received from a command.
+       */
+      client_state?: string;
+
+      /**
+       * Call Control App ID (formerly Telnyx connection ID) used in the call.
+       */
+      connection_id?: string;
+
+      /**
+       * Unique identifier of the conversation created for this call.
+       */
+      conversation_id?: string;
+
+      /**
+       * The caller's number or identifier.
+       */
+      from?: string;
+
+      /**
+       * The callee's number or SIP address.
+       */
+      to?: string;
+    }
+  }
+}
+
 export interface CallConversationEndedWebhookEvent {
   data?: CallConversationEnded;
 }
@@ -5238,10 +5332,159 @@ export interface CallMachineGreetingEndedWebhookEvent {
   data?: CallMachineGreetingEnded;
 }
 
+export interface CallMachinePremiumCallScreeningDetectedWebhookEvent {
+  data?: CallMachinePremiumCallScreeningDetectedWebhookEvent.Data;
+}
+
+export namespace CallMachinePremiumCallScreeningDetectedWebhookEvent {
+  export interface Data {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'call.machine.premium.call_screening.detected';
+
+    /**
+     * ISO 8601 datetime of when the event occurred.
+     */
+    occurred_at?: string;
+
+    payload?: Data.Payload;
+
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Call ID used to issue commands via Call Control API.
+       */
+      call_control_id?: string;
+
+      /**
+       * ID that is unique to the call and can be used to correlate webhook events.
+       */
+      call_leg_id?: string;
+
+      /**
+       * ID that is unique to the call session and can be used to correlate webhook
+       * events. Call session is a group of related call legs that logically belong to
+       * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+       */
+      call_session_id?: string;
+
+      /**
+       * State received from a command.
+       */
+      client_state?: string;
+
+      /**
+       * Call Control App ID (formerly Telnyx connection ID) used in the call.
+       */
+      connection_id?: string;
+
+      /**
+       * Number or SIP URI placing the call.
+       */
+      from?: string;
+
+      /**
+       * Apple Call Screening detection result. Sent when an Apple Call Screening tone is
+       * detected; Premium Answering Machine Detection is restarted on the screened call
+       * afterwards.
+       */
+      result?: 'screening';
+
+      /**
+       * Destination number or SIP URI of the call.
+       */
+      to?: string;
+    }
+  }
+}
+
 export interface CallMachinePremiumDetectionEndedWebhookEvent {
   data?: CallMachinePremiumDetectionEnded;
 }
 
+export interface CallMachinePremiumDetectionStartedWebhookEvent {
+  data?: CallMachinePremiumDetectionStartedWebhookEvent.Data;
+}
+
+export namespace CallMachinePremiumDetectionStartedWebhookEvent {
+  export interface Data {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'call.machine.premium.detection.started';
+
+    /**
+     * ISO 8601 datetime of when the event occurred.
+     */
+    occurred_at?: string;
+
+    payload?: Data.Payload;
+
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Call ID used to issue commands via Call Control API.
+       */
+      call_control_id?: string;
+
+      /**
+       * ID that is unique to the call and can be used to correlate webhook events.
+       */
+      call_leg_id?: string;
+
+      /**
+       * ID that is unique to the call session and can be used to correlate webhook
+       * events. Call session is a group of related call legs that logically belong to
+       * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+       */
+      call_session_id?: string;
+
+      /**
+       * State received from a command.
+       */
+      client_state?: string;
+
+      /**
+       * Call Control App ID (formerly Telnyx connection ID) used in the call.
+       */
+      connection_id?: string;
+
+      /**
+       * Number or SIP URI placing the call.
+       */
+      from?: string;
+
+      /**
+       * Destination number or SIP URI of the call.
+       */
+      to?: string;
+    }
+  }
+}
+
 export interface CallMachinePremiumGreetingEndedWebhookEvent {
   data?: CallMachinePremiumGreetingEnded;
 }
@@ -6417,6 +6660,98 @@ export interface CallBridgedWebhookEvent {
   data?: CallBridged;
 }
 
+export interface CallConversationCreatedWebhookEvent {
+  /**
+   * A conversation has been created for the call. Use the conversation ID to
+   * correlate subsequent conversation events.
+   */
+  data?: CallConversationCreatedWebhookEvent.Data;
+}
+
+export namespace CallConversationCreatedWebhookEvent {
+  /**
+   * A conversation has been created for the call. Use the conversation ID to
+   * correlate subsequent conversation events.
+   */
+  export interface Data {
+    /**
+     * Unique identifier for the event.
+     */
+    id?: string;
+
+    /**
+     * Timestamp when the event was created in the system.
+     */
+    created_at?: string;
+
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'call.conversation.created';
+
+    /**
+     * ISO 8601 datetime of when the event occurred.
+     */
+    occurred_at?: string;
+
+    payload?: Data.Payload;
+
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Call ID used to issue commands via Call Control API.
+       */
+      call_control_id?: string;
+
+      /**
+       * ID that is unique to the call leg.
+       */
+      call_leg_id?: string;
+
+      /**
+       * ID that is unique to the call session (group of related call legs).
+       */
+      call_session_id?: string;
+
+      /**
+       * The type of calling party connection.
+       */
+      calling_party_type?: 'pstn' | 'sip';
+
+      /**
+       * Base64-encoded state received from a command.
+       */
+      client_state?: string;
+
+      /**
+       * Call Control App ID (formerly Telnyx connection ID) used in the call.
+       */
+      connection_id?: string;
+
+      /**
+       * Unique identifier of the conversation created for this call.
+       */
+      conversation_id?: string;
+
+      /**
+       * The caller's number or identifier.
+       */
+      from?: string;
+
+      /**
+       * The callee's number or SIP address.
+       */
+      to?: string;
+    }
+  }
+}
+
 export interface CallConversationEndedWebhookEvent {
   data?: CallConversationEnded;
 }
@@ -6807,10 +7142,159 @@ export interface CallMachineGreetingEndedWebhookEvent {
   data?: CallMachineGreetingEnded;
 }
 
+export interface CallMachinePremiumCallScreeningDetectedWebhookEvent {
+  data?: CallMachinePremiumCallScreeningDetectedWebhookEvent.Data;
+}
+
+export namespace CallMachinePremiumCallScreeningDetectedWebhookEvent {
+  export interface Data {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'call.machine.premium.call_screening.detected';
+
+    /**
+     * ISO 8601 datetime of when the event occurred.
+     */
+    occurred_at?: string;
+
+    payload?: Data.Payload;
+
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Call ID used to issue commands via Call Control API.
+       */
+      call_control_id?: string;
+
+      /**
+       * ID that is unique to the call and can be used to correlate webhook events.
+       */
+      call_leg_id?: string;
+
+      /**
+       * ID that is unique to the call session and can be used to correlate webhook
+       * events. Call session is a group of related call legs that logically belong to
+       * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+       */
+      call_session_id?: string;
+
+      /**
+       * State received from a command.
+       */
+      client_state?: string;
+
+      /**
+       * Call Control App ID (formerly Telnyx connection ID) used in the call.
+       */
+      connection_id?: string;
+
+      /**
+       * Number or SIP URI placing the call.
+       */
+      from?: string;
+
+      /**
+       * Apple Call Screening detection result. Sent when an Apple Call Screening tone is
+       * detected; Premium Answering Machine Detection is restarted on the screened call
+       * afterwards.
+       */
+      result?: 'screening';
+
+      /**
+       * Destination number or SIP URI of the call.
+       */
+      to?: string;
+    }
+  }
+}
+
 export interface CallMachinePremiumDetectionEndedWebhookEvent {
   data?: CallMachinePremiumDetectionEnded;
 }
 
+export interface CallMachinePremiumDetectionStartedWebhookEvent {
+  data?: CallMachinePremiumDetectionStartedWebhookEvent.Data;
+}
+
+export namespace CallMachinePremiumDetectionStartedWebhookEvent {
+  export interface Data {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'call.machine.premium.detection.started';
+
+    /**
+     * ISO 8601 datetime of when the event occurred.
+     */
+    occurred_at?: string;
+
+    payload?: Data.Payload;
+
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+  }
+
+  export namespace Data {
+    export interface Payload {
+      /**
+       * Call ID used to issue commands via Call Control API.
+       */
+      call_control_id?: string;
+
+      /**
+       * ID that is unique to the call and can be used to correlate webhook events.
+       */
+      call_leg_id?: string;
+
+      /**
+       * ID that is unique to the call session and can be used to correlate webhook
+       * events. Call session is a group of related call legs that logically belong to
+       * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+       */
+      call_session_id?: string;
+
+      /**
+       * State received from a command.
+       */
+      client_state?: string;
+
+      /**
+       * Call Control App ID (formerly Telnyx connection ID) used in the call.
+       */
+      connection_id?: string;
+
+      /**
+       * Number or SIP URI placing the call.
+       */
+      from?: string;
+
+      /**
+       * Destination number or SIP URI of the call.
+       */
+      to?: string;
+    }
+  }
+}
+
 export interface CallMachinePremiumGreetingEndedWebhookEvent {
   data?: CallMachinePremiumGreetingEnded;
 }
@@ -7839,6 +8323,7 @@ export type UnsafeUnwrapWebhookEvent =
   | ArtifactFailedWebhookEvent
   | CallAnsweredWebhookEvent
   | CallBridgedWebhookEvent
+  | CallConversationCreatedWebhookEvent
   | CallConversationEndedWebhookEvent
   | CallConversationInsightsGeneratedWebhookEvent
   | CallCostWebhookEvent
@@ -7855,7 +8340,9 @@ export type UnsafeUnwrapWebhookEvent =
   | CallLeftQueueWebhookEvent
   | CallMachineDetectionEndedWebhookEvent
   | CallMachineGreetingEndedWebhookEvent
+  | CallMachinePremiumCallScreeningDetectedWebhookEvent
   | CallMachinePremiumDetectionEndedWebhookEvent
+  | CallMachinePremiumDetectionStartedWebhookEvent
   | CallMachinePremiumGreetingEndedWebhookEvent
   | CallPaymentCompletedWebhookEvent
   | CallPaymentProgressWebhookEvent
@@ -7916,6 +8403,7 @@ export type UnwrapWebhookEvent =
   | ArtifactFailedWebhookEvent
   | CallAnsweredWebhookEvent
   | CallBridgedWebhookEvent
+  | CallConversationCreatedWebhookEvent
   | CallConversationEndedWebhookEvent
   | CallConversationInsightsGeneratedWebhookEvent
   | CallCostWebhookEvent
@@ -7932,7 +8420,9 @@ export type UnwrapWebhookEvent =
   | CallLeftQueueWebhookEvent
   | CallMachineDetectionEndedWebhookEvent
   | CallMachineGreetingEndedWebhookEvent
+  | CallMachinePremiumCallScreeningDetectedWebhookEvent
   | CallMachinePremiumDetectionEndedWebhookEvent
+  | CallMachinePremiumDetectionStartedWebhookEvent
   | CallMachinePremiumGreetingEndedWebhookEvent
   | CallPaymentCompletedWebhookEvent
   | CallPaymentProgressWebhookEvent
@@ -8058,6 +8548,7 @@ export declare namespace Webhooks {
     type ArtifactFailedWebhookEvent as ArtifactFailedWebhookEvent,
     type CallAnsweredWebhookEvent as CallAnsweredWebhookEvent,
     type CallBridgedWebhookEvent as CallBridgedWebhookEvent,
+    type CallConversationCreatedWebhookEvent as CallConversationCreatedWebhookEvent,
     type CallConversationEndedWebhookEvent as CallConversationEndedWebhookEvent,
     type CallConversationInsightsGeneratedWebhookEvent as CallConversationInsightsGeneratedWebhookEvent,
     type CallCostWebhookEvent as CallCostWebhookEvent,
@@ -8074,7 +8565,9 @@ export declare namespace Webhooks {
     type CallLeftQueueWebhookEvent as CallLeftQueueWebhookEvent,
     type CallMachineDetectionEndedWebhookEvent as CallMachineDetectionEndedWebhookEvent,
     type CallMachineGreetingEndedWebhookEvent as CallMachineGreetingEndedWebhookEvent,
+    type CallMachinePremiumCallScreeningDetectedWebhookEvent as CallMachinePremiumCallScreeningDetectedWebhookEvent,
     type CallMachinePremiumDetectionEndedWebhookEvent as CallMachinePremiumDetectionEndedWebhookEvent,
+    type CallMachinePremiumDetectionStartedWebhookEvent as CallMachinePremiumDetectionStartedWebhookEvent,
     type CallMachinePremiumGreetingEndedWebhookEvent as CallMachinePremiumGreetingEndedWebhookEvent,
     type CallPaymentCompletedWebhookEvent as CallPaymentCompletedWebhookEvent,
     type CallPaymentProgressWebhookEvent as CallPaymentProgressWebhookEvent,

package/src/resources/whatsapp/phone-numbers/calling-routing.ts

@@ -0,0 +1,113 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Manage Whatsapp phone numbers
+ */
+export class CallingRouting extends APIResource {
+  /**
+   * Retrieve the routing connection currently stored for a BYON (Bring Your Own
+   * Number) phone number: the connection that inbound WhatsApp calls to the number
+   * are delivered to.
+   *
+   * Use it to check the result of
+   * `PATCH /whatsapp/phone_numbers/{id}/calling_routing`. A read made immediately
+   * after an update can still return the previous value.
+   *
+   * Sub-users need read permission on connections.
+   *
+   * @example
+   * ```ts
+   * const callingRoutings =
+   *   await client.whatsapp.phoneNumbers.callingRouting.list(
+   *     '+13125550100',
+   *   );
+   * ```
+   */
+  list(id: string, options?: RequestOptions): APIPromise<CallingRoutingListResponse> {
+    return this._client.get(path`/whatsapp/phone_numbers/${id}/calling_routing`, options);
+  }
+
+  /**
+   * Set or clear the connection that inbound WhatsApp calls to a BYON (Bring Your
+   * Own Number) phone number are delivered to.
+   *
+   * The update is processed asynchronously. A `202` response means the request was
+   * accepted, not that the routing changed. Check the result with
+   * `GET /whatsapp/phone_numbers/{id}/calling_routing`, which can return the
+   * previous value immediately after an update. An update for a number that is not a
+   * WhatsApp Calling number in the account returns 404.
+   *
+   * The connection must belong to the same account and must not be a WhatsApp
+   * connection. Send `connection_id: null` to clear the routing; omitting
+   * `connection_id` is rejected. Numbers active on Telnyx are rejected, because they
+   * route through their own connection assignment.
+   *
+   * Sub-users need update permission on connections, and read permission to check
+   * the result with `GET`.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.whatsapp.phoneNumbers.callingRouting.patchAll(
+   *     '+13125550100',
+   *     { connection_id: '1234567890' },
+   *   );
+   * ```
+   */
+  patchAll(
+    id: string,
+    body: CallingRoutingPatchAllParams,
+    options?: RequestOptions,
+  ): APIPromise<CallingRoutingPatchAllResponse> {
+    return this._client.patch(path`/whatsapp/phone_numbers/${id}/calling_routing`, { body, ...options });
+  }
+}
+
+export interface WhatsappCallingRoutingData {
+  /**
+   * ID of the routing connection, or `null` when none is set.
+   */
+  connection_id: string | null;
+
+  /**
+   * Phone number in E.164 format, with a leading `+`.
+   */
+  phone_number: string;
+
+  /**
+   * Identifies the type of the resource.
+   */
+  record_type: 'whatsapp_calling_routing';
+}
+
+export interface CallingRoutingListResponse {
+  data: WhatsappCallingRoutingData;
+}
+
+export interface CallingRoutingPatchAllResponse {
+  data: WhatsappCallingRoutingData;
+}
+
+export interface CallingRoutingPatchAllParams {
+  /**
+   * ID of the connection to deliver inbound WhatsApp calls to: a positive integer up
+   * to 9223372036854775807, sent as a decimal string or an integer. Send a string to
+   * keep large IDs exact. Non-null values are returned as strings. `null` clears the
+   * routing.
+   */
+  connection_id: string | number | null;
+}
+
+export declare namespace CallingRouting {
+  export {
+    type WhatsappCallingRoutingData as WhatsappCallingRoutingData,
+    type CallingRoutingListResponse as CallingRoutingListResponse,
+    type CallingRoutingPatchAllResponse as CallingRoutingPatchAllResponse,
+    type CallingRoutingPatchAllParams as CallingRoutingPatchAllParams,
+  };
+}

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

@@ -1,5 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  CallingRouting,
+  type WhatsappCallingRoutingData,
+  type CallingRoutingListResponse,
+  type CallingRoutingPatchAllResponse,
+  type CallingRoutingPatchAllParams,
+} from './calling-routing';
 export {
   CallingSettings,
   type WhatsappCallingSettingsData,