merge_hris_client 3.0.0 → 3.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (232) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -9
  3. data/docs/AccountIntegration.md +6 -2
  4. data/docs/AsyncPassthroughApi.md +155 -0
  5. data/docs/AsyncPassthroughReciept.md +18 -0
  6. data/docs/BankInfo.md +9 -5
  7. data/docs/BankInfoApi.md +17 -13
  8. data/docs/Benefit.md +15 -5
  9. data/docs/BenefitPlanTypeEnum.md +15 -0
  10. data/docs/BenefitsApi.md +6 -6
  11. data/docs/CommonModelScopeData.md +20 -0
  12. data/docs/CommonModelScopes.md +20 -0
  13. data/docs/CommonModelScopesApi.md +157 -0
  14. data/docs/CommonModelScopesBodyRequest.md +22 -0
  15. data/docs/CommonModelScopesDisabledModels.md +26 -0
  16. data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
  17. data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
  18. data/docs/CommonModelScopesUpdateSerializer.md +18 -0
  19. data/docs/CompaniesApi.md +4 -4
  20. data/docs/Company.md +7 -3
  21. data/docs/ConditionSchema.md +30 -0
  22. data/docs/ConditionTypeEnum.md +15 -0
  23. data/docs/DataPassthroughRequest.md +1 -1
  24. data/docs/Deduction.md +11 -5
  25. data/docs/DeleteAccountApi.md +9 -9
  26. data/docs/Dependent.md +50 -0
  27. data/docs/DependentsApi.md +181 -0
  28. data/docs/Earning.md +10 -2
  29. data/docs/Employee.md +19 -15
  30. data/docs/EmployeePayrollRun.md +11 -7
  31. data/docs/EmployeePayrollRunsApi.md +4 -4
  32. data/docs/EmployeeRequest.md +16 -18
  33. data/docs/EmployeesApi.md +31 -18
  34. data/docs/EmployerBenefit.md +36 -0
  35. data/docs/EmployerBenefitsApi.md +177 -0
  36. data/docs/Employment.md +14 -10
  37. data/docs/EmploymentsApi.md +15 -11
  38. data/docs/EnabledActionsEnum.md +15 -0
  39. data/docs/EndUserDetailsRequest.md +6 -4
  40. data/docs/ForceResyncApi.md +1 -1
  41. data/docs/Group.md +8 -4
  42. data/docs/GroupsApi.md +15 -9
  43. data/docs/Issue.md +10 -8
  44. data/docs/IssuesApi.md +6 -6
  45. data/docs/LinkToken.md +1 -1
  46. data/docs/LinkedAccountCondition.md +28 -0
  47. data/docs/LinkedAccountConditionRequest.md +22 -0
  48. data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
  49. data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
  50. data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
  51. data/docs/LinkedAccountsApi.md +2 -2
  52. data/docs/Location.md +10 -6
  53. data/docs/LocationsApi.md +13 -9
  54. data/docs/MetaResponse.md +2 -0
  55. data/docs/MultipartFormFieldRequest.md +1 -1
  56. data/docs/OperatorSchema.md +20 -0
  57. data/docs/PaginatedConditionSchemaList.md +22 -0
  58. data/docs/PaginatedDependentList.md +22 -0
  59. data/docs/PaginatedEmployerBenefitList.md +22 -0
  60. data/docs/PayGroup.md +7 -3
  61. data/docs/PayGroupsApi.md +4 -4
  62. data/docs/PayrollRun.md +9 -5
  63. data/docs/PayrollRunsApi.md +14 -10
  64. data/docs/RelationshipEnum.md +15 -0
  65. data/docs/RemoteData.md +1 -1
  66. data/docs/SelectiveSyncApi.md +233 -0
  67. data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
  68. data/docs/SyncStatus.md +5 -3
  69. data/docs/SyncStatusApi.md +1 -1
  70. data/docs/Tax.md +9 -1
  71. data/docs/Team.md +8 -4
  72. data/docs/TeamsApi.md +4 -4
  73. data/docs/TimeOff.md +13 -9
  74. data/docs/TimeOffApi.md +16 -12
  75. data/docs/TimeOffBalance.md +10 -6
  76. data/docs/TimeOffBalancesApi.md +15 -11
  77. data/docs/TimeOffRequest.md +11 -9
  78. data/lib/merge_hris_client/api/async_passthrough_api.rb +160 -0
  79. data/lib/merge_hris_client/api/bank_info_api.rb +26 -12
  80. data/lib/merge_hris_client/api/benefits_api.rb +6 -6
  81. data/lib/merge_hris_client/api/common_model_scopes_api.rb +146 -0
  82. data/lib/merge_hris_client/api/companies_api.rb +4 -4
  83. data/lib/merge_hris_client/api/delete_account_api.rb +7 -7
  84. data/lib/merge_hris_client/api/dependents_api.rb +188 -0
  85. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +4 -4
  86. data/lib/merge_hris_client/api/employees_api.rb +44 -17
  87. data/lib/merge_hris_client/api/employer_benefits_api.rb +182 -0
  88. data/lib/merge_hris_client/api/employments_api.rb +24 -10
  89. data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
  90. data/lib/merge_hris_client/api/groups_api.rb +25 -8
  91. data/lib/merge_hris_client/api/issues_api.rb +6 -6
  92. data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
  93. data/lib/merge_hris_client/api/locations_api.rb +22 -8
  94. data/lib/merge_hris_client/api/pay_groups_api.rb +4 -4
  95. data/lib/merge_hris_client/api/payroll_runs_api.rb +24 -10
  96. data/lib/merge_hris_client/api/selective_sync_api.rb +225 -0
  97. data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
  98. data/lib/merge_hris_client/api/teams_api.rb +4 -4
  99. data/lib/merge_hris_client/api/time_off_api.rb +26 -12
  100. data/lib/merge_hris_client/api/time_off_balances_api.rb +24 -10
  101. data/lib/merge_hris_client/models/account_integration.rb +30 -8
  102. data/lib/merge_hris_client/models/async_passthrough_reciept.rb +223 -0
  103. data/lib/merge_hris_client/models/bank_info.rb +39 -16
  104. data/lib/merge_hris_client/models/benefit.rb +70 -14
  105. data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +48 -0
  106. data/lib/merge_hris_client/models/categories_enum.rb +3 -1
  107. data/lib/merge_hris_client/models/category_enum.rb +3 -1
  108. data/lib/merge_hris_client/models/common_model_scope_data.rb +234 -0
  109. data/lib/merge_hris_client/models/common_model_scopes.rb +234 -0
  110. data/lib/merge_hris_client/models/common_model_scopes_body_request.rb +274 -0
  111. data/lib/merge_hris_client/models/common_model_scopes_disabled_models.rb +283 -0
  112. data/lib/merge_hris_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
  113. data/lib/merge_hris_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
  114. data/lib/merge_hris_client/models/common_model_scopes_update_serializer.rb +226 -0
  115. data/lib/merge_hris_client/models/company.rb +37 -15
  116. data/lib/merge_hris_client/models/condition_schema.rb +298 -0
  117. data/lib/merge_hris_client/models/condition_type_enum.rb +50 -0
  118. data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
  119. data/lib/merge_hris_client/models/deduction.rb +50 -17
  120. data/lib/merge_hris_client/models/dependent.rb +470 -0
  121. data/lib/merge_hris_client/models/earning.rb +51 -6
  122. data/lib/merge_hris_client/models/employee.rb +51 -23
  123. data/lib/merge_hris_client/models/employee_payroll_run.rb +41 -17
  124. data/lib/merge_hris_client/models/employee_request.rb +34 -39
  125. data/lib/merge_hris_client/models/employer_benefit.rb +363 -0
  126. data/lib/merge_hris_client/models/employment.rb +44 -20
  127. data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
  128. data/lib/merge_hris_client/models/end_user_details_request.rb +21 -8
  129. data/lib/merge_hris_client/models/group.rb +38 -16
  130. data/lib/merge_hris_client/models/group_type_enum.rb +2 -1
  131. data/lib/merge_hris_client/models/issue.rb +16 -4
  132. data/lib/merge_hris_client/models/link_token.rb +0 -5
  133. data/lib/merge_hris_client/models/linked_account_condition.rb +282 -0
  134. data/lib/merge_hris_client/models/linked_account_condition_request.rb +269 -0
  135. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration.rb +221 -0
  136. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
  137. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
  138. data/lib/merge_hris_client/models/location.rb +39 -17
  139. data/lib/merge_hris_client/models/meta_response.rb +12 -1
  140. data/lib/merge_hris_client/models/multipart_form_field_request.rb +1 -1
  141. data/lib/merge_hris_client/models/operator_schema.rb +229 -0
  142. data/lib/merge_hris_client/models/paginated_condition_schema_list.rb +240 -0
  143. data/lib/merge_hris_client/models/paginated_dependent_list.rb +240 -0
  144. data/lib/merge_hris_client/models/paginated_employer_benefit_list.rb +240 -0
  145. data/lib/merge_hris_client/models/pay_frequency_enum.rb +2 -1
  146. data/lib/merge_hris_client/models/pay_group.rb +37 -15
  147. data/lib/merge_hris_client/models/pay_period_enum.rb +2 -1
  148. data/lib/merge_hris_client/models/payroll_run.rb +39 -17
  149. data/lib/merge_hris_client/models/relationship_enum.rb +46 -0
  150. data/lib/merge_hris_client/models/remote_data.rb +3 -4
  151. data/lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb +45 -0
  152. data/lib/merge_hris_client/models/sync_status.rb +13 -4
  153. data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -1
  154. data/lib/merge_hris_client/models/tax.rb +50 -5
  155. data/lib/merge_hris_client/models/team.rb +38 -15
  156. data/lib/merge_hris_client/models/time_off.rb +43 -19
  157. data/lib/merge_hris_client/models/time_off_balance.rb +40 -17
  158. data/lib/merge_hris_client/models/time_off_request.rb +36 -21
  159. data/lib/merge_hris_client/version.rb +1 -1
  160. data/lib/merge_hris_client.rb +31 -0
  161. data/spec/api/async_passthrough_api_spec.rb +59 -0
  162. data/spec/api/bank_info_api_spec.rb +8 -6
  163. data/spec/api/benefits_api_spec.rb +3 -3
  164. data/spec/api/common_model_scopes_api_spec.rb +58 -0
  165. data/spec/api/companies_api_spec.rb +2 -2
  166. data/spec/api/delete_account_api_spec.rb +2 -2
  167. data/spec/api/dependents_api_spec.rb +70 -0
  168. data/spec/api/employee_payroll_runs_api_spec.rb +2 -2
  169. data/spec/api/employees_api_spec.rb +13 -6
  170. data/spec/api/employer_benefits_api_spec.rb +68 -0
  171. data/spec/api/employments_api_spec.rb +7 -5
  172. data/spec/api/force_resync_api_spec.rb +1 -1
  173. data/spec/api/groups_api_spec.rb +7 -4
  174. data/spec/api/issues_api_spec.rb +3 -3
  175. data/spec/api/linked_accounts_api_spec.rb +1 -1
  176. data/spec/api/locations_api_spec.rb +6 -4
  177. data/spec/api/pay_groups_api_spec.rb +2 -2
  178. data/spec/api/payroll_runs_api_spec.rb +7 -5
  179. data/spec/api/selective_sync_api_spec.rb +72 -0
  180. data/spec/api/sync_status_api_spec.rb +1 -1
  181. data/spec/api/teams_api_spec.rb +2 -2
  182. data/spec/api/time_off_api_spec.rb +8 -6
  183. data/spec/api/time_off_balances_api_spec.rb +7 -5
  184. data/spec/models/account_integration_spec.rb +12 -0
  185. data/spec/models/async_passthrough_reciept_spec.rb +34 -0
  186. data/spec/models/bank_info_spec.rb +14 -2
  187. data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
  188. data/spec/models/benefit_spec.rb +31 -1
  189. data/spec/models/common_model_scope_data_spec.rb +40 -0
  190. data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
  191. data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
  192. data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
  193. data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
  194. data/spec/models/common_model_scopes_spec.rb +40 -0
  195. data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
  196. data/spec/models/company_spec.rb +14 -2
  197. data/spec/models/condition_schema_spec.rb +70 -0
  198. data/spec/models/condition_type_enum_spec.rb +28 -0
  199. data/spec/models/deduction_spec.rb +20 -2
  200. data/spec/models/dependent_spec.rb +130 -0
  201. data/spec/models/earning_spec.rb +24 -0
  202. data/spec/models/employee_payroll_run_spec.rb +14 -2
  203. data/spec/models/employee_request_spec.rb +5 -11
  204. data/spec/models/employee_spec.rb +15 -3
  205. data/spec/models/employer_benefit_spec.rb +88 -0
  206. data/spec/models/employment_spec.rb +14 -2
  207. data/spec/models/enabled_actions_enum_spec.rb +28 -0
  208. data/spec/models/end_user_details_request_spec.rb +6 -0
  209. data/spec/models/group_spec.rb +14 -2
  210. data/spec/models/issue_spec.rb +6 -0
  211. data/spec/models/linked_account_condition_request_spec.rb +46 -0
  212. data/spec/models/linked_account_condition_spec.rb +64 -0
  213. data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
  214. data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
  215. data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
  216. data/spec/models/location_spec.rb +14 -2
  217. data/spec/models/meta_response_spec.rb +6 -0
  218. data/spec/models/operator_schema_spec.rb +40 -0
  219. data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
  220. data/spec/models/paginated_dependent_list_spec.rb +46 -0
  221. data/spec/models/paginated_employer_benefit_list_spec.rb +46 -0
  222. data/spec/models/pay_group_spec.rb +14 -2
  223. data/spec/models/payroll_run_spec.rb +14 -2
  224. data/spec/models/relationship_enum_spec.rb +28 -0
  225. data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
  226. data/spec/models/sync_status_spec.rb +6 -0
  227. data/spec/models/tax_spec.rb +24 -0
  228. data/spec/models/team_spec.rb +14 -2
  229. data/spec/models/time_off_balance_spec.rb +14 -2
  230. data/spec/models/time_off_request_spec.rb +12 -6
  231. data/spec/models/time_off_spec.rb +14 -2
  232. metadata +225 -105
