telnyx 5.151.0 → 5.152.0

data/rbi/telnyx/models/dir/email_verification_status_wrapped.rbi

@@ -0,0 +1,184 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class EmailVerificationStatusWrapped < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Dir::EmailVerificationStatusWrapped,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Verification state for a DIR's authorizer email.
+        sig { returns(Telnyx::Dir::EmailVerificationStatusWrapped::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: Telnyx::Dir::EmailVerificationStatusWrapped::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data: Telnyx::Dir::EmailVerificationStatusWrapped::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Verification state for a DIR's authorizer email.
+          data:
+        )
+        end
+
+        sig do
+          override.returns(
+            { data: Telnyx::Dir::EmailVerificationStatusWrapped::Data }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Dir::EmailVerificationStatusWrapped::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Whether the DIR's authorizer email has been confirmed.
+          sig { returns(T::Boolean) }
+          attr_accessor :email_verified
+
+          # `sent` after a code is emailed; `verified` after a successful confirm;
+          # `unverified` when no verification is in progress.
+          sig do
+            returns(
+              Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
+          # Always `email_verification`.
+          sig do
+            returns(
+              Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType::TaggedSymbol
+            )
+          end
+          attr_accessor :record_type
+
+          # Verification state for a DIR's authorizer email.
+          sig do
+            params(
+              email_verified: T::Boolean,
+              record_type:
+                Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType::OrSymbol,
+              status:
+                Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Whether the DIR's authorizer email has been confirmed.
+            email_verified:,
+            # Always `email_verification`.
+            record_type:,
+            # `sent` after a code is emailed; `verified` after a successful confirm;
+            # `unverified` when no verification is in progress.
+            status:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                email_verified: T::Boolean,
+                record_type:
+                  Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType::TaggedSymbol,
+                status:
+                  Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Always `email_verification`.
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            EMAIL_VERIFICATION =
+              T.let(
+                :email_verification,
+                Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # `sent` after a code is emailed; `verified` after a successful confirm;
+          # `unverified` when no verification is in progress.
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SENT =
+              T.let(
+                :sent,
+                Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+              )
+            VERIFIED =
+              T.let(
+                :verified,
+                Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+              )
+            UNVERIFIED =
+              T.let(
+                :unverified,
+                Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

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