telnyx 5.126.0 → 5.128.0

data/lib/telnyx/resources/reports.rb

@@ -15,23 +15,23 @@ module Telnyx
       #
       # @overload list_mdrs(id: nil, cld: nil, cli: nil, direction: nil, end_date: nil, message_type: nil, profile: nil, start_date: nil, status: nil, request_options: {})
       #
-      # @param id [String] Message uuid
+      # @param id [String] Filter results by identifier.
       #
-      # @param cld [String] Destination number
+      # @param cld [String] Filter results by cld.
       #
-      # @param cli [String] Origination number
+      # @param cli [String] Filter results by cli.
       #
-      # @param direction [Symbol, Telnyx::Models::ReportListMdrsParams::Direction] Direction (inbound or outbound)
+      # @param direction [Symbol, Telnyx::Models::ReportListMdrsParams::Direction] Filter results by direction.
       #
       # @param end_date [String] Pagination end date
       #
-      # @param message_type [Symbol, Telnyx::Models::ReportListMdrsParams::MessageType] Type of message
+      # @param message_type [Symbol, Telnyx::Models::ReportListMdrsParams::MessageType] Filter results by message type.
       #
-      # @param profile [String] Name of the profile
+      # @param profile [String] Filter results by profile.
       #
       # @param start_date [String] Pagination start date
       #
-      # @param status [Symbol, Telnyx::Models::ReportListMdrsParams::Status] Message status
+      # @param status [Symbol, Telnyx::Models::ReportListMdrsParams::Status] Filter results by status.
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -50,36 +50,33 @@ module Telnyx
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Telnyx::Models::ReportListWdrsParams} for more details.
-      #
       # Fetch all Wdr records
       #
       # @overload list_wdrs(id: nil, end_date: nil, imsi: nil, mcc: nil, mnc: nil, page_number: nil, page_size: nil, phone_number: nil, sim_card_id: nil, sim_group_id: nil, sim_group_name: nil, sort: nil, start_date: nil, request_options: {})
       #
-      # @param id [String] WDR uuid
+      # @param id [String] Filter results by identifier.
       #
       # @param end_date [String] End date
       #
-      # @param imsi [String] International mobile subscriber identity
+      # @param imsi [String] Filter results by imsi.
       #
-      # @param mcc [String] Mobile country code
+      # @param mcc [String] Filter results by mcc.
       #
-      # @param mnc [String] Mobile network code
+      # @param mnc [String] Filter results by mnc.
       #
       # @param page_number [Integer]
       #
       # @param page_size [Integer]
       #
-      # @param phone_number [String] Phone number
+      # @param phone_number [String] Filter results by phone number.
       #
-      # @param sim_card_id [String] Sim card unique identifier
+      # @param sim_card_id [String] Filter results by sim card id.
       #
-      # @param sim_group_id [String] Sim group unique identifier
+      # @param sim_group_id [String] Filter results by sim group id.
       #
-      # @param sim_group_name [String] Sim group name
+      # @param sim_group_name [String] Filter results by sim group name.
       #
-      # @param sort [Array<String>] Field used to order the data. If no field is specified, default value is 'create
+      # @param sort [Array<String>] Field and direction to sort the results by.
       #
       # @param start_date [String] Start date
       #

data/lib/telnyx/resources/reputation/numbers.rb

@@ -3,22 +3,19 @@
 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
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Reputation::NumberRetrieveParams} for more details.
         #
-        # 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}`.
         #
         # @overload retrieve(phone_number, fresh: nil, request_options: {})
         #
-        # @param phone_number [String] Phone number in E.164 format
+        # @param phone_number [String] Phone number in E.164 format (`+1NPANXXXXXX` for US/CA). The leading `+` MUST be
         #
