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
@@ -6,12 +6,14 @@
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
- | **balance** | **Float** | The current remaining PTO balance in terms of hours. This does not represent the starting PTO balance. If the API provider only provides PTO balance in terms of days, we estimate 8 hours per day. | [optional] |
9
+ | **employee** | **String** | The employee the balance belongs to. | [optional] |
10
+ | **balance** | **Float** | The current remaining PTO balance, always measured in terms of hours. | [optional] |
11
11
  | **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
12
- | **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. | [optional] |
13
- | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
12
+ | **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
14
13
  | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
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] |
15
17
 
16
18
  ## Example
17
19
 
@@ -25,8 +27,10 @@ instance = MergeHRISClient::TimeOffBalance.new(
25
27
  balance: 60.0,
26
28
  used: 45.0,
27
29
  policy_type: VACATION,
28
- remote_data: [{"path":"/leave","data":["Varies by platform"]}],
29
- 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":"/leave","data":["Varies by platform"]}]
30
34
  )
31
35
  ```
32
36
 
@@ -39,12 +39,13 @@ opts = {
39
39
  expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
40
40
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
41
41
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
42
- modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
43
- modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
42
+ 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.
43
+ 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.
44
44
  page_size: 56, # Integer | Number of results to return per page.
45
- policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
46
- remote_fields: 'policy_type', # String | Which fields should be returned in non-normalized form.
47
- remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
45
+ policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
46
+ remote_fields: 'policy_type', # String | Deprecated. Use show_enum_origins.
47
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
48
+ show_enum_origins: 'policy_type' # String | Which fields should be returned in non-normalized form.
48
49
  }
49
50
 
50
51
  begin
@@ -86,12 +87,13 @@ end
86
87
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
87
88
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
88
89
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
89
- | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
90
- | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
90
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
91
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
91
92
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
92
- | **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
93
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
93
+ | **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
94
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
94
95
  | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
96
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
95
97
 
96
98
  ### Return type
97
99
 
@@ -134,7 +136,8 @@ id = TODO # String |
134
136
  opts = {
135
137
  expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
136
138
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
137
- remote_fields: 'policy_type' # String | Which fields should be returned in non-normalized form.
139
+ remote_fields: 'policy_type', # String | Deprecated. Use show_enum_origins.
140
+ show_enum_origins: 'policy_type' # String | Which fields should be returned in non-normalized form.
138
141
  }
139
142
 
140
143
  begin
@@ -172,7 +175,8 @@ end
172
175
  | **id** | [**String**](.md) | | |
173
176
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
174
177
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
175
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
178
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
179
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
176
180
 
177
181
  ### Return type
178
182
 
@@ -4,16 +4,17 @@
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** | **String** | | [optional] |
9
- | **approver** | **String** | | [optional] |
10
- | **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
7
+ | **employee** | **String** | The employee requesting time off. | [optional] |
8
+ | **approver** | **String** | The Merge ID of the employee with the ability to approve the time off request. | [optional] |
9
+ | **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
11
10
  | **employee_note** | **String** | The employee note for this time off request. | [optional] |
12
- | **units** | [**UnitsEnum**](UnitsEnum.md) | The unit of time requested. | [optional] |
13
- | **amount** | **Float** | The number of time off units requested. | [optional] |
14
- | **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
11
+ | **units** | [**UnitsEnum**](UnitsEnum.md) | The measurement that the third-party integration uses to count time requested. * `HOURS` - HOURS * `DAYS` - DAYS | [optional] |
12
+ | **amount** | **Float** | The time off quantity measured by the prescribed “units”. | [optional] |
13
+ | **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
15
14
  | **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
16
15
  | **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
16
+ | **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
17
+ | **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
17
18
 
18
19
  ## Example
19
20
 
@@ -21,7 +22,6 @@
21
22
  require 'merge_hris_client'
22
23
 
23
24
  instance = MergeHRISClient::TimeOffRequest.new(
24
- remote_id: 19202938,
25
25
  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
26
26
  approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
27
27
  status: APPROVED,
@@ -30,7 +30,9 @@ instance = MergeHRISClient::TimeOffRequest.new(
30
30
  amount: 3,
31
31
  request_type: VACATION,
32
32
  start_time: 2020-11-10T00:00Z,
33
- end_time: 2020-11-17T00:00Z
33
+ end_time: 2020-11-17T00:00Z,
34
+ integration_params: {"unique_integration_field":"unique_integration_field_value"},
35
+ linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
34
36
  )
35
37
  ```
