telnyx 5.150.0 → 5.152.0

data/rbi/telnyx/models/dir/reference.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class Reference < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Dir::Reference, Telnyx::Internal::AnyHash)
+          end
+
+        # Full name of the reference contact.
+        sig { returns(String) }
+        attr_accessor :full_name
+
+        # Reference phone number in E.164 format.
+        sig { returns(String) }
+        attr_accessor :phone_e164
+
+        # Whether this is a business reference or the financial reference.
+        sig { returns(Telnyx::Dir::Reference::RefType::TaggedSymbol) }
+        attr_accessor :ref_type
+
+        # Position within the reference type. Business references occupy slots 0 and 1;
+        # the financial reference occupies slot 0.
+        sig { returns(Integer) }
+        attr_accessor :slot
+
+        # IANA timezone id for the reference. Calls are only placed within the reference's
+        # local 8am-9pm window.
+        sig { returns(String) }
+        attr_accessor :timezone
+
+        # Reference contact email address.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :email
+
+        # Job title of the reference contact.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :job_title
+
+        # Organization the reference contact belongs to.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :organization
+
+        # How the reference contact is related to the registering business.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :relationship_to_registrant
+
+        # Always `dir_reference`.
+        sig { returns(Telnyx::Dir::Reference::RecordType::TaggedSymbol) }
+        attr_accessor :record_type
+
+        # A reference (business or financial) on a DIR, in the customer-facing shape. No
+        # internal identifiers are exposed.
+        sig do
+          params(
+            full_name: String,
+            phone_e164: String,
+            record_type: Telnyx::Dir::Reference::RecordType::OrSymbol,
+            ref_type: Telnyx::Dir::Reference::RefType::OrSymbol,
+            slot: Integer,
+            timezone: String,
+            email: T.nilable(String),
+            job_title: T.nilable(String),
+            organization: T.nilable(String),
+            relationship_to_registrant: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Full name of the reference contact.
+          full_name:,
+          # Reference phone number in E.164 format.
+          phone_e164:,
+          # Always `dir_reference`.
+          record_type:,
+          # Whether this is a business reference or the financial reference.
+          ref_type:,
+          # Position within the reference type. Business references occupy slots 0 and 1;
+          # the financial reference occupies slot 0.
+          slot:,
+          # IANA timezone id for the reference. Calls are only placed within the reference's
+          # local 8am-9pm window.
+          timezone:,
+          # Reference contact email address.
+          email: nil,
+          # Job title of the reference contact.
+          job_title: nil,
+          # Organization the reference contact belongs to.
+          organization: nil,
+          # How the reference contact is related to the registering business.
+          relationship_to_registrant: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              full_name: String,
+              phone_e164: String,
+              record_type: Telnyx::Dir::Reference::RecordType::TaggedSymbol,
+              ref_type: Telnyx::Dir::Reference::RefType::TaggedSymbol,
+              slot: Integer,
+              timezone: String,
+              email: T.nilable(String),
+              job_title: T.nilable(String),
+              organization: T.nilable(String),
+              relationship_to_registrant: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Always `dir_reference`.
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::Dir::Reference::RecordType) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DIR_REFERENCE =
+            T.let(
+              :dir_reference,
+              Telnyx::Dir::Reference::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Dir::Reference::RecordType::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Whether this is a business reference or the financial reference.
+        module RefType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::Dir::Reference::RefType) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BUSINESS =
+            T.let(:business, Telnyx::Dir::Reference::RefType::TaggedSymbol)
+          FINANCIAL =
+            T.let(:financial, Telnyx::Dir::Reference::RefType::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Dir::Reference::RefType::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir/reference_create_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class ReferenceCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Dir::ReferenceCreateParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :dir_id
+
+        # Exactly two business references.
+        sig { returns(T::Array[Telnyx::Dir::ReferenceInput]) }
+        attr_accessor :business_references
+
+        # One reference supplied at submit. The reference type is implied by the field
+        # that carries it (business_references vs financial_reference).
+        sig { returns(Telnyx::Dir::ReferenceInput) }
+        attr_reader :financial_reference
+
+        sig do
+          params(financial_reference: Telnyx::Dir::ReferenceInput::OrHash).void
+        end
+        attr_writer :financial_reference
+
+        sig do
+          params(
+            dir_id: String,
+            business_references: T::Array[Telnyx::Dir::ReferenceInput::OrHash],
+            financial_reference: Telnyx::Dir::ReferenceInput::OrHash,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          dir_id:,
+          # Exactly two business references.
+          business_references:,
+          # One reference supplied at submit. The reference type is implied by the field
+          # that carries it (business_references vs financial_reference).
+          financial_reference:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              dir_id: String,
+              business_references: T::Array[Telnyx::Dir::ReferenceInput],
+              financial_reference: Telnyx::Dir::ReferenceInput,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir/reference_input.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class ReferenceInput < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Dir::ReferenceInput, Telnyx::Internal::AnyHash)
+          end
+
+        # Reference contact email address. Required: the reference is emailed scheduling
+        # and dial-in notices.
+        sig { returns(String) }
+        attr_accessor :email
+
+        # Full name of the reference contact.
+        sig { returns(String) }
+        attr_accessor :full_name
+
+        # Reference phone number in E.164 format, e.g. +14155550123.
+        sig { returns(String) }
+        attr_accessor :phone_e164
+
+        # IANA timezone id for the reference (e.g. America/New_York). Required: calls are
+        # only placed within the reference's local 8am-9pm window.
+        sig { returns(String) }
+        attr_accessor :timezone
+
+        # Job title of the reference contact.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :job_title
+
+        # Organization the reference contact belongs to.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :organization
+
+        # How the reference contact is related to the registering business.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :relationship_to_registrant
+
+        # One reference supplied at submit. The reference type is implied by the field
+        # that carries it (business_references vs financial_reference).
+        sig do
+          params(
+            email: String,
+            full_name: String,
+            phone_e164: String,
+            timezone: String,
+            job_title: T.nilable(String),
+            organization: T.nilable(String),
+            relationship_to_registrant: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Reference contact email address. Required: the reference is emailed scheduling
+          # and dial-in notices.
+          email:,
+          # Full name of the reference contact.
+          full_name:,
+          # Reference phone number in E.164 format, e.g. +14155550123.
+          phone_e164:,
+          # IANA timezone id for the reference (e.g. America/New_York). Required: calls are
+          # only placed within the reference's local 8am-9pm window.
+          timezone:,
+          # Job title of the reference contact.
+          job_title: nil,
+          # Organization the reference contact belongs to.
+          organization: nil,
+          # How the reference contact is related to the registering business.
+          relationship_to_registrant: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              email: String,
+              full_name: String,
+              phone_e164: String,
+              timezone: String,
+              job_title: T.nilable(String),
+              organization: T.nilable(String),
+              relationship_to_registrant: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir/reference_list.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class ReferenceList < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Dir::ReferenceList, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T::Array[Telnyx::Dir::Reference]) }
+        attr_accessor :data
+
+        sig do
+          params(data: T::Array[Telnyx::Dir::Reference::OrHash]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data:)
+        end
+
+        sig { override.returns({ data: T::Array[Telnyx::Dir::Reference] }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir/reference_list_params.rbi

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

data/rbi/telnyx/models/dir/reference_update_params.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class ReferenceUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Dir::ReferenceUpdateParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :dir_id
+
+        sig { returns(Telnyx::Dir::ReferenceUpdateParams::RefType::OrSymbol) }
+        attr_accessor :ref_type
+
+        sig { returns(Integer) }
+        attr_accessor :slot
+
+        # Reference contact email address.
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        # Full name of the reference contact.
+        sig { returns(T.nilable(String)) }
+        attr_reader :full_name
+
+        sig { params(full_name: String).void }
+        attr_writer :full_name
+
+        # Job title of the reference contact.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :job_title
+
+        # Organization the reference contact belongs to.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :organization
+
+        # Reference phone number in E.164 format.
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_e164
+
+        sig { params(phone_e164: String).void }
+        attr_writer :phone_e164
+
+        # How the reference contact is related to the registering business.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :relationship_to_registrant
+
+        # IANA timezone id for the reference.
+        sig { returns(T.nilable(String)) }
+        attr_reader :timezone
+
+        sig { params(timezone: String).void }
+        attr_writer :timezone
+
+        sig do
+          params(
+            dir_id: String,
+            ref_type: Telnyx::Dir::ReferenceUpdateParams::RefType::OrSymbol,
+            slot: Integer,
+            email: String,
+            full_name: String,
+            job_title: T.nilable(String),
+            organization: T.nilable(String),
+            phone_e164: String,
+            relationship_to_registrant: T.nilable(String),
+            timezone: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          dir_id:,
+          ref_type:,
+          slot:,
+          # Reference contact email address.
+          email: nil,
+          # Full name of the reference contact.
+          full_name: nil,
+          # Job title of the reference contact.
+          job_title: nil,
+          # Organization the reference contact belongs to.
+          organization: nil,
+          # Reference phone number in E.164 format.
+          phone_e164: nil,
+          # How the reference contact is related to the registering business.
+          relationship_to_registrant: nil,
+          # IANA timezone id for the reference.
+          timezone: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              dir_id: String,
+              ref_type: Telnyx::Dir::ReferenceUpdateParams::RefType::OrSymbol,
+              slot: Integer,
+              email: String,
+              full_name: String,
+              job_title: T.nilable(String),
+              organization: T.nilable(String),
+              phone_e164: String,
+              relationship_to_registrant: T.nilable(String),
+              timezone: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module RefType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Dir::ReferenceUpdateParams::RefType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BUSINESS =
+            T.let(
+              :business,
+              Telnyx::Dir::ReferenceUpdateParams::RefType::TaggedSymbol
+            )
+          FINANCIAL =
+            T.let(
+              :financial,
+              Telnyx::Dir::ReferenceUpdateParams::RefType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Dir::ReferenceUpdateParams::RefType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir/reference_update_response.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class ReferenceUpdateResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Dir::ReferenceUpdateResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # A reference (business or financial) on a DIR, in the customer-facing shape. No
+        # internal identifiers are exposed.
+        sig { returns(Telnyx::Dir::Reference) }
+        attr_reader :data
+
+        sig { params(data: Telnyx::Dir::Reference::OrHash).void }
+        attr_writer :data
+
+        sig do
+          params(data: Telnyx::Dir::Reference::OrHash).returns(T.attached_class)
+        end
+        def self.new(
+          # A reference (business or financial) on a DIR, in the customer-facing shape. No
+          # internal identifiers are exposed.
+          data:
+        )
+        end
+
+        sig { override.returns({ data: Telnyx::Dir::Reference }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir/{phone_number_delete_all_params.rbi → verify_email_confirm_params.rbi}

@@ -3,14 +3,14 @@
 module Telnyx
   module Models
     module Dir
-      class PhoneNumberDeleteAllParams < Telnyx::Internal::Type::BaseModel
+      class VerifyEmailConfirmParams < Telnyx::Internal::Type::BaseModel
         extend Telnyx::Internal::Type::RequestParameters::Converter
         include Telnyx::Internal::Type::RequestParameters
 
         OrHash =
           T.type_alias do
             T.any(
-              Telnyx::Dir::PhoneNumberDeleteAllParams,
+              Telnyx::Dir::VerifyEmailConfirmParams,
               Telnyx::Internal::AnyHash
             )
           end
@@ -18,24 +18,30 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :dir_id
 
-        sig { returns(T::Array[String]) }
-        attr_accessor :phone_numbers
+        # The 6-digit code sent to the authorizer email.
+        sig { returns(String) }
+        attr_accessor :code
 
         sig do
           params(
             dir_id: String,
-            phone_numbers: T::Array[String],
+            code: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(dir_id:, phone_numbers:, request_options: {})
+        def self.new(
+          dir_id:,
+          # The 6-digit code sent to the authorizer email.
+          code:,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
             {
               dir_id: String,
-              phone_numbers: T::Array[String],
+              code: String,
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/models/dir/verify_email_create_params.rbi

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