telnyx 5.126.0 → 5.128.0

data/lib/telnyx/models/enterprises/reputation/number_associate_response.rb

@@ -8,60 +8,121 @@ module Telnyx
         class NumberAssociateResponse < Telnyx::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [Array<Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Data>, nil]
-          optional :data,
+          #   @return [Array<Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Data>]
+          required :data,
                    -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Data] }
 
           # @!attribute meta
+          #   JSON:API pagination metadata returned with every paginated list response. Page
+          #   numbering is 1-based. `page_size` reports the number of items actually returned
+          #   in `data` for this page; the requested size is taken from the `page[size]` query
+          #   parameter.
           #
-          #   @return [Telnyx::Models::MetaInfo, nil]
-          optional :meta, -> { Telnyx::MetaInfo }
+          #   @return [Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Meta]
+          required :meta, -> { Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Meta }
 
-          # @!method initialize(data: nil, meta: nil)
+          # @!method initialize(data:, meta:)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse} for more
+          #   details.
+          #
           #   @param data [Array<Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Data>]
-          #   @param meta [Telnyx::Models::MetaInfo]
+          #
+          #   @param meta [Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Meta] JSON:API pagination metadata returned with every paginated list response. Page n
 
           class Data < Telnyx::Internal::Type::BaseModel
-            # @!attribute id
-            #   Unique identifier
-            #
-            #   @return [String, nil]
-            optional :id, String
-
-            # @!attribute created_at
-            #   When the number was associated
-            #
-            #   @return [Time, nil]
-            optional :created_at, Time
-
             # @!attribute enterprise_id
-            #   ID of the associated enterprise
             #
             #   @return [String, nil]
             optional :enterprise_id, String
 
             # @!attribute phone_number
-            #   Phone number in E.164 format
+            #   E.164 with leading `+`.
             #
             #   @return [String, nil]
             optional :phone_number, String
 
-            # @!attribute updated_at
-            #   When the record was last updated
+            # @!attribute reputation_data
+            #   `null` until the first refresh has been collected for this number.
+            #
+            #   @return [Telnyx::Models::ReputationData, nil]
+            optional :reputation_data, -> { Telnyx::ReputationData }, nil?: true
+
+            response_only do
+              # @!attribute id
+              #
+              #   @return [String, nil]
+              optional :id, String
+
+              # @!attribute created_at
+              #
+              #   @return [Time, nil]
+              optional :created_at, Time
+
+              # @!attribute updated_at
+              #
+              #   @return [Time, nil]
+              optional :updated_at, Time
+            end
+
+            # @!method initialize(id: nil, created_at: nil, enterprise_id: nil, phone_number: nil, reputation_data: nil, updated_at: nil)
+            #   @param id [String]
+            #
+            #   @param created_at [Time]
+            #
+            #   @param enterprise_id [String]
+            #
+            #   @param phone_number [String] E.164 with leading `+`.
+            #
+            #   @param reputation_data [Telnyx::Models::ReputationData, nil] `null` until the first refresh has been collected for this number.
+            #
+            #   @param updated_at [Time]
+          end
+
+          # @see Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse#meta
+          class Meta < Telnyx::Internal::Type::BaseModel
+            # @!attribute page_number
+            #   1-based index of this page. Echoes the `page[number]` query parameter (default
+            #   `1`).
             #
-            #   @return [Time, nil]
-            optional :updated_at, Time
+            #   @return [Integer]
+            required :page_number, Integer
 
-            # @!method initialize(id: nil, created_at: nil, enterprise_id: nil, phone_number: nil, updated_at: nil)
-            #   @param id [String] Unique identifier
+            # @!attribute page_size
+            #   Number of items returned in this page's `data` array. Capped at 250.
+            #
+            #   @return [Integer]
+            required :page_size, Integer
+
+            # @!attribute total_pages
+            #   Total number of pages available given the current `page_size`.
+            #
+            #   @return [Integer]
+            required :total_pages, Integer
+
+            # @!attribute total_results
+            #   Total number of items across all pages (excludes soft-deleted rows).
+            #
+            #   @return [Integer]
+            required :total_results, Integer
+
+            # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Meta} for
+            #   more details.
+            #
+            #   JSON:API pagination metadata returned with every paginated list response. Page
+            #   numbering is 1-based. `page_size` reports the number of items actually returned
+            #   in `data` for this page; the requested size is taken from the `page[size]` query
+            #   parameter.
             #
-            #   @param created_at [Time] When the number was associated
+            #   @param page_number [Integer] 1-based index of this page. Echoes the `page[number]` query parameter (default `
             #
-            #   @param enterprise_id [String] ID of the associated enterprise
+            #   @param page_size [Integer] Number of items returned in this page's `data` array. Capped at 250.
             #
-            #   @param phone_number [String] Phone number in E.164 format
+            #   @param total_pages [Integer] Total number of pages available given the current `page_size`.
             #
