telnyx 5.171.0 → 5.174.0

data/lib/telnyx/models/credential_connection_create_params.rb

@@ -47,6 +47,18 @@ module Telnyx
       #   @return [String, nil]
       optional :android_push_credential_id, String, nil?: true
 
+      # @!attribute bridge_generate_comfort_noise_on_cn
+      #   Stores the connection preference for generating silent RTP toward the opposite
+      #   call leg when comfort-noise packets (CN, payload type 13) are received during
+      #   hold. Optional; defaults to false when omitted on creation. Only JSON true and
+      #   false are accepted; null and non-boolean values are rejected. This preference is
+      #   independent of default_on_hold_comfort_noise_enabled and does not modify that
+      #   setting. This API provisions the preference; call-processing behavior is
+      #   implemented separately.
+      #
+      #   @return [Boolean, nil]
+      optional :bridge_generate_comfort_noise_on_cn, Telnyx::Internal::Type::Boolean
+
       # @!attribute call_cost_in_webhooks
       #   Specifies if call cost webhooks should be sent for this connection.
       #
@@ -76,8 +88,8 @@ module Telnyx
       optional :encode_contact_header_enabled, Telnyx::Internal::Type::Boolean
 
       # @!attribute encrypted_media
-      #   Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-      #   TLS.
+      #   Enable use of SRTP for encryption. Can only be set when the SIP signaling
+      #   transport protocol is TLS.
       #
       #   @return [Symbol, Telnyx::Models::EncryptedMedia, nil]
       optional :encrypted_media, enum: -> { Telnyx::EncryptedMedia }, nil?: true
@@ -184,7 +196,7 @@ module Telnyx
       #   @return [Integer, nil]
       optional :webhook_timeout_secs, Integer, nil?: true
 
-      # @!method initialize(connection_name:, password:, user_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @!method initialize(connection_name:, password:, user_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::CredentialConnectionCreateParams} for more details.
       #
@@ -200,6 +212,8 @@ module Telnyx
       #
       #   @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      #   @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       #   @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       #   @param default_on_hold_comfort_noise_enabled [Boolean] When enabled, Telnyx will generate comfort noise when you place the call on hold
@@ -208,7 +222,7 @@ module Telnyx
       #
       #   @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       #   @param inbound [Telnyx::Models::CredentialInbound]
       #

data/lib/telnyx/models/credential_connection_update_params.rb

@@ -32,6 +32,18 @@ module Telnyx
       #   @return [String, nil]
       optional :android_push_credential_id, String, nil?: true
 
+      # @!attribute bridge_generate_comfort_noise_on_cn
+      #   Stores the connection preference for generating silent RTP toward the opposite
+      #   call leg when comfort-noise packets (CN, payload type 13) are received during
+      #   hold. Optional; omitting this field preserves the saved value. Only JSON true
+      #   and false are accepted; null and non-boolean values are rejected. This
+      #   preference is independent of default_on_hold_comfort_noise_enabled and does not
+      #   modify that setting. This API provisions the preference; call-processing
+      #   behavior is implemented separately.
+      #
+      #   @return [Boolean, nil]
+      optional :bridge_generate_comfort_noise_on_cn, Telnyx::Internal::Type::Boolean
+
       # @!attribute call_cost_in_webhooks
       #   Specifies if call cost webhooks should be sent for this connection.
       #
@@ -75,8 +87,8 @@ module Telnyx
       optional :encode_contact_header_enabled, Telnyx::Internal::Type::Boolean
 
       # @!attribute encrypted_media
-      #   Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-      #   TLS.
+      #   Enable use of SRTP for encryption. Can only be set when the SIP signaling
+      #   transport protocol is TLS.
       #
       #   @return [Symbol, Telnyx::Models::EncryptedMedia, nil]
       optional :encrypted_media, enum: -> { Telnyx::EncryptedMedia }, nil?: true
