telnyx 5.170.0 → 5.171.0

data/rbi/telnyx/models/enterprise_list_params.rbi

@@ -18,6 +18,23 @@ module Telnyx
       sig { params(filter_legal_name_contains: String).void }
       attr_writer :filter_legal_name_contains
 
+      # Only return enterprises of this type: `bpo` for call-center (BPO) enterprises,
+      # `enterprise` for normal enterprises. Omit to return both.
+      sig do
+        returns(
+          T.nilable(Telnyx::EnterpriseListParams::FilterRoleType::OrSymbol)
+        )
+      end
+      attr_reader :filter_role_type
+
+      sig do
+        params(
+          filter_role_type:
+            Telnyx::EnterpriseListParams::FilterRoleType::OrSymbol
+        ).void
+      end
+      attr_writer :filter_role_type
+
       # Filter by legal name (partial match).
       sig { returns(T.nilable(String)) }
       attr_reader :legal_name
@@ -42,6 +59,8 @@ module Telnyx
       sig do
         params(
           filter_legal_name_contains: String,
+          filter_role_type:
+            Telnyx::EnterpriseListParams::FilterRoleType::OrSymbol,
           legal_name: String,
           page_number: Integer,
           page_size: Integer,
@@ -51,6 +70,9 @@ module Telnyx
       def self.new(
         # Case-insensitive partial match on legal name.
         filter_legal_name_contains: nil,
+        # Only return enterprises of this type: `bpo` for call-center (BPO) enterprises,
+        # `enterprise` for normal enterprises. Omit to return both.
+        filter_role_type: nil,
         # Filter by legal name (partial match).
         legal_name: nil,
         # 1-based page number. Out-of-range values return an empty page with correct meta.
@@ -65,6 +87,8 @@ module Telnyx
         override.returns(
           {
             filter_legal_name_contains: String,
+            filter_role_type:
+              Telnyx::EnterpriseListParams::FilterRoleType::OrSymbol,
             legal_name: String,
             page_number: Integer,
             page_size: Integer,
@@ -74,6 +98,37 @@ module Telnyx
       end
       def to_hash
       end
+
+      # Only return enterprises of this type: `bpo` for call-center (BPO) enterprises,
+      # `enterprise` for normal enterprises. Omit to return both.
+      module FilterRoleType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EnterpriseListParams::FilterRoleType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENTERPRISE =
+          T.let(
+            :enterprise,
+            Telnyx::EnterpriseListParams::FilterRoleType::TaggedSymbol
+          )
+        BPO =
+          T.let(
+            :bpo,
+            Telnyx::EnterpriseListParams::FilterRoleType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EnterpriseListParams::FilterRoleType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/telnyx/models/enterprise_public.rbi

@@ -20,6 +20,24 @@ module Telnyx
       sig { params(billing_contact: Telnyx::BillingContact::OrHash).void }
       attr_writer :billing_contact
 
+      # Reason Telnyx rejected the BPO (Business Process Outsourcer) verification, when
+      # `bpo_verification_status` is `rejected`; `null` otherwise.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :bpo_verification_rejection_reason
+
+      # Whether Telnyx has approved this BPO (Business Process Outsourcer) account. Only
+      # set for accounts created with `role_type` `bpo`; `null` for normal enterprises.
+      # A BPO enterprise must be `approved` before a DIR can be linked to it through
+      # `bpo_authorizations`.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::EnterprisePublic::BpoVerificationStatus::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :bpo_verification_status
+
       # True once Branded Calling has been activated on this enterprise (see
       # `POST /enterprises/{id}/branded_calling`).
       sig { returns(T.nilable(T::Boolean)) }
@@ -28,7 +46,9 @@ module Telnyx
       sig { params(branded_calling_enabled: T::Boolean).void }
       attr_writer :branded_calling_enabled
 
-      # Optional corporate-registration / company-number identifier.
+      # The official number your company received when it was legally registered or
+      # incorporated (for example from your state or national business registry). It is
+      # on your certificate of incorporation.
       sig { returns(T.nilable(String)) }
       attr_accessor :corporate_registration_number
 
@@ -38,46 +58,61 @@ module Telnyx
       sig { params(country_code: String).void }
       attr_writer :country_code
 
+      # Your own label for this account. Enter any reference that helps you find it in
+      # your records. Telnyx does not use it during vetting.
       sig { returns(T.nilable(String)) }
       attr_reader :customer_reference
 
       sig { params(customer_reference: String).void }
       attr_writer :customer_reference
 
+      # The trade name your business operates under if it is different from your legal
+      # name, also called a Doing Business As (DBA) name. Leave blank if you only use
+      # your legal name.
       sig { returns(T.nilable(String)) }
       attr_reader :doing_business_as
 
       sig { params(doing_business_as: String).void }
       attr_writer :doing_business_as
 
-      # Optional D-U-N-S Number issued by Dun & Bradstreet.
+      # Your optional 9-digit D-U-N-S Number issued by Dun & Bradstreet, a unique
+      # identifier for your business. Leave blank if you do not have one.
       sig { returns(T.nilable(String)) }
       attr_accessor :dun_bradstreet_number
 
+      # US Federal Employer Identification Number (`NN-NNNNNNN`) or Canadian equivalent.
       sig { returns(T.nilable(String)) }
       attr_reader :fein
 
       sig { params(fein: String).void }
       attr_writer :fein
 
+      # The industry your business operates in. Choose the closest match from the list;
+      # if your value is not accepted, pick the nearest category.
       sig { returns(T.nilable(String)) }
       attr_reader :industry
 
       sig { params(industry: String).void }
       attr_writer :industry
 
+      # The state, province, or country where your business was legally incorporated,
+      # for example Delaware.
       sig { returns(T.nilable(String)) }
       attr_reader :jurisdiction_of_incorporation
 
       sig { params(jurisdiction_of_incorporation: String).void }
       attr_writer :jurisdiction_of_incorporation
 
+      # Your business's full registered legal name, exactly as it appears on your
+      # incorporation or tax documents, 3 to 64 characters.
       sig { returns(T.nilable(String)) }
       attr_reader :legal_name
 
       sig { params(legal_name: String).void }
       attr_writer :legal_name
 
+      # Approximate headcount range. Used for vetting heuristics; pick the bucket that
+      # contains your current employee count.
       sig { returns(T.nilable(String)) }
       attr_reader :number_of_employees
 
@@ -100,6 +135,15 @@ module Telnyx
       end
       attr_writer :organization_contact
 
+      # Legal-entity form. Pick the form that matches your incorporation documents:
+      #
+      # - `corporation` - C-corp or S-corp.
+      # - `llc` - limited liability company.
+      # - `partnership` - general/limited partnership.
+      # - `nonprofit` - non-profit corporation, charitable trust, or
+      #   501(c)(3)/equivalent.
+      # - `other` - anything else (sole proprietorships, government bodies, DBAs, etc.).
+      #   You may be asked for additional documents during vetting.
       sig { returns(T.nilable(String)) }
       attr_reader :organization_legal_type
 
@@ -122,20 +166,30 @@ module Telnyx
       sig { params(organization_type: String).void }
       attr_writer :organization_type
 
-      # Optional SIC code for the primary line of business.
+      # The 4-digit Standard Industrial Classification code for your main line of
+      # business, which tells us what industry you operate in. Look it up in the SIC
+      # code directory if you are unsure.
       sig { returns(T.nilable(String)) }
       attr_accessor :primary_business_domain_sic_code
 
-      # Optional professional-license number for regulated industries.
+      # If your business operates under a professional license (for example legal,
+      # medical, or financial services), enter the license number issued by the
+      # licensing authority. Leave blank if it does not apply.
       sig { returns(T.nilable(String)) }
       attr_accessor :professional_license_number
 
-      sig { returns(T.nilable(String)) }
+      sig do
+        returns(T.nilable(Telnyx::EnterprisePublic::RoleType::TaggedSymbol))
+      end
       attr_reader :role_type
 
-      sig { params(role_type: String).void }
+      sig do
+        params(role_type: Telnyx::EnterprisePublic::RoleType::OrSymbol).void
+      end
       attr_writer :role_type
 
+      # Your business's public website address, including https://. Leave blank if your
+      # business has no website.
       sig { returns(T.nilable(String)) }
       attr_reader :website
 
@@ -165,6 +219,11 @@ module Telnyx
           id: String,
           billing_address: Telnyx::PhysicalAddress::OrHash,
           billing_contact: Telnyx::BillingContact::OrHash,
+          bpo_verification_rejection_reason: T.nilable(String),
+          bpo_verification_status:
+            T.nilable(
+              Telnyx::EnterprisePublic::BpoVerificationStatus::OrSymbol
+            ),
           branded_calling_enabled: T::Boolean,
           corporate_registration_number: T.nilable(String),
           country_code: String,
@@ -184,7 +243,7 @@ module Telnyx
           organization_type: String,
           primary_business_domain_sic_code: T.nilable(String),
           professional_license_number: T.nilable(String),
-          role_type: String,
+          role_type: Telnyx::EnterprisePublic::RoleType::OrSymbol,
           updated_at: Time,
           website: String
         ).returns(T.attached_class)
@@ -193,35 +252,75 @@ module Telnyx
         id: nil,
         billing_address: nil,
         billing_contact: nil,
+        # Reason Telnyx rejected the BPO (Business Process Outsourcer) verification, when
+        # `bpo_verification_status` is `rejected`; `null` otherwise.
+        bpo_verification_rejection_reason: nil,
+        # Whether Telnyx has approved this BPO (Business Process Outsourcer) account. Only
+        # set for accounts created with `role_type` `bpo`; `null` for normal enterprises.
+        # A BPO enterprise must be `approved` before a DIR can be linked to it through
+        # `bpo_authorizations`.
+        bpo_verification_status: nil,
         # True once Branded Calling has been activated on this enterprise (see
         # `POST /enterprises/{id}/branded_calling`).
         branded_calling_enabled: nil,
-        # Optional corporate-registration / company-number identifier.
+        # The official number your company received when it was legally registered or
+        # incorporated (for example from your state or national business registry). It is
+        # on your certificate of incorporation.
         corporate_registration_number: nil,
         country_code: nil,
         created_at: nil,
+        # Your own label for this account. Enter any reference that helps you find it in
+        # your records. Telnyx does not use it during vetting.
         customer_reference: nil,
+        # The trade name your business operates under if it is different from your legal
+        # name, also called a Doing Business As (DBA) name. Leave blank if you only use
+        # your legal name.
         doing_business_as: nil,
-        # Optional D-U-N-S Number issued by Dun & Bradstreet.
+        # Your optional 9-digit D-U-N-S Number issued by Dun & Bradstreet, a unique
+        # identifier for your business. Leave blank if you do not have one.
         dun_bradstreet_number: nil,
+        # US Federal Employer Identification Number (`NN-NNNNNNN`) or Canadian equivalent.
         fein: nil,
+        # The industry your business operates in. Choose the closest match from the list;
+        # if your value is not accepted, pick the nearest category.
         industry: nil,
+        # The state, province, or country where your business was legally incorporated,
+        # for example Delaware.
         jurisdiction_of_incorporation: nil,
+        # Your business's full registered legal name, exactly as it appears on your
+        # incorporation or tax documents, 3 to 64 characters.
         legal_name: nil,
+        # Approximate headcount range. Used for vetting heuristics; pick the bucket that
+        # contains your current employee count.
         number_of_employees: nil,
         # True once Phone Number Reputation has been enabled on this enterprise (see
         # `POST /enterprises/{id}/reputation`).
         number_reputation_enabled: nil,
         organization_contact: nil,
+        # Legal-entity form. Pick the form that matches your incorporation documents:
+        #
+        # - `corporation` - C-corp or S-corp.
+        # - `llc` - limited liability company.
+        # - `partnership` - general/limited partnership.
+        # - `nonprofit` - non-profit corporation, charitable trust, or
+        #   501(c)(3)/equivalent.
+        # - `other` - anything else (sole proprietorships, government bodies, DBAs, etc.).
+        #   You may be asked for additional documents during vetting.
         organization_legal_type: nil,
         organization_physical_address: nil,
         organization_type: nil,
-        # Optional SIC code for the primary line of business.
+        # The 4-digit Standard Industrial Classification code for your main line of
+        # business, which tells us what industry you operate in. Look it up in the SIC
+        # code directory if you are unsure.
         primary_business_domain_sic_code: nil,
-        # Optional professional-license number for regulated industries.
+        # If your business operates under a professional license (for example legal,
+        # medical, or financial services), enter the license number issued by the
+        # licensing authority. Leave blank if it does not apply.
         professional_license_number: nil,
         role_type: nil,
         updated_at: nil,
+        # Your business's public website address, including https://. Leave blank if your
+        # business has no website.
         website: nil
       )
       end
@@ -232,6 +331,11 @@ module Telnyx
             id: String,
             billing_address: Telnyx::PhysicalAddress,
             billing_contact: Telnyx::BillingContact,
+            bpo_verification_rejection_reason: T.nilable(String),
+            bpo_verification_status:
+              T.nilable(
+                Telnyx::EnterprisePublic::BpoVerificationStatus::TaggedSymbol
+              ),
             branded_calling_enabled: T::Boolean,
             corporate_registration_number: T.nilable(String),
             country_code: String,
@@ -251,7 +355,7 @@ module Telnyx
             organization_type: String,
             primary_business_domain_sic_code: T.nilable(String),
             professional_license_number: T.nilable(String),
-            role_type: String,
+            role_type: Telnyx::EnterprisePublic::RoleType::TaggedSymbol,
             updated_at: Time,
             website: String
           }
@@ -259,6 +363,66 @@ module Telnyx
       end
       def to_hash
       end
+
+      # Whether Telnyx has approved this BPO (Business Process Outsourcer) account. Only
+      # set for accounts created with `role_type` `bpo`; `null` for normal enterprises.
+      # A BPO enterprise must be `approved` before a DIR can be linked to it through
+      # `bpo_authorizations`.
+      module BpoVerificationStatus
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EnterprisePublic::BpoVerificationStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :pending,
+            Telnyx::EnterprisePublic::BpoVerificationStatus::TaggedSymbol
+          )
+        APPROVED =
+          T.let(
+            :approved,
+            Telnyx::EnterprisePublic::BpoVerificationStatus::TaggedSymbol
+          )
+        REJECTED =
+          T.let(
+            :rejected,
+            Telnyx::EnterprisePublic::BpoVerificationStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::EnterprisePublic::BpoVerificationStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module RoleType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EnterprisePublic::RoleType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENTERPRISE =
+          T.let(:enterprise, Telnyx::EnterprisePublic::RoleType::TaggedSymbol)
+        BPO = T.let(:bpo, Telnyx::EnterprisePublic::RoleType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EnterprisePublic::RoleType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/telnyx/models/enterprise_update_params.rbi

@@ -26,30 +26,43 @@ module Telnyx
       sig { params(billing_contact: Telnyx::BillingContact::OrHash).void }
       attr_writer :billing_contact
 
+      # The official number your company received when it was legally registered or
+      # incorporated (for example from your state or national business registry). It is
+      # on your certificate of incorporation.
       sig { returns(T.nilable(String)) }
       attr_accessor :corporate_registration_number
 
+      # Your own label for this account. Enter any reference that helps you find it in
+      # your records. Telnyx does not use it during vetting.
       sig { returns(T.nilable(String)) }
       attr_reader :customer_reference
 
       sig { params(customer_reference: String).void }
       attr_writer :customer_reference
 
+      # The trade name your business operates under if it is different from your legal
+      # name, also called a Doing Business As (DBA) name. Leave blank if you only use
+      # your legal name.
       sig { returns(T.nilable(String)) }
       attr_reader :doing_business_as
 
       sig { params(doing_business_as: String).void }
       attr_writer :doing_business_as
 
+      # Your optional 9-digit D-U-N-S Number issued by Dun & Bradstreet, a unique
+      # identifier for your business. Leave blank if you do not have one.
       sig { returns(T.nilable(String)) }
       attr_accessor :dun_bradstreet_number
 
+      # US Federal Employer Identification Number (`NN-NNNNNNN`) or Canadian equivalent.
       sig { returns(T.nilable(String)) }
       attr_reader :fein
 
       sig { params(fein: String).void }
       attr_writer :fein
 
+      # The industry your business operates in. Choose the closest match from the list;
+      # if your value is not accepted, pick the nearest category.
       sig do
         returns(T.nilable(Telnyx::EnterpriseUpdateParams::Industry::OrSymbol))
       end
@@ -62,20 +75,24 @@ module Telnyx
       end
       attr_writer :industry
 
-      # Updated state/province/country of incorporation. Optional on update.
+      # The state, province, or country where your business was legally incorporated,
+      # for example Delaware.
       sig { returns(T.nilable(String)) }
       attr_reader :jurisdiction_of_incorporation
 
       sig { params(jurisdiction_of_incorporation: String).void }
       attr_writer :jurisdiction_of_incorporation
 
-      # Legal name of the enterprise.
+      # Your business's full registered legal name, exactly as it appears on your
+      # incorporation or tax documents, 3 to 64 characters.
       sig { returns(T.nilable(String)) }
       attr_reader :legal_name
 
       sig { params(legal_name: String).void }
       attr_writer :legal_name
 
+      # Approximate headcount range. Used for vetting heuristics; pick the bucket that
+      # contains your current employee count.
       sig { returns(T.nilable(String)) }
       attr_reader :number_of_employees
 
@@ -90,6 +107,15 @@ module Telnyx
       end
       attr_writer :organization_contact
 
+      # Legal-entity form. Pick the form that matches your incorporation documents:
+      #
+      # - `corporation` - C-corp or S-corp.
+      # - `llc` - limited liability company.
+      # - `partnership` - general/limited partnership.
+      # - `nonprofit` - non-profit corporation, charitable trust, or
+      #   501(c)(3)/equivalent.
+      # - `other` - anything else (sole proprietorships, government bodies, DBAs, etc.).
+      #   You may be asked for additional documents during vetting.
       sig { returns(T.nilable(String)) }
       attr_reader :organization_legal_type
 
@@ -106,12 +132,20 @@ module Telnyx
       end
       attr_writer :organization_physical_address
 
+      # The 4-digit Standard Industrial Classification code for your main line of
+      # business, which tells us what industry you operate in. Look it up in the SIC
+      # code directory if you are unsure.
       sig { returns(T.nilable(String)) }
       attr_accessor :primary_business_domain_sic_code
 
+      # If your business operates under a professional license (for example legal,
+      # medical, or financial services), enter the license number issued by the
+      # licensing authority. Leave blank if it does not apply.
       sig { returns(T.nilable(String)) }
       attr_accessor :professional_license_number
 
+      # Your business's public website address, including https://. Leave blank if your
+      # business has no website.
       sig { returns(T.nilable(String)) }
       attr_reader :website
 
@@ -145,22 +179,56 @@ module Telnyx
         enterprise_id:,
         billing_address: nil,
         billing_contact: nil,
+        # The official number your company received when it was legally registered or
+        # incorporated (for example from your state or national business registry). It is
+        # on your certificate of incorporation.
         corporate_registration_number: nil,
+        # Your own label for this account. Enter any reference that helps you find it in
+        # your records. Telnyx does not use it during vetting.
         customer_reference: nil,
+        # The trade name your business operates under if it is different from your legal
+        # name, also called a Doing Business As (DBA) name. Leave blank if you only use
+        # your legal name.
         doing_business_as: nil,
+        # Your optional 9-digit D-U-N-S Number issued by Dun & Bradstreet, a unique
+        # identifier for your business. Leave blank if you do not have one.
         dun_bradstreet_number: nil,
+        # US Federal Employer Identification Number (`NN-NNNNNNN`) or Canadian equivalent.
         fein: nil,
+        # The industry your business operates in. Choose the closest match from the list;
+        # if your value is not accepted, pick the nearest category.
         industry: nil,
-        # Updated state/province/country of incorporation. Optional on update.
+        # The state, province, or country where your business was legally incorporated,
+        # for example Delaware.
         jurisdiction_of_incorporation: nil,
-        # Legal name of the enterprise.
+        # Your business's full registered legal name, exactly as it appears on your
+        # incorporation or tax documents, 3 to 64 characters.
         legal_name: nil,
+        # Approximate headcount range. Used for vetting heuristics; pick the bucket that
+        # contains your current employee count.
         number_of_employees: nil,
         organization_contact: nil,
+        # Legal-entity form. Pick the form that matches your incorporation documents:
+        #
+        # - `corporation` - C-corp or S-corp.
+        # - `llc` - limited liability company.
+        # - `partnership` - general/limited partnership.
+        # - `nonprofit` - non-profit corporation, charitable trust, or
+        #   501(c)(3)/equivalent.
+        # - `other` - anything else (sole proprietorships, government bodies, DBAs, etc.).
+        #   You may be asked for additional documents during vetting.
         organization_legal_type: nil,
         organization_physical_address: nil,
+        # The 4-digit Standard Industrial Classification code for your main line of
+        # business, which tells us what industry you operate in. Look it up in the SIC
+        # code directory if you are unsure.
         primary_business_domain_sic_code: nil,
+        # If your business operates under a professional license (for example legal,
+        # medical, or financial services), enter the license number issued by the
+        # licensing authority. Leave blank if it does not apply.
         professional_license_number: nil,
+        # Your business's public website address, including https://. Leave blank if your
+        # business has no website.
         website: nil,
         request_options: {}
       )
@@ -194,6 +262,8 @@ module Telnyx
       def to_hash
       end
 
+      # The industry your business operates in. Choose the closest match from the list;
+      # if your value is not accepted, pick the nearest category.
       module Industry
         extend Telnyx::Internal::Type::Enum