Class: FinchAPI::Resources::Jobs::Manual

Inherits:
Object
  • Object
show all
Defined in:
lib/finch_api/resources/jobs/manual.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Manual

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Manual.

Parameters:



38
39
40
 
# File 'lib/finch_api/resources/jobs/manual.rb', line 38

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(job_id, entity_id: nil, request_options: {}) ⇒ FinchAPI::Models::Jobs::ManualAsyncJob

Some parameter documentations has been truncated, see Models::Jobs::ManualRetrieveParams for more details.

Get a manual job by ‘job_id`. Manual jobs are completed by a human and include Assisted Benefits jobs.

Parameters:

  • job_id (String)
  • entity_id (String) —

    The entity ID to use when authenticating with a multi-account token. Required wh

  • request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/finch_api/resources/jobs/manual.rb', line 24

def retrieve(job_id, params = {})
  parsed, options = FinchAPI::Jobs::ManualRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["jobs/manual/%1$s", job_id],
    query: parsed,
    model: FinchAPI::Jobs::ManualAsyncJob,
    options: options
  )
end