telnyx 5.151.0 → 5.152.0

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/verify_email_confirm_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      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::VerifyEmailConfirmParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :dir_id
+
+        # The 6-digit code sent to the authorizer email.
+        sig { returns(String) }
+        attr_accessor :code
+
+        sig do
+          params(
+            dir_id: String,
+            code: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        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,
+              code: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

data/rbi/telnyx/models/dir/verify_email_list_params.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class VerifyEmailListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Dir::VerifyEmailListParams, 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_update_infringement_params.rbi

@@ -56,7 +56,8 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :display_name
 
-      # Append-only supporting documents.
+      # Append-only supporting documents to attach while resolving the claim (e.g.
+      # authorization or licensing proof).
       sig { returns(T.nilable(T::Array[Telnyx::Document])) }
       attr_accessor :documents
 
@@ -97,7 +98,8 @@ module Telnyx
         infringement_resolution_notes:,
         call_reasons: nil,
         display_name: nil,
-        # Append-only supporting documents.
+        # Append-only supporting documents to attach while resolving the claim (e.g.
+        # authorization or licensing proof).
         documents: nil,
         # Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
         logo_url: nil,

data/rbi/telnyx/models/enterprises/dir_create_params.rbi

@@ -28,6 +28,11 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :authorizer_name
 
+        # 1–10 reasons your business calls customers. Validate phrasing against
+        # `POST /call_reasons/validate`.
+        sig { returns(T::Array[String]) }
+        attr_accessor :call_reasons
+
         # Must be `true`.
         sig do
           returns(
@@ -57,14 +62,6 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :display_name
 
-        # 1–10 reasons your business calls customers. Validate phrasing against
-        # `POST /call_reasons/validate`.
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :call_reasons
-
-        sig { params(call_reasons: T::Array[String]).void }
-        attr_writer :call_reasons
-
         # Supporting documents. Each `document_id` may appear at most once on a DIR.
         sig { returns(T.nilable(T::Array[Telnyx::Document])) }
         attr_reader :documents
@@ -92,6 +89,7 @@ module Telnyx
             enterprise_id: String,
             authorizer_email: String,
             authorizer_name: String,
+            call_reasons: T::Array[String],
             certify_brand_is_accurate:
               Telnyx::Enterprises::DirCreateParams::CertifyBrandIsAccurate::OrBoolean,
             certify_ip_ownership:
@@ -99,7 +97,6 @@ module Telnyx
             certify_no_shaft_content:
               Telnyx::Enterprises::DirCreateParams::CertifyNoShaftContent::OrBoolean,
             display_name: String,
-            call_reasons: T::Array[String],
             documents: T::Array[Telnyx::Document::OrHash],
             logo_url: String,
             reselling: T::Boolean,
@@ -114,6 +111,9 @@ module Telnyx
           # Name of the person at your enterprise who is authorizing this DIR registration.
           # Must be a real individual (used for audit and trademark-claim contests).
           authorizer_name:,
+          # 1–10 reasons your business calls customers. Validate phrasing against
+          # `POST /call_reasons/validate`.
+          call_reasons:,
           # Must be `true`.
           certify_brand_is_accurate:,
           # Must be `true`. Confirms ownership of any logos/trademarks shown.
@@ -123,9 +123,6 @@ module Telnyx
           certify_no_shaft_content:,
           # Name shown to call recipients. No emoji; not whitespace-only.
           display_name:,
-          # 1–10 reasons your business calls customers. Validate phrasing against
-          # `POST /call_reasons/validate`.
-          call_reasons: nil,
           # Supporting documents. Each `document_id` may appear at most once on a DIR.
           documents: nil,
           # Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
@@ -143,6 +140,7 @@ module Telnyx
               enterprise_id: String,
               authorizer_email: String,
               authorizer_name: String,
+              call_reasons: T::Array[String],
               certify_brand_is_accurate:
                 Telnyx::Enterprises::DirCreateParams::CertifyBrandIsAccurate::OrBoolean,
               certify_ip_ownership:
@@ -150,7 +148,6 @@ module Telnyx
               certify_no_shaft_content:
                 Telnyx::Enterprises::DirCreateParams::CertifyNoShaftContent::OrBoolean,
               display_name: String,
-              call_reasons: T::Array[String],
               documents: T::Array[Telnyx::Document],
               logo_url: String,
               reselling: T::Boolean,

data/rbi/telnyx/models/messaging_profiles/autoresp_config_delete_response.rbi

@@ -3,7 +3,7 @@
 module Telnyx
   module Models
     module MessagingProfiles
-      AutorespConfigDeleteResponse = String
+      AutorespConfigDeleteResponse = T.type_alias { String }
     end
   end
 end

data/rbi/telnyx/models/storage/kv_create_params.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class KvCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Storage::KvCreateParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Namespace name. May contain lowercase letters, numbers, and hyphens only.
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig do
+          params(
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Namespace name. May contain lowercase letters, numbers, and hyphens only.
+          name:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { name: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/kv_delete_params.rbi

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

data/rbi/telnyx/models/storage/kv_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class KvListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Storage::KvListParams, Telnyx::Internal::AnyHash)
+          end
+
+        # The page number to load.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # The size of the page. Values above 250 are treated as 250.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The page number to load.
+          page_number: nil,
+          # The size of the page. Values above 250 are treated as 250.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/kv_namespace.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class KvNamespace < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Storage::KvNamespace, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :record_type
+
+        sig { params(record_type: String).void }
+        attr_writer :record_type
+
+        # Provisioning status. A namespace is usable once `status` is `provision_ok`. Once
+        # deletion completes, the namespace no longer appears in the API.
+        sig do
+          returns(T.nilable(Telnyx::Storage::KvNamespace::Status::TaggedSymbol))
+        end
+        attr_reader :status
+
+        sig do
+          params(status: Telnyx::Storage::KvNamespace::Status::OrSymbol).void
+        end
+        attr_writer :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :updated_at
+
+        sig { params(updated_at: Time).void }
+        attr_writer :updated_at
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            name: String,
+            record_type: String,
+            status: Telnyx::Storage::KvNamespace::Status::OrSymbol,
+            updated_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          created_at: nil,
+          name: nil,
+          record_type: nil,
+          # Provisioning status. A namespace is usable once `status` is `provision_ok`. Once
+          # deletion completes, the namespace no longer appears in the API.
+          status: nil,
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              name: String,
+              record_type: String,
+              status: Telnyx::Storage::KvNamespace::Status::TaggedSymbol,
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Provisioning status. A namespace is usable once `status` is `provision_ok`. Once
+        # deletion completes, the namespace no longer appears in the API.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::Storage::KvNamespace::Status) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(:pending, Telnyx::Storage::KvNamespace::Status::TaggedSymbol)
+          PROVISION_OK =
+            T.let(
+              :provision_ok,
+              Telnyx::Storage::KvNamespace::Status::TaggedSymbol
+            )
+          PROVISION_FAILED =
+            T.let(
+              :provision_failed,
+              Telnyx::Storage::KvNamespace::Status::TaggedSymbol
+            )
+          DELETING =
+            T.let(:deleting, Telnyx::Storage::KvNamespace::Status::TaggedSymbol)
+          DELETE_FAILED =
+            T.let(
+              :delete_failed,
+              Telnyx::Storage::KvNamespace::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Storage::KvNamespace::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end