Class: DocFox::StatusSummary::GetService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/doc_fox/status_summary/get_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:) ⇒ GetService

Returns a new instance of GetService.



12
13
14
 
# File 'lib/doc_fox/status_summary/get_service.rb', line 12

def initialize(id:)
  @id = id
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



4
5
6
 
# File 'lib/doc_fox/status_summary/get_service.rb', line 4

def id
  @id
end

Instance Method Details

#call ⇒ Object

Get a status summary of a KYC application.

https://www.docfoxapp.com/api/v2/documentation#tag/Status-Summaries/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1status_summaries/get

Examples

service = DocFox::StatusSummary::GetService.call(id: '')

service.success? # => true
service.errors # => #<ActiveModel::Errors []>

service.response # => #<Faraday::Response ...>
service.response.status # => 200
service.response.body # => {}

service.facade # => #<DocFox::StatusSummary::Facade ...>
service.facade.id
service.id

service.relationships.dig('kyc_application', 'links', 'related')

GET /api/v2/kyc_applications/:id/status_summaries



38
39
40
 
# File 'lib/doc_fox/status_summary/get_service.rb', line 38

def call
  connection.get("kyc_applications/#{id}/status_summaries")
end