Class: CheckoutSdk::Identities::IdDocumentVerification::IdDocumentVerificationClient

Inherits:
Client
  • Object
show all
Defined in:
lib/checkout_sdk/identities/id_document_verification/id_document_verification_client.rb

Overview

Client for the Identities — ID Document Verification API.

Instance Attribute Summary

Attributes inherited from Client

#api_client, #authorization_type, #configuration

Instance Method Summary collapse

Constructor Details

#initialize(api_client, configuration) ⇒ IdDocumentVerificationClient

Returns a new instance of IdDocumentVerificationClient.

Parameters:



16
17
18
 
# File 'lib/checkout_sdk/identities/id_document_verification/id_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_id_document_verification(id_document_verification_id) ⇒ Object

Parameters:

  • id_document_verification_id (String) 


32
33
34
35
36
37
 
# File 'lib/checkout_sdk/identities/id_document_verification/id_document_verification_client.rb', line 32

def anonymize_id_document_verification(id_document_verification_id)
  api_client.invoke_post(
    build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, ANONYMIZE),
    sdk_authorization
  )
end

#create_id_document_verification(request) ⇒ Object

Parameters:



21
22
23
 
# File 'lib/checkout_sdk/identities/id_document_verification/id_document_verification_client.rb', line 21

def create_id_document_verification(request)
  api_client.invoke_post(ID_DOCUMENT_VERIFICATIONS, sdk_authorization, request)
end

#create_id_document_verification_attempt(id_document_verification_id, attempt_request = nil) ⇒ Object

Create a new attempt for an existing ID document verification.

Parameters:

  • id_document_verification_id (String)
  • attempt_request (Hash) (defaults to: nil) —

    Optional body per swagger.



42
43
44
45
46
47
48
 
# File 'lib/checkout_sdk/identities/id_document_verification/id_document_verification_client.rb', line 42

def create_id_document_verification_attempt(id_document_verification_id, attempt_request = nil)
  api_client.invoke_post(
    build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, ATTEMPTS),
    sdk_authorization,
    attempt_request
  )
end

#get_id_document_verification(id_document_verification_id) ⇒ Object

Parameters:

  • id_document_verification_id (String) 


26
27
28
29
 
# File 'lib/checkout_sdk/identities/id_document_verification/id_document_verification_client.rb', line 26

def get_id_document_verification(id_document_verification_id)
  api_client.invoke_get(build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id),
                        sdk_authorization)
end

#get_id_document_verification_attempt(id_document_verification_id, attempt_id) ⇒ Object

Parameters:

  • id_document_verification_id (String)
  • attempt_id (String) 


60
61
62
63
64
65
 
# File 'lib/checkout_sdk/identities/id_document_verification/id_document_verification_client.rb', line 60

def get_id_document_verification_attempt(id_document_verification_id, attempt_id)
  api_client.invoke_get(
    build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, ATTEMPTS, attempt_id),
    sdk_authorization
  )
end

#get_id_document_verification_attempts(id_document_verification_id) ⇒ Object

Parameters:

  • id_document_verification_id (String) 


51
52
53
54
55
56
 
# File 'lib/checkout_sdk/identities/id_document_verification/id_document_verification_client.rb', line 51

def get_id_document_verification_attempts(id_document_verification_id)
  api_client.invoke_get(
    build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, ATTEMPTS),
    sdk_authorization
  )
end

#get_id_document_verification_pdf_report(id_document_verification_id) ⇒ Object

Parameters:

  • id_document_verification_id (String) 


68
69
70
71
72
73
 
# File 'lib/checkout_sdk/identities/id_document_verification/id_document_verification_client.rb', line 68

def get_id_document_verification_pdf_report(id_document_verification_id)
  api_client.invoke_get(
    build_path(ID_DOCUMENT_VERIFICATIONS, id_document_verification_id, PDF_REPORT),
    sdk_authorization
  )
end