telnyx 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b014a21b8d1c242d92ea5800d88a7d3ea0cc02bc7c1ed30372ce09fd2519a6e4
-  data.tar.gz: d61f21934afc98933044cbcb88383c29ab6069823f8dae8245372e6c4fc3b14c
+  metadata.gz: 85cb31e5cfbcd5e221323cf54bf99c6d862cbe715d453c04e7f925932efc7895
+  data.tar.gz: c3b349895a2aa5b05f72e63f60bfcc2d6053dbf0646654d2e5564ca705a1c165
 SHA512:
-  metadata.gz: 98eee4d0f19c56951b57f7f37c74b6adb912f5e4193396e8b32c33e31feade3fc637967fa988dcfa731851fc3745422b872b953b20b42d0c42378c4209d5a2b5
-  data.tar.gz: 15d7a5baefa69caa266a7921fd5ec4e948fa5a170b1a849dcc6a11b4ea2071337dfb591b6972cc9e192649540d5725bbe8e80c7fbe403325f6fe98382aa6ef9e
+  metadata.gz: ddfc2337669e3cf01bef562beba5014b4bdb6361e4841d8b6a0fb5b00511735dfa42d8868b94f3b8782a9720e5e670a5bfba275be2dfbbb9c74da2907eafb9a2
+  data.tar.gz: 11b4292b6e8c44f4e19d31ad3ceb0147d47edadddbbefa3665a20da72d0f1cec0a8a656626b5f98e7435b5c4317d406175cbd688bb0606e3fb459b519e6c22ba

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 4.4.0 (2025-10-27)
+
+Full Changelog: [v4.3.0...v4.4.0](https://github.com/team-telnyx/telnyx-ruby/compare/v4.3.0...v4.4.0)
+
+### Features
+
+* **api:** add method to upload JSON documents ([56c70d5](https://github.com/team-telnyx/telnyx-ruby/commit/56c70d5c38b93891f7f74c5e6db6db0d852030d7))
+* **api:** added webhook public key ([a37fe4c](https://github.com/team-telnyx/telnyx-ruby/commit/a37fe4c90b7e01a8991361f68c4fbefa9f17befd))
+* **api:** manual updates ([df6f135](https://github.com/team-telnyx/telnyx-ruby/commit/df6f1352160d21406056e85f6eaab8bc0f8cc3b8))
+* define more models ([a923e21](https://github.com/team-telnyx/telnyx-ruby/commit/a923e2121ff330f9bd2d837cc3a8fc3915498ccd))
+* handle thread interrupts in the core HTTP client ([6596282](https://github.com/team-telnyx/telnyx-ruby/commit/65962822840d249b535d9d9dea22349a892b7eef))
+
+
+### Documentation
+
+* update gemspec summary and description ([#1](https://github.com/team-telnyx/telnyx-ruby/issues/1)) ([75eba51](https://github.com/team-telnyx/telnyx-ruby/commit/75eba51e13d138690c5a8a5948d14d80cfe7d843))
+
 ## 4.3.0 (2025-10-16)
 
 Full Changelog: [v4.2.0...v4.3.0](https://github.com/team-telnyx/telnyx-ruby/compare/v4.2.0...v4.3.0)

data/README.md

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

data/lib/telnyx/client.rb

@@ -18,6 +18,9 @@ module Telnyx
     # @return [String]
     attr_reader :api_key
 
+    # @return [String, nil]
+    attr_reader :public_key
+
     # @return [Telnyx::Resources::Legacy]
     attr_reader :legacy
 
@@ -495,6 +498,8 @@ module Telnyx
     #
     # @param api_key [String, nil] Defaults to `ENV["TELNYX_API_KEY"]`
     #
+    # @param public_key [String, nil] Defaults to `ENV["TELNYX_PUBLIC_KEY"]`
+    #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["TELNYX_BASE_URL"]`
     #
@@ -507,6 +512,7 @@ module Telnyx
     # @param max_retry_delay [Float]
     def initialize(
       api_key: ENV["TELNYX_API_KEY"],
+      public_key: ENV["TELNYX_PUBLIC_KEY"],
       base_url: ENV["TELNYX_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
@@ -522,6 +528,7 @@ module Telnyx
       end
 
       @api_key = api_key.to_s
+      @public_key = public_key&.to_s
 
       super(
         base_url: base_url,

data/lib/telnyx/internal/transport/pooled_net_requester.rb

@@ -128,40 +128,48 @@ module Telnyx
           url, deadline = request.fetch_values(:url, :deadline)
 
           req = nil
-          eof = false
           finished = false
-          closing = nil
 
           # rubocop:disable Metrics/BlockLength
           enum = Enumerator.new do |y|
             next if finished
 
             with_pool(url, deadline: deadline) do |conn|
-              req, closing = self.class.build_request(request) do
-                self.class.calibrate_socket_timeout(conn, deadline)
-              end
-
-              self.class.calibrate_socket_timeout(conn, deadline)
-              unless conn.started?
-                conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
-                conn.start
-              end
+              eof = false
+              closing = nil
+              ::Thread.handle_interrupt(Object => :never) do
+                ::Thread.handle_interrupt(Object => :immediate) do
+                  req, closing = self.class.build_request(request) do
+                    self.class.calibrate_socket_timeout(conn, deadline)
+                  end
 
-              self.class.calibrate_socket_timeout(conn, deadline)
-              conn.request(req) do |rsp|
-                y << [req, rsp]
-                break if finished
-
-                rsp.read_body do |bytes|
-                  y << bytes.force_encoding(Encoding::BINARY)
-                  break if finished
+                  self.class.calibrate_socket_timeout(conn, deadline)
+                  unless conn.started?
+                    conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+                    conn.start
+                  end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
+                  conn.request(req) do |rsp|
+                    y << [req, rsp]
+                    break if finished
+
+                    rsp.read_body do |bytes|
+                      y << bytes.force_encoding(Encoding::BINARY)
+                      break if finished
+
+                      self.class.calibrate_socket_timeout(conn, deadline)
+                    end
+                    eof = true
+                  end
+                end
+              ensure
+                begin
+                  conn.finish if !eof && conn&.started?
+                ensure
+                  closing&.call
                 end
-                eof = true
               end
-            ensure
-              conn.finish if !eof && conn&.started?
             end
           rescue Timeout::Error
             raise Telnyx::Errors::APITimeoutError.new(url: url, request: req)
@@ -174,8 +182,6 @@ module Telnyx
           body = Telnyx::Internal::Util.fused_enum(enum, external: true) do
             finished = true
             loop { enum.next }
-          ensure
-            closing&.call
           end
           [Integer(response.code), response, body]
         end

data/lib/telnyx/internal/type/union.rb

@@ -6,16 +6,16 @@ module Telnyx
       # @api private
       #
       # @example
-      #   # `unwrap_webhook_event` is a `Telnyx::UnwrapWebhookEvent`
-      #   case unwrap_webhook_event
+      #   # `unsafe_unwrap_webhook_event` is a `Telnyx::UnsafeUnwrapWebhookEvent`
+      #   case unsafe_unwrap_webhook_event
       #   when Telnyx::CallAIGatherEndedWebhookEvent
-      #     puts(unwrap_webhook_event.data)
+      #     puts(unsafe_unwrap_webhook_event.data)
       #   when Telnyx::CallAIGatherMessageHistoryUpdatedWebhookEvent
-      #     puts(unwrap_webhook_event.data)
+      #     puts(unsafe_unwrap_webhook_event.data)
       #   when Telnyx::CallAIGatherPartialResultsWebhookEvent
-      #     puts(unwrap_webhook_event.data)
+      #     puts(unsafe_unwrap_webhook_event.data)
       #   else
-      #     puts(unwrap_webhook_event)
+      #     puts(unsafe_unwrap_webhook_event)
       #   end
       module Union
         include Telnyx::Internal::Type::Converter

data/lib/telnyx/models/access_ip_address_list_response.rb

@@ -11,41 +11,12 @@ module Telnyx
 
       # @!attribute meta
       #
-      #   @return [Telnyx::Models::AccessIPAddressListResponse::Meta]
-      required :meta, -> { Telnyx::Models::AccessIPAddressListResponse::Meta }
+      #   @return [Telnyx::Models::PaginationMetaCloudflareIPListSync]
+      required :meta, -> { Telnyx::PaginationMetaCloudflareIPListSync }
 
       # @!method initialize(data:, meta:)
       #   @param data [Array<Telnyx::Models::AccessIPAddressResponse>]
-      #   @param meta [Telnyx::Models::AccessIPAddressListResponse::Meta]
-
-      # @see Telnyx::Models::AccessIPAddressListResponse#meta
-      class Meta < Telnyx::Internal::Type::BaseModel
-        # @!attribute page_number
-        #
-        #   @return [Integer]
-        required :page_number, Integer
-
-        # @!attribute page_size
-        #
-        #   @return [Integer]
-        required :page_size, Integer
-
-        # @!attribute total_pages
-        #
-        #   @return [Integer]
-        required :total_pages, Integer
-
-        # @!attribute total_results
-        #
-        #   @return [Integer]
-        required :total_results, Integer
-
-        # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
-        #   @param page_number [Integer]
-        #   @param page_size [Integer]
-        #   @param total_pages [Integer]
-        #   @param total_results [Integer]
-      end
+      #   @param meta [Telnyx::Models::PaginationMetaCloudflareIPListSync]
     end
   end
 end

data/lib/telnyx/models/access_ip_range_list_response.rb

@@ -11,41 +11,12 @@ module Telnyx
 
       # @!attribute meta
       #
-      #   @return [Telnyx::Models::AccessIPRangeListResponse::Meta]
-      required :meta, -> { Telnyx::Models::AccessIPRangeListResponse::Meta }
+      #   @return [Telnyx::Models::PaginationMetaCloudflareIPListSync]
+      required :meta, -> { Telnyx::PaginationMetaCloudflareIPListSync }
 
       # @!method initialize(data:, meta:)
       #   @param data [Array<Telnyx::Models::AccessIPRange>]
-      #   @param meta [Telnyx::Models::AccessIPRangeListResponse::Meta]
-
-      # @see Telnyx::Models::AccessIPRangeListResponse#meta
-      class Meta < Telnyx::Internal::Type::BaseModel
-        # @!attribute page_number
-        #
-        #   @return [Integer]
-        required :page_number, Integer
-
-        # @!attribute page_size
-        #
-        #   @return [Integer]
-        required :page_size, Integer
-
-        # @!attribute total_pages
-        #
-        #   @return [Integer]
-        required :total_pages, Integer
-
-        # @!attribute total_results
-        #
-        #   @return [Integer]
-        required :total_results, Integer
-
-        # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
-        #   @param page_number [Integer]
-        #   @param page_size [Integer]
-        #   @param total_pages [Integer]
-        #   @param total_results [Integer]
-      end
+      #   @param meta [Telnyx::Models::PaginationMetaCloudflareIPListSync]
     end
   end
 end

data/lib/telnyx/models/advanced_order.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class AdvancedOrder < Telnyx::Internal::Type::BaseModel
+      # @!attribute area_code
+      #
+      #   @return [String, nil]
+      optional :area_code, String
+
+      # @!attribute comments
+      #
+      #   @return [String, nil]
+      optional :comments, String
+
+      # @!attribute country_code
+      #
+      #   @return [String, nil]
+      optional :country_code, String
+
+      # @!attribute customer_reference
+      #
+      #   @return [String, nil]
+      optional :customer_reference, String
+
+      # @!attribute features
+      #
+      #   @return [Array<Symbol, Telnyx::Models::AdvancedOrder::Feature>, nil]
+      optional :features, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AdvancedOrder::Feature] }
+
+      # @!attribute phone_number_type
+      #
+      #   @return [Symbol, Telnyx::Models::AdvancedOrder::PhoneNumberType, nil]
+      optional :phone_number_type, enum: -> { Telnyx::AdvancedOrder::PhoneNumberType }
+
+      # @!attribute quantity
+      #
+      #   @return [Integer, nil]
+      optional :quantity, Integer
+
+      # @!attribute requirement_group_id
+      #   The ID of the requirement group to associate with this advanced order
+      #
+      #   @return [String, nil]
+      optional :requirement_group_id, String
+
+      # @!method initialize(area_code: nil, comments: nil, country_code: nil, customer_reference: nil, features: nil, phone_number_type: nil, quantity: nil, requirement_group_id: nil)
+      #   @param area_code [String]
+      #
+      #   @param comments [String]
+      #
+      #   @param country_code [String]
+      #
+      #   @param customer_reference [String]
+      #
+      #   @param features [Array<Symbol, Telnyx::Models::AdvancedOrder::Feature>]
+      #
+      #   @param phone_number_type [Symbol, Telnyx::Models::AdvancedOrder::PhoneNumberType]
+      #
+      #   @param quantity [Integer]
+      #
+      #   @param requirement_group_id [String] The ID of the requirement group to associate with this advanced order
+
+      module Feature
+        extend Telnyx::Internal::Type::Enum
+
+        SMS = :sms
+        MMS = :mms
+        VOICE = :voice
+        FAX = :fax
+        EMERGENCY = :emergency
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::AdvancedOrder#phone_number_type
+      module PhoneNumberType
+        extend Telnyx::Internal::Type::Enum
+
+        LOCAL = :local
+        MOBILE = :mobile
+        TOLL_FREE = :toll_free
+        SHARED_COST = :shared_cost
+        NATIONAL = :national
+        LANDLINE = :landline
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/advanced_order_create_params.rb

@@ -3,97 +3,12 @@
 module Telnyx
   module Models
     # @see Telnyx::Resources::AdvancedOrders#create
-    class AdvancedOrderCreateParams < Telnyx::Internal::Type::BaseModel
+    class AdvancedOrderCreateParams < Telnyx::Models::AdvancedOrder
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      # @!attribute area_code
-      #
-      #   @return [String, nil]
-      optional :area_code, String
-
-      # @!attribute comments
-      #
-      #   @return [String, nil]
-      optional :comments, String
-
-      # @!attribute country_code
-      #
-      #   @return [String, nil]
-      optional :country_code, String
-
-      # @!attribute customer_reference
-      #
-      #   @return [String, nil]
-      optional :customer_reference, String
-
-      # @!attribute features
-      #
-      #   @return [Array<Symbol, Telnyx::Models::AdvancedOrderCreateParams::Feature>, nil]
-      optional :features,
-               -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AdvancedOrderCreateParams::Feature] }
-
-      # @!attribute phone_number_type
-      #
-      #   @return [Symbol, Telnyx::Models::AdvancedOrderCreateParams::PhoneNumberType, nil]
-      optional :phone_number_type, enum: -> { Telnyx::AdvancedOrderCreateParams::PhoneNumberType }
-
-      # @!attribute quantity
-      #
-      #   @return [Integer, nil]
-      optional :quantity, Integer
-
-      # @!attribute requirement_group_id
-      #   The ID of the requirement group to associate with this advanced order
-      #
-      #   @return [String, nil]
-      optional :requirement_group_id, String
-
-      # @!method initialize(area_code: nil, comments: nil, country_code: nil, customer_reference: nil, features: nil, phone_number_type: nil, quantity: nil, requirement_group_id: nil, request_options: {})
-      #   @param area_code [String]
-      #
-      #   @param comments [String]
-      #
-      #   @param country_code [String]
-      #
-      #   @param customer_reference [String]
-      #
-      #   @param features [Array<Symbol, Telnyx::Models::AdvancedOrderCreateParams::Feature>]
-      #
-      #   @param phone_number_type [Symbol, Telnyx::Models::AdvancedOrderCreateParams::PhoneNumberType]
-      #
-      #   @param quantity [Integer]
-      #
-      #   @param requirement_group_id [String] The ID of the requirement group to associate with this advanced order
-      #
+      # @!method initialize(request_options: {})
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-
-      module Feature
-        extend Telnyx::Internal::Type::Enum
-
-        SMS = :sms
-        MMS = :mms
-        VOICE = :voice
-        FAX = :fax
-        EMERGENCY = :emergency
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      module PhoneNumberType
-        extend Telnyx::Internal::Type::Enum
-
-        LOCAL = :local
-        MOBILE = :mobile
-        TOLL_FREE = :toll_free
-        SHARED_COST = :shared_cost
-        NATIONAL = :national
-        LANDLINE = :landline
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/telnyx/models/advanced_order_update_requirement_group_params.rb

@@ -3,98 +3,12 @@
 module Telnyx
   module Models
     # @see Telnyx::Resources::AdvancedOrders#update_requirement_group
-    class AdvancedOrderUpdateRequirementGroupParams < Telnyx::Internal::Type::BaseModel
+    class AdvancedOrderUpdateRequirementGroupParams < Telnyx::Models::AdvancedOrder
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      # @!attribute area_code
-      #
-      #   @return [String, nil]
-      optional :area_code, String
-
-      # @!attribute comments
-      #
-      #   @return [String, nil]
-      optional :comments, String
-
-      # @!attribute country_code
-      #
-      #   @return [String, nil]
-      optional :country_code, String
-
-      # @!attribute customer_reference
-      #
-      #   @return [String, nil]
-      optional :customer_reference, String
-
-      # @!attribute features
-      #
-      #   @return [Array<Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::Feature>, nil]
-      optional :features,
-               -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AdvancedOrderUpdateRequirementGroupParams::Feature] }
-
-      # @!attribute phone_number_type
-      #
-      #   @return [Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::PhoneNumberType, nil]
-      optional :phone_number_type,
-               enum: -> { Telnyx::AdvancedOrderUpdateRequirementGroupParams::PhoneNumberType }
-
-      # @!attribute quantity
-      #
-      #   @return [Integer, nil]
-      optional :quantity, Integer
-
-      # @!attribute requirement_group_id
-      #   The ID of the requirement group to associate with this advanced order
-      #
-      #   @return [String, nil]
-      optional :requirement_group_id, String
-
-      # @!method initialize(area_code: nil, comments: nil, country_code: nil, customer_reference: nil, features: nil, phone_number_type: nil, quantity: nil, requirement_group_id: nil, request_options: {})
-      #   @param area_code [String]
-      #
-      #   @param comments [String]
-      #
-      #   @param country_code [String]
-      #
-      #   @param customer_reference [String]
-      #
-      #   @param features [Array<Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::Feature>]
-      #
-      #   @param phone_number_type [Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::PhoneNumberType]
-      #
-      #   @param quantity [Integer]
-      #
-      #   @param requirement_group_id [String] The ID of the requirement group to associate with this advanced order
-      #
+      # @!method initialize(request_options: {})
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-
-      module Feature
-        extend Telnyx::Internal::Type::Enum
-
-        SMS = :sms
-        MMS = :mms
-        VOICE = :voice
-        FAX = :fax
-        EMERGENCY = :emergency
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      module PhoneNumberType
-        extend Telnyx::Internal::Type::Enum
-
-        LOCAL = :local
-        MOBILE = :mobile
-        TOLL_FREE = :toll_free
-        SHARED_COST = :shared_cost
-        NATIONAL = :national
-        LANDLINE = :landline
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end