-            #   @param updated_at [Time] When the record was last updated
+            #   @param total_results [Integer] Total number of items across all pages (excludes soft-deleted rows).
           end
         end
       end

data/lib/telnyx/models/enterprises/reputation/number_list_params.rb

@@ -14,32 +14,43 @@ module Telnyx
           #   @return [String]
           required :enterprise_id, String
 
+          # @!attribute filter_phone_number_contains
+          #   Partial match on phone number. Must contain at least 5 digits.
+          #
+          #   @return [String, nil]
+          optional :filter_phone_number_contains, String
+
+          # @!attribute filter_phone_number_eq
+          #   Exact phone-number match (E.164).
+          #
+          #   @return [String, nil]
+          optional :filter_phone_number_eq, String
+
           # @!attribute page_number
-          #   Page number (1-indexed)
+          #   1-based page number. Out-of-range values return an empty page with correct meta.
           #
           #   @return [Integer, nil]
           optional :page_number, Integer
 
           # @!attribute page_size
-          #   Number of items per page
+          #   Items per page. Default 10. Maximum 250; values above are clamped to 250.
           #
           #   @return [Integer, nil]
           optional :page_size, Integer
 
-          # @!attribute phone_number
-          #   Filter by specific phone number (E.164 format)
+          # @!method initialize(enterprise_id:, filter_phone_number_contains: nil, filter_phone_number_eq: nil, page_number: nil, page_size: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Enterprises::Reputation::NumberListParams} for more details.
           #
-          #   @return [String, nil]
-          optional :phone_number, String
-
-          # @!method initialize(enterprise_id:, page_number: nil, page_size: nil, phone_number: nil, request_options: {})
           #   @param enterprise_id [String]
           #
-          #   @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 filter_phone_number_eq [String] Exact phone-number match (E.164).
           #
-          #   @param page_size [Integer] Number of items per page
+          #   @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
           #
-          #   @param phone_number [String] Filter by specific phone number (E.164 format)
+          #   @param page_size [Integer] Items per page. Default 10. Maximum 250; values above are clamped to 250.
           #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/telnyx/models/enterprises/reputation/number_list_response.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::Numbers#list
+        class NumberListResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute enterprise_id
+          #
+          #   @return [String, nil]
+          optional :enterprise_id, String
+
+          # @!attribute phone_number
+          #   E.164 with leading `+`.
+          #
+          #   @return [String, nil]
+          optional :phone_number, String
+
+          # @!attribute reputation_data
+          #   `null` until the first refresh has been collected for this number.
+          #
+          #   @return [Telnyx::Models::ReputationData, nil]
+          optional :reputation_data, -> { Telnyx::ReputationData }, nil?: true
+
+          response_only do
+            # @!attribute id
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute created_at
+            #
+            #   @return [Time, nil]
+            optional :created_at, Time
+
+            # @!attribute updated_at
+            #
+            #   @return [Time, nil]
+            optional :updated_at, Time
+          end
+
+          # @!method initialize(id: nil, created_at: nil, enterprise_id: nil, phone_number: nil, reputation_data: nil, updated_at: nil)
+          #   @param id [String]
+          #
+          #   @param created_at [Time]
+          #
+          #   @param enterprise_id [String]
+          #
+          #   @param phone_number [String] E.164 with leading `+`.
+          #
+          #   @param reputation_data [Telnyx::Models::ReputationData, nil] `null` until the first refresh has been collected for this number.
+          #
+          #   @param updated_at [Time]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/number_refresh_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::Numbers#refresh
+        class NumberRefreshParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute enterprise_id
+          #
+          #   @return [String]
+          required :enterprise_id, String
+
+          # @!attribute phone_numbers
+          #   Phone numbers to refresh reputation data for. 1–100 numbers per request, each in
+          #   E.164 format. Reputation refreshes are subject to per-enterprise rate limits.
+          #
+          #   @return [Array<String>]
+          required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(enterprise_id:, phone_numbers:, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Enterprises::Reputation::NumberRefreshParams} for more details.
+          #
+          #   @param enterprise_id [String]
+          #
+          #   @param phone_numbers [Array<String>] Phone numbers to refresh reputation data for. 1–100 numbers per request, each in
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/number_refresh_response.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::Numbers#refresh
+        class NumberRefreshResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data]
+          required :data, -> { Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data }
+
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data]
+
+          # @see Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse#data
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute results
+            #   Per-number outcome of the refresh.
+            #
+            #   @return [Array<Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::Result>]
+            required :results,
+                     -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::Result] }
+
+            # @!attribute total_failed
+            #
+            #   @return [Integer]
+            required :total_failed, Integer
+
+            # @!attribute total_requested
+            #
+            #   @return [Integer]
+            required :total_requested, Integer
+
+            # @!attribute total_successful
+            #
+            #   @return [Integer]
+            required :total_successful, Integer
+
+            # @!method initialize(results:, total_failed:, total_requested:, total_successful:)
+            #   @param results [Array<Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::Result>] Per-number outcome of the refresh.
+            #
+            #   @param total_failed [Integer]
+            #
+            #   @param total_requested [Integer]
+            #
+            #   @param total_successful [Integer]
+
+            class Result < Telnyx::Internal::Type::BaseModel
+              # @!attribute phone_number
+              #
+              #   @return [String]
+              required :phone_number, String
+
+              # @!attribute success
+              #
+              #   @return [Boolean]
+              required :success, Telnyx::Internal::Type::Boolean
+
+              # @!attribute error
+              #   `null` when `success` is `true`; carries an error message otherwise.
+              #
+              #   @return [String, nil]
+              optional :error, String, nil?: true
+
+              # @!method initialize(phone_number:, success:, error: nil)
+              #   @param phone_number [String]
+              #
+              #   @param success [Boolean]
+              #
+              #   @param error [String, nil] `null` when `success` is `true`; carries an error message otherwise.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/number_retrieve_params.rb

