Module: PaypalAPI::Disputes::APIs

Included in:

PaypalAPI::Disputes, PaypalAPI::Disputes

Defined in:

lib/paypal-api/api_collections/disputes.rb

Overview

Common methods for PaypalAPI::Disputes class and client.disputes instance

Instance Method Summary

• #accept_claim(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Accept claim.

• #accept_offer(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Accept offer to resolve dispute.

• #acknowledge_return_item(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Acknowledge returned item.

• #appeal(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Appeal dispute.

• #deny_offer(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Deny offer to resolve dispute.

• #escalate(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Escalate dispute to claim.

• #list(query: nil, body: nil, headers: nil) ⇒ Response

  List disputes.

• #make_offer(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Make offer to resolve dispute.

• #provide_evidence(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Provide evidence.

• #provide_supporting_info(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Provide supporting information for dispute.

• #send_message(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Send message about dispute to other party.

• #settle(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Settle dispute.

• #show(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Show dispute details.

• #update(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Update dispute.

• #update_status(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

  Update dispute status.

Instance Method Details

#accept_claim(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Accept claim

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_accept-claim

# File 'lib/paypal-api/api_collections/disputes.rb', line 148

def accept_claim(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/accept-claim", query: query, body: body, headers: headers)
end

#accept_offer(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Accept offer to resolve dispute

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_accept-offer

# File 'lib/paypal-api/api_collections/disputes.rb', line 180

def accept_offer(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/accept-offer", query: query, body: body, headers: headers)
end

#acknowledge_return_item(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Acknowledge returned item

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_acknowledge-return-item

# File 'lib/paypal-api/api_collections/disputes.rb', line 137

def acknowledge_return_item(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/acknowledge-return-item", query: query, body: body, headers: headers)
end

#appeal(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Appeal dispute

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_appeal

# File 'lib/paypal-api/api_collections/disputes.rb', line 27

def appeal(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/appeal", query: query, body: body, headers: headers)
end

#deny_offer(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Deny offer to resolve dispute

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_deny-offer

# File 'lib/paypal-api/api_collections/disputes.rb', line 104

def deny_offer(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/deny-offer", query: query, body: body, headers: headers)
end

#escalate(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Escalate dispute to claim

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_escalate

# File 'lib/paypal-api/api_collections/disputes.rb', line 169

def escalate(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/escalate", query: query, body: body, headers: headers)
end

#list(query: nil, body: nil, headers: nil) ⇒ Response

List disputes

Parameters:

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_list

# File 'lib/paypal-api/api_collections/disputes.rb', line 158

def list(query: nil, body: nil, headers: nil)
  client.get("/v1/customer/disputes", query: query, body: body, headers: headers)
end

#make_offer(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Make offer to resolve dispute

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_make-offer

# File 'lib/paypal-api/api_collections/disputes.rb', line 38

def make_offer(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/make-offer", query: query, body: body, headers: headers)
end

#provide_evidence(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Provide evidence

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_provide-evidence

# File 'lib/paypal-api/api_collections/disputes.rb', line 115

def provide_evidence(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/provide-evidence", query: query, body: body, headers: headers)
end

#provide_supporting_info(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Provide supporting information for dispute

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_provide-supporting-info

# File 'lib/paypal-api/api_collections/disputes.rb', line 82

def provide_supporting_info(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/provide-supporting-info", query: query, body: body, headers: headers)
end

#send_message(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Send message about dispute to other party

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_send-message

# File 'lib/paypal-api/api_collections/disputes.rb', line 71

def send_message(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/send-message", query: query, body: body, headers: headers)
end

#settle(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Settle dispute

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_adjudicate

# File 'lib/paypal-api/api_collections/disputes.rb', line 126

def settle(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/adjudicate", query: query, body: body, headers: headers)
end

#show(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Show dispute details

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_get

# File 'lib/paypal-api/api_collections/disputes.rb', line 49

def show(dispute_id, query: nil, body: nil, headers: nil)
  client.get("/v1/customer/disputes/#{encode(dispute_id)}", query: query, body: body, headers: headers)
end

#update(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Update dispute

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_patch

# File 'lib/paypal-api/api_collections/disputes.rb', line 60

def update(dispute_id, query: nil, body: nil, headers: nil)
  client.patch("/v1/customer/disputes/#{encode(dispute_id)}", query: query, body: body, headers: headers)
end

#update_status(dispute_id, query: nil, body: nil, headers: nil) ⇒ Response

Update dispute status

Parameters:

• dispute_id (String) —

  Dispute ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_require-evidence

# File 'lib/paypal-api/api_collections/disputes.rb', line 93

def update_status(dispute_id, query: nil, body: nil, headers: nil)
  client.post("/v1/customer/disputes/#{encode(dispute_id)}/require-evidence", query: query, body: body, headers: headers)
end