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

Inherits:

Object

• Object
• FinchAPI::Resources::HRIS::Employments

Defined in:

lib/finch_api/resources/hris/employments.rb

Instance Method Summary

• #initialize(client:) ⇒ Employments constructor private

  A new instance of Employments.

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

  Read individual employment and income data.

Constructor Details

#initialize(client:) ⇒ Employments

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

Parameters:

• client (FinchAPI::Client)

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

def initialize(client:)
  @client = client
end

Instance Method Details

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

Read individual employment and income data

Parameters:

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

  Body param: The array of batch requests.

• entity_ids (Array<String>) —

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

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

Returns:

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

See Also:

• Models::HRIS::EmploymentRetrieveManyParams

# File 'lib/finch_api/resources/hris/employments.rb', line 20

def retrieve_many(params)
  query_params = [:entity_ids]
  parsed, options = FinchAPI::HRIS::EmploymentRetrieveManyParams.dump_request(params)
  query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: "employer/employment",
    query: query,
    body: parsed.except(*query_params),
    page: FinchAPI::Internal::ResponsesPage,
    model: FinchAPI::HRIS::EmploymentDataResponse,
    security: {bearer_auth: true},
    options: options
  )
end