telnyx 5.171.0 → 5.174.0

data/lib/telnyx/models/pay_connector_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PayConnectors#retrieve
+    class PayConnectorRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(name:, request_options: {})
+      #   @param name [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/pay_connector_update_params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PayConnectors#update
+    class PayConnectorUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute config
+      #   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.
+      #
+      #   @return [Telnyx::Models::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault, Telnyx::Models::GenericPayConnectorConfig::BearerAuthentication, Telnyx::Models::GenericPayConnectorConfig::NoProcessorAuthentication, nil]
+      optional :config, union: -> { Telnyx::GenericPayConnectorConfig }
+
+      # @!attribute mode
+      #   Omit to preserve the existing mode. Use an explicit test or live value.
+      #
+      #   @return [Symbol, Telnyx::Models::PayConnectorUpdateParams::Mode, nil]
+      optional :mode, enum: -> { Telnyx::PayConnectorUpdateParams::Mode }
+
+      # @!attribute type
+      #   Generic connector type. Omit to preserve the existing value.
+      #
+      #   @return [Symbol, Telnyx::Models::PayConnectorUpdateParams::Type, nil]
+      optional :type, enum: -> { Telnyx::PayConnectorUpdateParams::Type }
+
+      # @!method initialize(name:, config: nil, mode: nil, type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::PayConnectorUpdateParams} for more details.
+      #
+      #   @param name [String]
+      #
+      #   @param config [Telnyx::Models::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault, Telnyx::Models::GenericPayConnectorConfig::BearerAuthentication, Telnyx::Models::GenericPayConnectorConfig::NoProcessorAuthentication] Configuration for a generic connector. A config update replaces the complete obj
+      #
+      #   @param mode [Symbol, Telnyx::Models::PayConnectorUpdateParams::Mode] Omit to preserve the existing mode. Use an explicit test or live value.
+      #
+      #   @param type [Symbol, Telnyx::Models::PayConnectorUpdateParams::Type] Generic connector type. Omit to preserve the existing value.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Omit to preserve the existing mode. Use an explicit test or live value.
+      module Mode
+        extend Telnyx::Internal::Type::Enum
+
+        TEST = :test
+        LIVE = :live
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Generic connector type. Omit to preserve the existing value.
+      module Type
+        extend Telnyx::Internal::Type::Enum
+
+        GENERIC = :generic
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/phone_numbers/csv_download_create_params.rb

@@ -25,7 +25,18 @@ module Telnyx
         #   @return [Telnyx::Models::PhoneNumbers::CsvDownloadCreateParams::Filter, nil]
         optional :filter, -> { Telnyx::PhoneNumbers::CsvDownloadCreateParams::Filter }
 
-        # @!method initialize(csv_format: nil, filter: nil, request_options: {})
+        # @!attribute include_managed_accounts
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :include_managed_accounts, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(csv_format: nil, filter: nil, include_managed_accounts: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::PhoneNumbers::CsvDownloadCreateParams} for more details.
         #
@@ -33,6 +44,8 @@ module Telnyx
         #
         #   @param filter [Telnyx::Models::PhoneNumbers::CsvDownloadCreateParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[has_bundle]
         #
+        #   @param include_managed_accounts [Boolean] When true, the CSV includes phone numbers from all managed accounts in addition
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
         # Which format to use when generating the CSV file. The default for backwards

data/lib/telnyx/models/phone_numbers/job_delete_batch_response.rb

@@ -7,11 +7,11 @@ module Telnyx
       class JobDeleteBatchResponse < Telnyx::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Telnyx::Models::PhoneNumbers::PhoneNumbersJob, nil]
-        optional :data, -> { Telnyx::PhoneNumbers::PhoneNumbersJob }
+        #   @return [Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob, nil]
+        optional :data, -> { Telnyx::PhoneNumbers::NumbersPhoneNumbersJob }
 
         # @!method initialize(data: nil)
