telnyx 5.41.0 → 5.43.0

data/rbi/telnyx/models/queue_update_response.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class QueueUpdateResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::Models::QueueUpdateResponse, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Telnyx::Queue)) }
+      attr_reader :data
+
+      sig { params(data: Telnyx::Queue::OrHash).void }
+      attr_writer :data
+
+      sig { params(data: Telnyx::Queue::OrHash).returns(T.attached_class) }
+      def self.new(data: nil)
+      end
+
+      sig { override.returns({ data: Telnyx::Queue }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models.rbi

@@ -1194,6 +1194,9 @@ module Telnyx
 
   Payment = Telnyx::Models::Payment
 
+  PaymentCreateStoredPaymentTransactionParams =
+    Telnyx::Models::PaymentCreateStoredPaymentTransactionParams
+
   PhoneNumber = Telnyx::Models::PhoneNumber
 
   PhoneNumberBlocks = Telnyx::Models::PhoneNumberBlocks
@@ -1332,10 +1335,20 @@ module Telnyx
 
   PwgAssignedResourcesSummary = Telnyx::Models::PwgAssignedResourcesSummary
 
+  Queue = Telnyx::Models::Queue
+
+  QueueCreateParams = Telnyx::Models::QueueCreateParams
+
+  QueueDeleteParams = Telnyx::Models::QueueDeleteParams
+
+  QueueListParams = Telnyx::Models::QueueListParams
+
   QueueRetrieveParams = Telnyx::Models::QueueRetrieveParams
 
   Queues = Telnyx::Models::Queues
 
+  QueueUpdateParams = Telnyx::Models::QueueUpdateParams
+
   RcsAgent = Telnyx::Models::RcsAgent
 
   RcsAgentMessage = Telnyx::Models::RcsAgentMessage

data/rbi/telnyx/resources/calls/actions.rbi

@@ -86,9 +86,17 @@ module Telnyx
             transcription: T::Boolean,
             transcription_config:
               Telnyx::Calls::TranscriptionStartRequest::OrHash,
+            webhook_retries_policies:
+              T::Hash[
+                Symbol,
+                Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy::OrHash
+              ],
             webhook_url: String,
             webhook_url_method:
               Telnyx::Calls::ActionAnswerParams::WebhookURLMethod::OrSymbol,
+            webhook_urls: T::Hash[Symbol, String],
+            webhook_urls_method:
+              Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod::OrSymbol,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::Calls::ActionAnswerResponse)
         end
@@ -160,11 +168,21 @@ module Telnyx
           # Enable transcription upon call answer. The default value is false.
           transcription: nil,
           transcription_config: nil,
+          # A map of event types to retry policies. Each retry policy contains an array of
+          # `retries_ms` specifying the delays between retry attempts in milliseconds.
+          # Maximum 5 retries, total delay cannot exceed 60 seconds.
+          webhook_retries_policies: nil,
           # Use this field to override the URL for which Telnyx will send subsequent
           # webhooks to for this call.
           webhook_url: nil,
           # HTTP request type used for `webhook_url`.
           webhook_url_method: nil,
+          # A map of event types to webhook URLs. When an event of the specified type
+          # occurs, the webhook URL associated with that event type will be called instead
+          # of `webhook_url`. Events not mapped here will use the default `webhook_url`.
+          webhook_urls: nil,
+          # HTTP request method to invoke `webhook_urls`.
+          webhook_urls_method: nil,
           request_options: {}
         )
         end
@@ -181,6 +199,7 @@ module Telnyx
             call_control_id_to_bridge_with: String,
             client_state: String,
             command_id: String,
+            hold_after_unbridge: T::Boolean,
             mute_dtmf: Telnyx::Calls::ActionBridgeParams::MuteDtmf::OrSymbol,
             park_after_unbridge: String,
             play_ringtone: T::Boolean,
@@ -216,6 +235,9 @@ module Telnyx
           # Use this field to avoid duplicate commands. Telnyx will ignore any command with
           # the same `command_id` for the same `call_control_id`.
           command_id: nil,
