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

Inherits:

Object

• Object
• FinchAPI::Resources::HRIS::Company

Defined in:

lib/finch-api/resources/hris/company.rb

Instance Method Summary

• #initialize(client:) ⇒ Company constructor

  A new instance of Company.

• #retrieve(params = {}) ⇒ FinchAPI::Models::HRIS::HRISCompany

  Read basic company data.

Constructor Details

#initialize(client:) ⇒ Company

Returns a new instance of Company.

Parameters:

• client (FinchAPI::Client)

# File 'lib/finch-api/resources/hris/company.rb', line 24

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(params = {}) ⇒ FinchAPI::Models::HRIS::HRISCompany

Read basic company data

Parameters:

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

  .

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

Returns:

• (FinchAPI::Models::HRIS::HRISCompany)

# File 'lib/finch-api/resources/hris/company.rb', line 14

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "employer/company",
    model: FinchAPI::Models::HRIS::HRISCompany,
    options: params[:request_options]
  )
end