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

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

Overview

Phone-number reputation monitoring (spam-score lookup and tracking).

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:



107
108
109
 
# File 'lib/telnyx/resources/reputation/numbers.rb', line 107

def initialize(client:)
  @client = client
end

Instance Method Details

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

Some parameter documentations has been truncated, see Models::Reputation::NumberDeleteParams for more details.

Convenience alias for ‘DELETE /v2/enterprises/enterprise_id/reputation/numbers/phone_number`.

Parameters:

  • phone_number (String) —

    Phone number in E.164 format (‘+1NPANXXXXXX` for US/CA). The leading `+` MUST be

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

Returns:

  • (nil)

See Also:



95
96
97
98
99
100
101
102
 
# File 'lib/telnyx/resources/reputation/numbers.rb', line 95

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

#list(filter_enterprise_id: nil, filter_phone_number_contains: nil, filter_phone_number_eq: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Reputation::NumberListResponse>

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

Parameters:

  • filter_enterprise_id (String) —

    Filter by enterprise ID.

  • filter_phone_number_contains (String) —

    Partial match on phone number. Must contain at least 5 digits.

  • filter_phone_number_eq (String) —

    Exact phone-number match (E.164).

  • page_number (Integer) —

    1-based page number. Out-of-range values return an empty page with correct meta.

  • page_size (Integer) —

    Items per page. Maximum 250; values above are clamped to 250.

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

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/telnyx/resources/reputation/numbers.rb', line 61

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(
      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::Models::Reputation::NumberListResponse,
    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.

Convenience alias for ‘GET /v2/enterprises/enterprise_id/reputation/numbers/phone_number`.

Parameters:

  • phone_number (String) —

    Phone number in E.164 format (‘+1NPANXXXXXX` for US/CA). The leading `+` MUST be

  • fresh (Boolean) —

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

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

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/telnyx/resources/reputation/numbers.rb', line 25

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