Class: Telnyx::Resources::InfringementClaims

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/infringement_claims.rb,
sig/telnyx/resources/infringement_claims.rbs

Overview

Trademark or impersonation claims filed against your DIR. Customers may contest a claim with supporting evidence.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InfringementClaims

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

Parameters:



75
76
77
 
# File 'lib/telnyx/resources/infringement_claims.rb', line 75

def initialize(client:)
  @client = client
end

Instance Method Details

#contest(claim_id, contest_notes:, documents: nil, request_options: {}) ⇒ Telnyx::Models::InfringementClaimWrapped

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

Submit a written response and supporting documents disputing the claim. The first call moves the claim from pending to contested; subsequent calls append supplementary evidence without changing status. The documents[] you attach are aggregated across rounds in the claim's contest_documents field.

Only pending and contested claims accept new evidence. A resolved claim returns 400.

Failure modes:

  • 400 - the claim is resolved (terminal); cannot be contested further.
  • 404 - the claim does not exist or is not against a DIR you own.
  • 422 - contest_notes is too short (< 10 chars), too long (> 2000 chars), documents is > 20 entries, or a document_id is duplicated within the same submission.

Parameters:

  • claim_id (String) —

    Unique identifier of the claim.

  • contest_notes (String) —

    Customer's response to the claim. 10–2000 characters.

  • documents (Array<Telnyx::Models::Document>) —

    Up to 20 supporting documents per submission. document_id must be unique withi

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

Returns:

See Also:



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

def contest(claim_id, params)
  parsed, options = Telnyx::InfringementClaimContestParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["infringement_claims/%1$s/contest", claim_id],
    body: parsed,
    model: Telnyx::InfringementClaimWrapped,
    options: options
  )
end

#retrieve(claim_id, request_options: {}) ⇒ Telnyx::Models::InfringementClaimWrapped

Retrieve a single claim by id. Returns 404 if the claim does not exist or is not against a DIR you own.

Parameters:

  • claim_id (String) —

    Claim id (lowercase UUID).

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

Returns:

See Also:



20
21
22
23
24
25
26
27
 
# File 'lib/telnyx/resources/infringement_claims.rb', line 20

def retrieve(claim_id, params = {})
  @client.request(
    method: :get,
    path: ["infringement_claims/%1$s", claim_id],
    model: Telnyx::InfringementClaimWrapped,
    options: params[:request_options]
  )
end