merge_hris_client 3.0.0 → 3.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (197) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -8
  3. data/docs/AccountIntegration.md +6 -2
  4. data/docs/BankInfo.md +9 -5
  5. data/docs/BankInfoApi.md +15 -11
  6. data/docs/Benefit.md +8 -4
  7. data/docs/BenefitsApi.md +6 -6
  8. data/docs/CommonModelScopeData.md +20 -0
  9. data/docs/CommonModelScopes.md +20 -0
  10. data/docs/CommonModelScopesApi.md +157 -0
  11. data/docs/CommonModelScopesBodyRequest.md +22 -0
  12. data/docs/CommonModelScopesDisabledModels.md +26 -0
  13. data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
  14. data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
  15. data/docs/CommonModelScopesUpdateSerializer.md +18 -0
  16. data/docs/CompaniesApi.md +4 -4
  17. data/docs/Company.md +7 -3
  18. data/docs/ConditionSchema.md +30 -0
  19. data/docs/ConditionTypeEnum.md +15 -0
  20. data/docs/DataPassthroughRequest.md +1 -1
  21. data/docs/Deduction.md +11 -5
  22. data/docs/Earning.md +10 -2
  23. data/docs/Employee.md +19 -15
  24. data/docs/EmployeePayrollRun.md +11 -7
  25. data/docs/EmployeePayrollRunsApi.md +4 -4
  26. data/docs/EmployeeRequest.md +16 -18
  27. data/docs/EmployeesApi.md +31 -18
  28. data/docs/Employment.md +14 -10
  29. data/docs/EmploymentsApi.md +13 -9
  30. data/docs/EnabledActionsEnum.md +15 -0
  31. data/docs/EndUserDetailsRequest.md +5 -3
  32. data/docs/ForceResyncApi.md +1 -1
  33. data/docs/Group.md +8 -4
  34. data/docs/GroupsApi.md +15 -9
  35. data/docs/Issue.md +10 -8
  36. data/docs/IssuesApi.md +6 -6
  37. data/docs/LinkToken.md +1 -1
  38. data/docs/LinkedAccountCondition.md +28 -0
  39. data/docs/LinkedAccountConditionRequest.md +22 -0
  40. data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
  41. data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
  42. data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
  43. data/docs/LinkedAccountsApi.md +2 -2
  44. data/docs/Location.md +9 -5
  45. data/docs/LocationsApi.md +13 -9
  46. data/docs/MetaResponse.md +2 -0
  47. data/docs/MultipartFormFieldRequest.md +1 -1
  48. data/docs/OperatorSchema.md +20 -0
  49. data/docs/PaginatedConditionSchemaList.md +22 -0
  50. data/docs/PayGroup.md +7 -3
  51. data/docs/PayGroupsApi.md +4 -4
  52. data/docs/PayrollRun.md +9 -5
  53. data/docs/PayrollRunsApi.md +14 -10
  54. data/docs/SelectiveSyncApi.md +233 -0
  55. data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
  56. data/docs/SyncStatus.md +5 -3
  57. data/docs/SyncStatusApi.md +11 -15
  58. data/docs/Tax.md +9 -1
  59. data/docs/Team.md +8 -4
  60. data/docs/TeamsApi.md +4 -4
  61. data/docs/TimeOff.md +13 -9
  62. data/docs/TimeOffApi.md +16 -12
  63. data/docs/TimeOffBalance.md +10 -6
  64. data/docs/TimeOffBalancesApi.md +15 -11
  65. data/docs/TimeOffRequest.md +11 -9
  66. data/lib/merge_hris_client/api/bank_info_api.rb +24 -10
  67. data/lib/merge_hris_client/api/benefits_api.rb +6 -6
  68. data/lib/merge_hris_client/api/common_model_scopes_api.rb +146 -0
  69. data/lib/merge_hris_client/api/companies_api.rb +4 -4
  70. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +4 -4
  71. data/lib/merge_hris_client/api/employees_api.rb +44 -17
  72. data/lib/merge_hris_client/api/employments_api.rb +22 -8
  73. data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
  74. data/lib/merge_hris_client/api/groups_api.rb +25 -8
  75. data/lib/merge_hris_client/api/issues_api.rb +6 -6
  76. data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
  77. data/lib/merge_hris_client/api/locations_api.rb +22 -8
  78. data/lib/merge_hris_client/api/pay_groups_api.rb +4 -4
  79. data/lib/merge_hris_client/api/payroll_runs_api.rb +24 -10
  80. data/lib/merge_hris_client/api/selective_sync_api.rb +225 -0
  81. data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
  82. data/lib/merge_hris_client/api/teams_api.rb +4 -4
  83. data/lib/merge_hris_client/api/time_off_api.rb +26 -12
  84. data/lib/merge_hris_client/api/time_off_balances_api.rb +24 -10
  85. data/lib/merge_hris_client/models/account_integration.rb +30 -8
  86. data/lib/merge_hris_client/models/bank_info.rb +39 -16
  87. data/lib/merge_hris_client/models/benefit.rb +38 -15
  88. data/lib/merge_hris_client/models/categories_enum.rb +3 -1
  89. data/lib/merge_hris_client/models/category_enum.rb +3 -1
  90. data/lib/merge_hris_client/models/common_model_scope_data.rb +234 -0
  91. data/lib/merge_hris_client/models/common_model_scopes.rb +234 -0
  92. data/lib/merge_hris_client/models/common_model_scopes_body_request.rb +274 -0
  93. data/lib/merge_hris_client/models/common_model_scopes_disabled_models.rb +283 -0
  94. data/lib/merge_hris_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
  95. data/lib/merge_hris_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
  96. data/lib/merge_hris_client/models/common_model_scopes_update_serializer.rb +226 -0
  97. data/lib/merge_hris_client/models/company.rb +37 -15
  98. data/lib/merge_hris_client/models/condition_schema.rb +298 -0
  99. data/lib/merge_hris_client/models/condition_type_enum.rb +50 -0
  100. data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
  101. data/lib/merge_hris_client/models/deduction.rb +50 -17
  102. data/lib/merge_hris_client/models/earning.rb +51 -6
  103. data/lib/merge_hris_client/models/employee.rb +51 -23
  104. data/lib/merge_hris_client/models/employee_payroll_run.rb +41 -17
  105. data/lib/merge_hris_client/models/employee_request.rb +34 -39
  106. data/lib/merge_hris_client/models/employment.rb +44 -20
  107. data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
  108. data/lib/merge_hris_client/models/end_user_details_request.rb +20 -7
  109. data/lib/merge_hris_client/models/group.rb +38 -16
  110. data/lib/merge_hris_client/models/group_type_enum.rb +2 -1
  111. data/lib/merge_hris_client/models/issue.rb +16 -4
  112. data/lib/merge_hris_client/models/link_token.rb +0 -5
  113. data/lib/merge_hris_client/models/linked_account_condition.rb +282 -0
  114. data/lib/merge_hris_client/models/linked_account_condition_request.rb +269 -0
  115. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration.rb +221 -0
  116. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
  117. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
  118. data/lib/merge_hris_client/models/location.rb +39 -17
  119. data/lib/merge_hris_client/models/meta_response.rb +12 -1
  120. data/lib/merge_hris_client/models/multipart_form_field_request.rb +1 -1
  121. data/lib/merge_hris_client/models/operator_schema.rb +229 -0
  122. data/lib/merge_hris_client/models/paginated_condition_schema_list.rb +240 -0
  123. data/lib/merge_hris_client/models/pay_frequency_enum.rb +2 -1
  124. data/lib/merge_hris_client/models/pay_group.rb +37 -15
  125. data/lib/merge_hris_client/models/pay_period_enum.rb +2 -1
  126. data/lib/merge_hris_client/models/payroll_run.rb +39 -17
  127. data/lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb +45 -0
  128. data/lib/merge_hris_client/models/sync_status.rb +13 -4
  129. data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -1
  130. data/lib/merge_hris_client/models/tax.rb +50 -5
  131. data/lib/merge_hris_client/models/team.rb +38 -15
  132. data/lib/merge_hris_client/models/time_off.rb +43 -19
  133. data/lib/merge_hris_client/models/time_off_balance.rb +40 -17
  134. data/lib/merge_hris_client/models/time_off_request.rb +36 -21
  135. data/lib/merge_hris_client/version.rb +1 -1
  136. data/lib/merge_hris_client.rb +20 -3
  137. data/spec/api/bank_info_api_spec.rb +7 -5
  138. data/spec/api/benefits_api_spec.rb +3 -3
  139. data/spec/api/common_model_scopes_api_spec.rb +58 -0
  140. data/spec/api/companies_api_spec.rb +2 -2
  141. data/spec/api/employee_payroll_runs_api_spec.rb +2 -2
  142. data/spec/api/employees_api_spec.rb +13 -6
  143. data/spec/api/employments_api_spec.rb +6 -4
  144. data/spec/api/force_resync_api_spec.rb +1 -1
  145. data/spec/api/groups_api_spec.rb +7 -4
  146. data/spec/api/issues_api_spec.rb +3 -3
  147. data/spec/api/linked_accounts_api_spec.rb +1 -1
  148. data/spec/api/locations_api_spec.rb +6 -4
  149. data/spec/api/pay_groups_api_spec.rb +2 -2
  150. data/spec/api/payroll_runs_api_spec.rb +7 -5
  151. data/spec/api/selective_sync_api_spec.rb +72 -0
  152. data/spec/api/sync_status_api_spec.rb +1 -1
  153. data/spec/api/teams_api_spec.rb +2 -2
  154. data/spec/api/time_off_api_spec.rb +8 -6
  155. data/spec/api/time_off_balances_api_spec.rb +7 -5
  156. data/spec/models/account_integration_spec.rb +12 -0
  157. data/spec/models/bank_info_spec.rb +14 -2
  158. data/spec/models/benefit_spec.rb +14 -2
  159. data/spec/models/common_model_scope_data_spec.rb +40 -0
  160. data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
  161. data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
  162. data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
  163. data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
  164. data/spec/models/common_model_scopes_spec.rb +40 -0
  165. data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
  166. data/spec/models/company_spec.rb +14 -2
  167. data/spec/models/condition_schema_spec.rb +70 -0
  168. data/spec/models/condition_type_enum_spec.rb +28 -0
  169. data/spec/models/deduction_spec.rb +20 -2
  170. data/spec/models/earning_spec.rb +24 -0
  171. data/spec/models/employee_payroll_run_spec.rb +14 -2
  172. data/spec/models/employee_request_spec.rb +5 -11
  173. data/spec/models/employee_spec.rb +15 -3
  174. data/spec/models/employment_spec.rb +14 -2
  175. data/spec/models/enabled_actions_enum_spec.rb +28 -0
  176. data/spec/models/end_user_details_request_spec.rb +6 -0
  177. data/spec/models/group_spec.rb +14 -2
  178. data/spec/models/issue_spec.rb +6 -0
  179. data/spec/models/linked_account_condition_request_spec.rb +46 -0
  180. data/spec/models/linked_account_condition_spec.rb +64 -0
  181. data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
  182. data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
  183. data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
  184. data/spec/models/location_spec.rb +14 -2
  185. data/spec/models/meta_response_spec.rb +6 -0
  186. data/spec/models/operator_schema_spec.rb +40 -0
  187. data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
  188. data/spec/models/pay_group_spec.rb +14 -2
  189. data/spec/models/payroll_run_spec.rb +14 -2
  190. data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
  191. data/spec/models/sync_status_spec.rb +6 -0
  192. data/spec/models/tax_spec.rb +24 -0
  193. data/spec/models/team_spec.rb +14 -2
  194. data/spec/models/time_off_balance_spec.rb +14 -2
  195. data/spec/models/time_off_request_spec.rb +12 -6
  196. data/spec/models/time_off_spec.rb +14 -2
  197. metadata +184 -104
