Class: FinchAPI::Resources::HRIS::Company

Inherits:
Object
  • Object
show all
Defined in:
lib/finch_api/resources/hris/company.rb,
sig/finch_api/resources/hris/company.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Company

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

Parameters:



37
38
39
 
# File 'lib/finch_api/resources/hris/company.rb', line 37

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(entity_ids: nil, request_options: {}) ⇒ FinchAPI::Models::HRIS::HRISCompany

Some parameter documentations has been truncated, see Models::HRIS::CompanyRetrieveParams for more details.

Read basic company data

Parameters:

  • entity_ids (Array<String>) —

    The entity IDs to specify which entities' data to access. Provide exactly one en

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

Returns:

See Also:



21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/finch_api/resources/hris/company.rb', line 21

def retrieve(params = {})
  parsed, options = FinchAPI::HRIS::CompanyRetrieveParams.dump_request(params)
  query = FinchAPI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "employer/company",
    query: query,
    model: FinchAPI::HRIS::HRISCompany,
    security: {bearer_auth: true},
    options: options
  )
end