telnyx 5.171.0 → 5.173.0

data/rbi/telnyx/models/pay_connector_delete_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class PayConnectorDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::PayConnectorDeleteParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(
+          name: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(name:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { name: String, request_options: Telnyx::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/pay_connector_list_params.rbi

@@ -0,0 +1,224 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class PayConnectorListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::PayConnectorListParams, Telnyx::Internal::AnyHash)
+        end
+
+      # Equal to this created_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_created_at_eq
+
+      sig { params(filter_created_at_eq: String).void }
+      attr_writer :filter_created_at_eq
+
+      # After this created_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_created_at_gt
+
+      sig { params(filter_created_at_gt: String).void }
+      attr_writer :filter_created_at_gt
+
+      # At or after this created_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_created_at_gte
+
+      sig { params(filter_created_at_gte: String).void }
+      attr_writer :filter_created_at_gte
+
+      # Before this created_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_created_at_lt
+
+      sig { params(filter_created_at_lt: String).void }
+      attr_writer :filter_created_at_lt
+
+      # At or before this created_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_created_at_lte
+
+      sig { params(filter_created_at_lte: String).void }
+      attr_writer :filter_created_at_lte
+
+      # Exact match on mode.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_mode
+
+      sig { params(filter_mode: String).void }
+      attr_writer :filter_mode
+
+      # Exact match on name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_name
+
+      sig { params(filter_name: String).void }
+      attr_writer :filter_name
+
+      # Exact match on type.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_type
+
+      sig { params(filter_type: String).void }
+      attr_writer :filter_type
+
+      # Equal to this updated_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_updated_at_eq
+
+      sig { params(filter_updated_at_eq: String).void }
+      attr_writer :filter_updated_at_eq
+
+      # After this updated_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_updated_at_gt
+
+      sig { params(filter_updated_at_gt: String).void }
+      attr_writer :filter_updated_at_gt
+
+      # At or after this updated_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_updated_at_gte
+
+      sig { params(filter_updated_at_gte: String).void }
+      attr_writer :filter_updated_at_gte
+
+      # Before this updated_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_updated_at_lt
+
+      sig { params(filter_updated_at_lt: String).void }
+      attr_writer :filter_updated_at_lt
+
+      # At or before this updated_at timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_updated_at_lte
+
+      sig { params(filter_updated_at_lte: String).void }
+      attr_writer :filter_updated_at_lte
+
+      # Opaque cursor from meta.end_cursor.
+      sig { returns(T.nilable(String)) }
+      attr_reader :page_after
+
+      sig { params(page_after: String).void }
+      attr_writer :page_after
+
+      # Opaque cursor from meta.start_cursor.
+      sig { returns(T.nilable(String)) }
+      attr_reader :page_before
+
+      sig { params(page_before: String).void }
+      attr_writer :page_before
+
+      # Number of records per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Comma-separated created_at or updated_at fields, optionally prefixed with - for
+      # descending order.
+      sig { returns(T.nilable(String)) }
+      attr_reader :sort
+
+      sig { params(sort: String).void }
+      attr_writer :sort
+
+      sig do
+        params(
+          filter_created_at_eq: String,
+          filter_created_at_gt: String,
+          filter_created_at_gte: String,
+          filter_created_at_lt: String,
+          filter_created_at_lte: String,
+          filter_mode: String,
+          filter_name: String,
+          filter_type: String,
+          filter_updated_at_eq: String,
+          filter_updated_at_gt: String,
+          filter_updated_at_gte: String,
+          filter_updated_at_lt: String,
+          filter_updated_at_lte: String,
+          page_after: String,
+          page_before: String,
+          page_size: Integer,
+          sort: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Equal to this created_at timestamp.
+        filter_created_at_eq: nil,
+        # After this created_at timestamp.
+        filter_created_at_gt: nil,
+        # At or after this created_at timestamp.
+        filter_created_at_gte: nil,
+        # Before this created_at timestamp.
+        filter_created_at_lt: nil,
+        # At or before this created_at timestamp.
+        filter_created_at_lte: nil,
+        # Exact match on mode.
+        filter_mode: nil,
+        # Exact match on name.
+        filter_name: nil,
+        # Exact match on type.
+        filter_type: nil,
+        # Equal to this updated_at timestamp.
+        filter_updated_at_eq: nil,
+        # After this updated_at timestamp.
+        filter_updated_at_gt: nil,
+        # At or after this updated_at timestamp.
+        filter_updated_at_gte: nil,
+        # Before this updated_at timestamp.
+        filter_updated_at_lt: nil,
+        # At or before this updated_at timestamp.
+        filter_updated_at_lte: nil,
+        # Opaque cursor from meta.end_cursor.
+        page_after: nil,
+        # Opaque cursor from meta.start_cursor.
+        page_before: nil,
+        # Number of records per page.
+        page_size: nil,
+        # Comma-separated created_at or updated_at fields, optionally prefixed with - for
+        # descending order.
+        sort: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            filter_created_at_eq: String,
+            filter_created_at_gt: String,
+            filter_created_at_gte: String,
+            filter_created_at_lt: String,
+            filter_created_at_lte: String,
+            filter_mode: String,
+            filter_name: String,
+            filter_type: String,
+            filter_updated_at_eq: String,
+            filter_updated_at_gt: String,
+            filter_updated_at_gte: String,
+            filter_updated_at_lt: String,
+            filter_updated_at_lte: String,
+            page_after: String,
+            page_before: String,
+            page_size: Integer,
+            sort: String,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/pay_connector_response.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class PayConnectorResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::PayConnectorResponse, Telnyx::Internal::AnyHash)
+        end
+
+      # Organization-owned connector. Examples and config properties here describe
+      # generic connectors; listing is not restricted to that type unless
+      # filter[type]=generic is supplied. Passwords and bearer tokens are omitted, not
+      # masked. Defaults for auth_type and timeout need not appear in stored config.
+      sig { returns(T.nilable(Telnyx::PayConnector)) }
+      attr_reader :data
+
+      sig { params(data: Telnyx::PayConnector::OrHash).void }
+      attr_writer :data
+
+      sig do
+        params(data: Telnyx::PayConnector::OrHash).returns(T.attached_class)
+      end
+      def self.new(
+        # Organization-owned connector. Examples and config properties here describe
+        # generic connectors; listing is not restricted to that type unless
+        # filter[type]=generic is supplied. Passwords and bearer tokens are omitted, not
+        # masked. Defaults for auth_type and timeout need not appear in stored config.
+        data: nil
+      )
+      end
+
+      sig { override.returns({ data: Telnyx::PayConnector }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/pay_connector_retrieve_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class PayConnectorRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::PayConnectorRetrieveParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(
+          name: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(name:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { name: String, request_options: Telnyx::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/pay_connector_update_params.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class PayConnectorUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::PayConnectorUpdateParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Configuration for a generic connector. A config update replaces the complete
+      # object, not individual keys. Unknown config keys are discarded. Authentication
+      # credentials must be nonblank strings when required by the selected auth_type.
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault,
+              Telnyx::GenericPayConnectorConfig::BearerAuthentication,
+              Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication
+            )
+          )
+        )
+      end
+      attr_reader :config
+
+      sig do
+        params(
+          config:
+            T.any(
+              Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::OrHash,
+              Telnyx::GenericPayConnectorConfig::BearerAuthentication::OrHash,
+              Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication::OrHash
+            )
+        ).void
+      end
+      attr_writer :config
+
+      # Omit to preserve the existing mode. Use an explicit test or live value.
+      sig do
+        returns(T.nilable(Telnyx::PayConnectorUpdateParams::Mode::OrSymbol))
+      end
+      attr_reader :mode
+
+      sig do
+        params(mode: Telnyx::PayConnectorUpdateParams::Mode::OrSymbol).void
+      end
+      attr_writer :mode
+
+      # Generic connector type. Omit to preserve the existing value.
+      sig do
+        returns(T.nilable(Telnyx::PayConnectorUpdateParams::Type::OrSymbol))
+      end
+      attr_reader :type
+
+      sig do
+        params(type: Telnyx::PayConnectorUpdateParams::Type::OrSymbol).void
+      end
+      attr_writer :type
+
+      sig do
+        params(
+          name: String,
+          config:
+            T.any(
+              Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::OrHash,
+              Telnyx::GenericPayConnectorConfig::BearerAuthentication::OrHash,
+              Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication::OrHash
+            ),
+          mode: Telnyx::PayConnectorUpdateParams::Mode::OrSymbol,
+          type: Telnyx::PayConnectorUpdateParams::Type::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        name:,
+        # Configuration for a generic connector. A config update replaces the complete
+        # object, not individual keys. Unknown config keys are discarded. Authentication
+        # credentials must be nonblank strings when required by the selected auth_type.
+        config: nil,
+        # Omit to preserve the existing mode. Use an explicit test or live value.
+        mode: nil,
+        # Generic connector type. Omit to preserve the existing value.
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            config:
+              T.any(
+                Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault,
+                Telnyx::GenericPayConnectorConfig::BearerAuthentication,
+                Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication
+              ),
+            mode: Telnyx::PayConnectorUpdateParams::Mode::OrSymbol,
+            type: Telnyx::PayConnectorUpdateParams::Type::OrSymbol,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Omit to preserve the existing mode. Use an explicit test or live value.
+      module Mode
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::PayConnectorUpdateParams::Mode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TEST =
+          T.let(:test, Telnyx::PayConnectorUpdateParams::Mode::TaggedSymbol)
+        LIVE =
+          T.let(:live, Telnyx::PayConnectorUpdateParams::Mode::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::PayConnectorUpdateParams::Mode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Generic connector type. Omit to preserve the existing value.
+      module Type
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::PayConnectorUpdateParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        GENERIC =
+          T.let(:generic, Telnyx::PayConnectorUpdateParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::PayConnectorUpdateParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/phone_numbers/csv_download_create_params.rbi

@@ -54,12 +54,25 @@ module Telnyx
         end
         attr_writer :filter
 
+        # When true, the CSV includes phone numbers from all managed accounts in addition
+        # to the requesting account's own numbers. Only applies to V2 format; ignored for
+        # V1. The export appends `user_id` and `email` columns identifying the account
+        # that owns each number. When a filter is provided, it applies to the combined set
+        # of numbers. Requires access to managed accounts; requests without that access
+        # are rejected.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_managed_accounts
+
+        sig { params(include_managed_accounts: T::Boolean).void }
+        attr_writer :include_managed_accounts
+
         sig do
           params(
             csv_format:
               Telnyx::PhoneNumbers::CsvDownloadCreateParams::CsvFormat::OrSymbol,
             filter:
               Telnyx::PhoneNumbers::CsvDownloadCreateParams::Filter::OrHash,
+            include_managed_accounts: T::Boolean,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -73,6 +86,13 @@ module Telnyx
           # filter[voice.usage_payment_method], filter[billing_group_id],
           # filter[emergency_address_id], filter[customer_reference]
           filter: nil,
+          # When true, the CSV includes phone numbers from all managed accounts in addition
+          # to the requesting account's own numbers. Only applies to V2 format; ignored for
+          # V1. The export appends `user_id` and `email` columns identifying the account
+          # that owns each number. When a filter is provided, it applies to the combined set
+          # of numbers. Requires access to managed accounts; requests without that access
+          # are rejected.
+          include_managed_accounts: nil,
           request_options: {}
         )
         end
@@ -83,6 +103,7 @@ module Telnyx
               csv_format:
                 Telnyx::PhoneNumbers::CsvDownloadCreateParams::CsvFormat::OrSymbol,
               filter: Telnyx::PhoneNumbers::CsvDownloadCreateParams::Filter,
+              include_managed_accounts: T::Boolean,
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/models/phone_numbers/job_delete_batch_response.rbi

@@ -12,22 +12,28 @@ module Telnyx
             )
           end
 
-        sig { returns(T.nilable(Telnyx::PhoneNumbers::PhoneNumbersJob)) }
+        sig { returns(T.nilable(Telnyx::PhoneNumbers::NumbersPhoneNumbersJob)) }
         attr_reader :data
 
-        sig { params(data: Telnyx::PhoneNumbers::PhoneNumbersJob::OrHash).void }
+        sig do
+          params(
+            data: Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::OrHash
+          ).void
+        end
         attr_writer :data
 
         sig do
-          params(data: Telnyx::PhoneNumbers::PhoneNumbersJob::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            data: Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(data: nil)
         end
 
         sig do
-          override.returns({ data: Telnyx::PhoneNumbers::PhoneNumbersJob })
+          override.returns(
+            { data: Telnyx::PhoneNumbers::NumbersPhoneNumbersJob }
+          )
         end
         def to_hash
         end

data/rbi/telnyx/models/phone_numbers/job_list_params.rbi

@@ -100,12 +100,15 @@ module Telnyx
               )
             end
 
-          # Returns jobs whose creation-time customer reference exactly matches the supplied
-          # value, not the current reference on a phone number. Only jobs within the lookup
-          # window (90 days by default) are returned. Supply a single non-blank string of up
-          # to 250 characters, without null characters, using
-          # `filter[customer_reference]=yourcustomerrefhere`. An invalid filter value
-          # returns HTTP 422.
+          # Exact, case-sensitive match for the customer reference supplied when the job was
+          # created. Only jobs created within the last 90 days are returned, including for
+          # accounts otherwise exempt from job retention limits. Searches the stored job
+          # reference, not the current reference on a phone number. Multiple jobs may share
+          # a reference. Combines with the other filters and account ownership. Supply a
+          # single non-blank string of up to 250 characters, without null characters, using
+          # `filter[customer_reference]=yourcustomerrefhere`. Whitespace is preserved; blank
+          # strings, arrays, and objects return HTTP 422. An invalid filter value returns
+          # HTTP 422. The literal string `null` is matched as text.
           sig { returns(T.nilable(String)) }
           attr_reader :customer_reference
 
@@ -190,12 +193,15 @@ module Telnyx
             ).returns(T.attached_class)
           end
           def self.new(
-            # Returns jobs whose creation-time customer reference exactly matches the supplied
-            # value, not the current reference on a phone number. Only jobs within the lookup
-            # window (90 days by default) are returned. Supply a single non-blank string of up
-            # to 250 characters, without null characters, using
-            # `filter[customer_reference]=yourcustomerrefhere`. An invalid filter value
-            # returns HTTP 422.
+            # Exact, case-sensitive match for the customer reference supplied when the job was
+            # created. Only jobs created within the last 90 days are returned, including for
+            # accounts otherwise exempt from job retention limits. Searches the stored job
+            # reference, not the current reference on a phone number. Multiple jobs may share
+            # a reference. Combines with the other filters and account ownership. Supply a
+            # single non-blank string of up to 250 characters, without null characters, using
+            # `filter[customer_reference]=yourcustomerrefhere`. Whitespace is preserved; blank
+            # strings, arrays, and objects return HTTP 422. An invalid filter value returns
+            # HTTP 422. The literal string `null` is matched as text.
             customer_reference: nil,
             # Returns jobs that targeted any of the supplied account-owned phone numbers.
             # Values beginning with `+` must contain 1 to 20 digits after the plus sign. The

data/rbi/telnyx/models/phone_numbers/job_retrieve_response.rbi

@@ -12,22 +12,28 @@ module Telnyx
             )
           end
 
-        sig { returns(T.nilable(Telnyx::PhoneNumbers::PhoneNumbersJob)) }
+        sig { returns(T.nilable(Telnyx::PhoneNumbers::NumbersPhoneNumbersJob)) }
         attr_reader :data
 
-        sig { params(data: Telnyx::PhoneNumbers::PhoneNumbersJob::OrHash).void }
+        sig do
+          params(
+            data: Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::OrHash
+          ).void
+        end
         attr_writer :data
 
         sig do
-          params(data: Telnyx::PhoneNumbers::PhoneNumbersJob::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            data: Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(data: nil)
         end
 
         sig do
-          override.returns({ data: Telnyx::PhoneNumbers::PhoneNumbersJob })
+          override.returns(
+            { data: Telnyx::PhoneNumbers::NumbersPhoneNumbersJob }
+          )
         end
         def to_hash
         end

data/rbi/telnyx/models/phone_numbers/job_update_batch_params.rbi

@@ -54,7 +54,12 @@ module Telnyx
         sig { params(connection_id: String).void }
         attr_writer :connection_id
 
-        # A customer reference string for customer look ups.
+        # Sets the customer reference on the selected phone numbers and retains the
+        # supplied value on the job. Recover the job without its ID using GET
+        # /phone_numbers/jobs with filter[customer_reference] within 90 days of job
+        # creation. This body field updates the numbers; the separate
+        # filter[customer_reference] query parameter selects numbers by their current
+        # reference.
         sig { returns(T.nilable(String)) }
         attr_reader :customer_reference
 
@@ -136,7 +141,12 @@ module Telnyx
           billing_group_id: nil,
           # Identifies the connection associated with the phone number.
           connection_id: nil,
-          # A customer reference string for customer look ups.
+          # Sets the customer reference on the selected phone numbers and retains the
+          # supplied value on the job. Recover the job without its ID using GET
+          # /phone_numbers/jobs with filter[customer_reference] within 90 days of job
+          # creation. This body field updates the numbers; the separate
+          # filter[customer_reference] query parameter selects numbers by their current
+          # reference.
           customer_reference: nil,
           # Indicates whether to enable or disable the deletion lock on each phone number.
           # When enabled, this prevents the phone number from being deleted via the API or