Class: FinchAPI::Models::HRIS::Individual::IndividualResponseBody

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

Defined Under Namespace

Modules: Ethnicity, Gender Classes: Email, PhoneNumber

Instance Attribute Summary collapse

Class Method 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_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

#initialize(id:, dob:, ethnicity:, first_name:, gender:, last_name:, middle_name:, phone_numbers:, preferred_name:, residence:, emails: nil, encrypted_ssn: nil, ssn: nil) ⇒ Object

Some parameter documentations has been truncated, see FinchAPI::Models::HRIS::Individual::IndividualResponseBody for more details.

Parameters:




# File 'lib/finch_api/models/hris/individual.rb', line 108

Instance Attribute Details

#dob ⇒ String?

Returns:

  • (String, nil) 


23
 
# File 'lib/finch_api/models/hris/individual.rb', line 23

required :dob, String, nil?: true

#emails ⇒ Array<FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Email>?

Returns:



85
86
87
88
89
 
# File 'lib/finch_api/models/hris/individual.rb', line 85

optional :emails,
-> {
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Individual::IndividualResponseBody::Email]
},
nil?: true

#encrypted_ssn ⇒ String?

Social Security Number of the individual in encrypted format. This field is only available with the ‘ssn` scope enabled and the `options: { include: [’ssn’] }‘ param set in the body.

Returns:

  • (String, nil) 


97
 
# File 'lib/finch_api/models/hris/individual.rb', line 97

optional :encrypted_ssn, String, nil?: true

#ethnicity ⇒ Symbol, ...

The EEOC-defined ethnicity of the individual.

Returns:



29
30
31
 
# File 'lib/finch_api/models/hris/individual.rb', line 29

required :ethnicity,
enum: -> { FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity },
nil?: true

#first_name ⇒ String?

The legal first name of the individual.

Returns:

  • (String, nil) 


37
 
# File 'lib/finch_api/models/hris/individual.rb', line 37

required :first_name, String, nil?: true

#gender ⇒ Symbol, ...

The gender of the individual.

Returns:



43
44
45
46
47
 
# File 'lib/finch_api/models/hris/individual.rb', line 43

required :gender,
enum: -> {
  FinchAPI::HRIS::Individual::IndividualResponseBody::Gender
},
nil?: true

#id ⇒ String

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

Returns:

  • (String) 


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

required :id, String

#last_name ⇒ String?

The legal last name of the individual.

Returns:

  • (String, nil) 


53
 
# File 'lib/finch_api/models/hris/individual.rb', line 53

required :last_name, String, nil?: true

#middle_name ⇒ String?

The legal middle name of the individual.

Returns:

  • (String, nil) 


59
 
# File 'lib/finch_api/models/hris/individual.rb', line 59

required :middle_name, String, nil?: true

#phone_numbers ⇒ Array<FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber, nil>?

Returns:



64
65
66
67
68
69
 
# File 'lib/finch_api/models/hris/individual.rb', line 64

required :phone_numbers,
-> {
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber,
                                    nil?: true]
},
nil?: true

#preferred_name ⇒ String?

The preferred name of the individual.

Returns:

  • (String, nil) 


75
 
# File 'lib/finch_api/models/hris/individual.rb', line 75

required :preferred_name, String, nil?: true

#residence ⇒ FinchAPI::Models::Location?

Returns:



80
 
# File 'lib/finch_api/models/hris/individual.rb', line 80

required :residence, -> { FinchAPI::Location }, nil?: true

#ssn ⇒ String?

Social Security Number of the individual. This field is only available with the ‘ssn` scope enabled and the `options: { include: [’ssn’] }‘ param set in the body. [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).

Returns:

  • (String, nil) 


106
 
# File 'lib/finch_api/models/hris/individual.rb', line 106

optional :ssn, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/finch_api/models/hris/individual.rb', line 153