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

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 Individuals.

Parameters:



33
34
35
 
# File 'lib/finch_api/resources/hris/individuals.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve_many(options: nil, requests: nil, request_options: {}) ⇒ FinchAPI::Internal::ResponsesPage<FinchAPI::HRIS::IndividualResponse>

Read individual data, excluding income and employment data

Parameters:

  • options (FinchAPI::HRIS::IndividualRetrieveManyParams::Options, nil)
  • requests (Array<FinchAPI::HRIS::IndividualRetrieveManyParams::Request>)
  • request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



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::HRIS::IndividualRetrieveManyParams.dump_request(params)
  @client.request(
    method: :post,
    path: "employer/individual",
    body: parsed,
    page: FinchAPI::Internal::ResponsesPage,
    model: FinchAPI::HRIS::IndividualResponse,
    options: options
  )
end