telnyx 5.126.0 → 5.128.0

data/rbi/telnyx/resources/reports.rbi

@@ -27,23 +27,23 @@ module Telnyx
         ).returns(Telnyx::Models::ReportListMdrsResponse)
       end
       def list_mdrs(
-        # Message uuid
+        # Filter results by identifier.
         id: nil,
-        # Destination number
+        # Filter results by cld.
         cld: nil,
-        # Origination number
+        # Filter results by cli.
         cli: nil,
-        # Direction (inbound or outbound)
+        # Filter results by direction.
         direction: nil,
         # Pagination end date
         end_date: nil,
-        # Type of message
+        # Filter results by message type.
         message_type: nil,
-        # Name of the profile
+        # Filter results by profile.
         profile: nil,
         # Pagination start date
         start_date: nil,
-        # Message status
+        # Filter results by status.
         status: nil,
         request_options: {}
       )
@@ -73,28 +73,27 @@ module Telnyx
         )
       end
       def list_wdrs(
-        # WDR uuid
+        # Filter results by identifier.
         id: nil,
         # End date
         end_date: nil,
-        # International mobile subscriber identity
+        # Filter results by imsi.
         imsi: nil,
-        # Mobile country code
+        # Filter results by mcc.
         mcc: nil,
-        # Mobile network code
+        # Filter results by mnc.
         mnc: nil,
         page_number: nil,
         page_size: nil,
-        # Phone number
+        # Filter results by phone number.
         phone_number: nil,
-        # Sim card unique identifier
+        # Filter results by sim card id.
         sim_card_id: nil,
-        # Sim group unique identifier
+        # Filter results by sim group id.
         sim_group_id: nil,
-        # Sim group name
+        # Filter results by sim group name.
         sim_group_name: nil,
-        # Field used to order the data. If no field is specified, default value is
-        # 'created_at'
+        # Field and direction to sort the results by.
         sort: nil,
         # Start date
         start_date: nil,

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

@@ -3,13 +3,10 @@
 module Telnyx
   module Resources
     class Reputation
-      # Associate phone numbers with an enterprise for reputation monitoring and
-      # retrieve reputation scores
+      # Phone-number reputation monitoring (spam-score lookup and tracking).
       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.
+        # Convenience alias for
+        # `GET /v2/enterprises/{enterprise_id}/reputation/numbers/{phone_number}`.
         sig do
           params(
             phone_number: String,
@@ -18,45 +15,50 @@ module Telnyx
           ).returns(Telnyx::Models::Reputation::NumberRetrieveResponse)
         end
         def retrieve(
-          # Phone number in E.164 format
+          # Phone number in E.164 format (`+1NPANXXXXXX` for US/CA). The leading `+` MUST be
+          # URL-encoded as `%2B` (e.g. `%2B19493253498`).
           phone_number,
-          # When true, fetches fresh reputation data (incurs API cost). When false, returns
-          # cached data.
+          # When true, fetches fresh reputation data (incurs API cost). When false
+          # (default), 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.
+        # Convenience alias for `GET /v2/enterprises/{enterprise_id}/reputation/numbers`
+        # that returns numbers across every enterprise you own. Useful when you don't want
+        # to look up the enterprise id first.
         sig do
           params(
+            filter_enterprise_id: String,
+            filter_phone_number_contains: String,
+            filter_phone_number_eq: String,
             page_number: Integer,
             page_size: Integer,
-            phone_number: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(
             Telnyx::Internal::DefaultFlatPagination[
-              Telnyx::ReputationPhoneNumberWithReputationData
+              Telnyx::Models::Reputation::NumberListResponse
             ]
           )
         end
         def list(
-          # Page number (1-indexed)
+          # Filter by enterprise ID.
+          filter_enterprise_id: nil,
+          # Partial match on phone number. Must contain at least 5 digits.
+          filter_phone_number_contains: nil,
+          # Exact phone-number match (E.164).
+          filter_phone_number_eq: nil,
+          # 1-based page number. Out-of-range values return an empty page with correct meta.
           page_number: nil,
-          # Number of items per page
+          # Items per page. Maximum 250; values above are clamped to 250.
           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`.
+        # Convenience alias for
+        # `DELETE /v2/enterprises/{enterprise_id}/reputation/numbers/{phone_number}`.
         sig do
           params(
             phone_number: String,
@@ -64,7 +66,8 @@ module Telnyx
           ).void
         end
         def delete(
-          # Phone number in E.164 format
+          # Phone number in E.164 format (`+1NPANXXXXXX` for US/CA). The leading `+` MUST be
+          # URL-encoded as `%2B` (e.g. `%2B19493253498`).
           phone_number,
           request_options: {}
         )

data/rbi/telnyx/resources/reputation.rbi

@@ -3,8 +3,7 @@
 module Telnyx
   module Resources
     class Reputation
-      # Associate phone numbers with an enterprise for reputation monitoring and
-      # retrieve reputation scores
+      # Phone-number reputation monitoring (spam-score lookup and tracking).
       sig { returns(Telnyx::Resources::Reputation::Numbers) }
       attr_reader :numbers
 

data/rbi/telnyx/resources/terms_of_service/agreements.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class TermsOfService
+      # Accept and review the Branded Calling and Phone Number Reputation terms of
+      # service.
+      class Agreements
+        # Retrieve a single ToS agreement record. Returns `404` if the agreement does not
+        # exist or does not belong to the authenticated user.
+        sig do
+          params(
+            agreement_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::TermsOfService::AgreementRetrieveResponse)
+        end
+        def retrieve(
+          # Unique identifier of the agreement.
+          agreement_id,
+          request_options: {}
+        )
+        end
+
+        # Returns the Terms of Service agreements the authenticated user has on file. Each
+        # entry records the version agreed to and when. Most users only have one agreement
+        # per product, but if the ToS is updated and the user re-agrees a new entry is
+        # added.
+        #
+        # Results are paginated with the standard `page[number]` / `page[size]`
+        # parameters; the response uses the standard `{data, meta}` JSON:API envelope.
+        #
+        # By default this returns agreements for **all** products the user has agreed to.
+        # Pass the `product_type` query parameter to scope the result to a single product.
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            product_type:
+              Telnyx::TermsOfService::AgreementListParams::ProductType::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Internal::DefaultFlatPagination[
+              Telnyx::Models::TermsOfService::AgreementListResponse
+            ]
+          )
+        end
+        def list(
+          # 1-based page number. Out-of-range values return an empty page with correct meta.
+          page_number: nil,
+          # Items per page. Maximum 250; values above are clamped to 250.
+          page_size: nil,
+          # Optional filter. Omit to list the user's agreements for **every** product
+          # (branded_calling and number_reputation); pass a value to return only that
+          # product's agreements.
+          product_type: nil,
+          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/branded_calling.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class TermsOfService
+      # Accept and review the Branded Calling and Phone Number Reputation terms of
+      # service.
+      class BrandedCalling
+        # Records the authenticated user's agreement to the current Branded Calling ToS.
+        # No body required. Idempotent - re-calling after agreement is a no-op and returns
+        # the existing agreement.
+        #
+        # This is a prerequisite for activating Branded Calling on any enterprise
+        # (`POST /enterprises/{id}/branded_calling`); without an agreement, activation
+        # returns `403`.
+        sig do
+          params(request_options: Telnyx::RequestOptions::OrHash).returns(
+            Telnyx::Models::TermsOfService::BrandedCallingAgreeResponse
+          )
+        end
+        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/number_reputation.rbi

@@ -3,14 +3,18 @@
 module Telnyx
   module Resources
     class TermsOfService
-      # Terms of Service agreement endpoints
+      # Accept and review the Branded Calling and Phone Number Reputation terms of
+      # service.
       class NumberReputation
-        # Accept the Terms of Service for the Number Reputation product. Must be called
-        # before using Number Reputation endpoints.
+        # Records the authenticated user's agreement to the current Phone Number
+        # Reputation ToS. No body required. Idempotent.
         #
-        # 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 }
+        # Prerequisite for using any of the `/v2/.../reputation/*` endpoints.
+        sig do
+          params(request_options: Telnyx::RequestOptions::OrHash).returns(
+            Telnyx::Models::TermsOfService::NumberReputationAgreeResponse
+          )
+        end
         def agree(request_options: {})
         end
 

data/rbi/telnyx/resources/terms_of_service.rbi

@@ -2,11 +2,61 @@
 
 module Telnyx
   module Resources
+    # Accept and review the Branded Calling and Phone Number Reputation terms of
+    # service.
     class TermsOfService
-      # Terms of Service agreement endpoints
+      # Accept and review the Branded Calling and Phone Number Reputation terms of
+      # service.
       sig { returns(Telnyx::Resources::TermsOfService::NumberReputation) }
       attr_reader :number_reputation
 
+      # Accept and review the Branded Calling and Phone Number Reputation terms of
+      # service.
+      sig { returns(Telnyx::Resources::TermsOfService::Agreements) }
+      attr_reader :agreements
+
+      # Accept and review the Branded Calling and Phone Number Reputation terms of
+      # service.
+      sig { returns(Telnyx::Resources::TermsOfService::BrandedCalling) }
+      attr_reader :branded_calling
+
+      # Returns the available Terms of Service agreements (product, current version,
+      # terms URL, effective date). Omit `product_type` to return all products; pass it
+      # to scope to one.
+      sig do
+        params(
+          product_type:
+            Telnyx::TermsOfServiceRetrieveInfoParams::ProductType::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::TermsOfServiceRetrieveInfoResponse)
+      end
+      def retrieve_info(
+        # Optional product filter. Omit to return info for all products.
+        product_type: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns whether the authenticated user has agreed to the current Terms of
+      # Service for the product given by `product_type`. Used during onboarding to
+      # decide whether to prompt the user with the ToS dialog before continuing.
+      #
+      # `agreement_required: true` means the user has not yet agreed (or has agreed to
+      # an outdated version) and must agree before using that product's endpoints.
+      sig do
+        params(
+          product_type:
+            Telnyx::TermsOfServiceStatusParams::ProductType::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::TermsOfServiceStatusResponse)
+      end
+      def status(
+        # Which product's ToS to check. Defaults to `branded_calling`.
+        product_type: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Telnyx::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/telnyx/resources/uac_connections.rbi

@@ -23,9 +23,11 @@ module Telnyx
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
           encrypted_media: T.nilable(Telnyx::EncryptedMedia::OrSymbol),
-          external_uac_settings: Telnyx::UacExternalSettings::OrHash,
+          external_uac_settings:
+            Telnyx::UacConnectionCreateParams::ExternalUacSettings::OrHash,
           inbound: Telnyx::UacConnectionCreateParams::Inbound::OrHash,
-          internal_uac_settings: Telnyx::UacInternalSettings::OrHash,
+          internal_uac_settings:
+            Telnyx::UacConnectionCreateParams::InternalUacSettings::OrHash,
           ios_push_credential_id: T.nilable(String),
           jitter_buffer: Telnyx::ConnectionJitterBuffer::OrHash,
           noise_suppression:
@@ -33,7 +35,7 @@ module Telnyx
           noise_suppression_details:
             Telnyx::ConnectionNoiseSuppressionDetails::OrHash,
           onnet_t38_passthrough_enabled: T::Boolean,
-          outbound: Telnyx::UacOutbound::OrHash,
+          outbound: Telnyx::UacConnectionCreateParams::Outbound::OrHash,
           password: String,
           rtcp_settings: Telnyx::ConnectionRtcpSettings::OrHash,
           sip_uri_calling_preference:
@@ -164,9 +166,11 @@ module Telnyx
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
           encrypted_media: T.nilable(Telnyx::EncryptedMedia::OrSymbol),
-          external_uac_settings: Telnyx::UacExternalSettings::OrHash,
+          external_uac_settings:
+            Telnyx::UacConnectionUpdateParams::ExternalUacSettings::OrHash,
           inbound: Telnyx::UacConnectionUpdateParams::Inbound::OrHash,
-          internal_uac_settings: Telnyx::UacInternalSettings::OrHash,
+          internal_uac_settings:
+            Telnyx::UacConnectionUpdateParams::InternalUacSettings::OrHash,
           ios_push_credential_id: T.nilable(String),
           jitter_buffer: Telnyx::ConnectionJitterBuffer::OrHash,
           noise_suppression:
@@ -174,7 +178,7 @@ module Telnyx
           noise_suppression_details:
             Telnyx::ConnectionNoiseSuppressionDetails::OrHash,
           onnet_t38_passthrough_enabled: T::Boolean,
-          outbound: Telnyx::UacOutbound::OrHash,
+          outbound: Telnyx::UacConnectionUpdateParams::Outbound::OrHash,
           password: String,
           rtcp_settings: Telnyx::ConnectionRtcpSettings::OrHash,
           sip_uri_calling_preference:
@@ -290,7 +294,9 @@ module Telnyx
           sort: Telnyx::UacConnectionListParams::Sort::OrSymbol,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(
-          Telnyx::Internal::DefaultFlatPagination[Telnyx::UacConnection]
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::Models::UacConnectionListResponse
+          ]
         )
       end
       def list(

data/rbi/telnyx/resources/virtual_cross_connects.rbi

@@ -154,7 +154,7 @@ module Telnyx
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(
           Telnyx::Internal::DefaultFlatPagination[
-            Telnyx::VirtualCrossConnectCombined
+            Telnyx::Models::VirtualCrossConnectListResponse
           ]
         )
       end

data/rbi/telnyx/resources/wireguard_interfaces.rbi

@@ -51,7 +51,7 @@ module Telnyx
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(
           Telnyx::Internal::DefaultFlatPagination[
-            Telnyx::WireguardInterfaceRead
+            Telnyx::Models::WireguardInterfaceListResponse
           ]
         )
       end

data/sig/telnyx/client.rbs

@@ -342,6 +342,12 @@ module Telnyx
 
     attr_reader pronunciation_dicts: Telnyx::Resources::PronunciationDicts
 
+    attr_reader call_reasons: Telnyx::Resources::CallReasons
+
+    attr_reader dir: Telnyx::Resources::Dir
+
+    attr_reader infringement_claims: Telnyx::Resources::InfringementClaims
+
     attr_reader uac_connections: Telnyx::Resources::UacConnections
 
     attr_reader sip_registration_status: Telnyx::Resources::SipRegistrationStatus