Class: FinchAPI::Resources::HRIS::Employments

Inherits:
Object
  • Object
show all
Defined in:
lib/finch-api/resources/hris/employments.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Employments

Returns a new instance of Employments.

Parameters:



29
30
31
 
# File 'lib/finch-api/resources/hris/employments.rb', line 29

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve_many(params) ⇒ FinchAPI::ResponsesPage<FinchAPI::Models::HRIS::EmploymentDataResponse>

Read individual employment and income data

Parameters:

  • params (FinchAPI::Models::HRIS::EmploymentRetrieveManyParams, Hash{Symbol=>Object}) —

    .

    @option params [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] :requests The array of batch requests.

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

Returns:



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/finch-api/resources/hris/employments.rb', line 16

def retrieve_many(params)
  parsed, options = FinchAPI::Models::HRIS::EmploymentRetrieveManyParams.dump_request(params)
  @client.request(
    method: :post,
    path: "employer/employment",
    body: parsed,
    page: FinchAPI::ResponsesPage,
    model: FinchAPI::Models::HRIS::EmploymentDataResponse,
    options: options
  )
end