data/docs/CompaniesApi.md CHANGED
@@ -37,8 +37,8 @@ opts = {
37
37
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
38
38
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
39
39
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
40
- modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
41
- modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
40
+ modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
41
+ modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
42
42
  page_size: 56, # Integer | Number of results to return per page.
43
43
  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
44
44
  }
@@ -80,8 +80,8 @@ end
80
80
  | **cursor** | **String** | The pagination cursor value. | [optional] |
81
81
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
82
82
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
83
- | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
84
- | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
83
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
84
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
85
85
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
86
86
  | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
87
87
 
data/docs/Company.md CHANGED
@@ -9,8 +9,10 @@
9
9
  | **legal_name** | **String** | The company's legal name. | [optional] |
10
10
  | **display_name** | **String** | The company's display name. | [optional] |
11
11
  | **eins** | **Array<String>** | The company's Employer Identification Numbers. | [optional] |
12
- | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
13
12
  | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
13
+ | **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
14
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
15
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
14
16
 
15
17
  ## Example
16
18
 
@@ -23,8 +25,10 @@ instance = MergeHRISClient::Company.new(
23
25
  legal_name: Waystar Royco, Inc.,
24
26
  display_name: Waystar Royco,
25
27
  eins: ["12-3456789","12-3451111","11-0011000"],
26
- remote_data: [{"path":"/companies","data":["Varies by platform"]}],
27
- remote_was_deleted: null
28
+ remote_was_deleted: null,
29
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
30
+ modified_at: 2021-10-16T00:00Z,
31
+ remote_data: [{"path":"/companies","data":["Varies by platform"]}]
28
32
  )