@@ -14,29 +14,43 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module MergeHRISClient
17
- # # The Earning Object ### Description The `Earning` object is used to represent an earning for a given employee's payroll run. One run could include several earnings. ### Usage Example Fetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings.
17
+ # # The Earning Object ### Description The `Earning` object is used to represent an array of different compensations that an employee receives within specific wage categories. ### Usage Example Fetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings.
18
18
  class Earning
19
19
  attr_accessor :id
20
20
 
21
+ # The third-party API ID of the matching object.
22
+ attr_accessor :remote_id
23
+
21
24
  attr_accessor :employee_payroll_run
22
25
 
23
26
  # The amount earned.
24
27
  attr_accessor :amount
25
28
 
26
- # The type of earning.
29
+ # The type of earning. * `SALARY` - SALARY * `REIMBURSEMENT` - REIMBURSEMENT * `OVERTIME` - OVERTIME * `BONUS` - BONUS
27
30
  attr_accessor :type
28
31
 
29
32
  # Indicates whether or not this object has been deleted by third party webhooks.
30
33
  attr_accessor :remote_was_deleted
31
34
 
35
+ # This is the datetime that this object was last updated by Merge
36
+ attr_accessor :modified_at
37
+
38
+ attr_accessor :field_mappings
39
+
40
+ attr_accessor :remote_data
41
+
32
42
  # Attribute mapping from ruby-style variable name to JSON key.