36
38
 
@@ -22,7 +22,7 @@ module MergeHRISClient
22
22
  # Returns a list of `BankInfo` objects.
23
23
  # @param x_account_token [String] Token identifying the end user.
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
25
+ # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING
26
26
  # @option opts [String] :bank_name If provided, will only return BankInfo's with this bank name.
27
27
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
28
28
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
@@ -31,12 +31,13 @@ module MergeHRISClient
31
31
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
32
32
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
33
33
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
34
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
35
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
34
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
35
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
36
36
  # @option opts [String] :order_by Overrides the default ordering for this endpoint.
37
37
  # @option opts [Integer] :page_size Number of results to return per page.
38
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
38
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
39
39
  # @option opts [String] :remote_id The API provider's ID for the given object.
40
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
40
41
  # @return [PaginatedBankInfoList]
41
42
  def bank_info_list(x_account_token, opts = {})
42
43
  data, _status_code, _headers = bank_info_list_with_http_info(x_account_token, opts)
@@ -46,7 +47,7 @@ module MergeHRISClient
46
47
  # Returns a list of `BankInfo` objects.
47
48
  # @param x_account_token [String] Token identifying the end user.
48
49
  # @param [Hash] opts the optional parameters
49
- # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
50
+ # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING
50
51
  # @option opts [String] :bank_name If provided, will only return BankInfo's with this bank name.
51
52
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
52
53
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
@@ -55,12 +56,13 @@ module MergeHRISClient
55
56
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
56
57
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
57
58
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
58
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
59
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
59
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
60
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
60
61
  # @option opts [String] :order_by Overrides the default ordering for this endpoint.
61
62
  # @option opts [Integer] :page_size Number of results to return per page.
62
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
63
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
63
64
  # @option opts [String] :remote_id The API provider's ID for the given object.
65
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
64
66
  # @return [Array<(PaginatedBankInfoList, Integer, Hash)>] PaginatedBankInfoList data, response status code and response headers
65
67
  def bank_info_list_with_http_info(x_account_token, opts = {})
66
68
  if @api_client.config.debugging
@@ -86,6 +88,10 @@ module MergeHRISClient
86
88
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
87
89
  fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
88
90
  end
91
+ allowable_values = ["account_type"]
92
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
93
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
94
+ end
89
95
  # resource path
90
96
  local_var_path = '/bank-info'
91
97
 
@@ -106,6 +112,7 @@ module MergeHRISClient
106
112
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
107
113
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
108
114
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
115
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
109
116
 
110
117
  # header parameters
111
118
  header_params = opts[:header_params] || {}
@@ -148,7 +155,8 @@ module MergeHRISClient
148
155
  # @param [Hash] opts the optional parameters
149
156
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
150
157
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
151
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
158
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
159
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
152
160
  # @return [BankInfo]
153
161
  def bank_info_retrieve(x_account_token, id, opts = {})
154
162
  data, _status_code, _headers = bank_info_retrieve_with_http_info(x_account_token, id, opts)
@@ -161,7 +169,8 @@ module MergeHRISClient
161
169
  # @param [Hash] opts the optional parameters
162
170
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
163
171
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
164
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
172
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
173
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
165
174
  # @return [Array<(BankInfo, Integer, Hash)>] BankInfo data, response status code and response headers
166
175
  def bank_info_retrieve_with_http_info(x_account_token, id, opts = {})
167
176
  if @api_client.config.debugging
@@ -183,6 +192,10 @@ module MergeHRISClient
183
192
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
184
193
  fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
