telnyx 5.41.0 → 5.43.0

data/lib/telnyx/resources/calls/actions.rb

@@ -50,7 +50,7 @@ module Telnyx
         # When the `record` parameter is set to `record-from-answer`, the response will
         # include a `recording_id` field.
         #
-        # @overload answer(call_control_id, billing_group_id: nil, client_state: nil, command_id: nil, custom_headers: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_headers: nil, sound_modifications: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, transcription: nil, transcription_config: nil, webhook_url: nil, webhook_url_method: nil, request_options: {})
+        # @overload answer(call_control_id, billing_group_id: nil, client_state: nil, command_id: nil, custom_headers: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_headers: nil, sound_modifications: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
         #
         # @param call_control_id [String] Unique identifier and token for controlling the call
         #
@@ -103,10 +103,16 @@ module Telnyx
         #
         # @param transcription_config [Telnyx::Models::Calls::TranscriptionStartRequest]
         #
+        # @param webhook_retries_policies [Hash{Symbol=>Telnyx::Models::Calls::ActionAnswerParams::WebhookRetriesPolicy}] A map of event types to retry policies. Each retry policy contains an array of `
+        #
         # @param webhook_url [String] Use this field to override the URL for which Telnyx will send subsequent webhook
         #
         # @param webhook_url_method [Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLMethod] HTTP request type used for `webhook_url`.
         #
+        # @param webhook_urls [Hash{Symbol=>String}] A map of event types to webhook URLs. When an event of the specified type occurs
+        #
+        # @param webhook_urls_method [Symbol, Telnyx::Models::Calls::ActionAnswerParams::WebhookURLsMethod] HTTP request method to invoke `webhook_urls`.
+        #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Telnyx::Models::Calls::ActionAnswerResponse]
@@ -133,7 +139,7 @@ module Telnyx
         # - `call.bridged` for Leg A
         # - `call.bridged` for Leg B
         #
-        # @overload bridge(call_control_id_to_bridge, call_control_id_to_bridge_with:, client_state: nil, command_id: nil, mute_dtmf: nil, park_after_unbridge: nil, play_ringtone: nil, prevent_double_bridge: nil, queue: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, ringtone: nil, video_room_context: nil, video_room_id: nil, request_options: {})
+        # @overload bridge(call_control_id_to_bridge, call_control_id_to_bridge_with:, client_state: nil, command_id: nil, hold_after_unbridge: nil, mute_dtmf: nil, park_after_unbridge: nil, play_ringtone: nil, prevent_double_bridge: nil, queue: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, ringtone: nil, video_room_context: nil, video_room_id: nil, request_options: {})
         #
         # @param call_control_id_to_bridge [String] Unique identifier and token for controlling the call
         #
@@ -143,6 +149,8 @@ module Telnyx
         #
         # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
         #
+        # @param hold_after_unbridge [Boolean] Specifies behavior after the bridge ends. If set to `true`, the current leg will
+        #
         # @param mute_dtmf [Symbol, Telnyx::Models::Calls::ActionBridgeParams::MuteDtmf] When enabled, DTMF tones are not passed to the call participant. The webhooks co
         #
         # @param park_after_unbridge [String] Specifies behavior after the bridge ends (i.e. the opposite leg either hangs up
@@ -491,7 +499,7 @@ module Telnyx
         # - `call.hangup`
         # - `call.recording.saved`
         #
-        # @overload hangup(call_control_id, client_state: nil, command_id: nil, request_options: {})
+        # @overload hangup(call_control_id, client_state: nil, command_id: nil, custom_headers: nil, request_options: {})
         #
         # @param call_control_id [String] Unique identifier and token for controlling the call
         #
@@ -499,6 +507,8 @@ module Telnyx
         #
         # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
         #
+        # @param custom_headers [Array<Telnyx::Models::CustomSipHeader>] Custom headers to be added to the SIP BYE message.
+        #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Telnyx::Models::Calls::ActionHangupResponse]

data/lib/telnyx/resources/payment.rb

@@ -6,6 +6,28 @@ module Telnyx
       # @return [Telnyx::Resources::Payment::AutoRechargePrefs]
       attr_reader :auto_recharge_prefs
 
+      # Create a stored payment transaction
+      #
+      # @overload create_stored_payment_transaction(amount:, request_options: {})
+      #
+      # @param amount [String] Amount in dollars and cents, e.g. "120.00"
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse]
+      #
+      # @see Telnyx::Models::PaymentCreateStoredPaymentTransactionParams
+      def create_stored_payment_transaction(params)
+        parsed, options = Telnyx::PaymentCreateStoredPaymentTransactionParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v2/payment/stored_payment_transactions",
+          body: parsed,
+          model: Telnyx::Models::PaymentCreateStoredPaymentTransactionResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Telnyx::Client]