-        # @param fresh [Boolean] When true, fetches fresh reputation data (incurs API cost). When false, returns
+        # @param fresh [Boolean] When true, fetches fresh reputation data (incurs API cost). When false (default)
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -37,23 +34,28 @@ module Telnyx
           )
         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.
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Reputation::NumberListParams} for more details.
+        #
+        # 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.
         #
-        # Supports pagination and filtering by phone number.
+        # @overload list(filter_enterprise_id: nil, filter_phone_number_contains: nil, filter_phone_number_eq: nil, page_number: nil, page_size: nil, request_options: {})
         #
-        # @overload list(page_number: nil, page_size: nil, phone_number: nil, request_options: {})
+        # @param filter_enterprise_id [String] Filter by enterprise ID.
         #
-        # @param page_number [Integer] Page number (1-indexed)
+        # @param filter_phone_number_contains [String] Partial match on phone number. Must contain at least 5 digits.
         #
-        # @param page_size [Integer] Number of items per page
+        # @param filter_phone_number_eq [String] Exact phone-number match (E.164).
         #
-        # @param phone_number [String] Filter by specific phone number (E.164 format)
+        # @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
+        #
+        # @param page_size [Integer] Items per page. Maximum 250; values above are clamped to 250.
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::ReputationPhoneNumberWithReputationData>]
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Reputation::NumberListResponse>]
         #
         # @see Telnyx::Models::Reputation::NumberListParams
         def list(params = {})
@@ -62,19 +64,28 @@ module Telnyx
           @client.request(
             method: :get,
             path: "reputation/numbers",
-            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            query: query.transform_keys(
+              filter_enterprise_id: "filter[enterprise_id]",
+              filter_phone_number_contains: "filter[phone_number][contains]",
+              filter_phone_number_eq: "filter[phone_number][eq]",
+              page_number: "page[number]",
+              page_size: "page[size]"
+            ),
             page: Telnyx::Internal::DefaultFlatPagination,
-            model: Telnyx::ReputationPhoneNumberWithReputationData,
+            model: Telnyx::Models::Reputation::NumberListResponse,
             options: options
           )
         end
 
-        # Remove a phone number from Number Reputation monitoring without requiring an
-        # `enterprise_id`.
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Reputation::NumberDeleteParams} for more details.
+        #
+        # Convenience alias for
+        # `DELETE /v2/enterprises/{enterprise_id}/reputation/numbers/{phone_number}`.
         #
         # @overload delete(phone_number, request_options: {})
         #
-        # @param phone_number [String] Phone number in E.164 format
+        # @param phone_number [String] Phone number in E.164 format (`+1NPANXXXXXX` for US/CA). The leading `+` MUST be
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/telnyx/resources/reputation.rb

@@ -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).
       # @return [Telnyx::Resources::Reputation::Numbers]
       attr_reader :numbers
 

