Class: FinchAPI::Models::HRIS::DirectoryListParams

Inherits:

BaseModel

• Object
• FinchAPI::Models::HRIS::DirectoryListParams

Includes:

Type::RequestParameters

Defined in:

lib/finch-api/models/hris/directory_list_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 Type::RequestParameters

#request_options

Instance Method Summary

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

  A new instance of DirectoryListParams.

Methods included from Type::RequestParameters

included

Constructor Details

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

Returns a new instance of DirectoryListParams.

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_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_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_params.rb', line 25

optional :offset, Integer