Class: CheckoutSdk::Identities::Applicants::ApplicantsClient

Inherits:
Client
  • Object
show all
Defined in:
lib/checkout_sdk/identities/applicants/applicants_client.rb

Overview

Client for the Identities — Applicants API.

Instance Attribute Summary

Attributes inherited from Client

#api_client, #authorization_type, #configuration

Instance Method Summary collapse

Constructor Details

#initialize(api_client, configuration) ⇒ ApplicantsClient

Returns a new instance of ApplicantsClient.

Parameters:



14
15
16
 
# File 'lib/checkout_sdk/identities/applicants/applicants_client.rb', line 14

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

Instance Method Details

#anonymize_applicant(applicant_id) ⇒ Object

Parameters:

  • applicant_id (String) 


37
38
39
 
# File 'lib/checkout_sdk/identities/applicants/applicants_client.rb', line 37

def anonymize_applicant(applicant_id)
  api_client.invoke_post(build_path(APPLICANTS, applicant_id, ANONYMIZE), sdk_authorization)
end

#create_applicant(create_applicant_request) ⇒ Object

Parameters:



19
20
21
 
# File 'lib/checkout_sdk/identities/applicants/applicants_client.rb', line 19

def create_applicant(create_applicant_request)
  api_client.invoke_post(APPLICANTS, sdk_authorization, create_applicant_request)
end

#get_applicant(applicant_id) ⇒ Object

Parameters:

  • applicant_id (String) 


24
25
26
 
# File 'lib/checkout_sdk/identities/applicants/applicants_client.rb', line 24

def get_applicant(applicant_id)
  api_client.invoke_get(build_path(APPLICANTS, applicant_id), sdk_authorization)
end

#update_applicant(applicant_id, update_applicant_request) ⇒ Object

Parameters:



30
31
32
33
34
 
# File 'lib/checkout_sdk/identities/applicants/applicants_client.rb', line 30

def update_applicant(applicant_id, update_applicant_request)
  api_client.invoke_patch(build_path(APPLICANTS, applicant_id),
                          sdk_authorization,
                          update_applicant_request)
end