29
33
  ```
30
34
 
@@ -0,0 +1,30 @@
1
+ # MergeHRISClient::ConditionSchema
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The ID of the condition schema. This ID is used when updating selective syncs for a linked account. | |
8
+ | **common_model** | **String** | The common model for which a condition schema is defined. | [optional][readonly] |
9
+ | **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". | |
10
+ | **field_name** | **String** | The name of the field on the common model that this condition corresponds to, if they conceptually match. e.g. \"location_type\". | |
11
+ | **is_unique** | **Boolean** | Whether this condition can only be applied once. If false, the condition can be AND'd together multiple times. | [optional] |
12
+ | **condition_type** | [**ConditionTypeEnum**](ConditionTypeEnum.md) | The type of value(s) that can be set for this condition. * `BOOLEAN` - BOOLEAN * `DATE` - DATE * `DATE_TIME` - DATE_TIME * `INTEGER` - INTEGER * `FLOAT` - FLOAT * `STRING` - STRING * `LIST_OF_STRINGS` - LIST_OF_STRINGS | |
13
+ | **operators** | [**Array<OperatorSchema>**](OperatorSchema.md) | The schemas for the operators that can be used on a condition. | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'merge_hris_client'
19
+
20
+ instance = MergeHRISClient::ConditionSchema.new(
21
+ id: null,
22
+ common_model: null,
23
+ native_name: null,
24
+ field_name: null,
25
+ is_unique: null,
26
+ condition_type: null,
27
+ operators: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::ConditionTypeEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'merge_hris_client'
12
+
13
+ instance = MergeHRISClient::ConditionTypeEnum.new()
14
+ ```
15
+
@@ -11,7 +11,7 @@
11
11
  | **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
12
12
  | **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
13
13
  | **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
14
- | **normalize_response** | **Boolean** | | [optional] |
14
+ | **normalize_response** | **Boolean** | Optional. If true, the response will always be an object of the form `{\"type\": T, \"value\": ...}` where `T` will be one of `string, boolean, number, null, array, object`. | [optional] |
15
15
 
16
16
  ## Example
17
17
 
data/docs/Deduction.md CHANGED
@@ -5,12 +5,15 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
8
9
  | **employee_payroll_run** | **String** | | [optional] |
9
10
  | **name** | **String** | The deduction's name. | [optional] |
10
- | **employee_deduction** | **Float** | The amount the employee is deducting. | [optional] |
11
- | **company_deduction** | **Float** | The amount the company is deducting. | [optional] |
12
- | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
11
+ | **employee_deduction** | **Float** | The amount of money that is withheld from an employee's gross pay by the employee. | [optional] |
12
+ | **company_deduction** | **Float** | The amount of money that is withheld on behalf of an employee by the company. | [optional] |
13
13
  | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
14
+ | **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
15
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
16
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
14
17
 
15
18
  ## Example
16
19
 
@@ -19,12 +22,15 @@ require 'merge_hris_client'
19
22
 
20
23
  instance = MergeHRISClient::Deduction.new(
21
24
  id: 5fd439fc-1b64-4755-b275-64918936c365,
25
+ remote_id: 93478612,
22
26
  employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
23
27
  name: Social Security,
24
28
  employee_deduction: 34.54,
25
29
  company_deduction: 78.78,
26
- remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}],
27
- remote_was_deleted: null
30
+ remote_was_deleted: null,
31
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
32
+ modified_at: 2021-10-16T00:00Z,
33
+ remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}]
28
34
  )
29
35
  ```
30
36
 
data/docs/Earning.md CHANGED
@@ -5,10 +5,14 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
8
9
  | **employee_payroll_run** | **String** | | [optional] |
9
10
  | **amount** | **Float** | The amount earned. | [optional] |
10
- | **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. | [optional] |
11
+ | **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. * `SALARY` - SALARY * `REIMBURSEMENT` - REIMBURSEMENT * `OVERTIME` - OVERTIME * `BONUS` - BONUS | [optional] |
11
12
  | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
13
+ | **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
14
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
15
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
12
16
 
13
17
  ## Example
14
18
 
@@ -17,10 +21,14 @@ require 'merge_hris_client'
17
21
 
18
22
  instance = MergeHRISClient::Earning.new(
19
23
  id: babbced6-3a81-4775-8da2-490dc6385259,
24
+ remote_id: 52802,
20
25
  employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
21
26
  amount: 1002.34,
22
27
  type: SALARY,
23
- remote_was_deleted: null
28
+ remote_was_deleted: null,
29
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
30
+ modified_at: 2021-10-16T00:00Z,
31
+ remote_data: null
24
32
  )
25
33
  ```
26
34
 
data/docs/Employee.md CHANGED
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
- | **employee_number** | **String** | 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. | [optional] |
10
- | **company** | **String** | | [optional] |
9
+ | **employee_number** | **String** | The employee's number that appears in the third-party integration's UI. | [optional] |
10
+ | **company** | **String** | The ID of the employee's company. | [optional] |
11
11
  | **first_name** | **String** | The employee's first name. | [optional] |
12
12
  | **last_name** | **String** | The employee's last name. | [optional] |
13
13
  | **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
@@ -17,25 +17,27 @@
17
17
  | **personal_email** | **String** | The employee's personal email. | [optional] |
18
18
  | **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
19
19
  | **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional] |
20
- | **home_location** | **String** | | [optional] |
21
- | **work_location** | **String** | | [optional] |
22
- | **manager** | **String** | | [optional] |
23
- | **team** | **String** | | [optional] |
24
- | **pay_group** | **String** | | [optional] |
20
+ | **home_location** | **String** | The employee's home address. | [optional] |
21
+ | **work_location** | **String** | The employee's work address. | [optional] |
22
+ | **manager** | **String** | The employee ID of the employee's manager. | [optional] |
23
+ | **team** | **String** | The employee's team. | [optional] |
24
+ | **pay_group** | **String** | The employee's pay group | [optional] |
25
25
  | **ssn** | **String** | The employee's social security number. | [optional] |
26
- | **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
27
- | **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
28
- | **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's marital status. | [optional] |
26
+ | **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE | [optional] |
27
+ | **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | 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 | [optional] |
28
+ | **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | 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 | [optional] |
29
29
  | **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
30
30
  | **hire_date** | **Time** | 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. | [optional] |
31
- | **start_date** | **Time** | The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date. | [optional] |
31
+ | **start_date** | **Time** | The date that the employee started working. If an employee was rehired, the most recent start date will be returned. | [optional] |
32
32
  | **remote_created_at** | **Time** | When the third party's employee was created. | [optional] |
33
- | **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
33
+ | **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE | [optional] |
34
34
  | **termination_date** | **Time** | The employee's termination date. | [optional] |
35
35
  | **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
36
- | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
37
36
  | **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
38
37
  | **remote_was_deleted** | **Boolean** | | [optional][readonly] |
38
+ | **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
39
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
40
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
39
41
 
40
42
  ## Example
41
43
 
@@ -72,9 +74,11 @@ instance = MergeHRISClient::Employee.new(
72
74
  employment_status: INACTIVE,
73
75
  termination_date: 2021-10-12T00:00Z,
74
76
  avatar: http://alturl.com/h2h8m,
75
- remote_data: [{"path":"/people","data":["Varies by platform"]}],
76
77
  custom_fields: null,
77
- remote_was_deleted: null
78
+ remote_was_deleted: null,
79
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
80
+ modified_at: 2021-10-16T00:00Z,
81
+ remote_data: [{"path":"/people","data":["Varies by platform"]}]
78
82
  )