33
43
  def self.attribute_map
34
44
  {
35
45
  :'id' => :'id',
46
+ :'remote_id' => :'remote_id',
36
47
  :'employee_payroll_run' => :'employee_payroll_run',
37
48
  :'amount' => :'amount',
38
49
  :'type' => :'type',
39
- :'remote_was_deleted' => :'remote_was_deleted'
50
+ :'remote_was_deleted' => :'remote_was_deleted',
51
+ :'modified_at' => :'modified_at',
52
+ :'field_mappings' => :'field_mappings',
53
+ :'remote_data' => :'remote_data'
40
54
  }
41
55
  end
42
56
 
@@ -49,19 +63,26 @@ module MergeHRISClient
49
63
  def self.openapi_types
50
64
  {
51
65
  :'id' => :'String',
66
+ :'remote_id' => :'String',
52
67
  :'employee_payroll_run' => :'String',
53
68
  :'amount' => :'Float',
54
69
  :'type' => :'EarningTypeEnum',
55
- :'remote_was_deleted' => :'Boolean'
70
+ :'remote_was_deleted' => :'Boolean',
71
+ :'modified_at' => :'Time',
72
+ :'field_mappings' => :'Hash<String, Object>',
73
+ :'remote_data' => :'Array<RemoteData>'
56
74
  }
