telnyx 5.170.0 → 5.171.0

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

@@ -0,0 +1,279 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class NumberRetrieveOwnershipResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(data:)
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Service provider ID (SPID) of the carrier that held the number when its
+            # ownership was last established.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :baseline_carrier
+
+            sig { returns(T.nilable(Time)) }
+            attr_accessor :baseline_recorded_at
+
+            sig { returns(T.nilable(Time)) }
+            attr_accessor :confirm_by
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :flag_reason
+
+            # Ownership events, most recent first.
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::History
+                  ]
+                )
+              )
+            end
+            attr_reader :history
+
+            sig do
+              params(
+                history:
+                  T::Array[
+                    Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::History::OrHash
+                  ]
+              ).void
+            end
+            attr_writer :history
+
+            # When ownership of the number was last checked.
+            sig { returns(T.nilable(Time)) }
+            attr_accessor :last_checked_at
+
+            # Result of ongoing ownership checks. `verified`: the number is with the carrier
+            # on record. `pending_confirmation`: the number's carrier changed, or a periodic
+            # ownership re-verification is due; confirm you still own it before `confirm_by`.
+            # `flagged`: a periodic re-verification went unanswered; the number stays
+            # monitored and is not removed, but confirm ownership
+            # (`POST .../ownership_confirm`) to return it to `verified`. `removed`: the number
+            # is no longer monitored; returned by `POST .../ownership_confirm` with
+            # `still_own: false`, and when listing numbers with
+            # `filter[ownership_status]=removed`.
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :ownership_status
+
+            sig do
+              params(
+                ownership_status:
+                  Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::OrSymbol
+              ).void
+            end
+            attr_writer :ownership_status
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :phone_number
+
+            sig { params(phone_number: String).void }
+            attr_writer :phone_number
+
+            # Where the phone number is hosted. `telnyx`: in your Telnyx inventory.
+            # `external`: a number you own that is hosted with another provider.
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::Enterprises::Reputation::ReputationNumberSource::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :source
+
+            sig do
+              params(
+                source:
+                  Telnyx::Enterprises::Reputation::ReputationNumberSource::OrSymbol
+              ).void
+            end
+            attr_writer :source
+
+            sig do
+              params(
+                baseline_carrier: T.nilable(String),
+                baseline_recorded_at: T.nilable(Time),
+                confirm_by: T.nilable(Time),
+                flag_reason: T.nilable(String),
+                history:
+                  T::Array[
+                    Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::History::OrHash
+                  ],
+                last_checked_at: T.nilable(Time),
+                ownership_status:
+                  Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::OrSymbol,
+                phone_number: String,
+                source:
+                  Telnyx::Enterprises::Reputation::ReputationNumberSource::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Service provider ID (SPID) of the carrier that held the number when its
+              # ownership was last established.
+              baseline_carrier: nil,
+              baseline_recorded_at: nil,
+              confirm_by: nil,
+              flag_reason: nil,
+              # Ownership events, most recent first.
+              history: nil,
+              # When ownership of the number was last checked.
+              last_checked_at: nil,
+              # Result of ongoing ownership checks. `verified`: the number is with the carrier
+              # on record. `pending_confirmation`: the number's carrier changed, or a periodic
+              # ownership re-verification is due; confirm you still own it before `confirm_by`.
+              # `flagged`: a periodic re-verification went unanswered; the number stays
+              # monitored and is not removed, but confirm ownership
+              # (`POST .../ownership_confirm`) to return it to `verified`. `removed`: the number
+              # is no longer monitored; returned by `POST .../ownership_confirm` with
+              # `still_own: false`, and when listing numbers with
+              # `filter[ownership_status]=removed`.
+              ownership_status: nil,
+              phone_number: nil,
+              # Where the phone number is hosted. `telnyx`: in your Telnyx inventory.
+              # `external`: a number you own that is hosted with another provider.
+              source: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  baseline_carrier: T.nilable(String),
+                  baseline_recorded_at: T.nilable(Time),
+                  confirm_by: T.nilable(Time),
+                  flag_reason: T.nilable(String),
+                  history:
+                    T::Array[
+                      Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::History
+                    ],
+                  last_checked_at: T.nilable(Time),
+                  ownership_status:
+                    Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::TaggedSymbol,
+                  phone_number: String,
+                  source:
+                    Telnyx::Enterprises::Reputation::ReputationNumberSource::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class History < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::History,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # `added`, `check`, `flag`, `confirm` or `removed`.
+              sig { returns(T.nilable(String)) }
+              attr_reader :event_type
+
+              sig { params(event_type: String).void }
+              attr_writer :event_type
+
+              sig { returns(T.nilable(Time)) }
+              attr_reader :occurred_at
+
+              sig { params(occurred_at: Time).void }
+              attr_writer :occurred_at
+
+              # What the event found or did, for example `unchanged` or `carrier_changed`.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :outcome
+
+              sig do
+                params(
+                  event_type: String,
+                  occurred_at: Time,
+                  outcome: T.nilable(String)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # `added`, `check`, `flag`, `confirm` or `removed`.
+                event_type: nil,
+                occurred_at: nil,
+                # What the event found or did, for example `unchanged` or `carrier_changed`.
+                outcome: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    event_type: String,
+                    occurred_at: Time,
+                    outcome: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -50,8 +50,9 @@ module Telnyx
           sig { returns(T.nilable(String)) }
           attr_accessor :contact_email
 
-          # Per-category buckets. Populated once results are available. Null while the
-          # request is still pending.
+          # Per-category buckets of phone numbers, populated once results are available.
+          # Empty lists are kept (not omitted) so consumers can iterate without
+          # null-checking each key.
           sig do
             returns(
               T.nilable(
@@ -118,8 +119,9 @@ module Telnyx
             status:,
             updated_at:,
             contact_email: nil,
-            # Per-category buckets. Populated once results are available. Null while the
-            # request is still pending.
+            # Per-category buckets of phone numbers, populated once results are available.
+            # Empty lists are kept (not omitted) so consumers can iterate without
+            # null-checking each key.
             results: nil,
             tier1_completed_at: nil,
             tier2_completed_at: nil,

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

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      ReputationNumberSource = Reputation::ReputationNumberSource
+
+      module Reputation
+        # Where the phone number is hosted. `telnyx`: in your Telnyx inventory.
+        # `external`: a number you own that is hosted with another provider.
+        module ReputationNumberSource
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Enterprises::Reputation::ReputationNumberSource
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TELNYX =
+            T.let(
+              :telnyx,
+              Telnyx::Enterprises::Reputation::ReputationNumberSource::TaggedSymbol
+            )
+          EXTERNAL =
+            T.let(
+              :external,
+              Telnyx::Enterprises::Reputation::ReputationNumberSource::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Enterprises::Reputation::ReputationNumberSource::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      ReputationOwnershipStatus = Reputation::ReputationOwnershipStatus
+
+      module Reputation
+        # Result of ongoing ownership checks. `verified`: the number is with the carrier
+        # on record. `pending_confirmation`: the number's carrier changed, or a periodic
+        # ownership re-verification is due; confirm you still own it before `confirm_by`.
+        # `flagged`: a periodic re-verification went unanswered; the number stays
+        # monitored and is not removed, but confirm ownership
+        # (`POST .../ownership_confirm`) to return it to `verified`. `removed`: the number
+        # is no longer monitored; returned by `POST .../ownership_confirm` with
+        # `still_own: false`, and when listing numbers with
+        # `filter[ownership_status]=removed`.
+        module ReputationOwnershipStatus
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Enterprises::Reputation::ReputationOwnershipStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          VERIFIED =
+            T.let(
+              :verified,
+              Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::TaggedSymbol
+            )
+          FLAGGED =
+            T.let(
+              :flagged,
+              Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::TaggedSymbol
+            )
+          PENDING_CONFIRMATION =
+            T.let(
+              :pending_confirmation,
+              Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::TaggedSymbol
+            )
+          REMOVED =
+            T.let(
+              :removed,
+              Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -15,12 +15,48 @@ module Telnyx
               )
             end
 
+          # Deadline to confirm you still own the number. Set only while `ownership_status`
+          # is `pending_confirmation`.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :confirm_by
+
           sig { returns(T.nilable(String)) }
           attr_reader :enterprise_id
 
           sig { params(enterprise_id: String).void }
           attr_writer :enterprise_id
 
+          # Why the number's ownership was flagged. `carrier_changed` when an ownership
+          # check found the number with a different carrier.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :flag_reason
+
+          # Result of ongoing ownership checks. `verified`: the number is with the carrier
+          # on record. `pending_confirmation`: the number's carrier changed, or a periodic
+          # ownership re-verification is due; confirm you still own it before `confirm_by`.
+          # `flagged`: a periodic re-verification went unanswered; the number stays
+          # monitored and is not removed, but confirm ownership
+          # (`POST .../ownership_confirm`) to return it to `verified`. `removed`: the number
+          # is no longer monitored; returned by `POST .../ownership_confirm` with
+          # `still_own: false`, and when listing numbers with
+          # `filter[ownership_status]=removed`.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :ownership_status
+
+          sig do
+            params(
+              ownership_status:
+                Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::OrSymbol
+            ).void
+          end
+          attr_writer :ownership_status
+
           # E.164 with leading `+`.
           sig { returns(T.nilable(String)) }
           attr_reader :phone_number
@@ -28,7 +64,26 @@ module Telnyx
           sig { params(phone_number: String).void }
           attr_writer :phone_number
 
-          # `null` until the first refresh has been collected for this number.
+          # Why a number was removed. `ported_away`: you confirmed the number left your
+          # control after a carrier change. `unconfirmed_ownership`: a carrier change was
+          # not confirmed before the deadline. `reassigned`: the number was reported as
+          # permanently disconnected. `customer_reported`: you reported that you no longer
+          # own the number. `customer_removed`: you removed the number.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :removal_reason
+
+          # When the number was removed. Set only for removed numbers.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :removed_at
+
+          # Reputation snapshot for a phone number. Each metric is a 0–100 score;
+          # `spam_risk` is a coarse bucket. Field set may grow over time - read by key.
           sig { returns(T.nilable(Telnyx::ReputationData)) }
           attr_reader :reputation_data
 
@@ -39,6 +94,25 @@ module Telnyx
           end
           attr_writer :reputation_data
 
+          # Where the phone number is hosted. `telnyx`: in your Telnyx inventory.
+          # `external`: a number you own that is hosted with another provider.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Enterprises::Reputation::ReputationNumberSource::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :source
+
+          sig do
+            params(
+              source:
+                Telnyx::Enterprises::Reputation::ReputationNumberSource::OrSymbol
+            ).void
+          end
+          attr_writer :source
+
           sig { returns(T.nilable(String)) }
           attr_reader :id
 
@@ -60,21 +134,60 @@ module Telnyx
           sig do
             params(
               id: String,
+              confirm_by: T.nilable(Time),
               created_at: Time,
               enterprise_id: String,
+              flag_reason: T.nilable(String),
+              ownership_status:
+                Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::OrSymbol,
               phone_number: String,
+              removal_reason:
+                T.nilable(
+                  Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason::OrSymbol
+                ),
+              removed_at: T.nilable(Time),
               reputation_data: T.nilable(Telnyx::ReputationData::OrHash),
+              source:
+                Telnyx::Enterprises::Reputation::ReputationNumberSource::OrSymbol,
               updated_at: Time
             ).returns(T.attached_class)
           end
           def self.new(
             id: nil,
+            # Deadline to confirm you still own the number. Set only while `ownership_status`
+            # is `pending_confirmation`.
+            confirm_by: nil,
             created_at: nil,
             enterprise_id: nil,
+            # Why the number's ownership was flagged. `carrier_changed` when an ownership
+            # check found the number with a different carrier.
+            flag_reason: nil,
+            # Result of ongoing ownership checks. `verified`: the number is with the carrier
+            # on record. `pending_confirmation`: the number's carrier changed, or a periodic
+            # ownership re-verification is due; confirm you still own it before `confirm_by`.
+            # `flagged`: a periodic re-verification went unanswered; the number stays
+            # monitored and is not removed, but confirm ownership
+            # (`POST .../ownership_confirm`) to return it to `verified`. `removed`: the number
+            # is no longer monitored; returned by `POST .../ownership_confirm` with
+            # `still_own: false`, and when listing numbers with
+            # `filter[ownership_status]=removed`.
+            ownership_status: nil,
             # E.164 with leading `+`.
             phone_number: nil,
-            # `null` until the first refresh has been collected for this number.
+            # Why a number was removed. `ported_away`: you confirmed the number left your
+            # control after a carrier change. `unconfirmed_ownership`: a carrier change was
+            # not confirmed before the deadline. `reassigned`: the number was reported as
+            # permanently disconnected. `customer_reported`: you reported that you no longer
+            # own the number. `customer_removed`: you removed the number.
+            removal_reason: nil,
+            # When the number was removed. Set only for removed numbers.
+            removed_at: nil,
+            # Reputation snapshot for a phone number. Each metric is a 0–100 score;
+            # `spam_risk` is a coarse bucket. Field set may grow over time - read by key.
             reputation_data: nil,
+            # Where the phone number is hosted. `telnyx`: in your Telnyx inventory.
+            # `external`: a number you own that is hosted with another provider.
+            source: nil,
             updated_at: nil
           )
           end
@@ -83,16 +196,81 @@ module Telnyx
             override.returns(
               {
                 id: String,
+                confirm_by: T.nilable(Time),
                 created_at: Time,
                 enterprise_id: String,
+                flag_reason: T.nilable(String),
+                ownership_status:
+                  Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::TaggedSymbol,
                 phone_number: String,
+                removal_reason:
+                  T.nilable(
+                    Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason::TaggedSymbol
+                  ),
+                removed_at: T.nilable(Time),
                 reputation_data: T.nilable(Telnyx::ReputationData),
+                source:
+                  Telnyx::Enterprises::Reputation::ReputationNumberSource::TaggedSymbol,
                 updated_at: Time
               }
             )
           end
           def to_hash
           end
+
+          # Why a number was removed. `ported_away`: you confirmed the number left your
+          # control after a carrier change. `unconfirmed_ownership`: a carrier change was
+          # not confirmed before the deadline. `reassigned`: the number was reported as
+          # permanently disconnected. `customer_reported`: you reported that you no longer
+          # own the number. `customer_removed`: you removed the number.
+          module RemovalReason
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PORTED_AWAY =
+              T.let(
+                :ported_away,
+                Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason::TaggedSymbol
+              )
+            UNCONFIRMED_OWNERSHIP =
+              T.let(
+                :unconfirmed_ownership,
+                Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason::TaggedSymbol
+              )
+            REASSIGNED =
+              T.let(
+                :reassigned,
+                Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason::TaggedSymbol
+              )
+            CUSTOMER_REPORTED =
+              T.let(
+                :customer_reported,
+                Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason::TaggedSymbol
+              )
+            CUSTOMER_REMOVED =
+              T.let(
+                :customer_removed,
+                Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end