79
83
  ```
80
84
 
@@ -6,18 +6,20 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
- | **employee** | **String** | | [optional] |
10
- | **payroll_run** | **String** | | [optional] |
11
- | **gross_pay** | **Float** | The gross pay from the run. | [optional] |
12
- | **net_pay** | **Float** | The net pay from the run. | [optional] |
9
+ | **employee** | **String** | The employee whose payroll is being run. | [optional] |
10
+ | **payroll_run** | **String** | The payroll being run. | [optional] |
11
+ | **gross_pay** | **Float** | The total earnings throughout a given period for an employee before any deductions are made. | [optional] |
12
+ | **net_pay** | **Float** | The take-home pay throughout a given period for an employee after deductions are made. | [optional] |
13
13
  | **start_date** | **Time** | The day and time the payroll run started. | [optional] |
14
14
  | **end_date** | **Time** | The day and time the payroll run ended. | [optional] |
15
15
  | **check_date** | **Time** | The day and time the payroll run was checked. | [optional] |
16
16
  | **earnings** | [**Array<Earning>**](Earning.md) | | [optional][readonly] |
17
17
  | **deductions** | [**Array<Deduction>**](Deduction.md) | | [optional][readonly] |
18
18
  | **taxes** | [**Array<Tax>**](Tax.md) | | [optional][readonly] |
19
- | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
20
19
  | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
20
+ | **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
21
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
22
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
21
23
 
22
24
  ## Example
23
25
 
@@ -37,8 +39,10 @@ instance = MergeHRISClient::EmployeePayrollRun.new(
37
39
  earnings: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":1002.34,"type":"SALARY"},{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":8342.34,"type":"OVERTIME"}],
38
40
  deductions: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"Social Security","employee_deduction":34.54,"company_deduction":78.78}],
39
41
  taxes: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":"False"}],
40
- remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}],
41
- remote_was_deleted: null
42
+ remote_was_deleted: null,
43
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
44
+ modified_at: 2021-10-16T00:00Z,
45
+ remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}]
42
46
  )
43
47
  ```
44
48
 
@@ -41,8 +41,8 @@ opts = {
41
41
  expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
42
42
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
43
43
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
44
- modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
45
- modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
44
+ modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
45
+ modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
46
46
  page_size: 56, # Integer | Number of results to return per page.
47
47
  payroll_run_id: 'payroll_run_id_example', # String | If provided, will only return employee payroll runs for this employee.
48
48
  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
@@ -91,8 +91,8 @@ end
91
91
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
92
92
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
93
93
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
94
- | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
95
- | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
94
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
95
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
96
96
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
97
97
  | **payroll_run_id** | **String** | If provided, will only return employee payroll runs for this employee. | [optional] |
98
98
  | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
@@ -4,9 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
8
- | **employee_number** | **String** | 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. | [optional] |
9
- | **company** | **String** | | [optional] |
7
+ | **employee_number** | **String** | The employee's number that appears in the third-party integration's UI. | [optional] |
8
+ | **company** | **String** | The ID of the employee's company. | [optional] |
10
9
  | **first_name** | **String** | The employee's first name. | [optional] |
11
10
  | **last_name** | **String** | The employee's last name. | [optional] |
12
11
  | **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
@@ -16,23 +15,23 @@
16
15
  | **personal_email** | **String** | The employee's personal email. | [optional] |
17
16
  | **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
18
17
  | **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional] |
19
- | **home_location** | **String** | | [optional] |
20
- | **work_location** | **String** | | [optional] |
21
- | **manager** | **String** | | [optional] |
22
- | **team** | **String** | | [optional] |
23
- | **pay_group** | **String** | | [optional] |
18
+ | **home_location** | **String** | The employee's home address. | [optional] |
19
+ | **work_location** | **String** | The employee's work address. | [optional] |
20
+ | **manager** | **String** | The employee ID of the employee's manager. | [optional] |
21
+ | **team** | **String** | The employee's team. | [optional] |
22
+ | **pay_group** | **String** | The employee's pay group | [optional] |
24
23
  | **ssn** | **String** | The employee's social security number. | [optional] |
25
- | **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
26
- | **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
27
- | **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's marital status. | [optional] |
24
+ | **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE | [optional] |
25
+ | **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | 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 | [optional] |
26
+ | **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | 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 | [optional] |
28
27
  | **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
29
28
  | **hire_date** | **Time** | 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. | [optional] |
30
- | **start_date** | **Time** | The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date. | [optional] |
31
- | **remote_created_at** | **Time** | When the third party's employee was created. | [optional] |
32
- | **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
29
+ | **start_date** | **Time** | The date that the employee started working. If an employee was rehired, the most recent start date will be returned. | [optional] |
30
+ | **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE | [optional] |
33
31
  | **termination_date** | **Time** | The employee's termination date. | [optional] |
34
32
  | **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
35
- | **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
33
+ | **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
34
+ | **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
36
35
 
37
36
  ## Example
38
37
 
@@ -40,7 +39,6 @@
40
39
  require 'merge_hris_client'
41
40
 
