telnyx 5.170.0 → 5.171.0

data/rbi/telnyx/models/number_reputation_number_removed_webhook_event.rbi

@@ -0,0 +1,440 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class NumberReputationNumberRemovedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::NumberReputationNumberRemovedWebhookEvent,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Telnyx::NumberReputationNumberRemovedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig { returns(Telnyx::NumberReputationNumberRemovedWebhookEvent::Meta) }
+      attr_reader :meta
+
+      sig do
+        params(
+          meta: Telnyx::NumberReputationNumberRemovedWebhookEvent::Meta::OrHash
+        ).void
+      end
+      attr_writer :meta
+
+      sig do
+        params(
+          data: Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::OrHash,
+          meta: Telnyx::NumberReputationNumberRemovedWebhookEvent::Meta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, meta:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Telnyx::NumberReputationNumberRemovedWebhookEvent::Data,
+            meta: Telnyx::NumberReputationNumberRemovedWebhookEvent::Meta
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Identifies the event; the same id is reused if the event is redelivered.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          returns(
+            Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::EventType::TaggedSymbol
+          )
+        end
+        attr_accessor :event_type
+
+        sig { returns(Time) }
+        attr_accessor :occurred_at
+
+        sig do
+          returns(
+            Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload
+          )
+        end
+        attr_reader :payload
+
+        sig do
+          params(
+            payload:
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::OrHash
+          ).void
+        end
+        attr_writer :payload
+
+        sig do
+          returns(
+            Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::RecordType::TaggedSymbol
+          )
+        end
+        attr_accessor :record_type
+
+        sig do
+          params(
+            id: String,
+            event_type:
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::EventType::OrSymbol,
+            occurred_at: Time,
+            payload:
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::OrHash,
+            record_type:
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::RecordType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Identifies the event; the same id is reused if the event is redelivered.
+          id:,
+          event_type:,
+          occurred_at:,
+          payload:,
+          record_type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              event_type:
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::EventType::TaggedSymbol,
+              occurred_at: Time,
+              payload:
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload,
+              record_type:
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::RecordType::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::EventType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NUMBER_REPUTATION_NUMBER_REMOVED =
+            T.let(
+              :"number_reputation.number.removed",
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::EventType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::EventType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :enterprise_id
+
+          sig do
+            returns(
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::OwnershipStatus::TaggedSymbol
+            )
+          end
+          attr_accessor :ownership_status
+
+          sig { returns(String) }
+          attr_accessor :phone_number
+
+          sig do
+            returns(
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RecordType::TaggedSymbol
+            )
+          end
+          attr_accessor :record_type
+
+          # `ported_away`: you confirmed you no longer own it after a carrier change.
+          # `unconfirmed_ownership`: the confirmation deadline passed. `reassigned`: the
+          # number was reported as permanently disconnected. `customer_reported`: you
+          # reported that you no longer own it. Removing a number yourself with `DELETE`
+          # sends no event.
+          sig do
+            returns(
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RemovalReason::TaggedSymbol
+            )
+          end
+          attr_accessor :removal_reason
+
+          sig { returns(Time) }
+          attr_accessor :removed_at
+
+          # 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(
+              Telnyx::Enterprises::Reputation::ReputationNumberSource::TaggedSymbol
+            )
+          end
+          attr_accessor :source
+
+          sig do
+            params(
+              enterprise_id: String,
+              ownership_status:
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::OwnershipStatus::OrSymbol,
+              phone_number: String,
+              record_type:
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RecordType::OrSymbol,
+              removal_reason:
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RemovalReason::OrSymbol,
+              removed_at: Time,
+              source:
+                Telnyx::Enterprises::Reputation::ReputationNumberSource::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            enterprise_id:,
+            ownership_status:,
+            phone_number:,
+            record_type:,
+            # `ported_away`: you confirmed you no longer own it after a carrier change.
+            # `unconfirmed_ownership`: the confirmation deadline passed. `reassigned`: the
+            # number was reported as permanently disconnected. `customer_reported`: you
+            # reported that you no longer own it. Removing a number yourself with `DELETE`
+            # sends no event.
+            removal_reason:,
+            removed_at:,
+            # Where the phone number is hosted. `telnyx`: in your Telnyx inventory.
+            # `external`: a number you own that is hosted with another provider.
+            source:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enterprise_id: String,
+                ownership_status:
+                  Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::OwnershipStatus::TaggedSymbol,
+                phone_number: String,
+                record_type:
+                  Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RecordType::TaggedSymbol,
+                removal_reason:
+                  Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RemovalReason::TaggedSymbol,
+                removed_at: Time,
+                source:
+                  Telnyx::Enterprises::Reputation::ReputationNumberSource::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module OwnershipStatus
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::OwnershipStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            REMOVED =
+              T.let(
+                :removed,
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::OwnershipStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::OwnershipStatus::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RecordType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            REPUTATION_PHONE_NUMBER =
+              T.let(
+                :reputation_phone_number,
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RecordType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RecordType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # `ported_away`: you confirmed you no longer own it after a carrier change.
+          # `unconfirmed_ownership`: the confirmation deadline passed. `reassigned`: the
+          # number was reported as permanently disconnected. `customer_reported`: you
+          # reported that you no longer own it. Removing a number yourself with `DELETE`
+          # sends no event.
+          module RemovalReason
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RemovalReason
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PORTED_AWAY =
+              T.let(
+                :ported_away,
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RemovalReason::TaggedSymbol
+              )
+            UNCONFIRMED_OWNERSHIP =
+              T.let(
+                :unconfirmed_ownership,
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RemovalReason::TaggedSymbol
+              )
+            REASSIGNED =
+              T.let(
+                :reassigned,
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RemovalReason::TaggedSymbol
+              )
+            CUSTOMER_REPORTED =
+              T.let(
+                :customer_reported,
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RemovalReason::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::Payload::RemovalReason::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::NumberReputationNumberRemovedWebhookEvent::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class Meta < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::NumberReputationNumberRemovedWebhookEvent::Meta,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :attempt
+
+        sig { returns(String) }
+        attr_accessor :delivered_to
+
+        sig do
+          params(attempt: Integer, delivered_to: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(attempt:, delivered_to:)
+        end
+
+        sig { override.returns({ attempt: Integer, delivered_to: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/organization_contact.rbi

@@ -8,19 +8,25 @@ module Telnyx
           T.any(Telnyx::OrganizationContact, Telnyx::Internal::AnyHash)
         end
 
+      # The email address of the main person Telnyx should contact about this account.
+      # For a call center (BPO) account this is the email you will verify later, so use
+      # a mailbox you can access.
       sig { returns(String) }
       attr_accessor :email
 
+      # The first name of the main person Telnyx should contact about this account.
       sig { returns(String) }
       attr_accessor :first_name
 
+      # The job title of the main person Telnyx should contact about this account.
       sig { returns(String) }
       attr_accessor :job_title
 
+      # The last name of the main person Telnyx should contact about this account.
       sig { returns(String) }
       attr_accessor :last_name
 
-      # E.164 format with leading `+`.
+      # The phone number of the main contact, in E.164 format, for example +12125551234.
       sig { returns(String) }
       attr_accessor :phone_number
 
@@ -34,11 +40,17 @@ module Telnyx
         ).returns(T.attached_class)
       end
       def self.new(
+        # The email address of the main person Telnyx should contact about this account.
+        # For a call center (BPO) account this is the email you will verify later, so use
+        # a mailbox you can access.
         email:,
+        # The first name of the main person Telnyx should contact about this account.
         first_name:,
+        # The job title of the main person Telnyx should contact about this account.
         job_title:,
+        # The last name of the main person Telnyx should contact about this account.
         last_name:,
-        # E.164 format with leading `+`.
+        # The phone number of the main contact, in E.164 format, for example +12125551234.
         phone_number:
       )
       end

data/rbi/telnyx/models/phone_numbers/job_list_params.rbi

@@ -16,7 +16,8 @@ module Telnyx
           end
 
         # Consolidated filter parameter (deepObject style). Originally: filter[type],
-        # filter[phone_number], filter[phone_number][], filter[status][]
+        # filter[phone_number], filter[phone_number][], filter[status][],
+        # filter[customer_reference]
         sig { returns(T.nilable(Telnyx::PhoneNumbers::JobListParams::Filter)) }
         attr_reader :filter
 
@@ -64,7 +65,8 @@ module Telnyx
         end
         def self.new(
           # Consolidated filter parameter (deepObject style). Originally: filter[type],
-          # filter[phone_number], filter[phone_number][], filter[status][]
+          # filter[phone_number], filter[phone_number][], filter[status][],
+          # filter[customer_reference]
           filter: nil,
           page_number: nil,
           page_size: nil,
@@ -98,6 +100,18 @@ module Telnyx
               )
             end
 
+          # Returns jobs whose creation-time customer reference exactly matches the supplied
+          # value, not the current reference on a phone number. Only jobs within the lookup
+          # window (90 days by default) are returned. Supply a single non-blank string of up
+          # to 250 characters, without null characters, using
+          # `filter[customer_reference]=yourcustomerrefhere`. An invalid filter value
+          # returns HTTP 422.
+          sig { returns(T.nilable(String)) }
+          attr_reader :customer_reference
+
+          sig { params(customer_reference: String).void }
+          attr_writer :customer_reference
+
           # Returns jobs that targeted any of the supplied account-owned phone numbers.
           # Values beginning with `+` must contain 1 to 20 digits after the plus sign. The
           # 10-value limit is enforced before duplicate values are removed. Unmatched or
@@ -161,9 +175,11 @@ module Telnyx
           attr_writer :type
 
           # Consolidated filter parameter (deepObject style). Originally: filter[type],
-          # filter[phone_number], filter[phone_number][], filter[status][]
+          # filter[phone_number], filter[phone_number][], filter[status][],
+          # filter[customer_reference]
           sig do
             params(
+              customer_reference: String,
               phone_number:
                 Telnyx::PhoneNumbers::JobListParams::Filter::PhoneNumber::Variants,
               status:
@@ -174,6 +190,13 @@ module Telnyx
             ).returns(T.attached_class)
           end
           def self.new(
+            # Returns jobs whose creation-time customer reference exactly matches the supplied
+            # value, not the current reference on a phone number. Only jobs within the lookup
+            # window (90 days by default) are returned. Supply a single non-blank string of up
+            # to 250 characters, without null characters, using
+            # `filter[customer_reference]=yourcustomerrefhere`. An invalid filter value
+            # returns HTTP 422.
+            customer_reference: nil,
             # Returns jobs that targeted any of the supplied account-owned phone numbers.
             # Values beginning with `+` must contain 1 to 20 digits after the plus sign. The
             # 10-value limit is enforced before duplicate values are removed. Unmatched or
@@ -191,6 +214,7 @@ module Telnyx
           sig do
             override.returns(
               {
+                customer_reference: String,
                 phone_number:
                   Telnyx::PhoneNumbers::JobListParams::Filter::PhoneNumber::Variants,
                 status:

data/rbi/telnyx/models/physical_address.rbi

@@ -12,6 +12,7 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :administrative_area
 
+      # The city of your registered business address.
       sig { returns(String) }
       attr_accessor :city
 
@@ -19,12 +20,17 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :country
 
+      # The postal or ZIP code of your registered business address.
       sig { returns(String) }
       attr_accessor :postal_code
 
+      # The street address of your registered business, including the building number
+      # and street name.
       sig { returns(String) }
       attr_accessor :street_address
 
+      # An optional second address line, such as a suite, unit, or floor. Leave blank if
+      # it does not apply.
       sig { returns(T.nilable(String)) }
       attr_accessor :extended_address
 
@@ -41,11 +47,17 @@ module Telnyx
       def self.new(
         # State or province code (e.g. `IL`, `ON`).
         administrative_area:,
+        # The city of your registered business address.
         city:,
         # ISO 3166-1 alpha-2 code (currently `US` or `CA`).
         country:,
+        # The postal or ZIP code of your registered business address.
         postal_code:,
+        # The street address of your registered business, including the building number
+        # and street name.
         street_address:,
+        # An optional second address line, such as a suite, unit, or floor. Leave blank if
+        # it does not apply.
         extended_address: nil
       )
       end

data/rbi/telnyx/models/porting_order.rbi

@@ -370,8 +370,15 @@ module Telnyx
           T.let(:local, Telnyx::PortingOrder::PhoneNumberType::TaggedSymbol)
         MOBILE =
           T.let(:mobile, Telnyx::PortingOrder::PhoneNumberType::TaggedSymbol)
+        MULTIPURPOSE =
+          T.let(
+            :multipurpose,
+            Telnyx::PortingOrder::PhoneNumberType::TaggedSymbol
+          )
         NATIONAL =
           T.let(:national, Telnyx::PortingOrder::PhoneNumberType::TaggedSymbol)
+        OTHER =
+          T.let(:other, Telnyx::PortingOrder::PhoneNumberType::TaggedSymbol)
         SHARED_COST =
           T.let(
             :shared_cost,

data/rbi/telnyx/models/porting_orders/porting_phone_number_block.rbi

@@ -283,11 +283,21 @@ module Telnyx
               :mobile,
               Telnyx::PortingOrders::PortingPhoneNumberBlock::PhoneNumberType::TaggedSymbol
             )
+          MULTIPURPOSE =
+            T.let(
+              :multipurpose,
+              Telnyx::PortingOrders::PortingPhoneNumberBlock::PhoneNumberType::TaggedSymbol
+            )
           NATIONAL =
             T.let(
               :national,
               Telnyx::PortingOrders::PortingPhoneNumberBlock::PhoneNumberType::TaggedSymbol
             )
+          OTHER =
+            T.let(
+              :other,
+              Telnyx::PortingOrders::PortingPhoneNumberBlock::PhoneNumberType::TaggedSymbol
+            )
           SHARED_COST =
             T.let(
               :shared_cost,

data/rbi/telnyx/models/porting_phone_number.rbi

@@ -206,11 +206,21 @@ module Telnyx
             :mobile,
             Telnyx::PortingPhoneNumber::PhoneNumberType::TaggedSymbol
           )
+        MULTIPURPOSE =
+          T.let(
+            :multipurpose,
+            Telnyx::PortingPhoneNumber::PhoneNumberType::TaggedSymbol
+          )
         NATIONAL =
           T.let(
             :national,
             Telnyx::PortingPhoneNumber::PhoneNumberType::TaggedSymbol
           )
+        OTHER =
+          T.let(
+            :other,
+            Telnyx::PortingPhoneNumber::PhoneNumberType::TaggedSymbol
+          )
         SHARED_COST =
           T.let(
             :shared_cost,