telnyx 5.170.0 → 5.171.0

data/rbi/telnyx/models/whatsapp_waba_added_webhook_event.rbi

@@ -0,0 +1,324 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class WhatsappWabaAddedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::WhatsappWabaAddedWebhookEvent,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Telnyx::WhatsappWabaAddedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: Telnyx::WhatsappWabaAddedWebhookEvent::Data::OrHash).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::WhatsappWabaAddedWebhookEvent::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns({ data: Telnyx::WhatsappWabaAddedWebhookEvent::Data })
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::WhatsappWabaAddedWebhookEvent::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          returns(
+            Telnyx::WhatsappWabaAddedWebhookEvent::Data::EventType::TaggedSymbol
+          )
+        end
+        attr_accessor :event_type
+
+        sig { returns(Time) }
+        attr_accessor :occurred_at
+
+        sig { returns(Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload) }
+        attr_reader :payload
+
+        sig do
+          params(
+            payload:
+              Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::OrHash
+          ).void
+        end
+        attr_writer :payload
+
+        sig do
+          returns(
+            Telnyx::WhatsappWabaAddedWebhookEvent::Data::RecordType::TaggedSymbol
+          )
+        end
+        attr_accessor :record_type
+
+        sig do
+          params(
+            id: String,
+            event_type:
+              Telnyx::WhatsappWabaAddedWebhookEvent::Data::EventType::OrSymbol,
+            occurred_at: Time,
+            payload:
+              Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::OrHash,
+            record_type:
+              Telnyx::WhatsappWabaAddedWebhookEvent::Data::RecordType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, event_type:, occurred_at:, payload:, record_type:)
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              event_type:
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::EventType::TaggedSymbol,
+              occurred_at: Time,
+              payload: Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload,
+              record_type:
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::RecordType::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::EventType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          WHATSAPP_WABA_ADDED =
+            T.let(
+              :"whatsapp.waba_added",
+              Telnyx::WhatsappWabaAddedWebhookEvent::Data::EventType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::EventType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Signup session ID.
+          sig { returns(String) }
+          attr_accessor :event_id
+
+          sig do
+            returns(
+              Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::RecordType::TaggedSymbol
+            )
+          end
+          attr_accessor :record_type
+
+          # Signup session outcome.
+          sig do
+            returns(
+              Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::Status::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
+          # Meta WhatsApp Business Account identifier.
+          sig { returns(String) }
+          attr_accessor :waba_id
+
+          # Errors recorded during provisioning.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :errors
+
+          sig { params(errors: T::Array[String]).void }
+          attr_writer :errors
+
+          # Phone numbers found on the WABA. Omitted for standard sessions started with a
+          # phone_number_id, and for sessions that fail before Telnyx fetches the numbers.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :phone_numbers
+
+          sig { params(phone_numbers: T::Array[String]).void }
+          attr_writer :phone_numbers
+
+          sig do
+            params(
+              event_id: String,
+              record_type:
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::RecordType::OrSymbol,
+              status:
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::Status::OrSymbol,
+              waba_id: String,
+              errors: T::Array[String],
+              phone_numbers: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Signup session ID.
+            event_id:,
+            record_type:,
+            # Signup session outcome.
+            status:,
+            # Meta WhatsApp Business Account identifier.
+            waba_id:,
+            # Errors recorded during provisioning.
+            errors: nil,
+            # Phone numbers found on the WABA. Omitted for standard sessions started with a
+            # phone_number_id, and for sessions that fail before Telnyx fetches the numbers.
+            phone_numbers: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                event_id: String,
+                record_type:
+                  Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::RecordType::TaggedSymbol,
+                status:
+                  Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::Status::TaggedSymbol,
+                waba_id: String,
+                errors: T::Array[String],
+                phone_numbers: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::RecordType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            WABA_ACCOUNT_ADDED =
+              T.let(
+                :waba_account_added,
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::RecordType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::RecordType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Signup session outcome.
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SUCCESS =
+              T.let(
+                :SUCCESS,
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::Status::TaggedSymbol
+              )
+            FAILURE =
+              T.let(
+                :FAILURE,
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::WhatsappWabaAddedWebhookEvent::Data::Payload::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              Telnyx::WhatsappWabaAddedWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::WhatsappWabaAddedWebhookEvent::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models.rbi

@@ -141,6 +141,8 @@ module Telnyx
   BotSignupResendMagicLinkParams =
     Telnyx::Models::BotSignupResendMagicLinkParams
 
+  BpoAuthorizationInput = Telnyx::Models::BpoAuthorizationInput
+
   BrandedCallingPaginationMeta = Telnyx::Models::BrandedCallingPaginationMeta
 
   BulkMessagingSettingsUpdatePhoneNumbers =
@@ -206,6 +208,9 @@ module Telnyx
 
   CallControlRetrievalTool = Telnyx::Models::CallControlRetrievalTool
 
+  CallConversationCreatedWebhookEvent =
+    Telnyx::Models::CallConversationCreatedWebhookEvent
+
   CallConversationEnded = Telnyx::Models::CallConversationEnded
 
   CallConversationEndedWebhookEvent =
@@ -217,6 +222,9 @@ module Telnyx
   CallConversationInsightsGeneratedWebhookEvent =
     Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent
 
+  CallConversationStartFailedWebhookEvent =
+    Telnyx::Models::CallConversationStartFailedWebhookEvent
+
   CallCostWebhookEvent = Telnyx::Models::CallCostWebhookEvent
 
   CallDeepfakeDetectionErrorWebhookEvent =
@@ -273,12 +281,18 @@ module Telnyx
   CallMachineGreetingEndedWebhookEvent =
     Telnyx::Models::CallMachineGreetingEndedWebhookEvent
 
+  CallMachinePremiumCallScreeningDetectedWebhookEvent =
+    Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent
+
   CallMachinePremiumDetectionEnded =
     Telnyx::Models::CallMachinePremiumDetectionEnded
 
   CallMachinePremiumDetectionEndedWebhookEvent =
     Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent
 
+  CallMachinePremiumDetectionStartedWebhookEvent =
+    Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent
+
   CallMachinePremiumGreetingEnded =
     Telnyx::Models::CallMachinePremiumGreetingEnded
 
@@ -621,6 +635,8 @@ module Telnyx
 
   DirAPI = Telnyx::Models::DirAPI
 
+  DirBpoLoaParams = Telnyx::Models::DirBpoLoaParams
+
   DirDeleteParams = Telnyx::Models::DirDeleteParams
 
   DirList = Telnyx::Models::DirList
@@ -634,6 +650,9 @@ module Telnyx
 
   DirNewLoaParams = Telnyx::Models::DirNewLoaParams
 
+  DirRetrieveBpoAuthorizationsParams =
+    Telnyx::Models::DirRetrieveBpoAuthorizationsParams
+
   DirRetrieveParams = Telnyx::Models::DirRetrieveParams
 
   DirStatus = Telnyx::Models::DirStatus
@@ -812,6 +831,8 @@ module Telnyx
 
   EmailTemplate = Telnyx::Models::EmailTemplate
 
+  EmailTemplateCommon = Telnyx::Models::EmailTemplateCommon
+
   EmailTemplateCreateParams = Telnyx::Models::EmailTemplateCreateParams
 
   EmailTemplateDeleteParams = Telnyx::Models::EmailTemplateDeleteParams
@@ -1132,6 +1153,8 @@ module Telnyx
 
   ListRetrieveByZoneParams = Telnyx::Models::ListRetrieveByZoneParams
 
+  LlmTokenGateway = Telnyx::Models::LlmTokenGateway
+
   MachinePaymentAccountCreditParams =
     Telnyx::Models::MachinePaymentAccountCreditParams
 
@@ -1513,6 +1536,15 @@ module Telnyx
 
   NumberPoolSettings = Telnyx::Models::NumberPoolSettings
 
+  NumberReputationExternalVerificationStatusChangedWebhookEvent =
+    Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent
+
+  NumberReputationNumberFlaggedWebhookEvent =
+    Telnyx::Models::NumberReputationNumberFlaggedWebhookEvent
+
+  NumberReputationNumberRemovedWebhookEvent =
+    Telnyx::Models::NumberReputationNumberRemovedWebhookEvent
+
   NumberReputationPaginationMeta =
     Telnyx::Models::NumberReputationPaginationMeta
 
@@ -1968,6 +2000,8 @@ module Telnyx
 
   ShortCodeUpdateParams = Telnyx::Models::ShortCodeUpdateParams
 
+  SignaturePayload = Telnyx::Models::SignaturePayload
+
   SimCard = Telnyx::Models::SimCard
 
   SimCardActionsSummary = Telnyx::Models::SimCardActionsSummary
@@ -2050,6 +2084,9 @@ module Telnyx
 
   SiprecConnectorUpdateParams = Telnyx::Models::SiprecConnectorUpdateParams
 
+  SipRegistrationStatusListParams =
+    Telnyx::Models::SipRegistrationStatusListParams
+
   SoundModifications = Telnyx::Models::SoundModifications
 
   SpeechToTextListProvidersParams =
@@ -2058,6 +2095,20 @@ module Telnyx
   SpeechToTextRetrieveTranscriptionParams =
     Telnyx::Models::SpeechToTextRetrieveTranscriptionParams
 
+  SpendLimit = Telnyx::Models::SpendLimit
+
+  SpendLimitCreateParams = Telnyx::Models::SpendLimitCreateParams
+
+  SpendLimitDeleteParams = Telnyx::Models::SpendLimitDeleteParams
+
+  SpendLimitListParams = Telnyx::Models::SpendLimitListParams
+
+  SpendLimitPeriod = Telnyx::Models::SpendLimitPeriod
+
+  SpendLimitResponse = Telnyx::Models::SpendLimitResponse
+
+  SpendLimitUpdateParams = Telnyx::Models::SpendLimitUpdateParams
+
   Storage = Telnyx::Models::Storage
 
   StorageListMigrationSourceCoverageParams =
@@ -2447,6 +2498,8 @@ module Telnyx
 
   WhatsappTemplateData = Telnyx::Models::WhatsappTemplateData
 
+  WhatsappWabaAddedWebhookEvent = Telnyx::Models::WhatsappWabaAddedWebhookEvent
+
   WireguardInterface = Telnyx::Models::WireguardInterface
 
   WireguardInterfaceCreateParams =

data/rbi/telnyx/resources/ai/assistants/deleted.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Assistants
+        # Configure AI assistant specifications
+        class Deleted
+          # List the organization's soft-deleted assistants in the Recently Deleted list.
+          #
+          # Each entry includes `deleted_at` and `permanently_deleted_at`, the point after
+          # which the assistant is erased automatically and can no longer be restored.
+          sig do
+            params(
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::Internal::DefaultFlatPagination[
+                Telnyx::AI::Assistants::DeletedAssistant
+              ]
+            )
+          end
+          def list(
+            # Page number to retrieve (1-based).
+            page_number: nil,
+            # Number of items to return per page.
+            page_size: nil,
+            request_options: {}
+          )
+          end
+
+          # Retrieve a soft-deleted assistant from the Recently Deleted list by
+          # `assistant_id`, including its `deleted_at` and `permanently_deleted_at`
+          # timestamps. This is a read-only view; the assistant cannot be modified while it
+          # remains deleted.
+          sig do
+            params(
+              assistant_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::AI::Assistants::DeletedAssistant)
+          end
+          def get(
+            # Unique identifier of the assistant.
+            assistant_id,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/assistants/versions.rbi

@@ -33,7 +33,10 @@ module Telnyx
               version_id: String,
               assistant_id: String,
               a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent::OrHash],
+              avatar_settings:
+                T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash),
               conversation_flow: Telnyx::AI::ConversationFlowReq::OrHash,
+              delegation_settings: Telnyx::AI::DelegationSettings::OrHash,
               description: String,
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_timeout_ms: Integer,
@@ -82,6 +85,7 @@ module Telnyx
               version_name: String,
               voice_settings:
                 Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
+              websocket_settings: Telnyx::AI::WebsocketSettings::OrHash,
               widget_settings: Telnyx::AI::WidgetSettings::OrHash,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(Telnyx::AI::InferenceEmbedding)
@@ -102,12 +106,24 @@ module Telnyx
             # to leave the assistant's agents unchanged; send an empty array to remove them
             # all.
             a2a_agents: nil,
+            # Body param: **Beta:** Configuration for the Telnyx open-source avatar provider.
+            # The launch catalog supports six avatars and office, studio, or reception
+            # backgrounds.
+            avatar_settings: nil,
             # Body param: Conversation flow as supplied by API clients (create / update).
             #
             # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
             # unique node/edge IDs, that `start_node_id` references a real node, and that
             # every edge's endpoints reference real nodes.
             conversation_flow: nil,
+            # Body param: Splits the conversation between a frontend model that talks to the
+            # caller and a backend model that does the work. On the GPT-Live route the
+            # frontend model cannot call tools at all — when it needs something done it raises
+            # a delegation and waits. On the chat completion route the frontend keeps a single
+            # `delegate` tool that returns immediately, so the conversation carries on while
+            # the backend works. Either way the backend's answer is spoken as commentary or
+            # kept as silent context, depending on `speak_results`. Beta feature.
+            delegation_settings: nil,
             # Body param
             description: nil,
             # Body param: Map of dynamic variables and their default values
@@ -217,6 +233,12 @@ module Telnyx
             version_name: nil,
             # Body param
             voice_settings: nil,
+            # Body param: Streams conversation and telephony events to a WebSocket server you
+            # host, and accepts messages injected back into the conversation. Telnyx opens the
+            # connection as a client, once per conversation. Delivery is best effort
+            # throughout: while the connection is down events are dropped rather than queued,
+            # and no socket failure is ever allowed to affect the call. Beta feature.
+            websocket_settings: nil,
             # Body param: Configuration settings for the assistant's web widget.
             widget_settings: nil,
             request_options: {}