+          # Specifies behavior after the bridge ends. If set to `true`, the current leg will
+          # be put on hold after unbridge instead of being hung up.
+          hold_after_unbridge: nil,
           # When enabled, DTMF tones are not passed to the call participant. The webhooks
           # containing the DTMF information will be sent.
           mute_dtmf: nil,
@@ -721,6 +743,7 @@ module Telnyx
             call_control_id: String,
             client_state: String,
             command_id: String,
+            custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::Calls::ActionHangupResponse)
         end
@@ -733,6 +756,8 @@ module Telnyx
           # Use this field to avoid duplicate commands. Telnyx will ignore any command with
           # the same `command_id` for the same `call_control_id`.
           command_id: nil,
+          # Custom headers to be added to the SIP BYE message.
+          custom_headers: nil,
           request_options: {}
         )
         end

data/rbi/telnyx/resources/payment.rbi

@@ -6,6 +6,20 @@ module Telnyx
       sig { returns(Telnyx::Resources::Payment::AutoRechargePrefs) }
       attr_reader :auto_recharge_prefs
 
+      # Create a stored payment transaction
+      sig do
+        params(
+          amount: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse)
+      end
+      def create_stored_payment_transaction(
+        # Amount in dollars and cents, e.g. "120.00"
+        amount:,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Telnyx::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/telnyx/resources/queues.rbi

@@ -6,6 +6,23 @@ module Telnyx
       sig { returns(Telnyx::Resources::Queues::Calls) }
       attr_reader :calls
 
+      # Create a new call queue.
+      sig do
+        params(
+          queue_name: String,
+          max_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::QueueCreateResponse)
+      end
+      def create(
+        # The name of the queue. Must be between 1 and 255 characters.
+        queue_name:,
+        # The maximum number of calls allowed in the queue.
+        max_size: nil,
+        request_options: {}
+      )
+      end
+
       # Retrieve an existing call queue
       sig do
         params(
@@ -20,6 +37,54 @@ module Telnyx
       )
       end
 
+      # Update properties of an existing call queue.
+      sig do
+        params(
+          queue_name: String,
+          max_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::QueueUpdateResponse)
+      end
+      def update(
+        # Uniquely identifies the queue by name
+        queue_name,
+        # The maximum number of calls allowed in the queue.
+        max_size:,
+        request_options: {}
+      )
+      end
+
+      # List all queues for the authenticated user.
+      sig do
+        params(
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Internal::DefaultFlatPagination[Telnyx::Queue])
+      end
+      def list(
+        # The page number to load
+        page_number: nil,
+        # The size of the page
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete an existing call queue.
+      sig do
+        params(
+          queue_name: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Uniquely identifies the queue by name
+        queue_name,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Telnyx::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/telnyx/models/calls/action_answer_params.rbs

@@ -27,8 +27,11 @@ module Telnyx
           stream_url: String,
           transcription: bool,
           transcription_config: Telnyx::Calls::TranscriptionStartRequest,
+          webhook_retries_policies: ::Hash[Symbol, Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy],
           webhook_url: String,
-          webhook_url_method: Telnyx::Models::Calls::ActionAnswerParams::webhook_url_method
+          webhook_url_method: Telnyx::Models::Calls::ActionAnswerParams::webhook_url_method,
+          webhook_urls: ::Hash[Symbol, String],
+          webhook_urls_method: Telnyx::Models::Calls::ActionAnswerParams::webhook_urls_method
         }
         & Telnyx::Internal::Type::request_parameters
 
@@ -162,6 +165,12 @@ module Telnyx
           Telnyx::Calls::TranscriptionStartRequest
         ) -> Telnyx::Calls::TranscriptionStartRequest
 
+        attr_reader webhook_retries_policies: ::Hash[Symbol, Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy]?
+
+        def webhook_retries_policies=: (
+          ::Hash[Symbol, Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy]
+        ) -> ::Hash[Symbol, Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy]
+
         attr_reader webhook_url: String?
 
         def webhook_url=: (String) -> String
@@ -172,6 +181,16 @@ module Telnyx
           Telnyx::Models::Calls::ActionAnswerParams::webhook_url_method
         ) -> Telnyx::Models::Calls::ActionAnswerParams::webhook_url_method
 
