Class: Onfido::Applicant

Inherits:
Resource show all
Defined in:
lib/onfido/resources/applicant.rb

Constant Summary

Constants inherited from Resource

Resource::ADDITIONAL_HEADERS, Resource::REQUEST_TIMEOUT_HTTP_CODE, Resource::VALID_HTTP_METHODS

Instance Method Summary collapse

Methods inherited from Resource

#initialize

Constructor Details

This class inherits a constructor from Onfido::Resource

Instance Method Details

#all(page: 1, per_page: 20) ⇒ Object 



21
22
23
 
# File 'lib/onfido/resources/applicant.rb', line 21

def all(page: 1, per_page: 20)
  get(path: "applicants?page=#{page}&per_page=#{per_page}")
end

#create(payload) ⇒ Object 



5
6
7
 
# File 'lib/onfido/resources/applicant.rb', line 5

def create(payload)
  post(path: 'applicants', payload: payload)
end

#destroy(applicant_id) ⇒ Object 



13
14
15
 
# File 'lib/onfido/resources/applicant.rb', line 13

def destroy(applicant_id)
  delete(path: "applicants/#{applicant_id}")
end

#find(applicant_id) ⇒ Object 



17
18
19
 
# File 'lib/onfido/resources/applicant.rb', line 17

def find(applicant_id)
  get(path: "applicants/#{applicant_id}")
end

#restore(applicant_id) ⇒ Object 



25
26
27
 
# File 'lib/onfido/resources/applicant.rb', line 25

def restore(applicant_id)
  post(path: "applicants/#{applicant_id}/restore")
end

#update(applicant_id, payload) ⇒ Object 



9
10
11
 
# File 'lib/onfido/resources/applicant.rb', line 9

def update(applicant_id, payload)
  put(path: "applicants/#{applicant_id}", payload: payload)
end