telnyx 5.162.0 → 5.163.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7708f9c5fde7caa42c63ed4cb40339bdfa84c9b161a6d524055843fd1988063
-  data.tar.gz: 4ab55177e33129022a5460eb6c41ad5b25963ece22d1aac684fcfbd796882201
+  metadata.gz: dd14ec881b84e3ce8b0d2ba88bc49cc87dd03da84dcaa0fd551a48a7a954d715
+  data.tar.gz: 75fef0397f90e5f5fb35702edad17b1956ee62024056661b670047bb68df30b8
 SHA512:
-  metadata.gz: 72f99386036ffbb741f1ac5f927b7c98499e0b0a05664954098abaa9fb19f3b9315f03c9f482706de1a8060b7899b66821d06a79b0f3a48ee49feff2d4098882
-  data.tar.gz: 0f072694323630e69c4c11226d4f67ca42c525effdc7c191fe00c5a266b68dad7d35035696903e154d897ce9a08c13fba7c0a993bbf36430fff1f6b81780ae3b
+  metadata.gz: 9f6682ab4347e4de132f6b73aa3bf0ab3927ab3b5da54a9d9a5cf10591777fe914cbf62e9599a3a06f034fb6cdf982f4cbb9868616ecb320433803feed6e6995
+  data.tar.gz: fc259dfb669208234bf0bc21ac8c92779781545ba8645f4c26c6b7312c36dee69936ea4ea544eb8c83ba24cd8f8f04ac43cf030d72f2aafcee943c8541d2d700

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [5.163.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.162.0...v5.163.0) (2026-08-21)
+
+
+### Features
+
+* promote from staging 0f2a825 ([242bc6d](https://github.com/team-telnyx/telnyx-ruby/commit/242bc6d58058866b6569ad9789e063a44c062246))
+
 ## [5.162.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.161.0...v5.162.0) (2026-08-18)
 
 

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "telnyx", "~> 5.162.0"
+gem "telnyx", "~> 5.163.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/internal/cloudfs_cursor_pagination.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if cloudfs_cursor_pagination.has_next?
+    #     cloudfs_cursor_pagination = cloudfs_cursor_pagination.next_page
+    #   end
+    #
+    # @example
+    #   cloudfs_cursor_pagination.auto_paging_each do |cloudf|
+    #     puts(cloudf)
+    #   end
+    class CloudfsCursorPagination
+      include Telnyx::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :data
+
+      # @return [Meta]
+      attr_accessor :meta
+
+      # @return [Boolean]
+      def next_page?
+        !data.to_a.empty? && !meta&.cursors&.after.to_s.empty?
+      end
+
+      # @raise [Telnyx::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Telnyx::Internal::Util.deep_merge(@req, {query: {"page[after]": meta&.cursors&.after}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.data&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Array => data}
+          @data = data.map { Telnyx::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        case page_data
+        in {meta: Hash | nil => meta}
+          @meta = Telnyx::Internal::Type::Converter.coerce(
+            Telnyx::Internal::CloudfsCursorPagination::Meta,
+            meta
+          )
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Telnyx::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+
+      class Meta < Telnyx::Internal::Type::BaseModel
+        # @!attribute cursors
+        #
+        #   @return [Meta::Cursors, nil]
+        optional :cursors, -> { Meta::Cursors }
+
+        # @!method initialize(cursors: nil)
+        #   @param cursors [Meta::Cursors]
+
+        # @see Meta#cursors
+        class Cursors < Telnyx::Internal::Type::BaseModel
+          # @!attribute after
+          #
+          #   @return [String, nil]
+          optional :after, String
+
+          # @!method initialize(after: nil)
+          #   @param after [String]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/internal/email_bracket_cursor_pagination.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if email_bracket_cursor_pagination.has_next?
+    #     email_bracket_cursor_pagination = email_bracket_cursor_pagination.next_page
+    #   end
+    #
+    # @example
+    #   email_bracket_cursor_pagination.auto_paging_each do |draft|
+    #     puts(draft)
+    #   end
+    class EmailBracketCursorPagination
+      include Telnyx::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :data
+
+      # @return [Meta]
+      attr_accessor :meta
+
+      # @return [Boolean]
+      def next_page?
+        !data.to_a.empty? && !meta&.page_cursor.to_s.empty?
+      end
+
+      # @raise [Telnyx::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Telnyx::Internal::Util.deep_merge(@req, {query: {"page[after]": meta&.page_cursor}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.data&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Array => data}
+          @data = data.map { Telnyx::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        case page_data
+        in {meta: Hash | nil => meta}
+          @meta =
+            Telnyx::Internal::Type::Converter.coerce(
+              Telnyx::Internal::EmailBracketCursorPagination::Meta,
+              meta
+            )
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Telnyx::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+
+      class Meta < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_cursor
+        #
+        #   @return [String, nil]
+        optional :page_cursor, String
+
+        # @!method initialize(page_cursor: nil)
+        #   @param page_cursor [String]
+      end
+    end
+  end
+end

data/lib/telnyx/internal/email_cursor_pagination.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if email_cursor_pagination.has_next?
+    #     email_cursor_pagination = email_cursor_pagination.next_page
+    #   end
+    #
+    # @example
+    #   email_cursor_pagination.auto_paging_each do |email_event|
+    #     puts(email_event)
+    #   end
+    class EmailCursorPagination
+      include Telnyx::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :data
+
+      # @return [Meta]
+      attr_accessor :meta
+
+      # @return [Boolean]
+      def next_page?
+        !data.to_a.empty? && !meta&.page_cursor.to_s.empty?
+      end
+
+      # @raise [Telnyx::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Telnyx::Internal::Util.deep_merge(@req, {query: {page_cursor: meta&.page_cursor}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.data&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Array => data}
+          @data = data.map { Telnyx::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        case page_data
+        in {meta: Hash | nil => meta}
+          @meta = Telnyx::Internal::Type::Converter.coerce(
+            Telnyx::Internal::EmailCursorPagination::Meta,
+            meta
+          )
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Telnyx::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+
+      class Meta < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_cursor
+        #
+        #   @return [String, nil]
+        optional :page_cursor, String
+
+        # @!method initialize(page_cursor: nil)
+        #   @param page_cursor [String]
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/assistant_clone_params.rb

@@ -13,8 +13,14 @@ module Telnyx
         #   @return [String]
         required :assistant_id, String
 
-        # @!method initialize(assistant_id:, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(assistant_id:, idempotency_key: nil, request_options: {})
         #   @param assistant_id [String]
+        #   @param idempotency_key [String]
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/telnyx/models/ai/assistant_create_params.rb

@@ -211,7 +211,12 @@ module Telnyx
         #   @return [Telnyx::Models::AI::WidgetSettings, nil]
         optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
 
-        # @!method initialize(instructions:, name:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(instructions:, name:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, idempotency_key: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::AssistantCreateParams} for more details.
         #
@@ -271,6 +276,8 @@ module Telnyx
         #
         #   @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
         #
+        #   @param idempotency_key [String]
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/telnyx/models/ai/assistant_imports_params.rb

@@ -29,7 +29,12 @@ module Telnyx
         #   @return [Array<String>, nil]
         optional :import_ids, Telnyx::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(api_key_ref:, provider:, import_ids: nil, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(api_key_ref:, provider:, import_ids: nil, idempotency_key: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::AssistantImportsParams} for more details.
         #
@@ -39,6 +44,8 @@ module Telnyx
         #
         #   @param import_ids [Array<String>] Optional list of assistant IDs to import from the external provider. If not prov
         #
+        #   @param idempotency_key [String]
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
         # The external provider to import assistants from.

data/lib/telnyx/models/ai/assistant_send_sms_params.rb

@@ -39,13 +39,19 @@ module Telnyx
         #   @return [String, nil]
         optional :text, String
 
-        # @!method initialize(assistant_id:, from:, to:, conversation_metadata: nil, should_create_conversation: nil, text: nil, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(assistant_id:, from:, to:, conversation_metadata: nil, should_create_conversation: nil, text: nil, idempotency_key: nil, request_options: {})
         #   @param assistant_id [String]
         #   @param from [String]
         #   @param to [String]
         #   @param conversation_metadata [Hash{Symbol=>String, Integer, Boolean}]
         #   @param should_create_conversation [Boolean]
         #   @param text [String]
+        #   @param idempotency_key [String]
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
         module ConversationMetadata

data/lib/telnyx/models/ai/assistants/canary_deploy_create_params.rb

@@ -14,8 +14,14 @@ module Telnyx
           #   @return [String]
           required :assistant_id, String
 
-          # @!method initialize(assistant_id:, request_options: {})
+          # @!attribute idempotency_key
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String
+
+          # @!method initialize(assistant_id:, idempotency_key: nil, request_options: {})
           #   @param assistant_id [String]
+          #   @param idempotency_key [String]
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/telnyx/models/ai/assistants/scheduled_event_create_params.rb

@@ -78,7 +78,12 @@ module Telnyx
           #   @return [String, nil]
           optional :text, String
 
-          # @!method initialize(assistant_id:, scheduled_at_fixed_datetime:, telnyx_agent_target:, telnyx_conversation_channel:, telnyx_end_user_target:, call_settings: nil, conversation_metadata: nil, dynamic_variables: nil, max_retries_client_errors: nil, retry_interval_secs: nil, text: nil, request_options: {})
+          # @!attribute idempotency_key
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String
+
+          # @!method initialize(assistant_id:, scheduled_at_fixed_datetime:, telnyx_agent_target:, telnyx_conversation_channel:, telnyx_end_user_target:, call_settings: nil, conversation_metadata: nil, dynamic_variables: nil, max_retries_client_errors: nil, retry_interval_secs: nil, text: nil, idempotency_key: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::AI::Assistants::ScheduledEventCreateParams} for more details.
           #
@@ -104,6 +109,8 @@ module Telnyx
           #
           #   @param text [String] Required for sms scheduled events. The text to be sent to the end user.
           #
+          #   @param idempotency_key [String]
+          #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
           module ConversationMetadata

data/lib/telnyx/models/ai/assistants/test_create_params.rb

@@ -65,7 +65,12 @@ module Telnyx
           #   @return [String, nil]
           optional :test_suite, String
 
-          # @!method initialize(destination:, instructions:, name:, rubric:, description: nil, max_duration_seconds: nil, telnyx_conversation_channel: nil, test_suite: nil, request_options: {})
+          # @!attribute idempotency_key
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String
+
+          # @!method initialize(destination:, instructions:, name:, rubric:, description: nil, max_duration_seconds: nil, telnyx_conversation_channel: nil, test_suite: nil, idempotency_key: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::AI::Assistants::TestCreateParams} for more details.
           #
@@ -85,6 +90,8 @@ module Telnyx
           #
           #   @param test_suite [String] Optional test suite name to group related tests together. Useful for organizing
           #
+          #   @param idempotency_key [String]
+          #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
           class Rubric < Telnyx::Internal::Type::BaseModel

data/lib/telnyx/models/ai/assistants/tests/run_trigger_params.rb

@@ -23,7 +23,12 @@ module Telnyx
             #   @return [String, nil]
             optional :destination_version_id, String
 
-            # @!method initialize(test_id:, destination_version_id: nil, request_options: {})
+            # @!attribute idempotency_key
+            #
+            #   @return [String, nil]
+            optional :idempotency_key, String
+
+            # @!method initialize(test_id:, destination_version_id: nil, idempotency_key: nil, request_options: {})
             #   Some parameter documentations has been truncated, see
             #   {Telnyx::Models::AI::Assistants::Tests::RunTriggerParams} for more details.
             #
@@ -31,6 +36,8 @@ module Telnyx
             #
             #   @param destination_version_id [String] Optional assistant version ID to use for this test run. If provided, the version
             #
+            #   @param idempotency_key [String]
+            #
             #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
           end
         end

data/lib/telnyx/models/ai/assistants/tests/test_suites/run_trigger_params.rb

@@ -24,7 +24,12 @@ module Telnyx
               #   @return [String, nil]
               optional :destination_version_id, String
 
-              # @!method initialize(suite_name:, destination_version_id: nil, request_options: {})
+              # @!attribute idempotency_key
+              #
+              #   @return [String, nil]
+              optional :idempotency_key, String
+
+              # @!method initialize(suite_name:, destination_version_id: nil, idempotency_key: nil, request_options: {})
               #   Some parameter documentations has been truncated, see
               #   {Telnyx::Models::AI::Assistants::Tests::TestSuites::RunTriggerParams} for more
               #   details.
@@ -33,6 +38,8 @@ module Telnyx
               #
               #   @param destination_version_id [String] Optional assistant version ID to use for all test runs in this suite. If provide
               #
+              #   @param idempotency_key [String]
+              #
               #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
             end
           end