+        attr_reader webhook_urls: ::Hash[Symbol, String]?
+
+        def webhook_urls=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+        attr_reader webhook_urls_method: Telnyx::Models::Calls::ActionAnswerParams::webhook_urls_method?
+
+        def webhook_urls_method=: (
+          Telnyx::Models::Calls::ActionAnswerParams::webhook_urls_method
+        ) -> Telnyx::Models::Calls::ActionAnswerParams::webhook_urls_method
+
         def initialize: (
           ?billing_group_id: String,
           ?client_state: String,
@@ -197,8 +216,11 @@ module Telnyx
           ?stream_url: String,
           ?transcription: bool,
           ?transcription_config: Telnyx::Calls::TranscriptionStartRequest,
+          ?webhook_retries_policies: ::Hash[Symbol, Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy],
           ?webhook_url: String,
           ?webhook_url_method: Telnyx::Models::Calls::ActionAnswerParams::webhook_url_method,
+          ?webhook_urls: ::Hash[Symbol, String],
+          ?webhook_urls_method: Telnyx::Models::Calls::ActionAnswerParams::webhook_urls_method,
           ?request_options: Telnyx::request_opts
         ) -> void
 
@@ -227,8 +249,11 @@ module Telnyx
           stream_url: String,
           transcription: bool,
           transcription_config: Telnyx::Calls::TranscriptionStartRequest,
+          webhook_retries_policies: ::Hash[Symbol, Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy],
           webhook_url: String,
           webhook_url_method: Telnyx::Models::Calls::ActionAnswerParams::webhook_url_method,
+          webhook_urls: ::Hash[Symbol, String],
+          webhook_urls_method: Telnyx::Models::Calls::ActionAnswerParams::webhook_urls_method,
           request_options: Telnyx::RequestOptions
         }
 
@@ -308,6 +333,18 @@ module Telnyx
           def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::stream_track]
         end
 
+        type webhook_retries_policy = { retries_ms: ::Array[Integer] }
+
+        class WebhookRetriesPolicy < Telnyx::Internal::Type::BaseModel
+          attr_reader retries_ms: ::Array[Integer]?
+
+          def retries_ms=: (::Array[Integer]) -> ::Array[Integer]
+
+          def initialize: (?retries_ms: ::Array[Integer]) -> void
+
+          def to_hash: -> { retries_ms: ::Array[Integer] }
+        end
+
         type webhook_url_method = :POST | :GET
 
         module WebhookURLMethod
@@ -318,6 +355,17 @@ module Telnyx
 
           def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::webhook_url_method]
         end
+
+        type webhook_urls_method = :POST | :GET
+
+        module WebhookURLsMethod
+          extend Telnyx::Internal::Type::Enum
+
+          POST: :POST
+          GET: :GET
+
+          def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::webhook_urls_method]
+        end
       end
     end
   end

data/sig/telnyx/models/calls/action_bridge_params.rbs

@@ -6,6 +6,7 @@ module Telnyx
           call_control_id_to_bridge_with: String,
           client_state: String,
           command_id: String,
+          hold_after_unbridge: bool,
           mute_dtmf: Telnyx::Models::Calls::ActionBridgeParams::mute_dtmf,
           park_after_unbridge: String,
           play_ringtone: bool,
@@ -39,6 +40,10 @@ module Telnyx
 
         def command_id=: (String) -> String
 
