Class: FinchAPI::Resources::HRIS::Individuals

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Individuals

Returns a new instance of Individuals.

Parameters:



31
32
33
 
# File 'lib/finch-api/resources/hris/individuals.rb', line 31

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve_many(params = {}) ⇒ FinchAPI::ResponsesPage<FinchAPI::Models::HRIS::IndividualResponse>

Read individual data, excluding income and employment data

Parameters:

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

    .

    @option params [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] :options

    @option params [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] :requests

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

Returns:



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/finch-api/resources/hris/individuals.rb', line 18

def retrieve_many(params = {})
  parsed, options = FinchAPI::Models::HRIS::IndividualRetrieveManyParams.dump_request(params)
  @client.request(
    method: :post,
    path: "employer/individual",
    body: parsed,
    page: FinchAPI::ResponsesPage,
    model: FinchAPI::Models::HRIS::IndividualResponse,
    options: options
  )
end