185
194
  end
195
+ allowable_values = ["account_type"]
196
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
197
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
198
+ end
186
199
  # resource path
187
200
  local_var_path = '/bank-info/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
188
201
 
@@ -191,6 +204,7 @@ module MergeHRISClient
191
204
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
192
205
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
193
206
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
207
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
194
208
 
195
209
  # header parameters
196
210
  header_params = opts[:header_params] || {}
@@ -25,12 +25,12 @@ module MergeHRISClient
25
25
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
26
26
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
- # @option opts [String] :employee_id If provided, will only return time off for this employee.
28
+ # @option opts [String] :employee_id If provided, will return the benefits associated with the employee.
29
29
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
30
30
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
31
31
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
32
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
33
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
32
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
33
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
34
34
  # @option opts [Integer] :page_size Number of results to return per page.
35
35
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
36
36
  # @return [PaginatedBenefitList]
@@ -45,12 +45,12 @@ module MergeHRISClient
45
45
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
46
46
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
47
47
  # @option opts [String] :cursor The pagination cursor value.
48
- # @option opts [String] :employee_id If provided, will only return time off for this employee.
48
+ # @option opts [String] :employee_id If provided, will return the benefits associated with the employee.
49
49
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
50
50
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
51
51
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
52
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
53
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
52
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
53
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
54
54
  # @option opts [Integer] :page_size Number of results to return per page.
55
55
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
56
56
  # @return [Array<(PaginatedBenefitList, Integer, Hash)>] PaginatedBenefitList data, response status code and response headers
