Class: FinchAPI::Resources::HRIS::Directory

Inherits:
Object
  • Object
show all
Defined in:
lib/finch-api/resources/hris/directory.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Directory

Returns a new instance of Directory.

Parameters:



36
37
38
 
# File 'lib/finch-api/resources/hris/directory.rb', line 36

def initialize(client:)
  @client = client
end

Instance Method Details

#list(params = {}) ⇒ FinchAPI::IndividualsPage<FinchAPI::Models::HRIS::IndividualInDirectory> Also known as: list_individuals

Read company directory and organization structure

Parameters:

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

    .

    @option params [Integer] :limit Number of employees to return (defaults to all)

    @option params [Integer] :offset Index to start from (defaults to 0)

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

Returns:



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/finch-api/resources/hris/directory.rb', line 18

def list(params = {})
  parsed, options = FinchAPI::Models::HRIS::DirectoryListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "employer/directory",
    query: parsed,
    page: FinchAPI::IndividualsPage,
    model: FinchAPI::Models::HRIS::IndividualInDirectory,
    options: options
  )
end