Class: StraddlePay::Resources::CustomerReviews

Inherits:
Base
  • Object
show all
Defined in:
lib/straddle_pay/resources/customer_reviews.rb

Overview

Manage customer identity reviews. Accessed via StraddlePay::Resources::Customers#reviews.

Constant Summary

Constants inherited from Base

Base::HEADER_KEYS

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from StraddlePay::Resources::Base

Instance Method Details

#decision(customer_id, status:, **options) ⇒ Hash

Submit a review decision.

Parameters:

  • customer_id (String) —

    customer ID

  • status (String) —

    decision status (e.g. "approved", "rejected")

Returns:

  • (Hash) —

    updated review



22
23
24
25
26
 
# File 'lib/straddle_pay/resources/customer_reviews.rb', line 22

def decision(customer_id, status:, **options)
  payload = { status: status, **options }.compact
  headers = extract_headers(payload)
  @client.patch("v1/customers/#{customer_id}/review", payload, headers: headers)
end

#get(customer_id, **options) ⇒ Hash

Get the identity review for a customer.

Parameters:

  • customer_id (String) —

    customer ID

Returns:

  • (Hash) —

    review details



12
13
14
15
 
# File 'lib/straddle_pay/resources/customer_reviews.rb', line 12

def get(customer_id, **options)
  headers = extract_headers(options)
  @client.get("v1/customers/#{customer_id}/review", headers: headers)
end

#refresh(customer_id, **options) ⇒ Hash

Refresh a customer's identity review.

Parameters:

  • customer_id (String) —

    customer ID

Returns:

  • (Hash) —

    refreshed review



32
33
34
35
 
# File 'lib/straddle_pay/resources/customer_reviews.rb', line 32

def refresh(customer_id, **options)
  headers = extract_headers(options)
  @client.put("v1/customers/#{customer_id}/refresh_review", options, headers: headers)
end