data/lib/telnyx/resources/queues.rb

@@ -6,6 +6,30 @@ module Telnyx
       # @return [Telnyx::Resources::Queues::Calls]
       attr_reader :calls
 
+      # Create a new call queue.
+      #
+      # @overload create(queue_name:, max_size: nil, request_options: {})
+      #
+      # @param queue_name [String] The name of the queue. Must be between 1 and 255 characters.
+      #
+      # @param max_size [Integer] The maximum number of calls allowed in the queue.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::QueueCreateResponse]
+      #
+      # @see Telnyx::Models::QueueCreateParams
+      def create(params)
+        parsed, options = Telnyx::QueueCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "queues",
+          body: parsed,
+          model: Telnyx::Models::QueueCreateResponse,
+          options: options
+        )
+      end
+
       # Retrieve an existing call queue
       #
       # @overload retrieve(queue_name, request_options: {})
@@ -26,6 +50,75 @@ module Telnyx
         )
       end
 
+      # Update properties of an existing call queue.
+      #
+      # @overload update(queue_name, max_size:, request_options: {})
+      #
+      # @param queue_name [String] Uniquely identifies the queue by name
+      #
+      # @param max_size [Integer] The maximum number of calls allowed in the queue.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::QueueUpdateResponse]
+      #
+      # @see Telnyx::Models::QueueUpdateParams
+      def update(queue_name, params)
+        parsed, options = Telnyx::QueueUpdateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["queues/%1$s", queue_name],
+          body: parsed,
+          model: Telnyx::Models::QueueUpdateResponse,
+          options: options
+        )
+      end
+
+      # List all queues for the authenticated user.
+      #
+      # @overload list(page_number: nil, page_size: nil, request_options: {})
+      #
+      # @param page_number [Integer] The page number to load
+      #
+      # @param page_size [Integer] The size of the page
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Queue>]
+      #
+      # @see Telnyx::Models::QueueListParams
+      def list(params = {})
+        parsed, options = Telnyx::QueueListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "queues",
+          query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+          page: Telnyx::Internal::DefaultFlatPagination,
+          model: Telnyx::Queue,
+          options: options
+        )
+      end
+
+      # Delete an existing call queue.
+      #
+      # @overload delete(queue_name, request_options: {})
+      #
+      # @param queue_name [String] Uniquely identifies the queue by name
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Telnyx::Models::QueueDeleteParams
+      def delete(queue_name, params = {})
+        @client.request(
+          method: :delete,
+          path: ["queues/%1$s", queue_name],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Telnyx::Client]

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.41.0"
+  VERSION = "5.43.0"
 end

data/lib/telnyx.rb

@@ -1448,6 +1448,8 @@ require_relative "telnyx/models/payment/auto_recharge_pref_list_params"
 require_relative "telnyx/models/payment/auto_recharge_pref_list_response"
 require_relative "telnyx/models/payment/auto_recharge_pref_update_params"
 require_relative "telnyx/models/payment/auto_recharge_pref_update_response"
+require_relative "telnyx/models/payment_create_stored_payment_transaction_params"
+require_relative "telnyx/models/payment_create_stored_payment_transaction_response"
 require_relative "telnyx/models/phone_number"
 require_relative "telnyx/models/phone_number_blocks/job"
 require_relative "telnyx/models/phone_number_blocks/job_delete_phone_number_block_params"
@@ -1675,6 +1677,11 @@ require_relative "telnyx/models/public_internet_gateway_retrieve_response"
 require_relative "telnyx/models/push_credential"
 require_relative "telnyx/models/push_credential_response"
 require_relative "telnyx/models/pwg_assigned_resources_summary"
+require_relative "telnyx/models/queue"
+require_relative "telnyx/models/queue_create_params"
+require_relative "telnyx/models/queue_create_response"
+require_relative "telnyx/models/queue_delete_params"
+require_relative "telnyx/models/queue_list_params"
 require_relative "telnyx/models/queue_retrieve_params"
 require_relative "telnyx/models/queue_retrieve_response"
 require_relative "telnyx/models/queues/call_list_params"
@@ -1683,6 +1690,8 @@ require_relative "telnyx/models/queues/call_remove_params"
 require_relative "telnyx/models/queues/call_retrieve_params"
 require_relative "telnyx/models/queues/call_retrieve_response"
 require_relative "telnyx/models/queues/call_update_params"
+require_relative "telnyx/models/queue_update_params"
+require_relative "telnyx/models/queue_update_response"
 require_relative "telnyx/models/rcs_agent"
 require_relative "telnyx/models/rcs_agent_message"
 require_relative "telnyx/models/rcs_agent_response"

data/rbi/telnyx/models/calls/action_answer_params.rbi

