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

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/finch_api/models/hris/document_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from FinchAPI::Internal::Type::BaseModel

Instance Attribute Details

#entity_ids ⇒ Array<String>?

The entity IDs to specify which entities’ data to access.

Returns:

  • (Array<String>, nil) 


15
 
# File 'lib/finch_api/models/hris/document_list_params.rb', line 15

optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

#individual_ids ⇒ Array<String>?

Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals

Returns:

  • (Array<String>, nil) 


22
 
# File 'lib/finch_api/models/hris/document_list_params.rb', line 22

optional :individual_ids, FinchAPI::Internal::Type::ArrayOf[String]

#limit ⇒ Integer?

Number of documents to return (defaults to all)

Returns:

  • (Integer, nil) 


28
 
# File 'lib/finch_api/models/hris/document_list_params.rb', line 28

optional :limit, Integer

#offset ⇒ Integer?

Index to start from (defaults to 0)

Returns:

  • (Integer, nil) 


34
 
# File 'lib/finch_api/models/hris/document_list_params.rb', line 34

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:



41
 
# File 'lib/finch_api/models/hris/document_list_params.rb', line 41

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