Class: FinchAPI::Models::HRIS::Individual::UnionMember0

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::HRIS::Individual::UnionMember0

Defined in:

lib/finch_api/models/hris/individual.rb

Defined Under Namespace

Modules: Ethnicity, Gender Classes: Email, PhoneNumber

Instance Attribute Summary

• #dob ⇒ String^?
• #emails ⇒ Array<FinchAPI::Models::HRIS::Individual::UnionMember0::Email>^?
• #encrypted_ssn ⇒ String^?

  Social Security Number of the individual in encrypted format.

• #ethnicity ⇒ Symbol, ...

  The EEOC-defined ethnicity of the individual.

• #first_name ⇒ String^?

  The legal first name of the individual.

• #gender ⇒ Symbol, ...

  The gender of the individual.

• #id ⇒ String

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

• #last_name ⇒ String^?

  The legal last name of the individual.

• #middle_name ⇒ String^?

  The legal middle name of the individual.

• #phone_numbers ⇒ Array<FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber, nil>^?
• #preferred_name ⇒ String^?

  The preferred name of the individual.

• #residence ⇒ FinchAPI::Models::Location^?
• #ssn ⇒ String^?

  Social Security Number of the individual.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

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

  Some parameter documentations has been truncated, see UnionMember0 for more details.

Methods inherited from Internal::Type::BaseModel

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

Methods included from Internal::Type::Converter

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

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::UnionMember0 for more details.

…

…

Parameters:

• id (String) (defaults to: ) —

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

• dob (String, nil) (defaults to: )
• ethnicity (Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity, nil) (defaults to: ) —

  The EEOC-defined ethnicity of the individual.

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

  The legal first name of the individual.

• gender (Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender, nil) (defaults to: ) —

  The gender of the individual.

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

  The legal last name of the individual.

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

  The legal middle name of the individual.

• phone_numbers (Array<FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber, nil>, nil) (defaults to: )
• preferred_name (String, nil) (defaults to: ) —

  The preferred name of the individual.

• residence (FinchAPI::Models::Location, nil) (defaults to: )
• emails (Array<FinchAPI::Models::HRIS::Individual::UnionMember0::Email>, nil) (defaults to: nil)
• encrypted_ssn (String, nil) (defaults to: nil) —

  Social Security Number of the individual in encrypted format. This field is

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

  Social Security Number of the individual. This field is only available with the

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

Instance Attribute Details

#dob ⇒ String^?

Returns:

• (String, nil)

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

required :dob, String, nil?: true

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

Returns:

• (Array<FinchAPI::Models::HRIS::Individual::UnionMember0::Email>, nil)

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

optional :emails,
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::Individual::UnionMember0::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)

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

optional :encrypted_ssn, String, nil?: true

#ethnicity ⇒ Symbol, ...

The EEOC-defined ethnicity of the individual.

Returns:

• (Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity, nil)

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

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

#first_name ⇒ String^?

The legal first name of the individual.

Returns:

• (String, nil)

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

required :first_name, String, nil?: true

#gender ⇒ Symbol, ...

The gender of the individual.

Returns:

• (Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender, nil)

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

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

#id ⇒ String

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

Returns:

• (String)

# 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)

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

required :last_name, String, nil?: true

#middle_name ⇒ String^?

The legal middle name of the individual.

Returns:

• (String, nil)

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

required :middle_name, String, nil?: true

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

Returns:

• (Array<FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber, nil>, nil)

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

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

#preferred_name ⇒ String^?

The preferred name of the individual.

Returns:

• (String, nil)

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

required :preferred_name, String, nil?: true

#residence ⇒ FinchAPI::Models::Location^?

Returns:

• (FinchAPI::Models::Location, nil)

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

required :residence, -> { FinchAPI::Models::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)

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

optional :ssn, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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