57
75
  end
58
76
 
59
77
  # List of attributes with nullable: true
60
78
  def self.openapi_nullable
61
79
  Set.new([
80
+ :'remote_id',
62
81
  :'employee_payroll_run',
63
82
  :'amount',
64
83
  :'type',
84
+ :'field_mappings',
85
+ :'remote_data'
65
86
  ])
66
87
  end
67
88
 
@@ -84,6 +105,10 @@ module MergeHRISClient
84
105
  self.id = attributes[:'id']
85
106
  end
86
107
 
108
+ if attributes.key?(:'remote_id')
109
+ self.remote_id = attributes[:'remote_id']
110
+ end
111
+
87
112
  if attributes.key?(:'employee_payroll_run')
88
113
  self.employee_payroll_run = attributes[:'employee_payroll_run']
89
114
  end
@@ -99,6 +124,22 @@ module MergeHRISClient
99
124
  if attributes.key?(:'remote_was_deleted')
100
125
  self.remote_was_deleted = attributes[:'remote_was_deleted']
101
126
  end
127
+
128
+ if attributes.key?(:'modified_at')
129
+ self.modified_at = attributes[:'modified_at']
130
+ end
131
+
132
+ if attributes.key?(:'field_mappings')
133
+ if (value = attributes[:'field_mappings']).is_a?(Hash)
134
+ self.field_mappings = value
135
+ end
136
+ end
137
+
138
+ if attributes.key?(:'remote_data')
139
+ if (value = attributes[:'remote_data']).is_a?(Array)
140
+ self.remote_data = value
141
+ end
142
+ end
102
143
  end
103
144
 
104
145
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -120,10 +161,14 @@ module MergeHRISClient
120
161
  return true if self.equal?(o)
121
162
  self.class == o.class &&
122
163
  id == o.id &&
164
+ remote_id == o.remote_id &&
123
165
  employee_payroll_run == o.employee_payroll_run &&
124
166
  amount == o.amount &&
125
167
  type == o.type &&
126
- remote_was_deleted == o.remote_was_deleted
168
+ remote_was_deleted == o.remote_was_deleted &&
169
+ modified_at == o.modified_at &&
170
+ field_mappings == o.field_mappings &&
171
+ remote_data == o.remote_data
127
172
  end
128
173
 
129
174
  # @see the `==` method
@@ -135,7 +180,7 @@ module MergeHRISClient
135
180
  # Calculates hash code according to all attributes.
136
181
  # @return [Integer] Hash code
137
182
  def hash
138
- [id, employee_payroll_run, amount, type, remote_was_deleted].hash
183
+ [id, remote_id, employee_payroll_run, amount, type, remote_was_deleted, modified_at, field_mappings, remote_data].hash
139
184
  end
140
185
 
141
186
  # Builds the object from hash
@@ -14,16 +14,17 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module MergeHRISClient
17
- # # The Employee Object ### Description The `Employee` object is used to represent an Employee for a company. ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.
17
+ # # The Employee Object ### Description The `Employee` object is used to represent any person who has been employed by a company. ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.
18
18
  class Employee
19
19
  attr_accessor :id
20
20
 
21
21
  # The third-party API ID of the matching object.
22
22
  attr_accessor :remote_id
23
23
 
24
- # The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers.
24
+ # The employee's number that appears in the third-party integration's UI.
25
25
  attr_accessor :employee_number
26
26
 
27
+ # The ID of the employee's company.
27
28
  attr_accessor :company
28
29
 
29
30
  # The employee's first name.
@@ -52,26 +53,31 @@ module MergeHRISClient
52
53
  # Array of `Employment` IDs for this Employee.
53
54
  attr_accessor :employments
54
55
 
56
+ # The employee's home address.
55
57
  attr_accessor :home_location
56
58
 
59
+ # The employee's work address.
57
60
  attr_accessor :work_location
58
61
 
62
+ # The employee ID of the employee's manager.
59
63
  attr_accessor :manager
