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 private

  A new instance of Manual.

• #retrieve(job_id, request_options: {}) ⇒ FinchAPI::Jobs::ManualAsyncJob

  Get a manual job by ‘job_id`.

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:

• client (FinchAPI::Client)

# File 'lib/finch_api/resources/jobs/manual.rb', line 30

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(job_id, request_options: {}) ⇒ FinchAPI::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)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (FinchAPI::Jobs::ManualAsyncJob)

See Also:

• Models::Jobs::ManualRetrieveParams

# File 'lib/finch_api/resources/jobs/manual.rb', line 18

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