telnyx 5.151.0 → 5.152.0

data/lib/telnyx/models/advanced_order_update_requirement_group_params.rb

@@ -12,96 +12,9 @@ module Telnyx
       #   @return [String]
       required :advanced_order_id, String
 
-      # @!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(advanced_order_id:, 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: {})
+      # @!method initialize(advanced_order_id:, request_options: {})
       #   @param advanced_order_id [String]
-      #
-      #   @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
-      #
       #   @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/dir/email_verification_status_wrapped.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::VerifyEmail#create
+      class EmailVerificationStatusWrapped < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   Verification state for a DIR's authorizer email.
+        #
+        #   @return [Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data]
+        required :data, -> { Telnyx::Dir::EmailVerificationStatusWrapped::Data }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data] Verification state for a DIR's authorizer email.
+
+        # @see Telnyx::Models::Dir::EmailVerificationStatusWrapped#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute email_verified
+          #   Whether the DIR's authorizer email has been confirmed.
+          #
+          #   @return [Boolean]
+          required :email_verified, Telnyx::Internal::Type::Boolean
+
+          # @!attribute status
+          #   `sent` after a code is emailed; `verified` after a successful confirm;
+          #   `unverified` when no verification is in progress.
+          #
+          #   @return [Symbol, Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::Status]
+          required :status, enum: -> { Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status }
+
+          response_only do
+            # @!attribute record_type
+            #   Always `email_verification`.
+            #
+            #   @return [Symbol, Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::RecordType]
+            required :record_type, enum: -> { Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType }
+          end
+
+          # @!method initialize(email_verified:, record_type:, status:)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data} for more details.
+          #
+          #   Verification state for a DIR's authorizer email.
+          #
+          #   @param email_verified [Boolean] Whether the DIR's authorizer email has been confirmed.
+          #
+          #   @param record_type [Symbol, Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::RecordType] Always `email_verification`.
+          #
+          #   @param status [Symbol, Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::Status] `sent` after a code is emailed; `verified` after a successful confirm; `unverifi
+
+          # Always `email_verification`.
+          #
+          # @see Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data#record_type
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            EMAIL_VERIFICATION = :email_verification
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # `sent` after a code is emailed; `verified` after a successful confirm;
+          # `unverified` when no verification is in progress.
+          #
+          # @see Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            SENT = :sent
+            VERIFIED = :verified
+            UNVERIFIED = :unverified
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      class Reference < Telnyx::Internal::Type::BaseModel
+        # @!attribute full_name
+        #   Full name of the reference contact.
+        #
+        #   @return [String]
+        required :full_name, String
+
+        # @!attribute phone_e164
+        #   Reference phone number in E.164 format.
+        #
+        #   @return [String]
+        required :phone_e164, String
+
+        # @!attribute ref_type
+        #   Whether this is a business reference or the financial reference.
+        #
+        #   @return [Symbol, Telnyx::Models::Dir::Reference::RefType]
+        required :ref_type, enum: -> { Telnyx::Dir::Reference::RefType }
+
+        # @!attribute slot
+        #   Position within the reference type. Business references occupy slots 0 and 1;
+        #   the financial reference occupies slot 0.
+        #
+        #   @return [Integer]
+        required :slot, Integer
+
+        # @!attribute timezone
+        #   IANA timezone id for the reference. Calls are only placed within the reference's
+        #   local 8am-9pm window.
+        #
+        #   @return [String]
+        required :timezone, String
+
+        # @!attribute email
+        #   Reference contact email address.
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
+
+        # @!attribute job_title
+        #   Job title of the reference contact.
+        #
+        #   @return [String, nil]
+        optional :job_title, String, nil?: true
+
+        # @!attribute organization
+        #   Organization the reference contact belongs to.
+        #
+        #   @return [String, nil]
+        optional :organization, String, nil?: true
+
+        # @!attribute relationship_to_registrant
+        #   How the reference contact is related to the registering business.
+        #
+        #   @return [String, nil]
+        optional :relationship_to_registrant, String, nil?: true
+
+        response_only do
+          # @!attribute record_type
+          #   Always `dir_reference`.
+          #
+          #   @return [Symbol, Telnyx::Models::Dir::Reference::RecordType]
+          required :record_type, enum: -> { Telnyx::Dir::Reference::RecordType }
+        end
+
+        # @!method initialize(full_name:, phone_e164:, record_type:, ref_type:, slot:, timezone:, email: nil, job_title: nil, organization: nil, relationship_to_registrant: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::Reference} for more details.
+        #
+        #   A reference (business or financial) on a DIR, in the customer-facing shape. No
+        #   internal identifiers are exposed.
+        #
+        #   @param full_name [String] Full name of the reference contact.
+        #
+        #   @param phone_e164 [String] Reference phone number in E.164 format.
+        #
+        #   @param record_type [Symbol, Telnyx::Models::Dir::Reference::RecordType] Always `dir_reference`.
+        #
+        #   @param ref_type [Symbol, Telnyx::Models::Dir::Reference::RefType] Whether this is a business reference or the financial reference.
+        #
+        #   @param slot [Integer] Position within the reference type. Business references occupy slots 0 and 1; th
+        #
+        #   @param timezone [String] IANA timezone id for the reference. Calls are only placed within the reference's
+        #
+        #   @param email [String, nil] Reference contact email address.
+        #
+        #   @param job_title [String, nil] Job title of the reference contact.
+        #
+        #   @param organization [String, nil] Organization the reference contact belongs to.
+        #
+        #   @param relationship_to_registrant [String, nil] How the reference contact is related to the registering business.
+
+        # Always `dir_reference`.
+        #
+        # @see Telnyx::Models::Dir::Reference#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          DIR_REFERENCE = :dir_reference
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Whether this is a business reference or the financial reference.
+        #
+        # @see Telnyx::Models::Dir::Reference#ref_type
+        module RefType
+          extend Telnyx::Internal::Type::Enum
+
+          BUSINESS = :business
+          FINANCIAL = :financial
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference_create_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::References#create
+      class ReferenceCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute dir_id
+        #
+        #   @return [String]
+        required :dir_id, String
+
+        # @!attribute business_references
+        #   Exactly two business references.
+        #
+        #   @return [Array<Telnyx::Models::Dir::ReferenceInput>]
+        required :business_references, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Dir::ReferenceInput] }
+
+        # @!attribute financial_reference
+        #   One reference supplied at submit. The reference type is implied by the field
+        #   that carries it (business_references vs financial_reference).
+        #
+        #   @return [Telnyx::Models::Dir::ReferenceInput]
+        required :financial_reference, -> { Telnyx::Dir::ReferenceInput }
+
+        # @!method initialize(dir_id:, business_references:, financial_reference:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::ReferenceCreateParams} for more details.
+        #
+        #   @param dir_id [String]
+        #
+        #   @param business_references [Array<Telnyx::Models::Dir::ReferenceInput>] Exactly two business references.
+        #
+        #   @param financial_reference [Telnyx::Models::Dir::ReferenceInput] One reference supplied at submit. The reference type is implied by the field tha
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference_input.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      class ReferenceInput < Telnyx::Internal::Type::BaseModel
+        # @!attribute email
+        #   Reference contact email address. Required: the reference is emailed scheduling
+        #   and dial-in notices.
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute full_name
+        #   Full name of the reference contact.
+        #
+        #   @return [String]
+        required :full_name, String
+
+        # @!attribute phone_e164
+        #   Reference phone number in E.164 format, e.g. +14155550123.
+        #
+        #   @return [String]
+        required :phone_e164, String
+
+        # @!attribute timezone
+        #   IANA timezone id for the reference (e.g. America/New_York). Required: calls are
+        #   only placed within the reference's local 8am-9pm window.
+        #
+        #   @return [String]
+        required :timezone, String
+
+        # @!attribute job_title
+        #   Job title of the reference contact.
+        #
+        #   @return [String, nil]
+        optional :job_title, String, nil?: true
+
+        # @!attribute organization
+        #   Organization the reference contact belongs to.
+        #
+        #   @return [String, nil]
+        optional :organization, String, nil?: true
+
+        # @!attribute relationship_to_registrant
+        #   How the reference contact is related to the registering business.
+        #
+        #   @return [String, nil]
+        optional :relationship_to_registrant, String, nil?: true
+
+        # @!method initialize(email:, full_name:, phone_e164:, timezone:, job_title: nil, organization: nil, relationship_to_registrant: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::ReferenceInput} for more details.
+        #
+        #   One reference supplied at submit. The reference type is implied by the field
+        #   that carries it (business_references vs financial_reference).
+        #
+        #   @param email [String] Reference contact email address. Required: the reference is emailed scheduling a
+        #
+        #   @param full_name [String] Full name of the reference contact.
+        #
+        #   @param phone_e164 [String] Reference phone number in E.164 format, e.g. +14155550123.
+        #
+        #   @param timezone [String] IANA timezone id for the reference (e.g. America/New_York). Required: calls are
+        #
+        #   @param job_title [String, nil] Job title of the reference contact.
+        #
+        #   @param organization [String, nil] Organization the reference contact belongs to.
+        #
+        #   @param relationship_to_registrant [String, nil] How the reference contact is related to the registering business.
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference_list.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::References#create
+      class ReferenceList < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::Dir::Reference>]
+        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Dir::Reference] }
+
+        # @!method initialize(data:)
+        #   @param data [Array<Telnyx::Models::Dir::Reference>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference_list_params.rb

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

