telnyx 5.158.0 → 5.160.0

data/lib/telnyx/models/call_payment_progress_webhook_event.rb

@@ -0,0 +1,338 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class CallPaymentProgressWebhookEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::CallPaymentProgressWebhookEvent::Data, nil]
+      optional :data, -> { Telnyx::CallPaymentProgressWebhookEvent::Data }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::CallPaymentProgressWebhookEvent::Data]
+
+      # @see Telnyx::Models::CallPaymentProgressWebhookEvent#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the event.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute event_type
+        #   The type of event being delivered.
+        #
+        #   @return [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::EventType, nil]
+        optional :event_type, enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::EventType }
+
+        # @!attribute occurred_at
+        #   ISO 8601 datetime when the event occurred.
+        #
+        #   @return [Time, nil]
+        optional :occurred_at, Time
+
+        # @!attribute payload
+        #
+        #   @return [Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload, nil]
+        optional :payload, -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload }
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::RecordType, nil]
+        optional :record_type, enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::RecordType }
+
+        # @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
+        #   @param id [String] Unique identifier for the event.
+        #
+        #   @param event_type [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::EventType] The type of event being delivered.
+        #
+        #   @param occurred_at [Time] ISO 8601 datetime when the event occurred.
+        #
+        #   @param payload [Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload]
+        #
+        #   @param record_type [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::RecordType] Identifies the type of the resource.
+
+        # The type of event being delivered.
+        #
+        # @see Telnyx::Models::CallPaymentProgressWebhookEvent::Data#event_type
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          CALL_PAYMENT_PROGRESS = :"call.payment.progress"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::CallPaymentProgressWebhookEvent::Data#payload
+        class Payload < Telnyx::Internal::Type::BaseModel
+          # @!attribute attempt
+          #   Current 1-based attempt number for the step.
+          #
+          #   @return [Integer, nil]
+          optional :attempt, Integer
+
+          # @!attribute bank_account_number
+          #   Masked bank account number with only the last two digits visible.
+          #
+          #   @return [String, nil]
+          optional :bank_account_number, String
+
+          # @!attribute bank_account_type
+          #   Bank account type, when available.
+          #
+          #   @return [String, nil]
+          optional :bank_account_type, String
+
+          # @!attribute bank_routing_number
+          #   Bank routing number collected from the caller.
+          #
+          #   @return [String, nil]
+          optional :bank_routing_number, String
+
+          # @!attribute call_control_id
+          #   Call ID used to issue commands via Call Control API.
+          #
+          #   @return [String, nil]
+          optional :call_control_id, String
+
+          # @!attribute call_leg_id
+          #   ID unique to the call leg.
+          #
+          #   @return [String, nil]
+          optional :call_leg_id, String
+
+          # @!attribute call_session_id
+          #   ID shared by related call legs in the same call session.
+          #
+          #   @return [String, nil]
+          optional :call_session_id, String
+
+          # @!attribute client_state
+          #   Base64-encoded state received from the command.
+          #
+          #   @return [String, nil]
+          optional :client_state, String
+
+          # @!attribute connection_id
+          #   Call Control App ID used in the call.
+          #
+          #   @return [String, nil]
+          optional :connection_id, String
+
+          # @!attribute error_type
+          #   Step-level error when payment collection fails.
+          #
+          #   @return [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::ErrorType, nil]
+          optional :error_type, enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::ErrorType }
+
+          # @!attribute expiration_date
+          #   Card expiration date in MMYY format.
+          #
+          #   @return [String, nil]
+          optional :expiration_date, String
+
+          # @!attribute from
+          #   Number or SIP URI placing the call.
+          #
+          #   @return [String, nil]
+          optional :from, String
+
+          # @!attribute payment_card_number
+          #   Masked card number with only the last four digits visible.
+          #
+          #   @return [String, nil]
+          optional :payment_card_number, String
+
+          # @!attribute payment_card_postal_code
+          #   Billing postal code collected from the caller.
+          #
+          #   @return [String, nil]
+          optional :payment_card_postal_code, String
+
+          # @!attribute payment_card_type
+          #   Detected card type. Present only for the recognized card brands listed below.
+          #
+          #   @return [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentCardType, nil]
+          optional :payment_card_type,
+                   enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::PaymentCardType }
+
+          # @!attribute payment_connector
+          #   Name of the Pay connector used.
+          #
+          #   @return [String, nil]
+          optional :payment_connector, String
+
+          # @!attribute payment_method
+          #   Payment method being collected.
+          #
+          #   @return [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentMethod, nil]
+          optional :payment_method,
+                   enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::PaymentMethod }
+
+          # @!attribute payment_status
+          #   Status of the current payment step.
+          #
+          #   @return [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStatus, nil]
+          optional :payment_status,
+                   enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStatus }
+
+          # @!attribute payment_step
+          #   Current payment collection or processing step.
+          #
+          #   @return [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStep, nil]
+          optional :payment_step, enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStep }
+
+          # @!attribute security_code
+          #   Fully masked card security code.
+          #
+          #   @return [String, nil]
+          optional :security_code, String
+
+          # @!attribute to
+          #   Destination number or SIP URI of the call.
+          #
+          #   @return [String, nil]
+          optional :to, String
+
+          # @!method initialize(attempt: nil, bank_account_number: nil, bank_account_type: nil, bank_routing_number: nil, call_control_id: nil, call_leg_id: nil, call_session_id: nil, client_state: nil, connection_id: nil, error_type: nil, expiration_date: nil, from: nil, payment_card_number: nil, payment_card_postal_code: nil, payment_card_type: nil, payment_connector: nil, payment_method: nil, payment_status: nil, payment_step: nil, security_code: nil, to: nil)
+          #   @param attempt [Integer] Current 1-based attempt number for the step.
+          #
+          #   @param bank_account_number [String] Masked bank account number with only the last two digits visible.
+          #
+          #   @param bank_account_type [String] Bank account type, when available.
+          #
+          #   @param bank_routing_number [String] Bank routing number collected from the caller.
+          #
+          #   @param call_control_id [String] Call ID used to issue commands via Call Control API.
+          #
+          #   @param call_leg_id [String] ID unique to the call leg.
+          #
+          #   @param call_session_id [String] ID shared by related call legs in the same call session.
+          #
+          #   @param client_state [String] Base64-encoded state received from the command.
+          #
+          #   @param connection_id [String] Call Control App ID used in the call.
+          #
+          #   @param error_type [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::ErrorType] Step-level error when payment collection fails.
+          #
+          #   @param expiration_date [String] Card expiration date in MMYY format.
+          #
+          #   @param from [String] Number or SIP URI placing the call.
+          #
+          #   @param payment_card_number [String] Masked card number with only the last four digits visible.
+          #
+          #   @param payment_card_postal_code [String] Billing postal code collected from the caller.
+          #
+          #   @param payment_card_type [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentCardType] Detected card type. Present only for the recognized card brands listed below.
+          #
+          #   @param payment_connector [String] Name of the Pay connector used.
+          #
+          #   @param payment_method [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentMethod] Payment method being collected.
+          #
+          #   @param payment_status [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStatus] Status of the current payment step.
+          #
+          #   @param payment_step [Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStep] Current payment collection or processing step.
+          #
+          #   @param security_code [String] Fully masked card security code.
+          #
+          #   @param to [String] Destination number or SIP URI of the call.
+
+          # Step-level error when payment collection fails.
+          #
+          # @see Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload#error_type
+          module ErrorType
+            extend Telnyx::Internal::Type::Enum
+
+            TIMEOUT = :timeout
+            INVALID_CARD_NUMBER = :"invalid-card-number"
+            INVALID_DATE = :"invalid-date"
+            INVALID_SECURITY_CODE = :"invalid-security-code"
+            INVALID_POSTAL_CODE = :"invalid-postal-code"
+            INVALID_BANK_ROUTING_NUMBER = :"invalid-bank-routing-number"
+            INVALID_BANK_ACCOUNT_NUMBER = :"invalid-bank-account-number"
+            INPUT_MATCHING_FAILED = :"input-matching-failed"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Detected card type. Present only for the recognized card brands listed below.
+          #
+          # @see Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload#payment_card_type
+          module PaymentCardType
+            extend Telnyx::Internal::Type::Enum
+
+            VISA = :visa
+            MASTERCARD = :mastercard
+            AMEX = :amex
+            DISCOVER = :discover
+            DINERS_CLUB = :"diners-club"
+            JCB = :jcb
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Payment method being collected.
+          #
+          # @see Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload#payment_method
+          module PaymentMethod
+            extend Telnyx::Internal::Type::Enum
+
+            CREDIT_CARD = :"credit-card"
+            ACH_DEBIT = :"ach-debit"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Status of the current payment step.
+          #
+          # @see Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload#payment_status
+          module PaymentStatus
+            extend Telnyx::Internal::Type::Enum
+
+            COMPLETED = :completed
+            FAILED = :failed
+            PROCESSING = :processing
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Current payment collection or processing step.
+          #
+          # @see Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload#payment_step
+          module PaymentStep
+            extend Telnyx::Internal::Type::Enum
+
+            PAYMENT_CARD_NUMBER = :"payment-card-number"
+            EXPIRATION_DATE = :"expiration-date"
+            POSTAL_CODE = :"postal-code"
+            SECURITY_CODE = :"security-code"
+            BANK_ROUTING_NUMBER = :"bank-routing-number"
+            BANK_ACCOUNT_NUMBER = :"bank-account-number"
+            PAYMENT_PROCESSING = :"payment-processing"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifies the type of the resource.
+        #
+        # @see Telnyx::Models::CallPaymentProgressWebhookEvent::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/calls/action_add_ai_assistant_messages_params.rb