60
64
 
65
+ # The employee's team.
61
66
  attr_accessor :team
62
67
 
68
+ # The employee's pay group
63
69
  attr_accessor :pay_group
64
70
 
65
71
  # The employee's social security number.
66
72
  attr_accessor :ssn
67
73
 
68
- # The employee's gender.
74
+ # The employee's gender. * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
69
75
  attr_accessor :gender
70
76
 
71
- # The employee's ethnicity.
77
+ # The employee's ethnicity. * `AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE * `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT * `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN * `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO * `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER * `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES * `WHITE` - WHITE * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
72
78
  attr_accessor :ethnicity
73
79
 
74
- # The employee's marital status.
80
+ # The employee's filing status as related to marital status. * `SINGLE` - SINGLE * `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY * `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY * `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD * `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD
75
81
  attr_accessor :marital_status
76
82
 
77
83
  # The employee's date of birth.
@@ -80,13 +86,13 @@ module MergeHRISClient
80
86
  # The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field.
81
87
  attr_accessor :hire_date
82
88
 
83
- # The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date.
89
+ # The date that the employee started working. If an employee was rehired, the most recent start date will be returned.
84
90
  attr_accessor :start_date
85
91
 
86
92
  # When the third party's employee was created.
87
93
  attr_accessor :remote_created_at
88
94
 
89
- # The employment status of the employee.
95
+ # The employment status of the employee. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
90
96
  attr_accessor :employment_status
91
97
 
92
98
  # The employee's termination date.
@@ -95,13 +101,18 @@ module MergeHRISClient
95
101
  # The URL of the employee's avatar image.
96
102
  attr_accessor :avatar
97
103
 
98
- attr_accessor :remote_data
99
-
100
104
  # Custom fields configured for a given model.
101
105
  attr_accessor :custom_fields
102
106
 
103
107
  attr_accessor :remote_was_deleted
104
108
 
109
+ # This is the datetime that this object was last updated by Merge
110
+ attr_accessor :modified_at
111
+
112
+ attr_accessor :field_mappings
113
+
114
+ attr_accessor :remote_data
115
+
105
116
  # Attribute mapping from ruby-style variable name to JSON key.
106
117
  def self.attribute_map
107
118
  {
@@ -134,9 +145,11 @@ module MergeHRISClient
134
145
  :'employment_status' => :'employment_status',
135
146
  :'termination_date' => :'termination_date',
136
147
  :'avatar' => :'avatar',
137
- :'remote_data' => :'remote_data',
138
148
  :'custom_fields' => :'custom_fields',
139
- :'remote_was_deleted' => :'remote_was_deleted'
149
+ :'remote_was_deleted' => :'remote_was_deleted',
150
+ :'modified_at' => :'modified_at',
151
+ :'field_mappings' => :'field_mappings',
152
+ :'remote_data' => :'remote_data'
140
153
  }
141
154
  end
142
155
 
@@ -177,9 +190,11 @@ module MergeHRISClient
177
190
  :'employment_status' => :'EmploymentStatusEnum',
178
191
  :'termination_date' => :'Time',
179
192
  :'avatar' => :'String',
180
- :'remote_data' => :'Array<RemoteData>',
181
193
  :'custom_fields' => :'Hash<String, Object>',
182
- :'remote_was_deleted' => :'Boolean'
194
+ :'remote_was_deleted' => :'Boolean',
195
+ :'modified_at' => :'Time',
196
+ :'field_mappings' => :'Hash<String, Object>',
197
+ :'remote_data' => :'Array<RemoteData>'
183
198
  }
184
199
  end
185
200
 
@@ -212,8 +227,9 @@ module MergeHRISClient
212
227
  :'employment_status',
213
228
  :'termination_date',
214
229
  :'avatar',
215
- :'remote_data',
216
230
  :'custom_fields',
231
+ :'field_mappings',
232
+ :'remote_data'
217
233
  ])
218
234
  end
219
235
 
@@ -352,12 +368,6 @@ module MergeHRISClient
352
368
  self.avatar = attributes[:'avatar']
353
369
  end
354
370
 
355
- if attributes.key?(:'remote_data')
356
- if (value = attributes[:'remote_data']).is_a?(Array)
357
- self.remote_data = value
358
- end
359
- end
360
-
361
371
  if attributes.key?(:'custom_fields')
362
372
  if (value = attributes[:'custom_fields']).is_a?(Hash)
363
373
  self.custom_fields = value
@@ -367,6 +377,22 @@ module MergeHRISClient
367
377
  if attributes.key?(:'remote_was_deleted')
368
378
  self.remote_was_deleted = attributes[:'remote_was_deleted']
369
379
  end
380
+
381
+ if attributes.key?(:'modified_at')
382
+ self.modified_at = attributes[:'modified_at']
383
+ end
384
+
385
+ if attributes.key?(:'field_mappings')
386
+ if (value = attributes[:'field_mappings']).is_a?(Hash)
387
+ self.field_mappings = value
388
+ end
389
+ end
390
+
391
+ if attributes.key?(:'remote_data')
392
+ if (value = attributes[:'remote_data']).is_a?(Array)
393
+ self.remote_data = value
394
+ end
395
+ end
370
396
  end
371
397
 
