telnyx 5.126.0 → 5.128.0

data/rbi/telnyx/models/dir/phone_number_list_params.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class PhoneNumberListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Dir::PhoneNumberListParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :dir_id
+
+        # 1-based page number. Out-of-range values return an empty page with correct meta.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # Items per page. Maximum 250; values above are clamped to 250.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        # Filter by phone-number status.
+        sig do
+          returns(
+            T.nilable(Telnyx::Dir::PhoneNumberListParams::Status::OrSymbol)
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status: Telnyx::Dir::PhoneNumberListParams::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig do
+          params(
+            dir_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            status: Telnyx::Dir::PhoneNumberListParams::Status::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          dir_id:,
+          # 1-based page number. Out-of-range values return an empty page with correct meta.
+          page_number: nil,
+          # Items per page. Maximum 250; values above are clamped to 250.
+          page_size: nil,
+          # Filter by phone-number status.
+          status: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              dir_id: String,
+              page_number: Integer,
+              page_size: Integer,
+              status: Telnyx::Dir::PhoneNumberListParams::Status::OrSymbol,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Filter by phone-number status.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Dir::PhoneNumberListParams::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SUBMITTED =
+            T.let(
+              :submitted,
+              Telnyx::Dir::PhoneNumberListParams::Status::TaggedSymbol
+            )
+          IN_REVIEW =
+            T.let(
+              :in_review,
+              Telnyx::Dir::PhoneNumberListParams::Status::TaggedSymbol
+            )
+          VERIFIED =
+            T.let(
+              :verified,
+              Telnyx::Dir::PhoneNumberListParams::Status::TaggedSymbol
+            )
+          UNSUCCESSFUL =
+            T.let(
+              :unsuccessful,
+              Telnyx::Dir::PhoneNumberListParams::Status::TaggedSymbol
+            )
+          SUSPENDED =
+            T.let(
+              :suspended,
+              Telnyx::Dir::PhoneNumberListParams::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              Telnyx::Dir::PhoneNumberListParams::Status::TaggedSymbol
+            )
+          PERMANENTLY_REJECTED =
+            T.let(
+              :permanently_rejected,
+              Telnyx::Dir::PhoneNumberListParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Dir::PhoneNumberListParams::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir/phone_number_list_response.rbi

@@ -0,0 +1,327 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class PhoneNumberListResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Dir::PhoneNumberListResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Id of the batch this number was vetted as part of.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :batch_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :dir_id
+
+        sig { params(dir_id: String).void }
+        attr_writer :dir_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :enterprise_id
+
+        sig { params(enterprise_id: String).void }
+        attr_writer :enterprise_id
+
+        # Id of the Letter of Authorization document attached to this number's batch.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :loa_document_id
+
+        # E.164 with leading `+`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        # Populated when `status` is `unsuccessful` or `permanently_rejected`.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::Dir::PhoneNumberListResponse::RejectionReason
+            )
+          )
+        end
+        attr_reader :rejection_reason
+
+        sig do
+          params(
+            rejection_reason:
+              T.nilable(
+                Telnyx::Models::Dir::PhoneNumberListResponse::RejectionReason::OrHash
+              )
+          ).void
+        end
+        attr_writer :rejection_reason
+
+        # Phone-number lifecycle status.
+        #
+        # - `submitted` / `in_review` - Telnyx is reviewing the batch this number belongs
+        #   to.
+        # - `verified` - approved; the DIR's display identity will be shown on outbound
+        #   calls from this number.
+        # - `unsuccessful` - Telnyx rejected this submission; the customer may re-add to
+        #   retry.
+        # - `suspended` - temporarily disabled (e.g. by an active infringement claim on
+        #   the DIR).
+        # - `expired` - verification expired; re-add to renew.
+        # - `permanently_rejected` - terminal; cannot be re-added on this or any other DIR
+        #   you own.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status:
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        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(Time)) }
+        attr_reader :updated_at
+
+        sig { params(updated_at: Time).void }
+        attr_writer :updated_at
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :verified_at
+
+        sig do
+          params(
+            id: String,
+            batch_id: T.nilable(String),
+            created_at: Time,
+            dir_id: String,
+            enterprise_id: String,
+            loa_document_id: T.nilable(String),
+            phone_number: String,
+            rejection_reason:
+              T.nilable(
+                Telnyx::Models::Dir::PhoneNumberListResponse::RejectionReason::OrHash
+              ),
+            status:
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::OrSymbol,
+            updated_at: Time,
+            verified_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          # Id of the batch this number was vetted as part of.
+          batch_id: nil,
+          created_at: nil,
+          dir_id: nil,
+          enterprise_id: nil,
+          # Id of the Letter of Authorization document attached to this number's batch.
+          loa_document_id: nil,
+          # E.164 with leading `+`.
+          phone_number: nil,
+          # Populated when `status` is `unsuccessful` or `permanently_rejected`.
+          rejection_reason: nil,
+          # Phone-number lifecycle status.
+          #
+          # - `submitted` / `in_review` - Telnyx is reviewing the batch this number belongs
+          #   to.
+          # - `verified` - approved; the DIR's display identity will be shown on outbound
+          #   calls from this number.
+          # - `unsuccessful` - Telnyx rejected this submission; the customer may re-add to
+          #   retry.
+          # - `suspended` - temporarily disabled (e.g. by an active infringement claim on
+          #   the DIR).
+          # - `expired` - verification expired; re-add to renew.
+          # - `permanently_rejected` - terminal; cannot be re-added on this or any other DIR
+          #   you own.
+          status: nil,
+          updated_at: nil,
+          verified_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              batch_id: T.nilable(String),
+              created_at: Time,
+              dir_id: String,
+              enterprise_id: String,
+              loa_document_id: T.nilable(String),
+              phone_number: String,
+              rejection_reason:
+                T.nilable(
+                  Telnyx::Models::Dir::PhoneNumberListResponse::RejectionReason
+                ),
+              status:
+                Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol,
+              updated_at: Time,
+              verified_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class RejectionReason < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Dir::PhoneNumberListResponse::RejectionReason,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :code
+
+          sig { params(code: String).void }
+          attr_writer :code
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :detail
+
+          sig { params(detail: String).void }
+          attr_writer :detail
+
+          # Customer-visible free-text comment from the Telnyx vetting team. Only the first
+          # entry of `rejection_reasons` carries this; the rest are `null`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :message
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :title
+
+          sig { params(title: String).void }
+          attr_writer :title
+
+          # Populated when `status` is `unsuccessful` or `permanently_rejected`.
+          sig do
+            params(
+              code: String,
+              detail: String,
+              message: T.nilable(String),
+              title: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            code: nil,
+            detail: nil,
+            # Customer-visible free-text comment from the Telnyx vetting team. Only the first
+            # entry of `rejection_reasons` carries this; the rest are `null`.
+            message: nil,
+            title: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                code: String,
+                detail: String,
+                message: T.nilable(String),
+                title: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # Phone-number lifecycle status.
+        #
+        # - `submitted` / `in_review` - Telnyx is reviewing the batch this number belongs
+        #   to.
+        # - `verified` - approved; the DIR's display identity will be shown on outbound
+        #   calls from this number.
+        # - `unsuccessful` - Telnyx rejected this submission; the customer may re-add to
+        #   retry.
+        # - `suspended` - temporarily disabled (e.g. by an active infringement claim on
+        #   the DIR).
+        # - `expired` - verification expired; re-add to renew.
+        # - `permanently_rejected` - terminal; cannot be re-added on this or any other DIR
+        #   you own.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Models::Dir::PhoneNumberListResponse::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SUBMITTED =
+            T.let(
+              :submitted,
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol
+            )
+          IN_REVIEW =
+            T.let(
+              :in_review,
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol
+            )
+          VERIFIED =
+            T.let(
+              :verified,
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol
+            )
+          UNSUCCESSFUL =
+            T.let(
+              :unsuccessful,
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol
+            )
+          SUSPENDED =
+            T.let(
+              :suspended,
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol
+            )
+          PERMANENTLY_REJECTED =
+            T.let(
+              :permanently_rejected,
+              Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::Dir::PhoneNumberListResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir/phone_number_remove_params.rbi

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

data/rbi/telnyx/models/dir/phone_number_remove_response.rbi

@@ -0,0 +1,204 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Dir
+      class PhoneNumberRemoveResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Dir::PhoneNumberRemoveResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Phone numbers that were successfully soft-deleted. Bare E.164 strings.
+        sig { returns(T::Array[String]) }
+        attr_accessor :data
+
+        sig { returns(Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta) }
+        attr_reader :meta
+
+        sig do
+          params(
+            meta: Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::OrHash
+          ).void
+        end
+        attr_writer :meta
+
+        # Bulk-delete partial-success response. `data` is the list of phone numbers that
+        # were soft-deleted. `meta.errors` holds per-number failures (e.g. number not
+        # associated with this DIR). When EVERY number in the request fails, the endpoint
+        # instead returns 400 with the canonical Telnyx error envelope and `data`/`meta`
+        # are absent.
+        sig do
+          params(
+            data: T::Array[String],
+            meta: Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Phone numbers that were successfully soft-deleted. Bare E.164 strings.
+          data:,
+          meta:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T::Array[String],
+              meta: Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Meta < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Per-number failures that did not block the call. Each entry has `phone_number`,
+          # `code`, `title`, `detail`.
+          sig do
+            returns(
+              T::Array[
+                Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error
+              ]
+            )
+          end
+          attr_accessor :errors
+
+          sig do
+            params(
+              errors:
+                T::Array[
+                  Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Per-number failures that did not block the call. Each entry has `phone_number`,
+            # `code`, `title`, `detail`.
+            errors:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                errors:
+                  T::Array[
+                    Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Error < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Stable per-number error code. Currently only `not_associated` is emitted, when
+            # the number is not attached to this DIR.
+            sig do
+              returns(
+                Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error::Code::TaggedSymbol
+              )
+            end
+            attr_accessor :code
+
+            sig { returns(String) }
+            attr_accessor :detail
+
+            sig { returns(String) }
+            attr_accessor :phone_number
+
+            sig { returns(String) }
+            attr_accessor :title
+
+            # Per-number error returned by the bulk-delete endpoint. Bulk-add does not use
+            # this shape - it returns a 400 with the canonical envelope grouping numbers by
+            # failure category.
+            sig do
+              params(
+                code:
+                  Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error::Code::OrSymbol,
+                detail: String,
+                phone_number: String,
+                title: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Stable per-number error code. Currently only `not_associated` is emitted, when
+              # the number is not attached to this DIR.
+              code:,
+              detail:,
+              phone_number:,
+              title:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  code:
+                    Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error::Code::TaggedSymbol,
+                  detail: String,
+                  phone_number: String,
+                  title: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Stable per-number error code. Currently only `not_associated` is emitted, when
+            # the number is not attached to this DIR.
+            module Code
+              extend Telnyx::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error::Code
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              NOT_ASSOCIATED =
+                T.let(
+                  :not_associated,
+                  Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error::Code::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::Models::Dir::PhoneNumberRemoveResponse::Meta::Error::Code::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end