Class: DocFox::DataRequirement::ListService

Inherits:
BaseService
  • Object
show all
Includes:
Enumerable
Defined in:
lib/doc_fox/data_requirement/list_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

#call, #each

Constructor Details

#initialize(kyc_application_id: nil, account_application_id: nil, page: 1, per_page: Float::INFINITY, forms: false) ⇒ ListService

List data requirements.

https://www.docfoxapp.com/api/v2/documentation#tag/Data-Requirements/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1data_requirements/get

List data requirements associated with an account application.

https://www.docfoxapp.com/api/v2/documentation#tag/Data-Requirements/paths/~1api~1v2~1account_applications~1%7Baccount_application_id%7D~1data_requirements/get

Examples

service = DocFox::DataRequirement::ListService.call(kyc_application_id: '').first
service.id
service.name

service = DocFox::DataRequirement::ListService.call(account_application_id: '').first
service.id
service.name

If you don't provide the per_page argument, multiple API requests will be made untill all records have been returned. You could be rate limited, so use wisely.

DocFox::DataRequirement::ListService.call(kyc_application_id: '', page: 1, per_page: 10).map { _1 }

Filter by forms.

DocFox::DataRequirement::ListService.call(kyc_application_id: '', forms: true).map { _1 }

GET /api/v2/kyc_applications/:kyc_application_id/data_requirements GET /api/v2/account_applications/:account_application_id/data_requirements



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/doc_fox/data_requirement/list_service.rb', line 39

def initialize(kyc_application_id: nil, account_application_id: nil, page: 1, per_page: Float::INFINITY, forms: false)
  @kyc_application_id     = kyc_application_id
  @account_application_id = 
  @forms                  = forms

  entity_path = kyc_application_id.present? ? 'kyc_applications' : 'account_applications'

  super(
    path:         "#{entity_path}/#{}/data_requirements",
    facade_klass: DocFox::DataRequirement::Facade,
    page:         page,
    per_page:     per_page
  )
end

Instance Attribute Details

#account_application_id ⇒ Object (readonly)

Returns the value of attribute account_application_id.



6
7
8
 
# File 'lib/doc_fox/data_requirement/list_service.rb', line 6

def 
  @account_application_id
end

#forms ⇒ Object (readonly)

Returns the value of attribute forms.



6
7
8
 
# File 'lib/doc_fox/data_requirement/list_service.rb', line 6

def forms
  @forms
end

#kyc_application_id ⇒ Object (readonly)

Returns the value of attribute kyc_application_id.



6
7
8
 
# File 'lib/doc_fox/data_requirement/list_service.rb', line 6

def kyc_application_id
  @kyc_application_id
end