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

Inherits:

Object

• Object
• FinchAPI::Resources::HRIS::Individuals

Defined in:

lib/finch_api/resources/hris/individuals.rb

Instance Method Summary

• #initialize(client:) ⇒ Individuals constructor private

  A new instance of Individuals.

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

  Read individual data, excluding income and employment data.

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:

• client (FinchAPI::Client)

# File 'lib/finch_api/resources/hris/individuals.rb', line 39

def initialize(client:)
  @client = client
end

Instance Method Details

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

Read individual data, excluding income and employment data

Parameters:

• entity_ids (Array<String>) —

  Query param: The entity IDs to specify which entities’ data to access.

• options (FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil) —

  Body param:

• requests (Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>) —

  Body param:

• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (FinchAPI::Internal::ResponsesPage<FinchAPI::Models::HRIS::IndividualResponse>)

See Also:

• Models::HRIS::IndividualRetrieveManyParams

# File 'lib/finch_api/resources/hris/individuals.rb', line 22

def retrieve_many(params = {})
  parsed, options = FinchAPI::HRIS::IndividualRetrieveManyParams.dump_request(params)
  query_params = [:entity_ids]
  @client.request(
    method: :post,
    path: "employer/individual",
    query: parsed.slice(*query_params),
    body: parsed.except(*query_params),
    page: FinchAPI::Internal::ResponsesPage,
    model: FinchAPI::HRIS::IndividualResponse,
    options: options
  )
end