@@ -34,7 +34,15 @@ module Telnyx
         optional :messages,
                  -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message] }
 
-        # @!method initialize(call_control_id:, client_state: nil, command_id: nil, messages: nil, request_options: {})
+        # @!attribute trigger_response
+        #   When `true`, the injected messages immediately trigger an assistant
+        #   response/turn instead of waiting for the next natural turn or idle timeout. This
+        #   may interrupt a user who is still speaking.
+        #
+        #   @return [Boolean, nil]
+        optional :trigger_response, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(call_control_id:, client_state: nil, command_id: nil, messages: nil, trigger_response: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams} for more details.
         #
@@ -46,6 +54,8 @@ module Telnyx
         #
         #   @param messages [Array<Telnyx::Models::Calls::UserMessage, Telnyx::Models::Calls::AssistantMessage, Telnyx::Models::Calls::ToolMessage, Telnyx::Models::Calls::SystemMessage, Telnyx::Models::Calls::DeveloperMessage>] The messages to add to the conversation.
         #
+        #   @param trigger_response [Boolean] When `true`, the injected messages immediately trigger an assistant response/tur
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
         # Messages sent by an end user

data/lib/telnyx/models/calls/action_gather_using_ai_params.rb

@@ -141,6 +141,10 @@ module Telnyx
         #     `s1`. `VoiceId` is a Fish Voice-Library reference ID.
         #   - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
         #     `ara`, `rex`, `sal`, `leo`.
