Class: FinchAPI::Models::HRIS::IndividualInDirectory

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/hris/individual_in_directory.rb

Overview

See Also:

Defined Under Namespace

Classes: Department, Manager

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

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

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!

Constructor Details

#initialize(name: nil) ⇒ Object

The department object.

Parameters:

  • name (String, nil) (defaults to: nil) —

    The name of the department.




# File 'lib/finch_api/models/hris/individual_in_directory.rb', line 50

Instance Attribute Details

#department ⇒ FinchAPI::HRIS::IndividualInDirectory::Department?

The department object.

Returns:

  • (FinchAPI::HRIS::IndividualInDirectory::Department, nil) 


18
 
# File 'lib/finch_api/models/hris/individual_in_directory.rb', line 18

required :department, -> { FinchAPI::HRIS::IndividualInDirectory::Department }, nil?: true

#first_name ⇒ String?

The legal first name of the individual.

Returns:

  • (String, nil) 


24
 
# File 'lib/finch_api/models/hris/individual_in_directory.rb', line 24

required :first_name, String, nil?: true

#id ⇒ String

A stable Finch ‘id` (UUID v4) for an individual in the company.

Returns:

  • (String) 


12
 
# File 'lib/finch_api/models/hris/individual_in_directory.rb', line 12

required :id, String

#is_active ⇒ Boolean?

‘true` if the individual is an active employee or contractor at the company.

Returns:

  • (Boolean, nil) 


30
 
# File 'lib/finch_api/models/hris/individual_in_directory.rb', line 30

required :is_active, FinchAPI::Internal::Type::Boolean, nil?: true

#last_name ⇒ String?

The legal last name of the individual.

Returns:

  • (String, nil) 


36
 
# File 'lib/finch_api/models/hris/individual_in_directory.rb', line 36

required :last_name, String, nil?: true

#manager ⇒ FinchAPI::HRIS::IndividualInDirectory::Manager?

The manager object.

Returns:

  • (FinchAPI::HRIS::IndividualInDirectory::Manager, nil) 


42
 
# File 'lib/finch_api/models/hris/individual_in_directory.rb', line 42

required :manager, -> { FinchAPI::HRIS::IndividualInDirectory::Manager }, nil?: true

#middle_name ⇒ String?

The legal middle name of the individual.

Returns:

  • (String, nil) 


48
 
# File 'lib/finch_api/models/hris/individual_in_directory.rb', line 48

required :middle_name, String, nil?: true