+        attr_reader hold_after_unbridge: bool?
+
+        def hold_after_unbridge=: (bool) -> bool
+
         attr_reader mute_dtmf: Telnyx::Models::Calls::ActionBridgeParams::mute_dtmf?
 
         def mute_dtmf=: (
@@ -121,6 +126,7 @@ module Telnyx
           call_control_id_to_bridge_with: String,
           ?client_state: String,
           ?command_id: String,
+          ?hold_after_unbridge: bool,
           ?mute_dtmf: Telnyx::Models::Calls::ActionBridgeParams::mute_dtmf,
           ?park_after_unbridge: String,
           ?play_ringtone: bool,
@@ -144,6 +150,7 @@ module Telnyx
           call_control_id_to_bridge_with: String,
           client_state: String,
           command_id: String,
+          hold_after_unbridge: bool,
           mute_dtmf: Telnyx::Models::Calls::ActionBridgeParams::mute_dtmf,
           park_after_unbridge: String,
           play_ringtone: bool,

data/sig/telnyx/models/calls/action_hangup_params.rbs

@@ -2,7 +2,11 @@ module Telnyx
   module Models
     module Calls
       type action_hangup_params =
-        { client_state: String, command_id: String }
+        {
+          client_state: String,
+          command_id: String,
+          custom_headers: ::Array[Telnyx::CustomSipHeader]
+        }
         & Telnyx::Internal::Type::request_parameters
 
       class ActionHangupParams < Telnyx::Internal::Type::BaseModel
@@ -17,15 +21,23 @@ module Telnyx
 
         def command_id=: (String) -> String
 
+        attr_reader custom_headers: ::Array[Telnyx::CustomSipHeader]?
+
+        def custom_headers=: (
+          ::Array[Telnyx::CustomSipHeader]
+        ) -> ::Array[Telnyx::CustomSipHeader]
+
         def initialize: (
           ?client_state: String,
           ?command_id: String,
+          ?custom_headers: ::Array[Telnyx::CustomSipHeader],
           ?request_options: Telnyx::request_opts
         ) -> void
 
         def to_hash: -> {
           client_state: String,
           command_id: String,
+          custom_headers: ::Array[Telnyx::CustomSipHeader],
           request_options: Telnyx::RequestOptions
         }
       end

data/sig/telnyx/models/payment_create_stored_payment_transaction_params.rbs

@@ -0,0 +1,23 @@
+module Telnyx
+  module Models
+    type payment_create_stored_payment_transaction_params =
+      { amount: String } & Telnyx::Internal::Type::request_parameters
+
+    class PaymentCreateStoredPaymentTransactionParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor amount: String
+
+      def initialize: (
+        amount: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        amount: String,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/payment_create_stored_payment_transaction_response.rbs

@@ -0,0 +1,116 @@
+module Telnyx
+  module Models
+    type payment_create_stored_payment_transaction_response =
+      {
+        data: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data
+      }
+
+    class PaymentCreateStoredPaymentTransactionResponse < Telnyx::Internal::Type::BaseModel
+      attr_reader data: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data?
+
+      def data=: (
+        Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data
+      ) -> Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data
+
+      def initialize: (
+        ?data: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data
+      }
+
+      type data =
+        {
+          id: String,
+          amount_cents: Integer,
+          amount_currency: String,
+          auto_recharge: bool,
+          created_at: Time,
+          processor_status: String,
+          record_type: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::record_type,
+          transaction_processing_type: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::transaction_processing_type
+        }
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader amount_cents: Integer?
+
+        def amount_cents=: (Integer) -> Integer
+
+        attr_reader amount_currency: String?
+
+        def amount_currency=: (String) -> String
+
+        attr_reader auto_recharge: bool?
+
+        def auto_recharge=: (bool) -> bool
+
+        attr_reader created_at: Time?
+
+        def created_at=: (Time) -> Time
+
+        attr_reader processor_status: String?
+
+        def processor_status=: (String) -> String
+
+        attr_reader record_type: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::record_type?
+
+        def record_type=: (
+          Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::record_type
+        ) -> Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::record_type
+
+        attr_reader transaction_processing_type: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::transaction_processing_type?
+
+        def transaction_processing_type=: (
+          Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::transaction_processing_type
+        ) -> Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::transaction_processing_type
+
+        def initialize: (
+          ?id: String,
+          ?amount_cents: Integer,
+          ?amount_currency: String,
+          ?auto_recharge: bool,
+          ?created_at: Time,
+          ?processor_status: String,
+          ?record_type: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::record_type,
+          ?transaction_processing_type: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::transaction_processing_type
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          amount_cents: Integer,
+          amount_currency: String,
+          auto_recharge: bool,
+          created_at: Time,
+          processor_status: String,
+          record_type: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::record_type,
+          transaction_processing_type: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::transaction_processing_type
+        }
+
+        type record_type = :transaction
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TRANSACTION: :transaction
+
+          def self?.values: -> ::Array[Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::record_type]
+        end
+
+        type transaction_processing_type = :stored_payment
+
+        module TransactionProcessingType
+          extend Telnyx::Internal::Type::Enum
+
+          STORED_PAYMENT: :stored_payment
+
+          def self?.values: -> ::Array[Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse::Data::transaction_processing_type]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/queue.rbs

@@ -0,0 +1,65 @@
+module Telnyx
+  module Models
+    type queue =
+      {
+        id: String,
+        average_wait_time_secs: Integer,
+        created_at: String,
+        current_size: Integer,
+        max_size: Integer,
+        name: String,
+        record_type: Telnyx::Models::Queue::record_type,
+        updated_at: String
+      }
+
+    class Queue < Telnyx::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor average_wait_time_secs: Integer
+
+      attr_accessor created_at: String
+
+      attr_accessor current_size: Integer
+
+      attr_accessor max_size: Integer
+
+      attr_accessor name: String
+
+      attr_accessor record_type: Telnyx::Models::Queue::record_type
+
+      attr_accessor updated_at: String
+
+      def initialize: (
+        id: String,
+        average_wait_time_secs: Integer,
+        created_at: String,
+        current_size: Integer,
+        max_size: Integer,
+        name: String,
+        record_type: Telnyx::Models::Queue::record_type,
+        updated_at: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        average_wait_time_secs: Integer,
+        created_at: String,
+        current_size: Integer,
+        max_size: Integer,
+        name: String,
+        record_type: Telnyx::Models::Queue::record_type,
+        updated_at: String
+      }
+
+      type record_type = :queue
+
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        QUEUE: :queue
+
+        def self?.values: -> ::Array[Telnyx::Models::Queue::record_type]
+      end
+    end
+  end
+end

data/sig/telnyx/models/queue_create_params.rbs

@@ -0,0 +1,30 @@
+module Telnyx
+  module Models
+    type queue_create_params =
+      { queue_name: String, max_size: Integer }
+      & Telnyx::Internal::Type::request_parameters
+
+    class QueueCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor queue_name: String
+
+      attr_reader max_size: Integer?
+
+      def max_size=: (Integer) -> Integer
+
+      def initialize: (
+        queue_name: String,
+        ?max_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        queue_name: String,
+        max_size: Integer,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/queue_create_response.rbs

@@ -0,0 +1,15 @@
+module Telnyx
+  module Models
+    type queue_create_response = { data: Telnyx::Queue }
+
+    class QueueCreateResponse < Telnyx::Internal::Type::BaseModel
+      attr_reader data: Telnyx::Queue?
+
+      def data=: (Telnyx::Queue) -> Telnyx::Queue
+
+      def initialize: (?data: Telnyx::Queue) -> void
+
+      def to_hash: -> { data: Telnyx::Queue }
+    end
+  end
+end

data/sig/telnyx/models/queue_delete_params.rbs

@@ -0,0 +1,14 @@
+module Telnyx
+  module Models
+    type queue_delete_params = {  } & Telnyx::Internal::Type::request_parameters
+
+    class QueueDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Telnyx::request_opts) -> void
+
+      def to_hash: -> { request_options: Telnyx::RequestOptions }
+    end
+  end
+end