+        #   - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
+        #     `sara-en`, `abdulaziz-en`, `sara-ar`, `abdulaziz-ar`, `nourah-ar`,
+        #     `abdullah-ar`. Native Arabic (Saudi dialect) and English voices only — no
+        #     `ModelId` segment.
         #
         #   @return [String, nil]
         optional :voice, String

data/lib/telnyx/models/calls/action_gather_using_speak_params.rb

@@ -69,6 +69,10 @@ module Telnyx
         #     `s1`. `VoiceId` is a Fish Voice-Library reference ID.
         #   - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
         #     `ara`, `rex`, `sal`, `leo`.
+        #   - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
+        #     `sara-en`, `abdulaziz-en`, `sara-ar`, `abdulaziz-ar`, `nourah-ar`,
+        #     `abdullah-ar`. Native Arabic (Saudi dialect) and English voices only — no
+        #     `ModelId` segment.
         #
         #   For service_level basic, you may define the gender of the speaker (male or
         #   female).

data/lib/telnyx/models/calls/action_pay_params.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Calls
+      # @see Telnyx::Resources::Calls::Actions#pay
+      class ActionPayParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute call_control_id
+        #
+        #   @return [String]
+        required :call_control_id, String
+
+        # @!attribute amount
+        #   Amount to charge. Required when `transaction_type` is `charge`.
+        #
+        #   @return [Float, nil]
+        optional :amount, Float
+
+        # @!attribute client_state
+        #   Base64-encoded state included in subsequent webhooks.
+        #
+        #   @return [String, nil]
+        optional :client_state, String
+
+        # @!attribute command_id
+        #   Idempotency key for the command. Telnyx ignores a duplicate command with the
+        #   same `command_id` for the same `call_control_id`.
+        #
+        #   @return [String, nil]
+        optional :command_id, String
+
+        # @!attribute connector_name
+        #   Name of the Pay connector used to process the transaction.
+        #
+        #   @return [String, nil]
+        optional :connector_name, String
+
+        # @!attribute currency
+        #   Currency used for the transaction. Pay currently supports USD only.
+        #
+        #   @return [Symbol, Telnyx::Models::Calls::ActionPayParams::Currency, nil]
+        optional :currency, enum: -> { Telnyx::Calls::ActionPayParams::Currency }
+
+        # @!attribute description
+        #   Optional description forwarded with the payment transaction.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute inter_digit_timeout_millis
+        #   Time in milliseconds to wait between consecutive DTMF digits.
+        #
+        #   @return [Integer, nil]
+        optional :inter_digit_timeout_millis, Integer
+
+        # @!attribute language
+        #   Language used for payment prompts.
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute max_attempts
+        #   Maximum number of attempts for each payment collection step.
+        #
+        #   @return [Integer, nil]
+        optional :max_attempts, Integer
+
+        # @!attribute metadata
+        #   Metadata forwarded to the Pay connector.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+        # @!attribute parameters
+        #   Additional parameters forwarded to the Pay connector.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :parameters, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+        # @!attribute payment_method
+        #   Payment method to collect.
+        #
+        #   @return [Symbol, Telnyx::Models::Calls::ActionPayParams::PaymentMethod, nil]
+        optional :payment_method, enum: -> { Telnyx::Calls::ActionPayParams::PaymentMethod }
+
+        # @!attribute payment_token
+        #   Existing payment token. When supplied, payment-detail collection is skipped.
+        #
+        #   @return [String, nil]
+        optional :payment_token, String
+
+        # @!attribute prompts
+        #   Custom text-to-speech prompts keyed by payment collection step.
+        #
+        #   @return [Telnyx::Models::Calls::ActionPayParams::Prompts, nil]
+        optional :prompts, -> { Telnyx::Calls::ActionPayParams::Prompts }
+
+        # @!attribute service_level
+        #   Speech synthesis service level used for payment prompts. Pay defaults to
+        #   `premium`.
+        #
+        #   @return [String, nil]
+        optional :service_level, String
+
+        # @!attribute timeout_millis
+        #   Time in milliseconds to wait for DTMF input for each collection step.
+        #
+        #   @return [Integer, nil]
+        optional :timeout_millis, Integer
+
+        # @!attribute transaction_type
+        #   Transaction to perform. If omitted, Pay infers `tokenize` when `amount` is
+        #   absent or zero and `charge` when `amount` is positive.
+        #
+        #   @return [Symbol, Telnyx::Models::Calls::ActionPayParams::TransactionType, nil]
+        optional :transaction_type, enum: -> { Telnyx::Calls::ActionPayParams::TransactionType }
+
+        # @!attribute voice
+        #   Voice used for payment prompts. Accepts `male`, `female`, or a provider voice in
+        #   `<Provider>.<Model>.<VoiceId>` format, for example `AWS.Polly.Joanna` or
+        #   `Telnyx.KokoroTTS.af`.
+        #
+        #   @return [String, nil]
+        optional :voice, String
+
+        # @!method initialize(call_control_id:, amount: nil, client_state: nil, command_id: nil, connector_name: nil, currency: nil, description: nil, inter_digit_timeout_millis: nil, language: nil, max_attempts: nil, metadata: nil, parameters: nil, payment_method: nil, payment_token: nil, prompts: nil, service_level: nil, timeout_millis: nil, transaction_type: nil, voice: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Calls::ActionPayParams} for more details.
+        #
+        #   @param call_control_id [String]
+        #
+        #   @param amount [Float] Amount to charge. Required when `transaction_type` is `charge`.
+        #
+        #   @param client_state [String] Base64-encoded state included in subsequent webhooks.
+        #
+        #   @param command_id [String] Idempotency key for the command. Telnyx ignores a duplicate command with the sam
+        #
+        #   @param connector_name [String] Name of the Pay connector used to process the transaction.
+        #
+        #   @param currency [Symbol, Telnyx::Models::Calls::ActionPayParams::Currency] Currency used for the transaction. Pay currently supports USD only.
+        #
+        #   @param description [String] Optional description forwarded with the payment transaction.
+        #
+        #   @param inter_digit_timeout_millis [Integer] Time in milliseconds to wait between consecutive DTMF digits.
+        #
+        #   @param language [String] Language used for payment prompts.
+        #
+        #   @param max_attempts [Integer] Maximum number of attempts for each payment collection step.
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Metadata forwarded to the Pay connector.
+        #
+        #   @param parameters [Hash{Symbol=>Object}] Additional parameters forwarded to the Pay connector.
+        #
+        #   @param payment_method [Symbol, Telnyx::Models::Calls::ActionPayParams::PaymentMethod] Payment method to collect.
+        #
+        #   @param payment_token [String] Existing payment token. When supplied, payment-detail collection is skipped.
+        #
+        #   @param prompts [Telnyx::Models::Calls::ActionPayParams::Prompts] Custom text-to-speech prompts keyed by payment collection step.
+        #
+        #   @param service_level [String] Speech synthesis service level used for payment prompts. Pay defaults to `premiu
+        #
+        #   @param timeout_millis [Integer] Time in milliseconds to wait for DTMF input for each collection step.
+        #
+        #   @param transaction_type [Symbol, Telnyx::Models::Calls::ActionPayParams::TransactionType] Transaction to perform. If omitted, Pay infers `tokenize` when `amount` is absen
+        #
+        #   @param voice [String] Voice used for payment prompts. Accepts `male`, `female`, or a provider voice in
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Currency used for the transaction. Pay currently supports USD only.
+        module Currency
+          extend Telnyx::Internal::Type::Enum
+
+          USD = :USD
+          USD_2 = :usd
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Payment method to collect.
+        module PaymentMethod
+          extend Telnyx::Internal::Type::Enum
+
+          CREDIT_CARD = :"credit-card"
+          ACH_DEBIT = :"ach-debit"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Prompts < Telnyx::Internal::Type::BaseModel
+          # @!attribute bank_account_number
+          #   A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
+          optional :bank_account_number,
+                   union: -> { Telnyx::Calls::PayPromptValue },
+                   api_name: :"bank-account-number"
+
+          # @!attribute bank_routing_number
+          #   A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
+          optional :bank_routing_number,
+                   union: -> { Telnyx::Calls::PayPromptValue },
+                   api_name: :"bank-routing-number"
+
+          # @!attribute expiration_date
+          #   A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
+          optional :expiration_date, union: -> { Telnyx::Calls::PayPromptValue }, api_name: :"expiration-date"
+
+          # @!attribute payment_card_number
+          #   A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
+          optional :payment_card_number,
+                   union: -> { Telnyx::Calls::PayPromptValue },
+                   api_name: :"payment-card-number"
+
+          # @!attribute postal_code
+          #   A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
+          optional :postal_code, union: -> { Telnyx::Calls::PayPromptValue }, api_name: :"postal-code"
+
+          # @!attribute security_code
+          #   A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
+          optional :security_code, union: -> { Telnyx::Calls::PayPromptValue }, api_name: :"security-code"
+
+          # @!method initialize(bank_account_number: nil, bank_routing_number: nil, expiration_date: nil, payment_card_number: nil, postal_code: nil, security_code: nil)
+          #   Custom text-to-speech prompts keyed by payment collection step.
+          #
+          #   @param bank_account_number [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @param bank_routing_number [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @param expiration_date [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @param payment_card_number [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @param postal_code [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
+          #
+          #   @param security_code [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
+        end
+
+        # Transaction to perform. If omitted, Pay infers `tokenize` when `amount` is
+        # absent or zero and `charge` when `amount` is positive.
+        module TransactionType
+          extend Telnyx::Internal::Type::Enum
+
+          CHARGE = :charge
+          TOKENIZE = :tokenize
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/calls/action_pay_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Calls
+      # @see Telnyx::Resources::Calls::Actions#pay
+      class ActionPayResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::Calls::CallControlCommandResult, nil]
+        optional :data, -> { Telnyx::Calls::CallControlCommandResult }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::Calls::CallControlCommandResult]
+      end
+    end
+  end
+end

data/lib/telnyx/models/calls/action_speak_params.rb

@@ -69,6 +69,10 @@ module Telnyx
         #     `s1`. `VoiceId` is a Fish Voice-Library reference ID.
         #   - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
         #     `ara`, `rex`, `sal`, `leo`.
+        #   - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
+        #     `sara-en`, `abdulaziz-en`, `sara-ar`, `abdulaziz-ar`, `nourah-ar`,
+        #     `abdullah-ar`. Native Arabic (Saudi dialect) and English voices only — no
+        #     `ModelId` segment.
         #
         #   For service_level basic, you may define the gender of the speaker (male or
         #   female).