372
398
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -476,9 +502,11 @@ module MergeHRISClient
476
502
  employment_status == o.employment_status &&
477
503
  termination_date == o.termination_date &&
478
504
  avatar == o.avatar &&
479
- remote_data == o.remote_data &&
480
505
  custom_fields == o.custom_fields &&
481
- remote_was_deleted == o.remote_was_deleted
506
+ remote_was_deleted == o.remote_was_deleted &&
507
+ modified_at == o.modified_at &&
508
+ field_mappings == o.field_mappings &&
509
+ remote_data == o.remote_data
482
510
  end
483
511
 
484
512
  # @see the `==` method
@@ -490,7 +518,7 @@ module MergeHRISClient
490
518
  # Calculates hash code according to all attributes.
491
519
  # @return [Integer] Hash code
492
520
  def hash
493
- [id, remote_id, employee_number, company, first_name, last_name, display_full_name, username, groups, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, pay_group, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, start_date, remote_created_at, employment_status, termination_date, avatar, remote_data, custom_fields, remote_was_deleted].hash
521
+ [id, remote_id, employee_number, company, first_name, last_name, display_full_name, username, groups, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, pay_group, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, start_date, remote_created_at, employment_status, termination_date, avatar, custom_fields, remote_was_deleted, modified_at, field_mappings, remote_data].hash
494
522
  end
495
523
 
496
524
  # Builds the object from hash
@@ -14,21 +14,23 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module MergeHRISClient
17
- # # The EmployeePayrollRun Object ### Description The `EmployeePayrollRun` object is used to represent a payroll run for a specific employee. ### Usage Example Fetch from the `LIST EmployeePayrollRun` endpoint and filter by `ID` to show all employee payroll runs.
17
+ # # The EmployeePayrollRun Object ### Description The `EmployeePayrollRun` object is used to represent an employee's pay statement for a specific payroll run. ### Usage Example Fetch from the `LIST EmployeePayrollRun` endpoint and filter by `ID` to show all employee payroll runs.
18
18
  class EmployeePayrollRun
19
19
  attr_accessor :id
20
20
 
21
21
  # The third-party API ID of the matching object.
22
22
  attr_accessor :remote_id
23
23
 
24
+ # The employee whose payroll is being run.
24
25
  attr_accessor :employee
25
26
 
27
+ # The payroll being run.
26
28
  attr_accessor :payroll_run
27
29
 
28
- # The gross pay from the run.
30
+ # The total earnings throughout a given period for an employee before any deductions are made.
29
31
  attr_accessor :gross_pay
30
32
 
31
- # The net pay from the run.
33
+ # The take-home pay throughout a given period for an employee after deductions are made.
32
34
  attr_accessor :net_pay
33
35
 
34
36
  # The day and time the payroll run started.
@@ -46,11 +48,16 @@ module MergeHRISClient
46
48
 
47
49
  attr_accessor :taxes
48
50
 
49
- attr_accessor :remote_data
50
-
51
51
  # Indicates whether or not this object has been deleted by third party webhooks.
52
52
  attr_accessor :remote_was_deleted
53
53
 
54
+ # This is the datetime that this object was last updated by Merge
55
+ attr_accessor :modified_at
56
+
57
+ attr_accessor :field_mappings
58
+
59
+ attr_accessor :remote_data
60
+
54
61
  # Attribute mapping from ruby-style variable name to JSON key.
55
62
  def self.attribute_map
56
63
  {
@@ -66,8 +73,10 @@ module MergeHRISClient
66
73
  :'earnings' => :'earnings',
67
74
  :'deductions' => :'deductions',
68
75
  :'taxes' => :'taxes',
69
- :'remote_data' => :'remote_data',
70
- :'remote_was_deleted' => :'remote_was_deleted'
76
+ :'remote_was_deleted' => :'remote_was_deleted',
77
+ :'modified_at' => :'modified_at',
78
+ :'field_mappings' => :'field_mappings',
79
+ :'remote_data' => :'remote_data'
71
80
  }
72
81
  end
73
82
 
@@ -91,8 +100,10 @@ module MergeHRISClient
91
100
  :'earnings' => :'Array<Earning>',
92
101
  :'deductions' => :'Array<Deduction>',
93
102
  :'taxes' => :'Array<Tax>',
94
- :'remote_data' => :'Array<RemoteData>',
95
- :'remote_was_deleted' => :'Boolean'
103
+ :'remote_was_deleted' => :'Boolean',
104
+ :'modified_at' => :'Time',
105
+ :'field_mappings' => :'Hash<String, Object>',
106
+ :'remote_data' => :'Array<RemoteData>'
96
107
  }
97
108
  end
98
109
 
@@ -107,7 +118,8 @@ module MergeHRISClient
107
118
  :'start_date',
108
119
  :'end_date',
109
120
  :'check_date',
110
- :'remote_data',
121
+ :'field_mappings',
122
+ :'remote_data'
111
123
  ])
112
124
  end
113
125
 
@@ -180,15 +192,25 @@ module MergeHRISClient
180
192
  end
181
193
  end
182
194
 
