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

Inherits:

Object

• Object
• FinchAPI::Resources::Jobs::Manual

Defined in:

lib/finch-api/resources/jobs/manual.rb

Instance Method Summary

• #initialize(client:) ⇒ Manual constructor

  A new instance of Manual.

• #retrieve(job_id, params = {}) ⇒ FinchAPI::Models::Jobs::ManualAsyncJob

  Get a manual job by ‘job_id`.

Constructor Details

#initialize(client:) ⇒ Manual

Returns a new instance of Manual.

Parameters:

• client (FinchAPI::Client)

# File 'lib/finch-api/resources/jobs/manual.rb', line 27

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(job_id, params = {}) ⇒ FinchAPI::Models::Jobs::ManualAsyncJob

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

Assisted Benefits jobs.

Parameters:

• job_id (String)
• params (FinchAPI::Models::Jobs::ManualRetrieveParams, Hash{Symbol=>Object}) (defaults to: {}) —

  .

  @option params [FinchAPI::RequestOptions, HashSymbol=>Object, nil] :request_options

Returns:

• (FinchAPI::Models::Jobs::ManualAsyncJob)

# File 'lib/finch-api/resources/jobs/manual.rb', line 17

def retrieve(job_id, params = {})
  @client.request(
    method: :get,
    path: ["jobs/manual/%0s", job_id],
    model: FinchAPI::Models::Jobs::ManualAsyncJob,
    options: params[:request_options]
  )
end