telnyx 5.126.0 → 5.128.0

data/rbi/telnyx/models/enterprises/reputation/number_retrieve_response.rbi

@@ -14,32 +14,128 @@ module Telnyx
             end
 
           sig do
-            returns(T.nilable(Telnyx::ReputationPhoneNumberWithReputationData))
+            returns(
+              Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data
+            )
           end
           attr_reader :data
 
           sig do
             params(
-              data: Telnyx::ReputationPhoneNumberWithReputationData::OrHash
+              data:
+                Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::OrHash
             ).void
           end
           attr_writer :data
 
           sig do
             params(
-              data: Telnyx::ReputationPhoneNumberWithReputationData::OrHash
+              data:
+                Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(data: nil)
+          def self.new(data:)
           end
 
           sig do
             override.returns(
-              { data: Telnyx::ReputationPhoneNumberWithReputationData }
+              {
+                data:
+                  Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data
+              }
             )
           end
           def to_hash
           end
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :enterprise_id
+
+            sig { params(enterprise_id: String).void }
+            attr_writer :enterprise_id
+
+            # E.164 with leading `+`.
+            sig { returns(T.nilable(String)) }
+            attr_reader :phone_number
+
+            sig { params(phone_number: String).void }
+            attr_writer :phone_number
+
+            # `null` until the first refresh has been collected for this number.
+            sig { returns(T.nilable(Telnyx::ReputationData)) }
+            attr_reader :reputation_data
+
+            sig do
+              params(
+                reputation_data: T.nilable(Telnyx::ReputationData::OrHash)
+              ).void
+            end
+            attr_writer :reputation_data
+
+            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 do
+              params(
+                id: String,
+                created_at: Time,
+                enterprise_id: String,
+                phone_number: String,
+                reputation_data: T.nilable(Telnyx::ReputationData::OrHash),
+                updated_at: Time
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              id: nil,
+              created_at: nil,
+              enterprise_id: nil,
+              # E.164 with leading `+`.
+              phone_number: nil,
+              # `null` until the first refresh has been collected for this number.
+              reputation_data: nil,
+              updated_at: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  created_at: Time,
+                  enterprise_id: String,
+                  phone_number: String,
+                  reputation_data: T.nilable(Telnyx::ReputationData),
+                  updated_at: Time
+                }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end

data/rbi/telnyx/models/enterprises/reputation/remediation_create_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class RemediationCreateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Enterprises::Reputation::RemediationCreateParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :enterprise_id
+
+          # How the numbers are used (free text).
+          sig { returns(String) }
+          attr_accessor :call_purpose
+
+          # Phone numbers in E.164 format. Each must belong to this enterprise. Maximum
+          # 2,000 per request.
+          sig { returns(T::Array[String]) }
+          attr_accessor :phone_numbers
+
+          # Optional contact email for this remediation request.
+          sig { returns(T.nilable(String)) }
+          attr_reader :contact_email
+
+          sig { params(contact_email: String).void }
+          attr_writer :contact_email
+
+          # Optional https:// URL for status notifications.
+          sig { returns(T.nilable(String)) }
+          attr_reader :webhook_url
+
+          sig { params(webhook_url: String).void }
+          attr_writer :webhook_url
+
+          sig do
+            params(
+              enterprise_id: String,
+              call_purpose: String,
+              phone_numbers: T::Array[String],
+              contact_email: String,
+              webhook_url: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            enterprise_id:,
+            # How the numbers are used (free text).
+            call_purpose:,
+            # Phone numbers in E.164 format. Each must belong to this enterprise. Maximum
+            # 2,000 per request.
+            phone_numbers:,
+            # Optional contact email for this remediation request.
+            contact_email: nil,
+            # Optional https:// URL for status notifications.
+            webhook_url: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enterprise_id: String,
+                call_purpose: String,
+                phone_numbers: T::Array[String],
+                contact_email: String,
+                webhook_url: String,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/enterprises/reputation/remediation_create_response.rbi

@@ -0,0 +1,332 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class RemediationCreateResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Full detail of a remediation request, returned on submit and GET by id.
+          sig do
+            returns(
+              Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Full detail of a remediation request, returned on submit and GET by id.
+            data:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :id
+
+            sig { returns(String) }
+            attr_accessor :call_purpose
+
+            sig { returns(Time) }
+            attr_accessor :created_at
+
+            # Total phone numbers in this batch, including any later cancelled. May exceed the
+            # sum of the per-category result buckets, which omit cancelled numbers.
+            sig { returns(Integer) }
+            attr_accessor :phone_numbers_count
+
+            # Numbers rejected before submission (e.g. cooldown).
+            sig { returns(Integer) }
+            attr_accessor :phone_numbers_ineligible
+
+            # Numbers accepted for remediation, i.e. not rejected as ineligible. Counts
+            # numbers still queued (pending) as well as processed ones.
+            sig { returns(Integer) }
+            attr_accessor :phone_numbers_submitted
+
+            # Customer-facing status of a remediation request.
+            sig do
+              returns(
+                Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status::TaggedSymbol
+              )
+            end
+            attr_accessor :status
+
+            sig { returns(Time) }
+            attr_accessor :updated_at
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :contact_email
+
+            # Per-category buckets. Populated once results are available. Null while the
+            # request is still pending.
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Results
+                )
+              )
+            end
+            attr_reader :results
+
+            sig do
+              params(
+                results:
+                  T.nilable(
+                    Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Results::OrHash
+                  )
+              ).void
+            end
+            attr_writer :results
+
+            sig { returns(T.nilable(Time)) }
+            attr_accessor :tier1_completed_at
+
+            sig { returns(T.nilable(Time)) }
+            attr_accessor :tier2_completed_at
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :webhook_url
+
+            # Full detail of a remediation request, returned on submit and GET by id.
+            sig do
+              params(
+                id: String,
+                call_purpose: String,
+                created_at: Time,
+                phone_numbers_count: Integer,
+                phone_numbers_ineligible: Integer,
+                phone_numbers_submitted: Integer,
+                status:
+                  Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status::OrSymbol,
+                updated_at: Time,
+                contact_email: T.nilable(String),
+                results:
+                  T.nilable(
+                    Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Results::OrHash
+                  ),
+                tier1_completed_at: T.nilable(Time),
+                tier2_completed_at: T.nilable(Time),
+                webhook_url: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              id:,
+              call_purpose:,
+              created_at:,
+              # Total phone numbers in this batch, including any later cancelled. May exceed the
+              # sum of the per-category result buckets, which omit cancelled numbers.
+              phone_numbers_count:,
+              # Numbers rejected before submission (e.g. cooldown).
+              phone_numbers_ineligible:,
+              # Numbers accepted for remediation, i.e. not rejected as ineligible. Counts
+              # numbers still queued (pending) as well as processed ones.
+              phone_numbers_submitted:,
+              # Customer-facing status of a remediation request.
+              status:,
+              updated_at:,
+              contact_email: nil,
+              # Per-category buckets. Populated once results are available. Null while the
+              # request is still pending.
+              results: nil,
+              tier1_completed_at: nil,
+              tier2_completed_at: nil,
+              webhook_url: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  call_purpose: String,
+                  created_at: Time,
+                  phone_numbers_count: Integer,
+                  phone_numbers_ineligible: Integer,
+                  phone_numbers_submitted: Integer,
+                  status:
+                    Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status::TaggedSymbol,
+                  updated_at: Time,
+                  contact_email: T.nilable(String),
+                  results:
+                    T.nilable(
+                      Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Results
+                    ),
+                  tier1_completed_at: T.nilable(Time),
+                  tier2_completed_at: T.nilable(Time),
+                  webhook_url: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Customer-facing status of a remediation request.
+            module Status
+              extend Telnyx::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PENDING =
+                T.let(
+                  :pending,
+                  Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status::TaggedSymbol
+                )
+              IN_PROGRESS =
+                T.let(
+                  :in_progress,
+                  Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status::TaggedSymbol
+                )
+              COMPLETED =
+                T.let(
+                  :completed,
+                  Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status::TaggedSymbol
+                )
+              FAILED =
+                T.let(
+                  :failed,
+                  Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status::TaggedSymbol
+                )
+              CANCELLED =
+                T.let(
+                  :cancelled,
+                  Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Status::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            class Results < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse::Data::Results,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(T.nilable(T::Array[String])) }
+              attr_reader :ineligible
+
+              sig { params(ineligible: T::Array[String]).void }
+              attr_writer :ineligible
+
+              sig { returns(T.nilable(T::Array[String])) }
+              attr_reader :not_flagged
+
+              sig { params(not_flagged: T::Array[String]).void }
+              attr_writer :not_flagged
+
+              sig { returns(T.nilable(T::Array[String])) }
+              attr_reader :refused
+
+              sig { params(refused: T::Array[String]).void }
+              attr_writer :refused
+
+              sig { returns(T.nilable(T::Array[String])) }
+              attr_reader :remediated
+
+              sig { params(remediated: T::Array[String]).void }
+              attr_writer :remediated
+
+              sig { returns(T.nilable(T::Array[String])) }
+              attr_reader :requires_review
+
+              sig { params(requires_review: T::Array[String]).void }
+              attr_writer :requires_review
+
+              # Per-category buckets. Populated once results are available. Null while the
+              # request is still pending.
+              sig do
+                params(
+                  ineligible: T::Array[String],
+                  not_flagged: T::Array[String],
+                  refused: T::Array[String],
+                  remediated: T::Array[String],
+                  requires_review: T::Array[String]
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                ineligible: nil,
+                not_flagged: nil,
+                refused: nil,
+                remediated: nil,
+                requires_review: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    ineligible: T::Array[String],
+                    not_flagged: T::Array[String],
+                    refused: T::Array[String],
+                    remediated: T::Array[String],
+                    requires_review: T::Array[String]
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end