telnyx 5.65.0 → 5.66.1

data/rbi/telnyx/models.rbi

@@ -590,6 +590,18 @@ module Telnyx
 
   EncryptedMedia = Telnyx::Models::EncryptedMedia
 
+  EnterpriseCreateParams = Telnyx::Models::EnterpriseCreateParams
+
+  EnterpriseDeleteParams = Telnyx::Models::EnterpriseDeleteParams
+
+  EnterpriseListParams = Telnyx::Models::EnterpriseListParams
+
+  EnterpriseRetrieveParams = Telnyx::Models::EnterpriseRetrieveParams
+
+  Enterprises = Telnyx::Models::Enterprises
+
+  EnterpriseUpdateParams = Telnyx::Models::EnterpriseUpdateParams
+
   EventNode = Telnyx::Models::EventNode
 
   ExternalConnection = Telnyx::Models::ExternalConnection
@@ -1430,6 +1442,8 @@ module Telnyx
 
   Reports = Telnyx::Models::Reports
 
+  Reputation = Telnyx::Models::Reputation
+
   RequirementGroup = Telnyx::Models::RequirementGroup
 
   RequirementGroupCreateParams = Telnyx::Models::RequirementGroupCreateParams
@@ -1668,6 +1682,8 @@ module Telnyx
   TelephonyCredentialUpdateParams =
     Telnyx::Models::TelephonyCredentialUpdateParams
 
+  TermsOfService = Telnyx::Models::TermsOfService
+
   Texml = Telnyx::Models::Texml
 
   TexmlApplication = Telnyx::Models::TexmlApplication

data/rbi/telnyx/resources/enterprises/reputation/numbers.rbi