@@ -20,8 +20,8 @@ module Telnyx
           required :phone_number, String
 
           # @!attribute fresh
-          #   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.
           #
           #   @return [Boolean, nil]
           optional :fresh, Telnyx::Internal::Type::Boolean
@@ -35,7 +35,7 @@ module Telnyx
           #
           #   @param phone_number [String]
           #
-          #   @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}]
         end

data/lib/telnyx/models/enterprises/reputation/number_retrieve_response.rb

@@ -8,11 +8,61 @@ module Telnyx
         class NumberRetrieveResponse < Telnyx::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [Telnyx::Models::ReputationPhoneNumberWithReputationData, nil]
-          optional :data, -> { Telnyx::ReputationPhoneNumberWithReputationData }
+          #   @return [Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data]
+          required :data, -> { Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data }
 
-          # @!method initialize(data: nil)
-          #   @param data [Telnyx::Models::ReputationPhoneNumberWithReputationData]
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data]
+
+          # @see Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse#data
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute enterprise_id
+            #
+            #   @return [String, nil]
+            optional :enterprise_id, String
+
+            # @!attribute phone_number
+            #   E.164 with leading `+`.
+            #
+            #   @return [String, nil]
+            optional :phone_number, String
+
+            # @!attribute reputation_data
+            #   `null` until the first refresh has been collected for this number.
+            #
+            #   @return [Telnyx::Models::ReputationData, nil]
+            optional :reputation_data, -> { Telnyx::ReputationData }, nil?: true
+
+            response_only do
+              # @!attribute id
+              #
+              #   @return [String, nil]
+              optional :id, String
+
+              # @!attribute created_at
+              #
+              #   @return [Time, nil]
+              optional :created_at, Time
+
+              # @!attribute updated_at
+              #
+              #   @return [Time, nil]
+              optional :updated_at, Time
+            end
+
+            # @!method initialize(id: nil, created_at: nil, enterprise_id: nil, phone_number: nil, reputation_data: nil, updated_at: nil)
+            #   @param id [String]
+            #
+            #   @param created_at [Time]
+            #
+            #   @param enterprise_id [String]
+            #
+            #   @param phone_number [String] E.164 with leading `+`.
+            #
+            #   @param reputation_data [Telnyx::Models::ReputationData, nil] `null` until the first refresh has been collected for this number.
+            #
+            #   @param updated_at [Time]
+          end
         end
       end
     end

data/lib/telnyx/models/enterprises/reputation/remediation_create_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::Remediation#create
+        class RemediationCreateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute enterprise_id
+          #
+          #   @return [String]
+          required :enterprise_id, String
+
+          # @!attribute call_purpose
+          #   How the numbers are used (free text).
+          #
+          #   @return [String]
+          required :call_purpose, String
+
+          # @!attribute phone_numbers
+          #   Phone numbers in E.164 format. Each must belong to this enterprise. Maximum
+          #   2,000 per request.
+          #
+          #   @return [Array<String>]
+          required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute contact_email
+          #   Optional contact email for this remediation request.
+          #
+          #   @return [String, nil]
+          optional :contact_email, String
+
+          # @!attribute webhook_url
+          #   Optional https:// URL for status notifications.
+          #
+          #   @return [String, nil]
+          optional :webhook_url, String
+
+          # @!method initialize(enterprise_id:, call_purpose:, phone_numbers:, contact_email: nil, webhook_url: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Enterprises::Reputation::RemediationCreateParams} for more
+          #   details.
+          #
+          #   @param enterprise_id [String]
+          #
+          #   @param call_purpose [String] How the numbers are used (free text).
+          #
+          #   @param phone_numbers [Array<String>] Phone numbers in E.164 format. Each must belong to this enterprise. Maximum 2,00
+          #
+          #   @param contact_email [String] Optional contact email for this remediation request.
+          #
+          #   @param webhook_url [String] Optional https:// URL for status notifications.
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end