Class: Merge::Accounting::Employee

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/types/employee.rb

Overview

# The Employee Object

### Description
An `Employee` is an individual who works for the company of the linked account.
The `Employee` model contains both contractors and full time employees.
* An `Employee` is a contractor if `is_contractor` property is `True`
* An `Employee` is a full time employee if `is_contractor` property is `False`
### Usage Example
Fetch from the `LIST Employees` endpoint and view a company's employees.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status:, id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, first_name: OMIT, last_name: OMIT, is_contractor: OMIT, employee_number: OMIT, email_address: OMIT, company: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Accounting::Employee

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • first_name (String) (defaults to: OMIT) —

    The employee’s first name.

  • last_name (String) (defaults to: OMIT) —

    The employee’s last name.

  • is_contractor (Boolean) (defaults to: OMIT) —

    ‘True` if the employee is a contractor, `False` if not.

  • employee_number (String) (defaults to: OMIT) —

    The employee’s internal identification number.

  • email_address (String) (defaults to: OMIT) —

    The employee’s email address.

  • company (Merge::Accounting::EmployeeCompany) (defaults to: OMIT) —

    The subsidiary that the employee belongs to.

  • status (Merge::Accounting::Status895Enum) —

    The employee’s status in the accounting system.

    • ‘ACTIVE` - ACTIVE

    • ‘INACTIVE` - INACTIVE

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Accounting::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 83

def initialize(status:, id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, first_name: OMIT, last_name: OMIT,
               is_contractor: OMIT, employee_number: OMIT, email_address: OMIT, company: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @first_name = first_name if first_name != OMIT
  @last_name = last_name if last_name != OMIT
  @is_contractor = is_contractor if is_contractor != OMIT
  @employee_number = employee_number if employee_number != OMIT
  @email_address = email_address if email_address != OMIT
  @company = company if company != OMIT
  @status = status
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "first_name": first_name,
    "last_name": last_name,
    "is_contractor": is_contractor,
    "employee_number": employee_number,
    "email_address": email_address,
    "company": company,
    "status": status,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



55
56
57
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 55

def additional_properties
  @additional_properties
end

#company ⇒ Merge::Accounting::EmployeeCompany (readonly)

Returns The subsidiary that the employee belongs to.

Returns:



40
41
42
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 40

def company
  @company
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



26
27
28
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 26

def created_at
  @created_at
end

#email_address ⇒ String (readonly)

Returns The employee’s email address.

Returns:

  • (String) —

    The employee’s email address.



38
39
40
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 38

def email_address
  @email_address
end

#employee_number ⇒ String (readonly)

Returns The employee’s internal identification number.

Returns:

  • (String) —

    The employee’s internal identification number.



36
37
38
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 36

def employee_number
  @employee_number
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


51
52
53
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 51

def field_mappings
  @field_mappings
end

#first_name ⇒ String (readonly)

Returns The employee’s first name.

Returns:

  • (String) —

    The employee’s first name.



30
31
32
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 30

def first_name
  @first_name
end

#id ⇒ String (readonly)

Returns:

  • (String) 


22
23
24
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 22

def id
  @id
end

#is_contractor ⇒ Boolean (readonly)

Returns ‘True` if the employee is a contractor, `False` if not.

Returns:

  • (Boolean) —

    ‘True` if the employee is a contractor, `False` if not.



34
35
36
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 34

def is_contractor
  @is_contractor
end

#last_name ⇒ String (readonly)

Returns The employee’s last name.

Returns:

  • (String) —

    The employee’s last name.



32
33
34
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 32

def last_name
  @last_name
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



28
29
30
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 28

def modified_at
  @modified_at
end

#remote_data ⇒ Array<Merge::Accounting::RemoteData> (readonly)

Returns:



53
54
55
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 53

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



24
25
26
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 24

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



49
50
51
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 49

def remote_was_deleted
  @remote_was_deleted
end

#status ⇒ Merge::Accounting::Status895Enum (readonly)

Returns The employee’s status in the accounting system.

  • ‘ACTIVE` - ACTIVE

  • ‘INACTIVE` - INACTIVE.

Returns:



44
45
46
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 44

def status
  @status
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Accounting::Employee

Deserialize a JSON object to an instance of Employee

Parameters:

  • json_object (String)

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 124

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  first_name = parsed_json["first_name"]
  last_name = parsed_json["last_name"]
  is_contractor = parsed_json["is_contractor"]
  employee_number = parsed_json["employee_number"]
  email_address = parsed_json["email_address"]
  if parsed_json["company"].nil?
    company = nil
  else
    company = parsed_json["company"].to_json
    company = Merge::Accounting::EmployeeCompany.from_json(json_object: company)
  end
  status = parsed_json["status"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    first_name: first_name,
    last_name: last_name,
    is_contractor: is_contractor,
    employee_number: employee_number,
    email_address: email_address,
    company: company,
    status: status,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 181

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
  obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
  obj.is_contractor&.is_a?(Boolean) != false || raise("Passed value for field obj.is_contractor is not the expected type, validation failed.")
  obj.employee_number&.is_a?(String) != false || raise("Passed value for field obj.employee_number is not the expected type, validation failed.")
  obj.email_address&.is_a?(String) != false || raise("Passed value for field obj.email_address is not the expected type, validation failed.")
  obj.company.nil? || Merge::Accounting::EmployeeCompany.validate_raw(obj: obj.company)
  obj.status.is_a?(Merge::Accounting::Status895Enum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of Employee to a JSON object

Returns:

  • (String) 


171
172
173
 
# File 'lib/merge_ruby_client/accounting/types/employee.rb', line 171

def to_json(*_args)
  @_field_set&.to_json
end