@@ -0,0 +1,142 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Enterprises
+      class Reputation
+        # Associate phone numbers with an enterprise for reputation monitoring and
+        # retrieve reputation scores
+        class Numbers
+          # Associate one or more phone numbers with an enterprise for Number Reputation
+          # monitoring.
+          #
+          # **Validations:**
+          #
+          # - Phone numbers must be in E.164 format (e.g., `+16035551234`)
+          # - Phone numbers must be in-service and belong to your account (verified via
+          #   Warehouse)
+          # - Phone numbers must be US local numbers
+          # - Phone numbers cannot already be associated with any enterprise
+          #
+          # **Note:** This operation is atomic — if any number fails validation, the entire
+          # request fails.
+          #
+          # **Maximum:** 100 phone numbers per request.
+          sig do
+            params(
+              enterprise_id: String,
+              phone_numbers: T::Array[String],
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::Models::Enterprises::Reputation::NumberCreateResponse
+            )
+          end
+          def create(
+            # Unique identifier of the enterprise (UUID)
+            enterprise_id,
+            # List of phone numbers to associate for reputation monitoring (max 100)
+            phone_numbers:,
+            request_options: {}
+          )
+          end
+
+          # Get detailed reputation data for a specific phone number associated with an
+          # enterprise.
+          #
+          # **Query Parameters:**
+          #
+          # - `fresh` (default: `false`): When `true`, fetches fresh reputation data (incurs
+          #   API cost). When `false`, returns cached data. If no cached data exists, fresh
+          #   data is automatically fetched.
+          #
+          # **Returns:**
+          #
+          # - `spam_risk`: Overall spam risk level (`low`, `medium`, `high`)
+          # - `spam_category`: Spam category classification
+          # - `maturity_score`: Maturity metric (0–100)
+          # - `connection_score`: Connection quality metric (0–100)
+          # - `engagement_score`: Engagement metric (0–100)
+          # - `sentiment_score`: Sentiment metric (0–100)
+          # - `last_refreshed_at`: Timestamp of last data refresh
+          sig do
+            params(
+              phone_number: String,
+              enterprise_id: String,
+              fresh: T::Boolean,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse
+            )
+          end
+          def retrieve(
+            # Path param: Phone number in E.164 format
+            phone_number,
+            # Path param: Unique identifier of the enterprise (UUID)
+            enterprise_id:,
+            # Query param: When true, fetches fresh reputation data (incurs API cost). When
+            # false, returns cached data.
+            fresh: nil,
+            request_options: {}
+          )
+          end
+
+          # List all phone numbers associated with an enterprise for Number Reputation
+          # monitoring.
+          #
+          # Returns phone numbers with their cached reputation data (if available). Supports
+          # pagination and filtering by phone number.
+          sig do
+            params(
+              enterprise_id: String,
+              page_number: Integer,
+              page_size: Integer,
+              phone_number: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::Internal::DefaultFlatPagination[
+                Telnyx::Models::Enterprises::Reputation::NumberListResponse
+              ]
+            )
+          end
+          def list(
+            # Unique identifier of the enterprise (UUID)
+            enterprise_id,
+            # Page number (1-indexed)
+            page_number: nil,
+            # Number of items per page
+            page_size: nil,
+            # Filter by specific phone number (E.164 format)
+            phone_number: nil,
+            request_options: {}
+          )
+          end
+
+          # Remove a phone number from Number Reputation monitoring for an enterprise.
+          #
+          # The number will no longer be tracked and reputation data will no longer be
+          # refreshed.
+          sig do
+            params(
+              phone_number: String,
+              enterprise_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).void
+          end
+          def delete(
+            # Phone number in E.164 format
+            phone_number,
+            # Unique identifier of the enterprise (UUID)
+            enterprise_id:,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/enterprises/reputation.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Enterprises
+      # Manage Number Reputation enrollment and check frequency settings for an
+      # enterprise
+      class Reputation
+        # Associate phone numbers with an enterprise for reputation monitoring and
+        # retrieve reputation scores
+        sig { returns(Telnyx::Resources::Enterprises::Reputation::Numbers) }
+        attr_reader :numbers
+
+        # Enable Number Reputation service for an enterprise.
+        #
+        # **Requirements:**
+        #
+        # - Signed LOA (Letter of Authorization) document ID
+        # - Reputation check frequency (defaults to `business_daily`)
+        # - Number Reputation Terms of Service must be accepted
+        #
+        # **Flow:**
+        #
+        # 1. Registers the enterprise for reputation monitoring
+        # 2. Creates reputation settings with `pending` status
+        # 3. Awaits admin approval before monitoring begins
+        #
+        # **Resubmission After Rejection:** If a previously rejected record exists, this
+        # endpoint will delete it and create a new `pending` record.
+        #
+        # **Available Frequencies:**
+        #
+        # - `business_daily` — Monday–Friday
+        # - `daily` — Every day
+        # - `weekly` — Once per week
+        # - `biweekly` — Once every two weeks
+        # - `monthly` — Once per month
+        # - `never` — Manual refresh only
+        sig do
+          params(
+            enterprise_id: String,
+            loa_document_id: String,
+            check_frequency:
+              Telnyx::Enterprises::ReputationCreateParams::CheckFrequency::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::Enterprises::ReputationCreateResponse)
+        end
+        def create(
+          # Unique identifier of the enterprise (UUID)
+          enterprise_id,
+          # ID of the signed Letter of Authorization (LOA) document uploaded to the document
+          # service
+          loa_document_id:,
+          # Frequency for automatically refreshing reputation data
+          check_frequency: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieve the current Number Reputation settings for an enterprise.
+        #
+        # Returns the enrollment status (`pending`, `approved`, `rejected`, `deleted`),
+        # check frequency, and any rejection reasons.
+        #
+        # Returns `404` if reputation has not been enabled for this enterprise.
+        sig do
+          params(
+            enterprise_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::Enterprises::ReputationListResponse)
+        end
+        def list(
+          # Unique identifier of the enterprise (UUID)
+          enterprise_id,
+          request_options: {}
+        )
+        end
+
+        # Disable Number Reputation for an enterprise.
+        #
+        # This will:
+        #
+        # - Delete the reputation settings record
+        # - Log the deletion for audit purposes
+        # - Stop all future automated reputation checks
+        #
+        # **Note:** Can only be performed on `approved` reputation settings.
+        sig do
+          params(
+            enterprise_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).void
+        end
+        def delete_all(
+          # Unique identifier of the enterprise (UUID)
+          enterprise_id,
+          request_options: {}
+        )
+        end
+
+        # Update how often reputation data is automatically refreshed.
+        #
+        # **Note:** The enterprise must have `approved` reputation settings. Updating
+        # frequency on `pending` or `rejected` settings will return an error.
+        #
+        # **Available Frequencies:**
+        #
+        # - `business_daily` — Monday–Friday
+        # - `daily` — Every day including weekends
+        # - `weekly` — Once per week
+        # - `biweekly` — Once every two weeks
+        # - `monthly` — Once per month
+        # - `never` — Manual refresh only (no automatic checks)
+        sig do
+          params(
+            enterprise_id: String,
+            check_frequency:
+              Telnyx::Enterprises::ReputationUpdateFrequencyParams::CheckFrequency::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse
+          )
+        end
+        def update_frequency(
+          # Unique identifier of the enterprise (UUID)
+          enterprise_id,
+          # New frequency for refreshing reputation data
+          check_frequency:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/enterprises.rbi

@@ -0,0 +1,226 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    # Enterprise management for Branded Calling and Number Reputation services
+    class Enterprises
+      # Manage Number Reputation enrollment and check frequency settings for an
+      # enterprise
+      sig { returns(Telnyx::Resources::Enterprises::Reputation) }
+      attr_reader :reputation
+
+      # Create a new enterprise for Branded Calling / Number Reputation services.
+      #
+      # Registers the enterprise in the Branded Calling / Number Reputation services,
+      # enabling it to create Display Identity Records (DIRs) or enroll in Number
+      # Reputation monitoring.
+      #
+      # **Required Fields:** `legal_name`, `doing_business_as`, `organization_type`,
+      # `country_code`, `website`, `fein`, `industry`, `number_of_employees`,
+      # `organization_legal_type`, `organization_contact`, `billing_contact`,
+      # `organization_physical_address`, `billing_address`
+      sig do
+        params(
+          billing_address:
+            Telnyx::EnterpriseCreateParams::BillingAddress::OrHash,
+          billing_contact:
+            Telnyx::EnterpriseCreateParams::BillingContact::OrHash,
+          country_code: String,
+          doing_business_as: String,
+          fein: String,
+          industry: String,
+          legal_name: String,
+          number_of_employees:
+            Telnyx::EnterpriseCreateParams::NumberOfEmployees::OrSymbol,
+          organization_contact:
+            Telnyx::EnterpriseCreateParams::OrganizationContact::OrHash,
+          organization_legal_type:
+            Telnyx::EnterpriseCreateParams::OrganizationLegalType::OrSymbol,
+          organization_physical_address:
+            Telnyx::EnterpriseCreateParams::OrganizationPhysicalAddress::OrHash,
+          organization_type:
+            Telnyx::EnterpriseCreateParams::OrganizationType::OrSymbol,
+          website: String,
+          corporate_registration_number: String,
+          customer_reference: String,
+          dun_bradstreet_number: String,
+          primary_business_domain_sic_code: String,
+          professional_license_number: String,
+          role_type: Telnyx::EnterpriseCreateParams::RoleType::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::EnterpriseCreateResponse)
+      end
+      def create(
+        billing_address:,
+        billing_contact:,
+        # Country code. Currently only 'US' is accepted.
+        country_code:,
+        # Primary business name / DBA name
+        doing_business_as:,
+        # Federal Employer Identification Number. Format: XX-XXXXXXX or 9-digit number
+        # (minimum 9 digits).
+        fein:,
+        # Industry classification. Case-insensitive. Accepted values: accounting, finance,
+        # billing, collections, business, charity, nonprofit, communications, telecom,
+        # customer service, support, delivery, shipping, logistics, education, financial,
+        # banking, government, public, healthcare, health, pharmacy, medical, insurance,
+        # legal, law, notifications, scheduling, real estate, property, retail, ecommerce,
+        # sales, marketing, software, technology, tech, media, surveys, market research,
+        # travel, hospitality, hotel
+        industry:,
+        # Legal name of the enterprise
+        legal_name:,
+        # Employee count range
+        number_of_employees:,
+        # Organization contact information. Note: the response returns this object with
+        # the phone field as 'phone' (not 'phone_number').
+        organization_contact:,
+        # Legal structure type
+        organization_legal_type:,
+        organization_physical_address:,
+        # Type of organization
+        organization_type:,
+        # Enterprise website URL. Accepts any string — no URL format validation enforced.
+        website:,
+        # Corporate registration number (optional)
+        corporate_registration_number: nil,
+        # Optional customer reference identifier for your own tracking
+        customer_reference: nil,
+        # D-U-N-S Number (optional)
+        dun_bradstreet_number: nil,
+        # SIC Code (optional)
+        primary_business_domain_sic_code: nil,
+        # Professional license number (optional)
+        professional_license_number: nil,
+        # Role type in Branded Calling / Number Reputation services
+        role_type: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve details of a specific enterprise by ID.
+      sig do
+        params(
+          enterprise_id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::EnterpriseRetrieveResponse)
+      end
+      def retrieve(
+        # Unique identifier of the enterprise (UUID)
+        enterprise_id,
+        request_options: {}
+      )
+      end
+
+      # Update enterprise information. All fields are optional — only the provided
+      # fields will be updated.
+      sig do
+        params(
+          enterprise_id: String,
+          billing_address:
+            Telnyx::EnterpriseUpdateParams::BillingAddress::OrHash,
+          billing_contact:
+            Telnyx::EnterpriseUpdateParams::BillingContact::OrHash,
+          corporate_registration_number: String,
+          customer_reference: String,
+          doing_business_as: String,
+          dun_bradstreet_number: String,
+          fein: String,
+          industry: String,
+          legal_name: String,
+          number_of_employees:
+            Telnyx::EnterpriseUpdateParams::NumberOfEmployees::OrSymbol,
+          organization_contact:
+            Telnyx::EnterpriseUpdateParams::OrganizationContact::OrHash,
+          organization_legal_type:
+            Telnyx::EnterpriseUpdateParams::OrganizationLegalType::OrSymbol,
+          organization_physical_address:
+            Telnyx::EnterpriseUpdateParams::OrganizationPhysicalAddress::OrHash,
+          primary_business_domain_sic_code: String,
+          professional_license_number: String,
+          website: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::EnterpriseUpdateResponse)
+      end
+      def update(
+        # Unique identifier of the enterprise (UUID)
+        enterprise_id,
+        billing_address: nil,
+        billing_contact: nil,
+        # Corporate registration number
+        corporate_registration_number: nil,
+        # Customer reference identifier
+        customer_reference: nil,
+        # DBA name
+        doing_business_as: nil,
+        # D-U-N-S Number
+        dun_bradstreet_number: nil,
+        # Federal Employer Identification Number. Format: XX-XXXXXXX or XXXXXXXXX
+        fein: nil,
+        # Industry classification
+        industry: nil,
+        # Legal name of the enterprise
+        legal_name: nil,
+        # Employee count range
+        number_of_employees: nil,
+        # Organization contact information. Note: the response returns this object with
+        # the phone field as 'phone' (not 'phone_number').
+        organization_contact: nil,
+        # Legal structure type
+        organization_legal_type: nil,
+        organization_physical_address: nil,
+        # SIC Code
+        primary_business_domain_sic_code: nil,
+        # Professional license number
+        professional_license_number: nil,
+        # Company website URL
+        website: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a paginated list of enterprises associated with your account.
+      sig do
+        params(
+          legal_name: String,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::Models::EnterpriseListResponse
+          ]
+        )
+      end
+      def list(
+        # Filter by legal name (partial match)
+        legal_name: nil,
+        # Page number (1-indexed)
+        page_number: nil,
+        # Number of items per page
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete an enterprise and all associated resources. This action is irreversible.
+      sig do
+        params(
+          enterprise_id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Unique identifier of the enterprise (UUID)
+        enterprise_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/reputation/numbers.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Reputation
+      # Associate phone numbers with an enterprise for reputation monitoring and
+      # retrieve reputation scores
+      class Numbers
+        # Get reputation data for a specific phone number without requiring an
+        # `enterprise_id`.
+        #
+        # Same response as the enterprise-scoped endpoint. Uses cached data by default.
+        sig do
+          params(
+            phone_number: String,
+            fresh: T::Boolean,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::Reputation::NumberRetrieveResponse)
+        end
+        def retrieve(
+          # Phone number in E.164 format
+          phone_number,
+          # When true, fetches fresh reputation data (incurs API cost). When false, returns
+          # cached data.
+          fresh: nil,
+          request_options: {}
+        )
+        end
+
+        # List all phone numbers enrolled in Number Reputation monitoring for your
+        # account. This is a simplified endpoint that does not require an `enterprise_id`
+        # — it returns numbers across all your enterprises.
+        #
+        # Supports pagination and filtering by phone number.
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            phone_number: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Internal::DefaultFlatPagination[
+              Telnyx::Models::Reputation::NumberListResponse
+            ]
+          )
+        end
+        def list(
+          # Page number (1-indexed)
+          page_number: nil,
+          # Number of items per page
+          page_size: nil,
+          # Filter by specific phone number (E.164 format)
+          phone_number: nil,
+          request_options: {}
+        )
+        end
+
+        # Remove a phone number from Number Reputation monitoring without requiring an
+        # `enterprise_id`.
+        sig do
+          params(
+            phone_number: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Phone number in E.164 format
+          phone_number,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/reputation.rbi

@@ -0,0 +1,17 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Reputation
+      # Associate phone numbers with an enterprise for reputation monitoring and
+      # retrieve reputation scores
+      sig { returns(Telnyx::Resources::Reputation::Numbers) }
+      attr_reader :numbers
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/terms_of_service/number_reputation.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class TermsOfService
+      # Terms of Service agreement endpoints
+      class NumberReputation
+        # Accept the Terms of Service for the Number Reputation product. Must be called
+        # before using Number Reputation endpoints.
+        #
+        # Returns `400` with error code `10015` if the user has already agreed to the
+        # current ToS version.
+        sig { params(request_options: Telnyx::RequestOptions::OrHash).void }
+        def agree(request_options: {})
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/terms_of_service.rbi

@@ -0,0 +1,16 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class TermsOfService
+      # Terms of Service agreement endpoints
+      sig { returns(Telnyx::Resources::TermsOfService::NumberReputation) }
+      attr_reader :number_reputation
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/telnyx/client.rbs

@@ -334,6 +334,12 @@ module Telnyx
 
     attr_reader traffic_policy_profiles: Telnyx::Resources::TrafficPolicyProfiles
 
+    attr_reader enterprises: Telnyx::Resources::Enterprises
+
+    attr_reader reputation: Telnyx::Resources::Reputation
+
+    attr_reader terms_of_service: Telnyx::Resources::TermsOfService
+
     private def auth_headers: -> ::Hash[String, String]
 
     private def bearer_auth: -> ::Hash[String, String]