Class: FinchAPI::Models::HRIS::DocumentListParams

Inherits:

BaseModel

• Object
• FinchAPI::Models::HRIS::DocumentListParams

Includes:

Type::RequestParameters

Defined in:

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

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #individual_ids ⇒ Array<String>^?

  Comma-delimited list of stable Finch uuids for each individual.

• #limit ⇒ Integer^?

  Number of documents to return (defaults to all).

• #offset ⇒ Integer^?

  Index to start from (defaults to 0).

• #types ⇒ Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>^?

  Comma-delimited list of document types to filter on.

Attributes included from Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}) ⇒ DocumentListParams constructor

  A new instance of DocumentListParams.

Methods included from Type::RequestParameters

included

Constructor Details

#initialize(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}) ⇒ DocumentListParams

Returns a new instance of DocumentListParams.

Parameters:

• individual_ids (Array<String>) (defaults to: nil)
• limit (Integer) (defaults to: nil)
• offset (Integer) (defaults to: nil)
• types (Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>) (defaults to: nil)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/finch-api/models/hris/document_list_params.rb', line 7

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

Instance Attribute Details

#individual_ids ⇒ Array<String>^?

Comma-delimited list of stable Finch uuids for each individual. If empty,

defaults to all individuals

Returns:

• (Array<String>, nil)

# File 'lib/finch-api/models/hris/document_list_params.rb', line 16

optional :individual_ids, FinchAPI::ArrayOf[String]

#limit ⇒ Integer^?

Number of documents to return (defaults to all)

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/hris/document_list_params.rb', line 26

optional :limit, Integer

#offset ⇒ Integer^?

Index to start from (defaults to 0)

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/hris/document_list_params.rb', line 36

optional :offset, Integer

#types ⇒ Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>^?

Comma-delimited list of document types to filter on. If empty, defaults to all

types

Returns:

• (Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>, nil)

# File 'lib/finch-api/models/hris/document_list_params.rb', line 47

optional :types, -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::DocumentListParams::Type] }