Class: FinchAPI::Models::HRIS::DirectoryListIndividualsParams

Inherits:

BaseModel

• Object
• BaseModel
• FinchAPI::Models::HRIS::DirectoryListIndividualsParams

Includes:

RequestParameters

Defined in:

lib/finch-api/models/hris/directory_list_individuals_params.rb

Instance Attribute Summary

• #limit ⇒ Integer^?

  Number of employees to return (defaults to all).

• #offset ⇒ Integer^?

  Index to start from (defaults to 0).

Attributes included from RequestParameters

#request_options

Instance Method Summary

• #initialize(limit: nil, offset: nil, request_options: {}) ⇒ DirectoryListIndividualsParams constructor

  A new instance of DirectoryListIndividualsParams.

Methods included from RequestParameters

included

Methods inherited from BaseModel

==, #==, #[], coerce, #deconstruct_keys, dump, fields, #inspect, known_fields, optional, required, #to_h

Methods included from Converter

#coerce, coerce, #dump, dump, type_info

Constructor Details

#initialize(limit: nil, offset: nil, request_options: {}) ⇒ DirectoryListIndividualsParams

Returns a new instance of DirectoryListIndividualsParams.

Parameters:

• limit (Integer) (defaults to: nil)
• offset (Integer) (defaults to: nil)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/finch-api/models/hris/directory_list_individuals_params.rb', line 5

def initialize(limit: nil, offset: nil, request_options: {}, **) = super

Instance Attribute Details

#limit ⇒ Integer^?

Number of employees to return (defaults to all)

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/hris/directory_list_individuals_params.rb', line 15

optional :limit, Integer

#offset ⇒ Integer^?

Index to start from (defaults to 0)

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/hris/directory_list_individuals_params.rb', line 25

optional :offset, Integer