Class: Telnyx::Resources::Enterprises::Reputation::Remediation

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

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Remediation

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 Remediation.

Parameters:



128
129
130
 
# File 'lib/telnyx/resources/enterprises/reputation/remediation.rb', line 128

def initialize(client:)
  @client = client
end

Instance Method Details

#create(enterprise_id, call_purpose:, phone_numbers:, contact_email: nil, webhook_url: nil, request_options: {}) ⇒ Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse

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

Submit a batch of phone numbers belonging to this enterprise for reputation remediation. The request is accepted asynchronously: this endpoint returns ‘202` with the persisted request id, then the request transitions through processing states until completion. Use the GET endpoints to poll status and per-number results.

Each phone number must be in E.164 format and belong to this enterprise. A number that already has an in-flight remediation request is rejected.

Parameters:

  • enterprise_id (String) —

    The enterprise id. Lowercase UUID.

  • call_purpose (String) —

    How the numbers are used (free text).

  • phone_numbers (Array<String>) —

    Phone numbers in E.164 format. Each must belong to this enterprise. Maximum 2,00

  • contact_email (String) —

    Optional contact email for this remediation request.

  • webhook_url (String) —

    Optional https:// URL for status notifications.

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

Returns:

See Also:



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/telnyx/resources/enterprises/reputation/remediation.rb', line 39

def create(enterprise_id, params)
  parsed, options = Telnyx::Enterprises::Reputation::RemediationCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["enterprises/%1$s/reputation/remediation", enterprise_id],
    body: parsed,
    model: Telnyx::Models::Enterprises::Reputation::RemediationCreateResponse,
    options: options
  )
end

#list(enterprise_id, filter_created_at_gte: nil, filter_created_at_lte: nil, filter_status: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Enterprises::Reputation::RemediationListResponse>

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

Paginated list of remediation requests for this enterprise. List items omit per-number results and webhook URLs to keep the response small; call GET by id for full detail. Supports JSON:API pagination and optional filters on status and created-at range.

Parameters:

  • enterprise_id (String) —

    The enterprise id. Lowercase UUID.

  • filter_created_at_gte (Time) —

    Only requests created on or after this timestamp (ISO 8601).

  • filter_created_at_lte (Time) —

    Only requests created on or before this timestamp (ISO 8601).

  • filter_status (Symbol, Telnyx::Models::Enterprises::Reputation::RemediationListParams::FilterStatus) —

    Filter by customer-facing status.

  • 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:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/telnyx/resources/enterprises/reputation/remediation.rb', line 106

def list(enterprise_id, params = {})
  parsed, options = Telnyx::Enterprises::Reputation::RemediationListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["enterprises/%1$s/reputation/remediation", enterprise_id],
    query: query.transform_keys(
      filter_created_at_gte: "filter[created_at][gte]",
      filter_created_at_lte: "filter[created_at][lte]",
      filter_status: "filter[status]",
      page_number: "page[number]",
      page_size: "page[size]"
    ),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::Enterprises::Reputation::RemediationListResponse,
    options: options
  )
end

#retrieve(remediation_id, enterprise_id:, request_options: {}) ⇒ Telnyx::Models::Enterprises::Reputation::RemediationRetrieveResponse

Retrieve the full detail of a remediation request, including current status, per-number results (once available), and submission metadata.

Parameters:

  • remediation_id (String) —

    The remediation request id. Lowercase UUID.

  • enterprise_id (String) —

    The enterprise id. Lowercase UUID.

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

Returns:

See Also:



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/telnyx/resources/enterprises/reputation/remediation.rb', line 64

def retrieve(remediation_id, params)
  parsed, options = Telnyx::Enterprises::Reputation::RemediationRetrieveParams.dump_request(params)
  enterprise_id =
    parsed.delete(:enterprise_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["enterprises/%1$s/reputation/remediation/%2$s", enterprise_id, remediation_id],
    model: Telnyx::Models::Enterprises::Reputation::RemediationRetrieveResponse,
    options: options
  )
end