195
+ if attributes.key?(:'remote_was_deleted')
196
+ self.remote_was_deleted = attributes[:'remote_was_deleted']
197
+ end
198
+
199
+ if attributes.key?(:'modified_at')
200
+ self.modified_at = attributes[:'modified_at']
201
+ end
202
+
203
+ if attributes.key?(:'field_mappings')
204
+ if (value = attributes[:'field_mappings']).is_a?(Hash)
205
+ self.field_mappings = value
206
+ end
207
+ end
208
+
183
209
  if attributes.key?(:'remote_data')
184
210
  if (value = attributes[:'remote_data']).is_a?(Array)
185
211
  self.remote_data = value
186
212
  end
187
213
  end
188
-
189
- if attributes.key?(:'remote_was_deleted')
190
- self.remote_was_deleted = attributes[:'remote_was_deleted']
191
- end
192
214
  end
193
215
 
194
216
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -221,8 +243,10 @@ module MergeHRISClient
221
243
  earnings == o.earnings &&
222
244
  deductions == o.deductions &&
223
245
  taxes == o.taxes &&
224
- remote_data == o.remote_data &&
225
- remote_was_deleted == o.remote_was_deleted
246
+ remote_was_deleted == o.remote_was_deleted &&
247
+ modified_at == o.modified_at &&
248
+ field_mappings == o.field_mappings &&
249
+ remote_data == o.remote_data
226
250
  end
227
251
 
228
252
  # @see the `==` method
@@ -234,7 +258,7 @@ module MergeHRISClient
234
258
  # Calculates hash code according to all attributes.
235
259
  # @return [Integer] Hash code
236
260
  def hash
237
- [id, remote_id, employee, payroll_run, gross_pay, net_pay, start_date, end_date, check_date, earnings, deductions, taxes, remote_data, remote_was_deleted].hash
261
+ [id, remote_id, employee, payroll_run, gross_pay, net_pay, start_date, end_date, check_date, earnings, deductions, taxes, remote_was_deleted, modified_at, field_mappings, remote_data].hash
238
262
  end
239
263
 
240
264
  # Builds the object from hash
@@ -14,14 +14,12 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module MergeHRISClient
17
- # # The Employee Object ### Description The `Employee` object is used to represent an Employee for a company. ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.
17
+ # # The Employee Object ### Description The `Employee` object is used to represent any person who has been employed by a company. ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.
18
18
  class EmployeeRequest
19
- # The third-party API ID of the matching object.
20
- attr_accessor :remote_id
21
-
22
- # The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers.
19
+ # The employee's number that appears in the third-party integration's UI.
23
20
  attr_accessor :employee_number
24
21
 
22
+ # The ID of the employee's company.
25
23
  attr_accessor :company
26
24
 
27
25
  # The employee's first name.
@@ -50,26 +48,31 @@ module MergeHRISClient
50
48
  # Array of `Employment` IDs for this Employee.
51
49
  attr_accessor :employments
52
50
 
51
+ # The employee's home address.
53
52
  attr_accessor :home_location
54
53
 
54
+ # The employee's work address.
55
55
  attr_accessor :work_location
56
56
 
57
+ # The employee ID of the employee's manager.
57
58
  attr_accessor :manager
58
59
 
60
+ # The employee's team.
59
61
  attr_accessor :team
60
62
 
63
+ # The employee's pay group
61
64
  attr_accessor :pay_group
62
65
 
63
66
  # The employee's social security number.
64
67
  attr_accessor :ssn
65
68
 
66
- # The employee's gender.
69
+ # The employee's gender. * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
67
70
  attr_accessor :gender
68
71
 
69
- # The employee's ethnicity.
72
+ # The employee's ethnicity. * `AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE * `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT * `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN * `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO * `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER * `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES * `WHITE` - WHITE * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
70
73
  attr_accessor :ethnicity
71
74
 
72
- # The employee's marital status.
75
+ # The employee's filing status as related to marital status. * `SINGLE` - SINGLE * `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY * `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY * `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD * `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD
73
76
  attr_accessor :marital_status
74
77
 
75
78
  # The employee's date of birth.
@@ -78,13 +81,10 @@ module MergeHRISClient
78
81
  # The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field.
79
82
  attr_accessor :hire_date
80
83
 
81
- # The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date.
84
+ # The date that the employee started working. If an employee was rehired, the most recent start date will be returned.
82
85
  attr_accessor :start_date
83
86
 
84
- # When the third party's employee was created.
85
- attr_accessor :remote_created_at
86
-
87
- # The employment status of the employee.
87
+ # The employment status of the employee. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
88
88
  attr_accessor :employment_status
89
89
 
90
90
  # The employee's termination date.
@@ -93,13 +93,13 @@ module MergeHRISClient
93
93
  # The URL of the employee's avatar image.
94
94
  attr_accessor :avatar
95
95
 
96
- # Custom fields configured for a given model.
97
- attr_accessor :custom_fields
96
+ attr_accessor :integration_params
97
+
98
+ attr_accessor :linked_account_params
98
99
 
99
100
  # Attribute mapping from ruby-style variable name to JSON key.
100
101
  def self.attribute_map