data/lib/telnyx/models/dir/reference_update_params.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::References#update
+      class ReferenceUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute dir_id
+        #
+        #   @return [String]
+        required :dir_id, String
+
+        # @!attribute ref_type
+        #
+        #   @return [Symbol, Telnyx::Models::Dir::ReferenceUpdateParams::RefType]
+        required :ref_type, enum: -> { Telnyx::Dir::ReferenceUpdateParams::RefType }
+
+        # @!attribute slot
+        #
+        #   @return [Integer]
+        required :slot, Integer
+
+        # @!attribute email
+        #   Reference contact email address.
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute full_name
+        #   Full name of the reference contact.
+        #
+        #   @return [String, nil]
+        optional :full_name, String
+
+        # @!attribute job_title
+        #   Job title of the reference contact.
+        #
+        #   @return [String, nil]
+        optional :job_title, String, nil?: true
+
+        # @!attribute organization
+        #   Organization the reference contact belongs to.
+        #
+        #   @return [String, nil]
+        optional :organization, String, nil?: true
+
+        # @!attribute phone_e164
+        #   Reference phone number in E.164 format.
+        #
+        #   @return [String, nil]
+        optional :phone_e164, String
+
+        # @!attribute relationship_to_registrant
+        #   How the reference contact is related to the registering business.
+        #
+        #   @return [String, nil]
+        optional :relationship_to_registrant, String, nil?: true
+
+        # @!attribute timezone
+        #   IANA timezone id for the reference.
+        #
+        #   @return [String, nil]
+        optional :timezone, String
+
+        # @!method initialize(dir_id:, ref_type:, slot:, email: nil, full_name: nil, job_title: nil, organization: nil, phone_e164: nil, relationship_to_registrant: nil, timezone: nil, request_options: {})
+        #   @param dir_id [String]
+        #
+        #   @param ref_type [Symbol, Telnyx::Models::Dir::ReferenceUpdateParams::RefType]
+        #
+        #   @param slot [Integer]
+        #
+        #   @param email [String] Reference contact email address.
+        #
+        #   @param full_name [String] Full name of the reference contact.
+        #
+        #   @param job_title [String, nil] Job title of the reference contact.
+        #
+        #   @param organization [String, nil] Organization the reference contact belongs to.
+        #
+        #   @param phone_e164 [String] Reference phone number in E.164 format.
+        #
+        #   @param relationship_to_registrant [String, nil] How the reference contact is related to the registering business.
+        #
+        #   @param timezone [String] IANA timezone id for the reference.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        module RefType
+          extend Telnyx::Internal::Type::Enum
+
+          BUSINESS = :business
+          FINANCIAL = :financial
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/reference_update_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::References#update
+      class ReferenceUpdateResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   A reference (business or financial) on a DIR, in the customer-facing shape. No
+        #   internal identifiers are exposed.
+        #
+        #   @return [Telnyx::Models::Dir::Reference]
+        required :data, -> { Telnyx::Dir::Reference }
+
+        # @!method initialize(data:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::ReferenceUpdateResponse} for more details.
+        #
+        #   @param data [Telnyx::Models::Dir::Reference] A reference (business or financial) on a DIR, in the customer-facing shape. No i
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/verify_email_confirm_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Dir
+      # @see Telnyx::Resources::Dir::VerifyEmail#confirm
+      class VerifyEmailConfirmParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute dir_id
+        #
+        #   @return [String]
+        required :dir_id, String
+
+        # @!attribute code
+        #   The 6-digit code sent to the authorizer email.
+        #
+        #   @return [String]
+        required :code, String
+
+        # @!method initialize(dir_id:, code:, request_options: {})
+        #   @param dir_id [String]
+        #
+        #   @param code [String] The 6-digit code sent to the authorizer email.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir/verify_email_create_params.rb

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

data/lib/telnyx/models/dir/verify_email_list_params.rb

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