Class: Telnyx::Resources::Reputation::Numbers

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/reputation/numbers.rb

Overview

Associate phone numbers with an enterprise for reputation monitoring and retrieve reputation scores

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Numbers

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Numbers.

Parameters:



96
97
98
 
# File 'lib/telnyx/resources/reputation/numbers.rb', line 96

def initialize(client:)
  @client = client
end

Instance Method Details

#delete(phone_number, request_options: {}) ⇒ nil

Remove a phone number from Number Reputation monitoring without requiring an ‘enterprise_id`.

Parameters:

  • phone_number (String) —

    Phone number in E.164 format

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



84
85
86
87
88
89
90
91
 
# File 'lib/telnyx/resources/reputation/numbers.rb', line 84

def delete(phone_number, params = {})
  @client.request(
    method: :delete,
    path: ["reputation/numbers/%1$s", phone_number],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(page_number: nil, page_size: nil, phone_number: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::ReputationPhoneNumberWithReputationData>

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.

Parameters:

  • page_number (Integer) —

    Page number (1-indexed)

  • page_size (Integer) —

    Number of items per page

  • phone_number (String) —

    Filter by specific phone number (E.164 format)

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/telnyx/resources/reputation/numbers.rb', line 59

def list(params = {})
  parsed, options = Telnyx::Reputation::NumberListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "reputation/numbers",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::ReputationPhoneNumberWithReputationData,
    options: options
  )
end

#retrieve(phone_number, fresh: nil, request_options: {}) ⇒ Telnyx::Models::Reputation::NumberRetrieveResponse

Some parameter documentations has been truncated, see 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.

Parameters:

  • phone_number (String) —

    Phone number in E.164 format

  • fresh (Boolean) —

    When true, fetches fresh reputation data (incurs API cost). When false, returns

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/telnyx/resources/reputation/numbers.rb', line 28

def retrieve(phone_number, params = {})
  parsed, options = Telnyx::Reputation::NumberRetrieveParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["reputation/numbers/%1$s", phone_number],
    query: query,
    model: Telnyx::Models::Reputation::NumberRetrieveResponse,
    options: options
  )
end