Class: CheckoutSdk::Identities::AddressDocumentVerification::AddressDocumentVerificationClient

Inherits:
Client
  • Object
show all
Defined in:
lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb

Overview

Client for the Identities — Address Document Verification (Adv) API.

Instance Attribute Summary

Attributes inherited from Client

#api_client, #authorization_type, #configuration

Instance Method Summary collapse

Constructor Details

#initialize(api_client, configuration) ⇒ AddressDocumentVerificationClient

Returns a new instance of AddressDocumentVerificationClient.

Parameters:



16
17
18
 
# File 'lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb', line 16

def initialize(api_client, configuration)
  super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
end

Instance Method Details

#anonymize_address_document_verification(address_document_verification_id) ⇒ Object

Parameters:

  • address_document_verification_id (String) 


34
35
36
37
38
39
 
# File 'lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb', line 34

def anonymize_address_document_verification(address_document_verification_id)
  api_client.invoke_post(
    build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, ANONYMIZE),
    sdk_authorization
  )
end

#create_address_document_verification(request) ⇒ Object

Parameters:



21
22
23
 
# File 'lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb', line 21

def create_address_document_verification(request)
  api_client.invoke_post(ADDRESS_DOCUMENT_VERIFICATIONS, sdk_authorization, request)
end

#create_address_document_verification_attempt(address_document_verification_id, attempt_request = nil) ⇒ Object

Create a new attempt for an existing address document verification.

Parameters:



44
45
46
47
48
49
50
 
# File 'lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb', line 44

def create_address_document_verification_attempt(address_document_verification_id, attempt_request = nil)
  api_client.invoke_post(
    build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, ATTEMPTS),
    sdk_authorization,
    attempt_request
  )
end

#get_address_document_verification(address_document_verification_id) ⇒ Object

Parameters:

  • address_document_verification_id (String) 


26
27
28
29
30
31
 
# File 'lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb', line 26

def get_address_document_verification(address_document_verification_id)
  api_client.invoke_get(
    build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id),
    sdk_authorization
  )
end

#get_address_document_verification_attempt(address_document_verification_id, attempt_id) ⇒ Object

Parameters:

  • address_document_verification_id (String)
  • attempt_id (String) 


62
63
64
65
66
67
 
# File 'lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb', line 62

def get_address_document_verification_attempt(address_document_verification_id, attempt_id)
  api_client.invoke_get(
    build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, ATTEMPTS, attempt_id),
    sdk_authorization
  )
end

#get_address_document_verification_attempts(address_document_verification_id) ⇒ Object

Parameters:

  • address_document_verification_id (String) 


53
54
55
56
57
58
 
# File 'lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb', line 53

def get_address_document_verification_attempts(address_document_verification_id)
  api_client.invoke_get(
    build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, ATTEMPTS),
    sdk_authorization
  )
end

#get_address_document_verification_pdf_report(address_document_verification_id) ⇒ Object

Parameters:

  • address_document_verification_id (String) 


70
71
72
73
74
75
 
# File 'lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb', line 70

def get_address_document_verification_pdf_report(address_document_verification_id)
  api_client.invoke_get(
    build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, PDF_REPORT),
    sdk_authorization
  )
end