42
41
  instance = MergeHRISClient::EmployeeRequest.new(
43
- remote_id: 19202938,
44
42
  employee_number: 2,
45
43
  company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
46
44
  first_name: Greg,
@@ -64,11 +62,11 @@ instance = MergeHRISClient::EmployeeRequest.new(
64
62
  date_of_birth: 1990-11-10T00:00Z,
65
63
  hire_date: 2020-10-10T00:00Z,
66
64
  start_date: 2020-10-11T00:00Z,
67
- remote_created_at: 2020-10-11T00:00Z,
68
65
  employment_status: INACTIVE,
69
66
  termination_date: 2021-10-12T00:00Z,
70
67
  avatar: http://alturl.com/h2h8m,
71
- custom_fields: null
68
+ integration_params: {"unique_integration_field":"unique_integration_field_value"},
69
+ linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
72
70
  )
73
71
  ```
74
72
 
data/docs/EmployeesApi.md CHANGED
@@ -92,7 +92,7 @@ end
92
92
 
93
93
  ## employees_ignore_create
94
94
 
95
- > <IgnoreCommonModel> employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
95
+ > employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
96
96
 
97
97
 
98
98
 
@@ -118,8 +118,7 @@ ignore_common_model_request = MergeHRISClient::IgnoreCommonModelRequest.new({rea
118
118
 
119
119
  begin
120
120
 
121
- result = api_instance.employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
122
- p result
121
+ api_instance.employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
123
122
  rescue MergeHRISClient::ApiError => e
124
123
  puts "Error when calling EmployeesApi->employees_ignore_create: #{e}"
125
124
  end
@@ -127,9 +126,9 @@ end
127
126
 
128
127
  #### Using the employees_ignore_create_with_http_info variant
129
128
 
130
- This returns an Array which contains the response data, status code and headers.
129
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
131
130
 
132
- > <Array(<IgnoreCommonModel>, Integer, Hash)> employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
131
+ > <Array(nil, Integer, Hash)> employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
133
132
 
134
133
  ```ruby
135
134
  begin
@@ -137,7 +136,7 @@ begin
137
136
  data, status_code, headers = api_instance.employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
138
137
  p status_code # => 2xx
139
138
  p headers # => { ... }
140
- p data # => <IgnoreCommonModel>
139
+ p data # => nil
141
140
  rescue MergeHRISClient::ApiError => e
142
141
  puts "Error when calling EmployeesApi->employees_ignore_create_with_http_info: #{e}"
143
142
  end
@@ -153,7 +152,7 @@ end
153
152
 
154
153
  ### Return type
155
154
 
156
- [**IgnoreCommonModel**](IgnoreCommonModel.md)
155
+ nil (empty response body)
157
156
 
158
157
  ### Authorization
159
158
 
@@ -162,7 +161,7 @@ end
162
161
  ### HTTP request headers
163
162
 
164
163
  - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
165
- - **Accept**: application/json
164
+ - **Accept**: Not defined
166
165
 
167
166
 
168
167
  ## employees_list
@@ -194,22 +193,28 @@ opts = {
194
193
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
195
194
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
196
195
  display_full_name: 'display_full_name_example', # String | If provided, will only return employees with this display name.
197
- employment_status: 'ACTIVE', # String | If provided, will only return employees with this employment status.
196
+ employment_status: 'ACTIVE', # String | If provided, will only return employees with this employment status. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
198
197
  expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
199
198
  first_name: 'first_name_example', # String | If provided, will only return employees with this first name.
199
+ groups: 'groups_example', # String | If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
200
200
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
201
201
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
202
202
  include_sensitive_fields: true, # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
203
203
  last_name: 'last_name_example', # String | If provided, will only return employees with this last name.
204
204
  manager_id: 'manager_id_example', # String | If provided, will only return employees for this manager.
205
- modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
206
- modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
205
+ modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
206
+ modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
207
207
  page_size: 56, # Integer | Number of results to return per page.
208
208
  pay_group_id: 'pay_group_id_example', # String | If provided, will only return employees for this pay group
209
209
  personal_email: TODO, # String | If provided, will only return Employees with this personal email
210
- remote_fields: 'employment_status', # String | Which fields should be returned in non-normalized form.
210
+ remote_fields: 'employment_status', # String | Deprecated. Use show_enum_origins.
211
211
  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
212
+ show_enum_origins: 'employment_status', # String | Which fields should be returned in non-normalized form.
213
+ started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that started after this datetime.
214
+ started_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that started before this datetime.
212
215
  team_id: 'team_id_example', # String | If provided, will only return employees for this team.
216
+ terminated_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that were terminated after this datetime.
217
+ terminated_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that were terminated before this datetime.
213
218
  work_email: TODO, # String | If provided, will only return Employees with this work email
214
219
  work_location_id: 'work_location_id_example' # String | If provided, will only return employees for this location.
215
220
  }
@@ -251,22 +256,28 @@ end
251
256
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
252
257
  | **cursor** | **String** | The pagination cursor value. | [optional] |
253
258
  | **display_full_name** | **String** | If provided, will only return employees with this display name. | [optional] |
254
- | **employment_status** | **String** | If provided, will only return employees with this employment status. | [optional] |
259
+ | **employment_status** | **String** | If provided, will only return employees with this employment status. * &#x60;ACTIVE&#x60; - ACTIVE * &#x60;PENDING&#x60; - PENDING * &#x60;INACTIVE&#x60; - INACTIVE | [optional] |
255
260
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
256
261
  | **first_name** | **String** | If provided, will only return employees with this first name. | [optional] |
262
+ | **groups** | **String** | If provided, will only return employees matching the group ids; multiple groups can be separated by commas. | [optional] |
257
263
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
258
264
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
259
265
  | **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
260
266
  | **last_name** | **String** | If provided, will only return employees with this last name. | [optional] |
261
267
  | **manager_id** | **String** | If provided, will only return employees for this manager. | [optional] |
262
- | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
263
- | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
268
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
269
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
264
270
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
265
271
  | **pay_group_id** | **String** | If provided, will only return employees for this pay group | [optional] |
266
272
  | **personal_email** | [**String**](.md) | If provided, will only return Employees with this personal email | [optional] |
267
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
273
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
268
274
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
275
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
276
+ | **started_after** | **Time** | If provided, will only return employees that started after this datetime. | [optional] |
277
+ | **started_before** | **Time** | If provided, will only return employees that started before this datetime. | [optional] |
269
278
  | **team_id** | **String** | If provided, will only return employees for this team. | [optional] |
279
+ | **terminated_after** | **Time** | If provided, will only return employees that were terminated after this datetime. | [optional] |
280
+ | **terminated_before** | **Time** | If provided, will only return employees that were terminated before this datetime. | [optional] |
270
281
  | **work_email** | [**String**](.md) | If provided, will only return Employees with this work email | [optional] |
271
282
  | **work_location_id** | **String** | If provided, will only return employees for this location. | [optional] |
272
283
 
@@ -383,7 +394,8 @@ opts = {
383
394
  expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
384
395
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
385
396
  include_sensitive_fields: true, # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
386
- remote_fields: 'employment_status' # String | Which fields should be returned in non-normalized form.
397
+ remote_fields: 'employment_status', # String | Deprecated. Use show_enum_origins.
398
+ show_enum_origins: 'employment_status' # String | Which fields should be returned in non-normalized form.
387
399
  }
388
400
 
389
401
  begin
@@ -422,7 +434,8 @@ end
422
434
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
423
435
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
424
436
  | **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
425
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
437
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
438
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
426
439
 
427
440
  ### Return type
428
441
 
data/docs/Employment.md CHANGED
@@ -6,18 +6,20 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
- | **employee** | **String** | | [optional] |
9
+ | **employee** | **String** | The employee holding this position. | [optional] |
10
10
  | **job_title** | **String** | The position&#39;s title. | [optional] |
11
11
  | **pay_rate** | **Float** | The position&#39;s pay rate in dollars. | [optional] |
12
- | **pay_period** | [**PayPeriodEnum**](PayPeriodEnum.md) | The time period this pay rate encompasses. | [optional] |
13
- | **pay_frequency** | [**PayFrequencyEnum**](PayFrequencyEnum.md) | The position&#39;s pay frequency. | [optional] |
14
- | **pay_currency** | [**PayCurrencyEnum**](PayCurrencyEnum.md) | The position&#39;s currency code. | [optional] |
15
- | **pay_group** | **String** | | [optional] |
16
- | **flsa_status** | [**FlsaStatusEnum**](FlsaStatusEnum.md) | The position&#39;s FLSA status. | [optional] |
12
+ | **pay_period** | [**PayPeriodEnum**](PayPeriodEnum.md) | The time period this pay rate encompasses. * &#x60;HOUR&#x60; - HOUR * &#x60;DAY&#x60; - DAY * &#x60;WEEK&#x60; - WEEK * &#x60;EVERY_TWO_WEEKS&#x60; - EVERY_TWO_WEEKS * &#x60;SEMIMONTHLY&#x60; - SEMIMONTHLY * &#x60;MONTH&#x60; - MONTH * &#x60;QUARTER&#x60; - QUARTER * &#x60;EVERY_SIX_MONTHS&#x60; - EVERY_SIX_MONTHS * &#x60;YEAR&#x60; - YEAR | [optional] |
13
+ | **pay_frequency** | [**PayFrequencyEnum**](PayFrequencyEnum.md) | The position&#39;s pay frequency. * &#x60;WEEKLY&#x60; - WEEKLY * &#x60;BIWEEKLY&#x60; - BIWEEKLY * &#x60;MONTHLY&#x60; - MONTHLY * &#x60;QUARTERLY&#x60; - QUARTERLY * &#x60;SEMIANNUALLY&#x60; - SEMIANNUALLY * &#x60;ANNUALLY&#x60; - ANNUALLY * &#x60;THIRTEEN-MONTHLY&#x60; - THIRTEEN-MONTHLY * &#x60;PRO_RATA&#x60; - PRO_RATA * &#x60;SEMIMONTHLY&#x60; - SEMIMONTHLY | [optional] |
14
+ | **pay_currency** | [**PayCurrencyEnum**](PayCurrencyEnum.md) | The position&#39;s currency code. * &#x60;XUA&#x60; - ADB Unit of Account * &#x60;AFN&#x60; - Afghan Afghani * &#x60;AFA&#x60; - Afghan Afghani (1927–2002) * &#x60;ALL&#x60; - Albanian Lek * &#x60;ALK&#x60; - Albanian Lek (1946–1965) * &#x60;DZD&#x60; - Algerian Dinar * &#x60;ADP&#x60; - Andorran Peseta * &#x60;AOA&#x60; - Angolan Kwanza * &#x60;AOK&#x60; - Angolan Kwanza (1977–1991) * &#x60;AON&#x60; - Angolan New Kwanza (1990–2000) * &#x60;AOR&#x60; - Angolan Readjusted Kwanza (1995–1999) * &#x60;ARA&#x60; - Argentine Austral * &#x60;ARS&#x60; - Argentine Peso * &#x60;ARM&#x60; - Argentine Peso (1881–1970) * &#x60;ARP&#x60; - Argentine Peso (1983–1985) * &#x60;ARL&#x60; - Argentine Peso Ley (1970–1983) * &#x60;AMD&#x60; - Armenian Dram * &#x60;AWG&#x60; - Aruban Florin * &#x60;AUD&#x60; - Australian Dollar * &#x60;ATS&#x60; - Austrian Schilling * &#x60;AZN&#x60; - Azerbaijani Manat * &#x60;AZM&#x60; - Azerbaijani Manat (1993–2006) * &#x60;BSD&#x60; - Bahamian Dollar * &#x60;BHD&#x60; - Bahraini Dinar * &#x60;BDT&#x60; - Bangladeshi Taka * &#x60;BBD&#x60; - Barbadian Dollar * &#x60;BYN&#x60; - Belarusian Ruble * &#x60;BYB&#x60; - Belarusian Ruble (1994–1999) * &#x60;BYR&#x60; - Belarusian Ruble (2000–2016) * &#x60;BEF&#x60; - Belgian Franc * &#x60;BEC&#x60; - Belgian Franc (convertible) * &#x60;BEL&#x60; - Belgian Franc (financial) * &#x60;BZD&#x60; - Belize Dollar * &#x60;BMD&#x60; - Bermudan Dollar * &#x60;BTN&#x60; - Bhutanese Ngultrum * &#x60;BOB&#x60; - Bolivian Boliviano * &#x60;BOL&#x60; - Bolivian Boliviano (1863–1963) * &#x60;BOV&#x60; - Bolivian Mvdol * &#x60;BOP&#x60; - Bolivian Peso * &#x60;BAM&#x60; - Bosnia-Herzegovina Convertible Mark * &#x60;BAD&#x60; - Bosnia-Herzegovina Dinar (1992–1994) * &#x60;BAN&#x60; - Bosnia-Herzegovina New Dinar (1994–1997) * &#x60;BWP&#x60; - Botswanan Pula * &#x60;BRC&#x60; - Brazilian Cruzado (1986–1989) * &#x60;BRZ&#x60; - Brazilian Cruzeiro (1942–1967) * &#x60;BRE&#x60; - Brazilian Cruzeiro (1990–1993) * &#x60;BRR&#x60; - Brazilian Cruzeiro (1993–1994) * &#x60;BRN&#x60; - Brazilian New Cruzado (1989–1990) * &#x60;BRB&#x60; - Brazilian New Cruzeiro (1967–1986) * &#x60;BRL&#x60; - Brazilian Real * &#x60;GBP&#x60; - British Pound * &#x60;BND&#x60; - Brunei Dollar * &#x60;BGL&#x60; - Bulgarian Hard Lev * &#x60;BGN&#x60; - Bulgarian Lev * &#x60;BGO&#x60; - Bulgarian Lev (1879–1952) * &#x60;BGM&#x60; - Bulgarian Socialist Lev * &#x60;BUK&#x60; - Burmese Kyat * &#x60;BIF&#x60; - Burundian Franc * &#x60;XPF&#x60; - CFP Franc * &#x60;KHR&#x60; - Cambodian Riel * &#x60;CAD&#x60; - Canadian Dollar * &#x60;CVE&#x60; - Cape Verdean Escudo * &#x60;KYD&#x60; - Cayman Islands Dollar * &#x60;XAF&#x60; - Central African CFA Franc * &#x60;CLE&#x60; - Chilean Escudo * &#x60;CLP&#x60; - Chilean Peso * &#x60;CLF&#x60; - Chilean Unit of Account (UF) * &#x60;CNX&#x60; - Chinese People’s Bank Dollar * &#x60;CNY&#x60; - Chinese Yuan * &#x60;CNH&#x60; - Chinese Yuan (offshore) * &#x60;COP&#x60; - Colombian Peso * &#x60;COU&#x60; - Colombian Real Value Unit * &#x60;KMF&#x60; - Comorian Franc * &#x60;CDF&#x60; - Congolese Franc * &#x60;CRC&#x60; - Costa Rican Colón * &#x60;HRD&#x60; - Croatian Dinar * &#x60;HRK&#x60; - Croatian Kuna * &#x60;CUC&#x60; - Cuban Convertible Peso * &#x60;CUP&#x60; - Cuban Peso * &#x60;CYP&#x60; - Cypriot Pound * &#x60;CZK&#x60; - Czech Koruna * &#x60;CSK&#x60; - Czechoslovak Hard Koruna * &#x60;DKK&#x60; - Danish Krone * &#x60;DJF&#x60; - Djiboutian Franc * &#x60;DOP&#x60; - Dominican Peso * &#x60;NLG&#x60; - Dutch Guilder * &#x60;XCD&#x60; - East Caribbean Dollar * &#x60;DDM&#x60; - East German Mark * &#x60;ECS&#x60; - Ecuadorian Sucre * &#x60;ECV&#x60; - Ecuadorian Unit of Constant Value * &#x60;EGP&#x60; - Egyptian Pound * &#x60;GQE&#x60; - Equatorial Guinean Ekwele * &#x60;ERN&#x60; - Eritrean Nakfa * &#x60;EEK&#x60; - Estonian Kroon * &#x60;ETB&#x60; - Ethiopian Birr * &#x60;EUR&#x60; - Euro * &#x60;XBA&#x60; - European Composite Unit * &#x60;XEU&#x60; - European Currency Unit * &#x60;XBB&#x60; - European Monetary Unit * &#x60;XBC&#x60; - European Unit of Account (XBC) * &#x60;XBD&#x60; - European Unit of Account (XBD) * &#x60;FKP&#x60; - Falkland Islands Pound * &#x60;FJD&#x60; - Fijian Dollar * &#x60;FIM&#x60; - Finnish Markka * &#x60;FRF&#x60; - French Franc * &#x60;XFO&#x60; - French Gold Franc * &#x60;XFU&#x60; - French UIC-Franc * &#x60;GMD&#x60; - Gambian Dalasi * &#x60;GEK&#x60; - Georgian Kupon Larit * &#x60;GEL&#x60; - Georgian Lari * &#x60;DEM&#x60; - German Mark * &#x60;GHS&#x60; - Ghanaian Cedi * &#x60;GHC&#x60; - Ghanaian Cedi (1979–2007) * &#x60;GIP&#x60; - Gibraltar Pound * &#x60;XAU&#x60; - Gold * &#x60;GRD&#x60; - Greek Drachma * &#x60;GTQ&#x60; - Guatemalan Quetzal * &#x60;GWP&#x60; - Guinea-Bissau Peso * &#x60;GNF&#x60; - Guinean Franc * &#x60;GNS&#x60; - Guinean Syli * &#x60;GYD&#x60; - Guyanaese Dollar * &#x60;HTG&#x60; - Haitian Gourde * &#x60;HNL&#x60; - Honduran Lempira * &#x60;HKD&#x60; - Hong Kong Dollar * &#x60;HUF&#x60; - Hungarian Forint * &#x60;IMP&#x60; - IMP * &#x60;ISK&#x60; - Icelandic Króna * &#x60;ISJ&#x60; - Icelandic Króna (1918–1981) * &#x60;INR&#x60; - Indian Rupee * &#x60;IDR&#x60; - Indonesian Rupiah * &#x60;IRR&#x60; - Iranian Rial * &#x60;IQD&#x60; - Iraqi Dinar * &#x60;IEP&#x60; - Irish Pound * &#x60;ILS&#x60; - Israeli New Shekel * &#x60;ILP&#x60; - Israeli Pound * &#x60;ILR&#x60; - Israeli Shekel (1980–1985) * &#x60;ITL&#x60; - Italian Lira * &#x60;JMD&#x60; - Jamaican Dollar * &#x60;JPY&#x60; - Japanese Yen * &#x60;JOD&#x60; - Jordanian Dinar * &#x60;KZT&#x60; - Kazakhstani Tenge * &#x60;KES&#x60; - Kenyan Shilling * &#x60;KWD&#x60; - Kuwaiti Dinar * &#x60;KGS&#x60; - Kyrgystani Som * &#x60;LAK&#x60; - Laotian Kip * &#x60;LVL&#x60; - Latvian Lats * &#x60;LVR&#x60; - Latvian Ruble * &#x60;LBP&#x60; - Lebanese Pound * &#x60;LSL&#x60; - Lesotho Loti * &#x60;LRD&#x60; - Liberian Dollar * &#x60;LYD&#x60; - Libyan Dinar * &#x60;LTL&#x60; - Lithuanian Litas * &#x60;LTT&#x60; - Lithuanian Talonas * &#x60;LUL&#x60; - Luxembourg Financial Franc * &#x60;LUC&#x60; - Luxembourgian Convertible Franc * &#x60;LUF&#x60; - Luxembourgian Franc * &#x60;MOP&#x60; - Macanese Pataca * &#x60;MKD&#x60; - Macedonian Denar * &#x60;MKN&#x60; - Macedonian Denar (1992–1993) * &#x60;MGA&#x60; - Malagasy Ariary * &#x60;MGF&#x60; - Malagasy Franc * &#x60;MWK&#x60; - Malawian Kwacha * &#x60;MYR&#x60; - Malaysian Ringgit * &#x60;MVR&#x60; - Maldivian Rufiyaa * &#x60;MVP&#x60; - Maldivian Rupee (1947–1981) * &#x60;MLF&#x60; - Malian Franc * &#x60;MTL&#x60; - Maltese Lira * &#x60;MTP&#x60; - Maltese Pound * &#x60;MRU&#x60; - Mauritanian Ouguiya * &#x60;MRO&#x60; - Mauritanian Ouguiya (1973–2017) * &#x60;MUR&#x60; - Mauritian Rupee * &#x60;MXV&#x60; - Mexican Investment Unit * &#x60;MXN&#x60; - Mexican Peso * &#x60;MXP&#x60; - Mexican Silver Peso (1861–1992) * &#x60;MDC&#x60; - Moldovan Cupon * &#x60;MDL&#x60; - Moldovan Leu * &#x60;MCF&#x60; - Monegasque Franc * &#x60;MNT&#x60; - Mongolian Tugrik * &#x60;MAD&#x60; - Moroccan Dirham * &#x60;MAF&#x60; - Moroccan Franc * &#x60;MZE&#x60; - Mozambican Escudo * &#x60;MZN&#x60; - Mozambican Metical * &#x60;MZM&#x60; - Mozambican Metical (1980–2006) * &#x60;MMK&#x60; - Myanmar Kyat * &#x60;NAD&#x60; - Namibian Dollar * &#x60;NPR&#x60; - Nepalese Rupee * &#x60;ANG&#x60; - Netherlands Antillean Guilder * &#x60;TWD&#x60; - New Taiwan Dollar * &#x60;NZD&#x60; - New Zealand Dollar * &#x60;NIO&#x60; - Nicaraguan Córdoba * &#x60;NIC&#x60; - Nicaraguan Córdoba (1988–1991) * &#x60;NGN&#x60; - Nigerian Naira * &#x60;KPW&#x60; - North Korean Won * &#x60;NOK&#x60; - Norwegian Krone * &#x60;OMR&#x60; - Omani Rial * &#x60;PKR&#x60; - Pakistani Rupee * &#x60;XPD&#x60; - Palladium * &#x60;PAB&#x60; - Panamanian Balboa * &#x60;PGK&#x60; - Papua New Guinean Kina * &#x60;PYG&#x60; - Paraguayan Guarani * &#x60;PEI&#x60; - Peruvian Inti * &#x60;PEN&#x60; - Peruvian Sol * &#x60;PES&#x60; - Peruvian Sol (1863–1965) * &#x60;PHP&#x60; - Philippine Peso * &#x60;XPT&#x60; - Platinum * &#x60;PLN&#x60; - Polish Zloty * &#x60;PLZ&#x60; - Polish Zloty (1950–1995) * &#x60;PTE&#x60; - Portuguese Escudo * &#x60;GWE&#x60; - Portuguese Guinea Escudo * &#x60;QAR&#x60; - Qatari Rial * &#x60;XRE&#x60; - RINET Funds * &#x60;RHD&#x60; - Rhodesian Dollar * &#x60;RON&#x60; - Romanian Leu * &#x60;ROL&#x60; - Romanian Leu (1952–2006) * &#x60;RUB&#x60; - Russian Ruble * &#x60;RUR&#x60; - Russian Ruble (1991–1998) * &#x60;RWF&#x60; - Rwandan Franc * &#x60;SVC&#x60; - Salvadoran Colón * &#x60;WST&#x60; - Samoan Tala * &#x60;SAR&#x60; - Saudi Riyal * &#x60;RSD&#x60; - Serbian Dinar * &#x60;CSD&#x60; - Serbian Dinar (2002–2006) * &#x60;SCR&#x60; - Seychellois Rupee * &#x60;SLL&#x60; - Sierra Leonean Leone * &#x60;XAG&#x60; - Silver * &#x60;SGD&#x60; - Singapore Dollar * &#x60;SKK&#x60; - Slovak Koruna * &#x60;SIT&#x60; - Slovenian Tolar * &#x60;SBD&#x60; - Solomon Islands Dollar * &#x60;SOS&#x60; - Somali Shilling * &#x60;ZAR&#x60; - South African Rand * &#x60;ZAL&#x60; - South African Rand (financial) * &#x60;KRH&#x60; - South Korean Hwan (1953–1962) * &#x60;KRW&#x60; - South Korean Won * &#x60;KRO&#x60; - South Korean Won (1945–1953) * &#x60;SSP&#x60; - South Sudanese Pound * &#x60;SUR&#x60; - Soviet Rouble * &#x60;ESP&#x60; - Spanish Peseta * &#x60;ESA&#x60; - Spanish Peseta (A account) * &#x60;ESB&#x60; - Spanish Peseta (convertible account) * &#x60;XDR&#x60; - Special Drawing Rights * &#x60;LKR&#x60; - Sri Lankan Rupee * &#x60;SHP&#x60; - St. Helena Pound * &#x60;XSU&#x60; - Sucre * &#x60;SDD&#x60; - Sudanese Dinar (1992–2007) * &#x60;SDG&#x60; - Sudanese Pound * &#x60;SDP&#x60; - Sudanese Pound (1957–1998) * &#x60;SRD&#x60; - Surinamese Dollar * &#x60;SRG&#x60; - Surinamese Guilder * &#x60;SZL&#x60; - Swazi Lilangeni * &#x60;SEK&#x60; - Swedish Krona * &#x60;CHF&#x60; - Swiss Franc * &#x60;SYP&#x60; - Syrian Pound * &#x60;STN&#x60; - São Tomé &amp; Príncipe Dobra * &#x60;STD&#x60; - São Tomé &amp; Príncipe Dobra (1977–2017) * &#x60;TVD&#x60; - TVD * &#x60;TJR&#x60; - Tajikistani Ruble * &#x60;TJS&#x60; - Tajikistani Somoni * &#x60;TZS&#x60; - Tanzanian Shilling * &#x60;XTS&#x60; - Testing Currency Code * &#x60;THB&#x60; - Thai Baht * &#x60;XXX&#x60; - The codes assigned for transactions where no currency is involved * &#x60;TPE&#x60; - Timorese Escudo * &#x60;TOP&#x60; - Tongan Paʻanga * &#x60;TTD&#x60; - Trinidad &amp; Tobago Dollar * &#x60;TND&#x60; - Tunisian Dinar * &#x60;TRY&#x60; - Turkish Lira * &#x60;TRL&#x60; - Turkish Lira (1922–2005) * &#x60;TMT&#x60; - Turkmenistani Manat * &#x60;TMM&#x60; - Turkmenistani Manat (1993–2009) * &#x60;USD&#x60; - US Dollar * &#x60;USN&#x60; - US Dollar (Next day) * &#x60;USS&#x60; - US Dollar (Same day) * &#x60;UGX&#x60; - Ugandan Shilling * &#x60;UGS&#x60; - Ugandan Shilling (1966–1987) * &#x60;UAH&#x60; - Ukrainian Hryvnia * &#x60;UAK&#x60; - Ukrainian Karbovanets * &#x60;AED&#x60; - United Arab Emirates Dirham * &#x60;UYW&#x60; - Uruguayan Nominal Wage Index Unit * &#x60;UYU&#x60; - Uruguayan Peso * &#x60;UYP&#x60; - Uruguayan Peso (1975–1993) * &#x60;UYI&#x60; - Uruguayan Peso (Indexed Units) * &#x60;UZS&#x60; - Uzbekistani Som * &#x60;VUV&#x60; - Vanuatu Vatu * &#x60;VES&#x60; - Venezuelan Bolívar * &#x60;VEB&#x60; - Venezuelan Bolívar (1871–2008) * &#x60;VEF&#x60; - Venezuelan Bolívar (2008–2018) * &#x60;VND&#x60; - Vietnamese Dong * &#x60;VNN&#x60; - Vietnamese Dong (1978–1985) * &#x60;CHE&#x60; - WIR Euro * &#x60;CHW&#x60; - WIR Franc * &#x60;XOF&#x60; - West African CFA Franc * &#x60;YDD&#x60; - Yemeni Dinar * &#x60;YER&#x60; - Yemeni Rial * &#x60;YUN&#x60; - Yugoslavian Convertible Dinar (1990–1992) * &#x60;YUD&#x60; - Yugoslavian Hard Dinar (1966–1990) * &#x60;YUM&#x60; - Yugoslavian New Dinar (1994–2002) * &#x60;YUR&#x60; - Yugoslavian Reformed Dinar (1992–1993) * &#x60;ZWN&#x60; - ZWN * &#x60;ZRN&#x60; - Zairean New Zaire (1993–1998) * &#x60;ZRZ&#x60; - Zairean Zaire (1971–1993) * &#x60;ZMW&#x60; - Zambian Kwacha * &#x60;ZMK&#x60; - Zambian Kwacha (1968–2012) * &#x60;ZWD&#x60; - Zimbabwean Dollar (1980–2008) * &#x60;ZWR&#x60; - Zimbabwean Dollar (2008) * &#x60;ZWL&#x60; - Zimbabwean Dollar (2009) | [optional] |
15
+ | **pay_group** | **String** | The employment&#39;s pay group | [optional] |
16
+ | **flsa_status** | [**FlsaStatusEnum**](FlsaStatusEnum.md) | The position&#39;s FLSA status. * &#x60;EXEMPT&#x60; - EXEMPT * &#x60;SALARIED_NONEXEMPT&#x60; - SALARIED_NONEXEMPT * &#x60;NONEXEMPT&#x60; - NONEXEMPT * &#x60;OWNER&#x60; - OWNER | [optional] |
17
17
  | **effective_date** | **Time** | The position&#39;s effective date. | [optional] |
18
- | **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | The position&#39;s type of employment. | [optional] |
19
- | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
18
+ | **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | The position&#39;s type of employment. * &#x60;FULL_TIME&#x60; - FULL_TIME * &#x60;PART_TIME&#x60; - PART_TIME * &#x60;INTERN&#x60; - INTERN * &#x60;CONTRACTOR&#x60; - CONTRACTOR * &#x60;FREELANCE&#x60; - FREELANCE | [optional] |
20
19
  | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
20
+ | **field_mappings** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional][readonly] |
21
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
22
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
21
23
 
22
24
  ## Example
23
25
 
@@ -37,8 +39,10 @@ instance = MergeHRISClient::Employment.new(
37
39
  flsa_status: EXEMPT,
38
40
  effective_date: 2023-10-06T18:42:34Z,
39
41
  employment_type: FULL TIME,
40
- remote_data: [{&quot;path&quot;:&quot;/jobs&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
41
- remote_was_deleted: null
42
+ remote_was_deleted: null,
43
+ field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
44
+ modified_at: 2021-10-16T00:00Z,
45
+ remote_data: [{&quot;path&quot;:&quot;/jobs&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
42
46
  )
43
47
  ```
44
48