@@ -195,7 +207,7 @@ module Telnyx
       #   @return [Integer, nil]
       optional :webhook_timeout_secs, Integer, nil?: true
 
-      # @!method initialize(id:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @!method initialize(id:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::CredentialConnectionUpdateParams} for more details.
       #
@@ -207,6 +219,8 @@ module Telnyx
       #
       #   @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      #   @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       #   @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       #   @param connection_name [String] A user-assigned name to help manage the connection.
@@ -219,7 +233,7 @@ module Telnyx
       #
       #   @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       #   @param inbound [Telnyx::Models::CredentialInbound]
       #

data/lib/telnyx/models/dial_metric_list_params.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::DialMetrics#list
+    class DialMetricListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute end_time
+      #   Exclusive end of the range, ISO 8601. Must be after `start_time`. Buckets that
+      #   start before this time are returned.
+      #
+      #   @return [Time]
+      required :end_time, Time
+
+      # @!attribute granularity
+      #   Bucket size. `second` returns 5-second buckets (the finest resolution) and is
+      #   kept for the last 48 hours. `minute` and `hour` are kept for the last 30 days.
+      #
+      #   @return [Symbol, Telnyx::Models::DialMetricListParams::Granularity]
+      required :granularity, enum: -> { Telnyx::DialMetricListParams::Granularity }
+
+      # @!attribute start_time
+      #   Inclusive start of the range, ISO 8601 (for example `2026-09-29T12:00:00.000Z`).
+      #   Buckets that start at or after this time are returned. A `start_time` older than
+      #   the retention window of the chosen `granularity` is moved forward to the start
+      #   of that window, and `meta.start_time` returns the start actually used.
+      #
+      #   @return [Time]
+      required :start_time, Time
+
+      # @!attribute page_after
+      #   Opaque cursor from `meta.cursors.after` of the previous page. Do not parse or
+      #   construct it. A cursor that matches no records returns an empty page whose
+      #   `meta.cursors.after` and `meta.cursors.before` both echo the given cursor.
+      #
+      #   @return [String, nil]
+      optional :page_after, String
+
+      # @!attribute page_limit
+      #   Maximum number of buckets per page. Values outside the range are clamped to
+      #   1-10,000.
+      #
+      #   @return [Integer, nil]
+      optional :page_limit, Integer
+
+      # @!attribute sort
+      #   Sort order of the buckets by `start_time`. `-start_time` (default) returns the
+      #   newest first, `start_time` the oldest first. `region` follows the same direction
+      #   for buckets with the same `start_time`. To read the live rate, use
+      #   `granularity=second` and `sort=-start_time`, then take the first record of each
+      #   `region`.
+      #
+      #   @return [Symbol, Telnyx::Models::DialMetricListParams::Sort, nil]
+      optional :sort, enum: -> { Telnyx::DialMetricListParams::Sort }
+
+      # @!method initialize(end_time:, granularity:, start_time:, page_after: nil, page_limit: nil, sort: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::DialMetricListParams} for more details.
+      #
+      #   @param end_time [Time] Exclusive end of the range, ISO 8601. Must be after `start_time`. Buckets that s
+      #
+      #   @param granularity [Symbol, Telnyx::Models::DialMetricListParams::Granularity] Bucket size. `second` returns 5-second buckets (the finest resolution) and is ke
+      #
+      #   @param start_time [Time] Inclusive start of the range, ISO 8601 (for example `2026-09-29T12:00:00.000Z`).
+      #
+      #   @param page_after [String] Opaque cursor from `meta.cursors.after` of the previous page. Do not parse or co
+      #
+      #   @param page_limit [Integer] Maximum number of buckets per page. Values outside the range are clamped to 1-10
+      #
+      #   @param sort [Symbol, Telnyx::Models::DialMetricListParams::Sort] Sort order of the buckets by `start_time`. `-start_time` (default) returns the n
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Bucket size. `second` returns 5-second buckets (the finest resolution) and is
+      # kept for the last 48 hours. `minute` and `hour` are kept for the last 30 days.
+      module Granularity
+        extend Telnyx::Internal::Type::Enum
+
+        SECOND = :second
+        MINUTE = :minute
+        HOUR = :hour
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Sort order of the buckets by `start_time`. `-start_time` (default) returns the
+      # newest first, `start_time` the oldest first. `region` follows the same direction
+      # for buckets with the same `start_time`. To read the live rate, use
+      # `granularity=second` and `sort=-start_time`, then take the first record of each
+      # `region`.
+      module Sort
+        extend Telnyx::Internal::Type::Enum
+
+        MINUS_START_TIME = :"-start_time"
+        START_TIME = :start_time
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/dial_metric_list_response.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::DialMetrics#list
+    class DialMetricListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute average_dps
+      #   `dials.total` divided by the bucket duration in seconds, rounded to 4 decimal
+      #   places. Counts every dial attempt, rejected ones included.
+      #
+      #   @return [Float, nil]
+      optional :average_dps, Float
+
+      # @!attribute dials
+      #   Dial attempt counts in the bucket.
+      #
+      #   @return [Telnyx::Models::DialMetricListResponse::Dials, nil]
+      optional :dials, -> { Telnyx::Models::DialMetricListResponse::Dials }
+
+      # @!attribute dps_limit
+      #   DPS limit in force during the busiest 5-second window, so it compares directly
+      #   with `peak_dps`. `null` means unlimited. Enforcement near the limit is
+      #   approximate; `dials.rejected.dps_limit` is the authoritative signal that the
+      #   limit was reached.
+      #
+      #   @return [Integer, nil]
+      optional :dps_limit, Integer, nil?: true
+
+      # @!attribute end_time
+      #   End of the bucket (exclusive), UTC. Five seconds, one minute or one hour after
+      #   `start_time`, depending on `granularity`.
+      #
+      #   @return [Time, nil]
+      optional :end_time, Time
+
+      # @!attribute peak_dps
+      #   Dials per second, rounded to 4 decimal places, in the busiest 5-second window of
+      #   the bucket, summed across all call-processing nodes of the region. Counts every
+      #   dial attempt, rejected ones included, so `peak_dps` above `dps_limit` is
+      #   expected when dials were rejected. For `granularity=second` it equals
+      #   `average_dps`.
+      #
+      #   @return [Float, nil]
+      optional :peak_dps, Float
+
+      # @!attribute record_type
+      #
+      #   @return [Symbol, Telnyx::Models::DialMetricListResponse::RecordType, nil]
+      optional :record_type, enum: -> { Telnyx::Models::DialMetricListResponse::RecordType }
+
+      # @!attribute region
+      #   Region where the dials were handled. Current values are `us`, `eu`, `australia`,
+      #   `middle_east`, `canada` and `india`. New values can be added, so clients must
+      #   tolerate values not listed here. Buckets of different regions are separate
+      #   records.
+      #
+      #   @return [String, nil]
+      optional :region, String
+
+      # @!attribute start_time
+      #   Start of the bucket (inclusive), UTC.
+      #
+      #   @return [Time, nil]
+      optional :start_time, Time
+
+      # @!method initialize(average_dps: nil, dials: nil, dps_limit: nil, end_time: nil, peak_dps: nil, record_type: nil, region: nil, start_time: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::DialMetricListResponse} for more details.
+      #
+      #   Dial counts and rates for one region in one time bucket. One record per region
+      #   per bucket.
+      #
+      #   @param average_dps [Float] `dials.total` divided by the bucket duration in seconds, rounded to 4 decimal pl
+      #
+      #   @param dials [Telnyx::Models::DialMetricListResponse::Dials] Dial attempt counts in the bucket.
+      #
+      #   @param dps_limit [Integer, nil] DPS limit in force during the busiest 5-second window, so it compares directly w
+      #
+      #   @param end_time [Time] End of the bucket (exclusive), UTC. Five seconds, one minute or one hour after `
+      #
+      #   @param peak_dps [Float] Dials per second, rounded to 4 decimal places, in the busiest 5-second window of
+      #
+      #   @param record_type [Symbol, Telnyx::Models::DialMetricListResponse::RecordType]
+      #
+      #   @param region [String] Region where the dials were handled. Current values are `us`, `eu`, `australia`,
+      #
+      #   @param start_time [Time] Start of the bucket (inclusive), UTC.
+
+      # @see Telnyx::Models::DialMetricListResponse#dials
+      class Dials < Telnyx::Internal::Type::BaseModel
+        # @!attribute accepted
+        #   Dial attempts that were not rejected by a limit.
+        #
+        #   @return [Integer, nil]
+        optional :accepted, Integer
+
+        # @!attribute rejected
+        #   Dial attempts rejected by a limit.
+        #
+        #   @return [Telnyx::Models::DialMetricListResponse::Dials::Rejected, nil]
+        optional :rejected, -> { Telnyx::Models::DialMetricListResponse::Dials::Rejected }
+
+        # @!attribute total
+        #   All dial attempts, rejected ones included: accepted plus every rejected count.
+        #
+        #   @return [Integer, nil]
+        optional :total, Integer
+
+        # @!method initialize(accepted: nil, rejected: nil, total: nil)
+        #   Dial attempt counts in the bucket.
+        #
+        #   @param accepted [Integer] Dial attempts that were not rejected by a limit.
+        #
+        #   @param rejected [Telnyx::Models::DialMetricListResponse::Dials::Rejected] Dial attempts rejected by a limit.
+        #
+        #   @param total [Integer] All dial attempts, rejected ones included: accepted plus every rejected count.
+
+        # @see Telnyx::Models::DialMetricListResponse::Dials#rejected
+        class Rejected < Telnyx::Internal::Type::BaseModel
+          # @!attribute daily_limit
+          #   Rejected by a daily limit.
+          #
+          #   @return [Integer, nil]
+          optional :daily_limit, Integer
+
+          # @!attribute dps_limit
+          #   Rejected by the dials-per-second limit.
+          #
+          #   @return [Integer, nil]
+          optional :dps_limit, Integer
+
+          # @!attribute hourly_limit
+          #   Rejected by an hourly limit.
+          #
+          #   @return [Integer, nil]
+          optional :hourly_limit, Integer
+
+          # @!method initialize(daily_limit: nil, dps_limit: nil, hourly_limit: nil)
+          #   Dial attempts rejected by a limit.
+          #
+          #   @param daily_limit [Integer] Rejected by a daily limit.
+          #
+          #   @param dps_limit [Integer] Rejected by the dials-per-second limit.
+          #
+          #   @param hourly_limit [Integer] Rejected by an hourly limit.
+        end
+      end
+
+      # @see Telnyx::Models::DialMetricListResponse#record_type
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        DIAL_METRIC = :dial_metric
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/document.rb

@@ -45,6 +45,7 @@ module Telnyx
         LETTER_OF_AUTHORIZATION = :letter_of_authorization
         BUSINESS_REGISTRATION = :business_registration
         ARTICLES_OF_INCORPORATION = :articles_of_incorporation
+        CERTIFICATE_OF_GOOD_STANDING = :certificate_of_good_standing
         TAX_DOCUMENT = :tax_document
         EIN_LETTER = :ein_letter
         TRADEMARK_REGISTRATION = :trademark_registration
@@ -54,6 +55,8 @@ module Telnyx
         GOVERNMENT_ID = :government_id
         UTILITY_BILL = :utility_bill
         BANK_STATEMENT = :bank_statement
+        BUSINESS_CREDIT_REPORT = :business_credit_report
+        BANK_REFERENCE_LETTER = :bank_reference_letter
         OTHER = :other
 
         # @!method self.values