-        #   @param data [Telnyx::Models::PhoneNumbers::PhoneNumbersJob]
+        #   @param data [Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob]
       end
     end
   end

data/lib/telnyx/models/phone_numbers/job_list_params.rb

@@ -49,12 +49,15 @@ module Telnyx
 
         class Filter < Telnyx::Internal::Type::BaseModel
           # @!attribute customer_reference
-          #   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.
           #
           #   @return [String, nil]
           optional :customer_reference, String
@@ -91,7 +94,7 @@ module Telnyx
           #   filter[phone_number], filter[phone_number][], filter[status][],
           #   filter[customer_reference]
           #
-          #   @param customer_reference [String] Returns jobs whose creation-time customer reference exactly matches the supplied
+          #   @param customer_reference [String] Exact, case-sensitive match for the customer reference supplied when the job was
           #
           #   @param phone_number [String, Array<String>] Returns jobs that targeted any of the supplied account-owned phone numbers. Valu
           #

data/lib/telnyx/models/phone_numbers/job_retrieve_response.rb

@@ -7,11 +7,11 @@ module Telnyx
       class JobRetrieveResponse < Telnyx::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Telnyx::Models::PhoneNumbers::PhoneNumbersJob, nil]
-        optional :data, -> { Telnyx::PhoneNumbers::PhoneNumbersJob }
+        #   @return [Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob, nil]
+        optional :data, -> { Telnyx::PhoneNumbers::NumbersPhoneNumbersJob }
 
         # @!method initialize(data: nil)
-        #   @param data [Telnyx::Models::PhoneNumbers::PhoneNumbersJob]
+        #   @param data [Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob]
       end
     end
   end

data/lib/telnyx/models/phone_numbers/job_update_batch_params.rb

@@ -41,7 +41,12 @@ module Telnyx
         optional :connection_id, String
 
         # @!attribute customer_reference
-        #   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.
         #
         #   @return [String, nil]
         optional :customer_reference, String
@@ -94,7 +99,7 @@ module Telnyx
         #
         #   @param connection_id [String] Identifies the connection associated with the phone number.
         #
-        #   @param customer_reference [String] A customer reference string for customer look ups.
+        #   @param customer_reference [String] Sets the customer reference on the selected phone numbers and retains the suppli
         #
         #   @param deletion_lock_enabled [Boolean] Indicates whether to enable or disable the deletion lock on each phone number. W
         #

data/lib/telnyx/models/phone_numbers/job_update_batch_response.rb

@@ -7,11 +7,11 @@ module Telnyx
       class JobUpdateBatchResponse < Telnyx::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Telnyx::Models::PhoneNumbers::PhoneNumbersJob, nil]
-        optional :data, -> { Telnyx::PhoneNumbers::PhoneNumbersJob }
+        #   @return [Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob, nil]
+        optional :data, -> { Telnyx::PhoneNumbers::NumbersPhoneNumbersJob }
 
         # @!method initialize(data: nil)
-        #   @param data [Telnyx::Models::PhoneNumbers::PhoneNumbersJob]
+        #   @param data [Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob]
       end
     end
   end

data/lib/telnyx/models/phone_numbers/job_update_emergency_settings_batch_response.rb

@@ -7,11 +7,11 @@ module Telnyx
       class JobUpdateEmergencySettingsBatchResponse < Telnyx::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Telnyx::Models::PhoneNumbers::PhoneNumbersJob, nil]
-        optional :data, -> { Telnyx::PhoneNumbers::PhoneNumbersJob }
+        #   @return [Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob, nil]
+        optional :data, -> { Telnyx::PhoneNumbers::NumbersPhoneNumbersJob }
 
         # @!method initialize(data: nil)
-        #   @param data [Telnyx::Models::PhoneNumbers::PhoneNumbersJob]
+        #   @param data [Telnyx::Models::PhoneNumbers::NumbersPhoneNumbersJob]
       end
     end
   end