@@ -0,0 +1,146 @@
1
+ =begin
2
+ #Merge HRIS API
3
+
4
+ #The unified API for building rich integrations with multiple HR Information System platforms.
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Contact: hello@merge.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MergeHRISClient
16
+ class CommonModelScopesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Update the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
23
+ # @param common_model_scopes_update_serializer [CommonModelScopesUpdateSerializer]
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :linked_account_id ID of specific linked account to fetch
26
+ # @return [CommonModelScopes]
27
+ def common_model_scopes_create(common_model_scopes_update_serializer, opts = {})
28
+ data, _status_code, _headers = common_model_scopes_create_with_http_info(common_model_scopes_update_serializer, opts)
29
+ data
30
+ end
31
+
32
+ # Update the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
33
+ # @param common_model_scopes_update_serializer [CommonModelScopesUpdateSerializer]
34
+ # @param [Hash] opts the optional parameters
35
+ # @option opts [String] :linked_account_id ID of specific linked account to fetch
36
+ # @return [Array<(CommonModelScopes, Integer, Hash)>] CommonModelScopes data, response status code and response headers
37
+ def common_model_scopes_create_with_http_info(common_model_scopes_update_serializer, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: CommonModelScopesApi.common_model_scopes_create ...'
40
+ end
41
+ # verify the required parameter 'common_model_scopes_update_serializer' is set
42
+ if @api_client.config.client_side_validation && common_model_scopes_update_serializer.nil?
43
+ fail ArgumentError, "Missing the required parameter 'common_model_scopes_update_serializer' when calling CommonModelScopesApi.common_model_scopes_create"
44
+ end
45
+ # resource path
46
+ local_var_path = '/common-model-scopes'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+ query_params[:'linked_account_id'] = opts[:'linked_account_id'] if !opts[:'linked_account_id'].nil?
51
+
52
+ # header parameters
53
+ header_params = opts[:header_params] || {}
54
+ # HTTP header 'Accept' (if needed)
55
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
56
+ # HTTP header 'Content-Type'
57
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
58
+
59
+ # form parameters
60
+ form_params = opts[:form_params] || {}
61
+
62
+ # http body (model)
63
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(common_model_scopes_update_serializer)
64
+
65
+ # return_type
66
+ return_type = opts[:debug_return_type] || 'CommonModelScopes'
67
+
68
+ # auth_names
69
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
70
+
71
+ new_options = opts.merge(
72
+ :operation => :"CommonModelScopesApi.common_model_scopes_create",
73
+ :header_params => header_params,
74
+ :query_params => query_params,
75
+ :form_params => form_params,
76
+ :body => post_body,
77
+ :auth_names => auth_names,
78
+ :return_type => return_type
79
+ )
80
+
81
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
82
+ if @api_client.config.debugging
83
+ @api_client.config.logger.debug "API called: CommonModelScopesApi#common_model_scopes_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
84
+ end
85
+ return data, status_code, headers
86
+ end
87
+
88
+ # Fetch the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
89
+ # @param [Hash] opts the optional parameters
90
+ # @option opts [String] :linked_account_id ID of specific linked account to fetch
91
+ # @return [CommonModelScopes]
92
+ def common_model_scopes_retrieve(opts = {})
93
+ data, _status_code, _headers = common_model_scopes_retrieve_with_http_info(opts)
94
+ data
95
+ end
96
+
97
+ # Fetch the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
98
+ # @param [Hash] opts the optional parameters
99
+ # @option opts [String] :linked_account_id ID of specific linked account to fetch
100
+ # @return [Array<(CommonModelScopes, Integer, Hash)>] CommonModelScopes data, response status code and response headers
101
+ def common_model_scopes_retrieve_with_http_info(opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: CommonModelScopesApi.common_model_scopes_retrieve ...'
104
+ end
105
+ # resource path
106
+ local_var_path = '/common-model-scopes'
107
+
108
+ # query parameters
109
+ query_params = opts[:query_params] || {}
110
+ query_params[:'linked_account_id'] = opts[:'linked_account_id'] if !opts[:'linked_account_id'].nil?
111
+
112
+ # header parameters
113
+ header_params = opts[:header_params] || {}
114
+ # HTTP header 'Accept' (if needed)
115
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
116
+
117
+ # form parameters
118
+ form_params = opts[:form_params] || {}
119
+
120
+ # http body (model)
121
+ post_body = opts[:debug_body]
122
+
123
+ # return_type
124
+ return_type = opts[:debug_return_type] || 'CommonModelScopes'
125
+
126
+ # auth_names
127
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
128
+
129
+ new_options = opts.merge(
130
+ :operation => :"CommonModelScopesApi.common_model_scopes_retrieve",
131
+ :header_params => header_params,
132
+ :query_params => query_params,
133
+ :form_params => form_params,
134
+ :body => post_body,
135
+ :auth_names => auth_names,
136
+ :return_type => return_type
137
+ )
138
+
139
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
140
+ if @api_client.config.debugging
141
+ @api_client.config.logger.debug "API called: CommonModelScopesApi#common_model_scopes_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
142
+ end
143
+ return data, status_code, headers
144
+ end
145
+ end
146
+ end
@@ -27,8 +27,8 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
29
29
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
30
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
31
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
30
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
31
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
32
32
  # @option opts [Integer] :page_size Number of results to return per page.
33
33
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
34
34
  # @return [PaginatedCompanyList]
@@ -45,8 +45,8 @@ module MergeHRISClient
45
45
  # @option opts [String] :cursor The pagination cursor value.
46
46
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
47
47
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
48
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
49
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
48
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
49
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
50
50
  # @option opts [Integer] :page_size Number of results to return per page.
51
51
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
52
52
  # @return [Array<(PaginatedCompanyList, Integer, Hash)>] PaginatedCompanyList data, response status code and response headers
@@ -31,8 +31,8 @@ module MergeHRISClient
31
31
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
32
32
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
33
33
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
34
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
35
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
34
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
35
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
36
36
  # @option opts [Integer] :page_size Number of results to return per page.
37
37
  # @option opts [String] :payroll_run_id If provided, will only return employee payroll runs for this employee.
38
38
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
@@ -56,8 +56,8 @@ module MergeHRISClient
56
56
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
57
57
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
58
58
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
59
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
60
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
59
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
60
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
61
61
  # @option opts [Integer] :page_size Number of results to return per page.
62
62
  # @option opts [String] :payroll_run_id If provided, will only return employee payroll runs for this employee.
63
63
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.