data/lib/telnyx/resources/terms_of_service/agreements.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+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.
+        #
+        # @overload retrieve(agreement_id, request_options: {})
+        #
+        # @param agreement_id [String] Unique identifier of the agreement.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::TermsOfService::AgreementRetrieveResponse]
+        #
+        # @see Telnyx::Models::TermsOfService::AgreementRetrieveParams
+        def retrieve(agreement_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["terms_of_service/agreements/%1$s", agreement_id],
+            model: Telnyx::Models::TermsOfService::AgreementRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::TermsOfService::AgreementListParams} for more details.
+        #
+        # 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.
+        #
+        # @overload list(page_number: nil, page_size: nil, product_type: nil, request_options: {})
+        #
+        # @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
+        #
+        # @param page_size [Integer] Items per page. Maximum 250; values above are clamped to 250.
+        #
+        # @param product_type [Symbol, Telnyx::Models::TermsOfService::AgreementListParams::ProductType] Optional filter. Omit to list the user's agreements for **every** product (brand
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::TermsOfService::AgreementListResponse>]
+        #
+        # @see Telnyx::Models::TermsOfService::AgreementListParams
+        def list(params = {})
+          parsed, options = Telnyx::TermsOfService::AgreementListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "terms_of_service/agreements",
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            page: Telnyx::Internal::DefaultFlatPagination,
+            model: Telnyx::Models::TermsOfService::AgreementListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/terms_of_service/branded_calling.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+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`.
+        #
+        # @overload agree(request_options: {})
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::TermsOfService::BrandedCallingAgreeResponse]
+        #
+        # @see Telnyx::Models::TermsOfService::BrandedCallingAgreeParams
+        def agree(params = {})
+          @client.request(
+            method: :post,
+            path: "terms_of_service/branded_calling/agree",
+            model: Telnyx::Models::TermsOfService::BrandedCallingAgreeResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/terms_of_service/number_reputation.rb

@@ -3,26 +3,26 @@
 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.
+        # Prerequisite for using any of the `/v2/.../reputation/*` endpoints.
         #
         # @overload agree(request_options: {})
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [Telnyx::Models::TermsOfService::NumberReputationAgreeResponse]
         #
         # @see Telnyx::Models::TermsOfService::NumberReputationAgreeParams
         def agree(params = {})
           @client.request(
             method: :post,
             path: "terms_of_service/number_reputation/agree",
-            model: NilClass,
+            model: Telnyx::Models::TermsOfService::NumberReputationAgreeResponse,
             options: params[:request_options]
           )
         end

data/lib/telnyx/resources/terms_of_service.rb

@@ -2,17 +2,85 @@
 
 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.
       # @return [Telnyx::Resources::TermsOfService::NumberReputation]
       attr_reader :number_reputation
 
+      # Accept and review the Branded Calling and Phone Number Reputation terms of
+      # service.
+      # @return [Telnyx::Resources::TermsOfService::Agreements]
+      attr_reader :agreements
+
+      # Accept and review the Branded Calling and Phone Number Reputation terms of
+      # service.
+      # @return [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.
+      #
+      # @overload retrieve_info(product_type: nil, request_options: {})
+      #
+      # @param product_type [Symbol, Telnyx::Models::TermsOfServiceRetrieveInfoParams::ProductType] Optional product filter. Omit to return info for all products.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::TermsOfServiceRetrieveInfoResponse]
+      #
+      # @see Telnyx::Models::TermsOfServiceRetrieveInfoParams
+      def retrieve_info(params = {})
+        parsed, options = Telnyx::TermsOfServiceRetrieveInfoParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "terms_of_service/info",
+          query: query,
+          model: Telnyx::Models::TermsOfServiceRetrieveInfoResponse,
+          options: 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.
+      #
+      # @overload status(product_type: nil, request_options: {})
+      #
+      # @param product_type [Symbol, Telnyx::Models::TermsOfServiceStatusParams::ProductType] Which product's ToS to check. Defaults to `branded_calling`.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::TermsOfServiceStatusResponse]
+      #
+      # @see Telnyx::Models::TermsOfServiceStatusParams
+      def status(params = {})
+        parsed, options = Telnyx::TermsOfServiceStatusParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "terms_of_service/status",
+          query: query,
+          model: Telnyx::Models::TermsOfServiceStatusResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Telnyx::Client]
       def initialize(client:)
         @client = client
         @number_reputation = Telnyx::Resources::TermsOfService::NumberReputation.new(client: client)
+        @agreements = Telnyx::Resources::TermsOfService::Agreements.new(client: client)
+        @branded_calling = Telnyx::Resources::TermsOfService::BrandedCalling.new(client: client)
       end
     end
   end

data/lib/telnyx/resources/uac_connections.rb

@@ -36,11 +36,11 @@ module Telnyx
       #
       # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
       #
-      # @param external_uac_settings [Telnyx::Models::UacExternalSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
+      # @param external_uac_settings [Telnyx::Models::UacConnectionCreateParams::ExternalUacSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
       #
       # @param inbound [Telnyx::Models::UacConnectionCreateParams::Inbound] Inbound settings that can be supplied when creating or updating a UAC connection
       #
-      # @param internal_uac_settings [Telnyx::Models::UacInternalSettings] Internal Telnyx-side settings for a UAC connection.
+      # @param internal_uac_settings [Telnyx::Models::UacConnectionCreateParams::InternalUacSettings] Internal Telnyx-side settings for a UAC connection.
       #
       # @param ios_push_credential_id [String, nil] The uuid of the push credential for Ios
       #
@@ -52,7 +52,7 @@ module Telnyx
       #
       # @param onnet_t38_passthrough_enabled [Boolean] Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
       #
-      # @param outbound [Telnyx::Models::UacOutbound]
+      # @param outbound [Telnyx::Models::UacConnectionCreateParams::Outbound]
       #
       # @param password [String] The password to be used as part of the credentials. Must be 8 to 128 characters
       #
@@ -135,11 +135,11 @@ module Telnyx
       #
       # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
       #
-      # @param external_uac_settings [Telnyx::Models::UacExternalSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
+      # @param external_uac_settings [Telnyx::Models::UacConnectionUpdateParams::ExternalUacSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
       #
       # @param inbound [Telnyx::Models::UacConnectionUpdateParams::Inbound] Inbound settings that can be supplied when creating or updating a UAC connection
       #
-      # @param internal_uac_settings [Telnyx::Models::UacInternalSettings] Internal Telnyx-side settings for a UAC connection.
+      # @param internal_uac_settings [Telnyx::Models::UacConnectionUpdateParams::InternalUacSettings] Internal Telnyx-side settings for a UAC connection.
       #
       # @param ios_push_credential_id [String, nil] The uuid of the push credential for Ios
       #
@@ -151,7 +151,7 @@ module Telnyx
       #
       # @param onnet_t38_passthrough_enabled [Boolean] Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
       #
-      # @param outbound [Telnyx::Models::UacOutbound]
+      # @param outbound [Telnyx::Models::UacConnectionUpdateParams::Outbound]
       #
       # @param password [String] The password to be used as part of the credentials. Must be 8 to 128 characters
       #
@@ -208,7 +208,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::UacConnection>]
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::UacConnectionListResponse>]
       #
       # @see Telnyx::Models::UacConnectionListParams
       def list(params = {})
@@ -219,7 +219,7 @@ module Telnyx
           path: "uac_connections",
           query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
           page: Telnyx::Internal::DefaultFlatPagination,
-          model: Telnyx::UacConnection,
+          model: Telnyx::Models::UacConnectionListResponse,
           options: options
         )
       end

data/lib/telnyx/resources/virtual_cross_connects.rb

@@ -140,7 +140,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::VirtualCrossConnectCombined>]
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::VirtualCrossConnectListResponse>]
       #
       # @see Telnyx::Models::VirtualCrossConnectListParams
       def list(params = {})
@@ -151,7 +151,7 @@ module Telnyx
           path: "virtual_cross_connects",
           query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
           page: Telnyx::Internal::DefaultFlatPagination,
-          model: Telnyx::VirtualCrossConnectCombined,
+          model: Telnyx::Models::VirtualCrossConnectListResponse,
           options: options
         )
       end

data/lib/telnyx/resources/wireguard_interfaces.rb

@@ -68,7 +68,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::WireguardInterfaceRead>]
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::WireguardInterfaceListResponse>]
       #
       # @see Telnyx::Models::WireguardInterfaceListParams
       def list(params = {})
@@ -79,7 +79,7 @@ module Telnyx
           path: "wireguard_interfaces",
           query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
           page: Telnyx::Internal::DefaultFlatPagination,
-          model: Telnyx::WireguardInterfaceRead,
+          model: Telnyx::Models::WireguardInterfaceListResponse,
           options: options
         )
       end

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.126.0"
+  VERSION = "5.128.0"
 end