101
102
  {
102
- :'remote_id' => :'remote_id',
103
103
  :'employee_number' => :'employee_number',
104
104
  :'company' => :'company',
105
105
  :'first_name' => :'first_name',
@@ -123,11 +123,11 @@ module MergeHRISClient
123
123
  :'date_of_birth' => :'date_of_birth',
124
124
  :'hire_date' => :'hire_date',
125
125
  :'start_date' => :'start_date',
126
- :'remote_created_at' => :'remote_created_at',
127
126
  :'employment_status' => :'employment_status',
128
127
  :'termination_date' => :'termination_date',
129
128
  :'avatar' => :'avatar',
130
- :'custom_fields' => :'custom_fields'
129
+ :'integration_params' => :'integration_params',
130
+ :'linked_account_params' => :'linked_account_params'
131
131
  }
132
132
  end
133
133
 
@@ -139,7 +139,6 @@ module MergeHRISClient
139
139
  # Attribute type mapping.
140
140
  def self.openapi_types
141
141
  {
142
- :'remote_id' => :'String',
143
142
  :'employee_number' => :'String',
144
143
  :'company' => :'String',
145
144
  :'first_name' => :'String',
@@ -163,18 +162,17 @@ module MergeHRISClient
163
162
  :'date_of_birth' => :'Time',
164
163
  :'hire_date' => :'Time',
165
164
  :'start_date' => :'Time',
166
- :'remote_created_at' => :'Time',
167
165
  :'employment_status' => :'EmploymentStatusEnum',
168
166
  :'termination_date' => :'Time',
169
167
  :'avatar' => :'String',
170
- :'custom_fields' => :'Hash<String, Object>'
168
+ :'integration_params' => :'Hash<String, Object>',
169
+ :'linked_account_params' => :'Hash<String, Object>'
171
170
  }
172
171
  end
173
172
 
174
173
  # List of attributes with nullable: true
175
174
  def self.openapi_nullable
176
175
  Set.new([
177
- :'remote_id',
178
176
  :'employee_number',
179
177
  :'company',
180
178
  :'first_name',
@@ -196,11 +194,11 @@ module MergeHRISClient
196
194
  :'date_of_birth',
197
195
  :'hire_date',
198
196
  :'start_date',
199
- :'remote_created_at',
200
197
  :'employment_status',
201
198
  :'termination_date',
202
199
  :'avatar',
203
- :'custom_fields'
200
+ :'integration_params',
201
+ :'linked_account_params'
204
202
  ])
205
203
  end
206
204
 
@@ -219,10 +217,6 @@ module MergeHRISClient
219
217
  h[k.to_sym] = v
220
218
  }
221
219
 
222
- if attributes.key?(:'remote_id')
223
- self.remote_id = attributes[:'remote_id']
224
- end
225
-
226
220
  if attributes.key?(:'employee_number')
227
221
  self.employee_number = attributes[:'employee_number']
228
222
  end
@@ -319,10 +313,6 @@ module MergeHRISClient
319
313
  self.start_date = attributes[:'start_date']
320
314
  end
321
315
 
322
- if attributes.key?(:'remote_created_at')
323
- self.remote_created_at = attributes[:'remote_created_at']
324
- end
325
-
326
316
  if attributes.key?(:'employment_status')
327
317
  self.employment_status = attributes[:'employment_status']
328
318
  end
@@ -335,9 +325,15 @@ module MergeHRISClient
335
325
  self.avatar = attributes[:'avatar']
336
326
  end
337
327
 
338
- if attributes.key?(:'custom_fields')
339
- if (value = attributes[:'custom_fields']).is_a?(Hash)
340
- self.custom_fields = value
328
+ if attributes.key?(:'integration_params')
329
+ if (value = attributes[:'integration_params']).is_a?(Hash)
330
+ self.integration_params = value
331
+ end
332
+ end
333
+
334
+ if attributes.key?(:'linked_account_params')
335
+ if (value = attributes[:'linked_account_params']).is_a?(Hash)
336
+ self.linked_account_params = value
341
337
  end
342
338
  end
343
339
  end
@@ -420,7 +416,6 @@ module MergeHRISClient
420
416
  def ==(o)
421
417
  return true if self.equal?(o)
422
418
  self.class == o.class &&
423
- remote_id == o.remote_id &&
424
419
  employee_number == o.employee_number &&
425
420
  company == o.company &&
426
421
  first_name == o.first_name &&
@@ -444,11 +439,11 @@ module MergeHRISClient
444
439
  date_of_birth == o.date_of_birth &&
445
440
  hire_date == o.hire_date &&
446
441
  start_date == o.start_date &&
447
- remote_created_at == o.remote_created_at &&
448
442
  employment_status == o.employment_status &&
449
443
  termination_date == o.termination_date &&
450
444
  avatar == o.avatar &&
451
- custom_fields == o.custom_fields
445
+ integration_params == o.integration_params &&
446
+ linked_account_params == o.linked_account_params
452
447
  end
453
448
 
454
449
  # @see the `==` method
@@ -460,7 +455,7 @@ module MergeHRISClient
460
455
  # Calculates hash code according to all attributes.
461
456
  # @return [Integer] Hash code
462
457
  def hash
463
- [remote_id, employee_number, company, first_name, last_name, display_full_name, username, groups, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, pay_group, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, start_date, remote_created_at, employment_status, termination_date, avatar, custom_fields].hash
458
+ [employee_number, company, first_name, last_name, display_full_name, username, groups, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, pay_group, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, start_date, employment_status, termination_date, avatar, integration_params, linked_account_params].hash
464
459
  end
465
460
 
466
461
  # Builds the object from hash