@@ -287,6 +287,32 @@ module Telnyx
         end
         attr_writer :transcription_config
 
+        # 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.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy
+              ]
+            )
+          )
+        end
+        attr_reader :webhook_retries_policies
+
+        sig do
+          params(
+            webhook_retries_policies:
+              T::Hash[
+                Symbol,
+                Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy::OrHash
+              ]
+          ).void
+        end
+        attr_writer :webhook_retries_policies
+
         # Use this field to override the URL for which Telnyx will send subsequent
         # webhooks to for this call.
         sig { returns(T.nilable(String)) }
@@ -313,6 +339,33 @@ module Telnyx
         end
         attr_writer :webhook_url_method
 
+        # 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`.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :webhook_urls
+
+        sig { params(webhook_urls: T::Hash[Symbol, String]).void }
+        attr_writer :webhook_urls
+
+        # HTTP request method to invoke `webhook_urls`.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod::OrSymbol
+            )
+          )
+        end
+        attr_reader :webhook_urls_method
+
+        sig do
+          params(
+            webhook_urls_method:
+              Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod::OrSymbol
+          ).void
+        end
+        attr_writer :webhook_urls_method
+
         sig do
           params(
             billing_group_id: String,
@@ -349,9 +402,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(T.attached_class)
         end
@@ -421,11 +482,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
@@ -466,9 +537,17 @@ module Telnyx
               stream_url: String,
               transcription: T::Boolean,
               transcription_config: Telnyx::Calls::TranscriptionStartRequest,
+              webhook_retries_policies:
+                T::Hash[
+                  Symbol,
+                  Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy
+                ],
               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
             }
           )
@@ -698,6 +777,38 @@ module Telnyx
           end
         end
 
+        class WebhookRetriesPolicy < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Calls::ActionAnswerParams::WebhookRetriesPolicy,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Array of delays in milliseconds between retry attempts. Total sum cannot exceed
+          # 60000ms.
+          sig { returns(T.nilable(T::Array[Integer])) }
+          attr_reader :retries_ms
+
+          sig { params(retries_ms: T::Array[Integer]).void }
+          attr_writer :retries_ms
+
+          sig do
+            params(retries_ms: T::Array[Integer]).returns(T.attached_class)
+          end
+          def self.new(
+            # Array of delays in milliseconds between retry attempts. Total sum cannot exceed
+            # 60000ms.
+            retries_ms: nil
+          )
+          end
+
+          sig { override.returns({ retries_ms: T::Array[Integer] }) }
+          def to_hash
+          end
+        end
+
         # HTTP request type used for `webhook_url`.
         module WebhookURLMethod
           extend Telnyx::Internal::Type::Enum
@@ -729,6 +840,41 @@ module Telnyx
           def self.values
           end
         end
+
+        # HTTP request method to invoke `webhook_urls`.
+        module WebhookURLsMethod
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          POST =
+            T.let(
+              :POST,
+              Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod::TaggedSymbol
+            )
+          GET =
+            T.let(
+              :GET,
+              Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/telnyx/models/calls/action_bridge_params.rbi

@@ -33,6 +33,14 @@ module Telnyx
         sig { params(command_id: String).void }
         attr_writer :command_id
 
+        # 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.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :hold_after_unbridge
+
+        sig { params(hold_after_unbridge: T::Boolean).void }
+        attr_writer :hold_after_unbridge
+
         # When enabled, DTMF tones are not passed to the call participant. The webhooks
         # containing the DTMF information will be sent.
         sig do
@@ -236,6 +244,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,
@@ -269,6 +278,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,
@@ -336,6 +348,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,

data/rbi/telnyx/models/calls/action_hangup_params.rbi

@@ -28,10 +28,20 @@ module Telnyx
         sig { params(command_id: String).void }
         attr_writer :command_id
 
+        # Custom headers to be added to the SIP BYE message.
+        sig { returns(T.nilable(T::Array[Telnyx::CustomSipHeader])) }
+        attr_reader :custom_headers
+
+        sig do
+          params(custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash]).void
+        end
+        attr_writer :custom_headers
+
         sig do
           params(
             client_state: String,
             command_id: String,
+            custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -42,6 +52,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
@@ -51,6 +63,7 @@ module Telnyx
             {
               client_state: String,
               command_id: String,
+              custom_headers: T::Array[Telnyx::CustomSipHeader],
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/models/payment_create_stored_payment_transaction_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class PaymentCreateStoredPaymentTransactionParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::PaymentCreateStoredPaymentTransactionParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Amount in dollars and cents, e.g. "120.00"
+      sig { returns(String) }
+      attr_accessor :amount
+
+      sig do
+        params(
+          amount: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Amount in dollars and cents, e.g. "120.00"
+        amount:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { amount: String, request_options: Telnyx::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end