Class: DocFox::EvidenceSubmission::ListService

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DocFox::Enumerable

#call, #each

Constructor Details

#initialize(data_requirement_id:, page: 1, per_page: Float::INFINITY) ⇒ ListService

List evidence submissions.

https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1data_requirements~1%7Bdata_requirement_id%7D~1evidence_submissions/get

Examples

service = DocFox::EvidenceSubmission::ListService.call(data_requirement_id: '').first
service.id
service.status

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::EvidenceSubmission::ListService.call(data_requirement_id: '', page: 1, per_page: 10).map { _1 }

GET /api/v2/data_requirements/:data_requirement_id/evidence_submissions



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/doc_fox/evidence_submission/list_service.rb', line 26

def initialize(data_requirement_id:, page: 1, per_page: Float::INFINITY)
  @data_requirement_id = data_requirement_id

  super(
    path:         "data_requirements/#{data_requirement_id}/evidence_submissions",
    facade_klass: DocFox::EvidenceSubmission::Facade,
    page:         page,
    per_page:     per_page
  )
end

Instance Attribute Details

#data_requirement_id ⇒ Object (readonly)

Returns the value of attribute data_requirement_id.



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

def data_requirement_id
  @data_requirement_id
end