merge_hris_client 3.0.0 → 3.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (232) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -9
  3. data/docs/AccountIntegration.md +6 -2
  4. data/docs/AsyncPassthroughApi.md +155 -0
  5. data/docs/AsyncPassthroughReciept.md +18 -0
  6. data/docs/BankInfo.md +9 -5
  7. data/docs/BankInfoApi.md +17 -13
  8. data/docs/Benefit.md +15 -5
  9. data/docs/BenefitPlanTypeEnum.md +15 -0
  10. data/docs/BenefitsApi.md +6 -6
  11. data/docs/CommonModelScopeData.md +20 -0
  12. data/docs/CommonModelScopes.md +20 -0
  13. data/docs/CommonModelScopesApi.md +157 -0
  14. data/docs/CommonModelScopesBodyRequest.md +22 -0
  15. data/docs/CommonModelScopesDisabledModels.md +26 -0
  16. data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
  17. data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
  18. data/docs/CommonModelScopesUpdateSerializer.md +18 -0
  19. data/docs/CompaniesApi.md +4 -4
  20. data/docs/Company.md +7 -3
  21. data/docs/ConditionSchema.md +30 -0
  22. data/docs/ConditionTypeEnum.md +15 -0
  23. data/docs/DataPassthroughRequest.md +1 -1
  24. data/docs/Deduction.md +11 -5
  25. data/docs/DeleteAccountApi.md +9 -9
  26. data/docs/Dependent.md +50 -0
  27. data/docs/DependentsApi.md +181 -0
  28. data/docs/Earning.md +10 -2
  29. data/docs/Employee.md +19 -15
  30. data/docs/EmployeePayrollRun.md +11 -7
  31. data/docs/EmployeePayrollRunsApi.md +4 -4
  32. data/docs/EmployeeRequest.md +16 -18
  33. data/docs/EmployeesApi.md +31 -18
  34. data/docs/EmployerBenefit.md +36 -0
  35. data/docs/EmployerBenefitsApi.md +177 -0
  36. data/docs/Employment.md +14 -10
  37. data/docs/EmploymentsApi.md +15 -11
  38. data/docs/EnabledActionsEnum.md +15 -0
  39. data/docs/EndUserDetailsRequest.md +6 -4
  40. data/docs/ForceResyncApi.md +1 -1
  41. data/docs/Group.md +8 -4
  42. data/docs/GroupsApi.md +15 -9
  43. data/docs/Issue.md +10 -8
  44. data/docs/IssuesApi.md +6 -6
  45. data/docs/LinkToken.md +1 -1
  46. data/docs/LinkedAccountCondition.md +28 -0
  47. data/docs/LinkedAccountConditionRequest.md +22 -0
  48. data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
  49. data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
  50. data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
  51. data/docs/LinkedAccountsApi.md +2 -2
  52. data/docs/Location.md +10 -6
  53. data/docs/LocationsApi.md +13 -9
  54. data/docs/MetaResponse.md +2 -0
  55. data/docs/MultipartFormFieldRequest.md +1 -1
  56. data/docs/OperatorSchema.md +20 -0
  57. data/docs/PaginatedConditionSchemaList.md +22 -0
  58. data/docs/PaginatedDependentList.md +22 -0
  59. data/docs/PaginatedEmployerBenefitList.md +22 -0
  60. data/docs/PayGroup.md +7 -3
  61. data/docs/PayGroupsApi.md +4 -4
  62. data/docs/PayrollRun.md +9 -5
  63. data/docs/PayrollRunsApi.md +14 -10
  64. data/docs/RelationshipEnum.md +15 -0
  65. data/docs/RemoteData.md +1 -1
  66. data/docs/SelectiveSyncApi.md +233 -0
  67. data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
  68. data/docs/SyncStatus.md +5 -3
  69. data/docs/SyncStatusApi.md +1 -1
  70. data/docs/Tax.md +9 -1
  71. data/docs/Team.md +8 -4
  72. data/docs/TeamsApi.md +4 -4
  73. data/docs/TimeOff.md +13 -9
  74. data/docs/TimeOffApi.md +16 -12
  75. data/docs/TimeOffBalance.md +10 -6
  76. data/docs/TimeOffBalancesApi.md +15 -11
  77. data/docs/TimeOffRequest.md +11 -9
  78. data/lib/merge_hris_client/api/async_passthrough_api.rb +160 -0
  79. data/lib/merge_hris_client/api/bank_info_api.rb +26 -12
  80. data/lib/merge_hris_client/api/benefits_api.rb +6 -6
  81. data/lib/merge_hris_client/api/common_model_scopes_api.rb +146 -0
  82. data/lib/merge_hris_client/api/companies_api.rb +4 -4
  83. data/lib/merge_hris_client/api/delete_account_api.rb +7 -7
  84. data/lib/merge_hris_client/api/dependents_api.rb +188 -0
  85. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +4 -4
  86. data/lib/merge_hris_client/api/employees_api.rb +44 -17
  87. data/lib/merge_hris_client/api/employer_benefits_api.rb +182 -0
  88. data/lib/merge_hris_client/api/employments_api.rb +24 -10
  89. data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
  90. data/lib/merge_hris_client/api/groups_api.rb +25 -8
  91. data/lib/merge_hris_client/api/issues_api.rb +6 -6
  92. data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
  93. data/lib/merge_hris_client/api/locations_api.rb +22 -8
  94. data/lib/merge_hris_client/api/pay_groups_api.rb +4 -4
  95. data/lib/merge_hris_client/api/payroll_runs_api.rb +24 -10
  96. data/lib/merge_hris_client/api/selective_sync_api.rb +225 -0
  97. data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
  98. data/lib/merge_hris_client/api/teams_api.rb +4 -4
  99. data/lib/merge_hris_client/api/time_off_api.rb +26 -12
  100. data/lib/merge_hris_client/api/time_off_balances_api.rb +24 -10
  101. data/lib/merge_hris_client/models/account_integration.rb +30 -8
  102. data/lib/merge_hris_client/models/async_passthrough_reciept.rb +223 -0
  103. data/lib/merge_hris_client/models/bank_info.rb +39 -16
  104. data/lib/merge_hris_client/models/benefit.rb +70 -14
  105. data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +48 -0
  106. data/lib/merge_hris_client/models/categories_enum.rb +3 -1
  107. data/lib/merge_hris_client/models/category_enum.rb +3 -1
  108. data/lib/merge_hris_client/models/common_model_scope_data.rb +234 -0
  109. data/lib/merge_hris_client/models/common_model_scopes.rb +234 -0
  110. data/lib/merge_hris_client/models/common_model_scopes_body_request.rb +274 -0
  111. data/lib/merge_hris_client/models/common_model_scopes_disabled_models.rb +283 -0
  112. data/lib/merge_hris_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
  113. data/lib/merge_hris_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
  114. data/lib/merge_hris_client/models/common_model_scopes_update_serializer.rb +226 -0
  115. data/lib/merge_hris_client/models/company.rb +37 -15
  116. data/lib/merge_hris_client/models/condition_schema.rb +298 -0
  117. data/lib/merge_hris_client/models/condition_type_enum.rb +50 -0
  118. data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
  119. data/lib/merge_hris_client/models/deduction.rb +50 -17
  120. data/lib/merge_hris_client/models/dependent.rb +470 -0
  121. data/lib/merge_hris_client/models/earning.rb +51 -6
  122. data/lib/merge_hris_client/models/employee.rb +51 -23
  123. data/lib/merge_hris_client/models/employee_payroll_run.rb +41 -17
  124. data/lib/merge_hris_client/models/employee_request.rb +34 -39
  125. data/lib/merge_hris_client/models/employer_benefit.rb +363 -0
  126. data/lib/merge_hris_client/models/employment.rb +44 -20
  127. data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
  128. data/lib/merge_hris_client/models/end_user_details_request.rb +21 -8
  129. data/lib/merge_hris_client/models/group.rb +38 -16
  130. data/lib/merge_hris_client/models/group_type_enum.rb +2 -1
  131. data/lib/merge_hris_client/models/issue.rb +16 -4
  132. data/lib/merge_hris_client/models/link_token.rb +0 -5
  133. data/lib/merge_hris_client/models/linked_account_condition.rb +282 -0
  134. data/lib/merge_hris_client/models/linked_account_condition_request.rb +269 -0
  135. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration.rb +221 -0
  136. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
  137. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
  138. data/lib/merge_hris_client/models/location.rb +39 -17
  139. data/lib/merge_hris_client/models/meta_response.rb +12 -1
  140. data/lib/merge_hris_client/models/multipart_form_field_request.rb +1 -1
  141. data/lib/merge_hris_client/models/operator_schema.rb +229 -0
  142. data/lib/merge_hris_client/models/paginated_condition_schema_list.rb +240 -0
  143. data/lib/merge_hris_client/models/paginated_dependent_list.rb +240 -0
  144. data/lib/merge_hris_client/models/paginated_employer_benefit_list.rb +240 -0
  145. data/lib/merge_hris_client/models/pay_frequency_enum.rb +2 -1
  146. data/lib/merge_hris_client/models/pay_group.rb +37 -15
  147. data/lib/merge_hris_client/models/pay_period_enum.rb +2 -1
  148. data/lib/merge_hris_client/models/payroll_run.rb +39 -17
  149. data/lib/merge_hris_client/models/relationship_enum.rb +46 -0
  150. data/lib/merge_hris_client/models/remote_data.rb +3 -4
  151. data/lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb +45 -0
  152. data/lib/merge_hris_client/models/sync_status.rb +13 -4
  153. data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -1
  154. data/lib/merge_hris_client/models/tax.rb +50 -5
  155. data/lib/merge_hris_client/models/team.rb +38 -15
  156. data/lib/merge_hris_client/models/time_off.rb +43 -19
  157. data/lib/merge_hris_client/models/time_off_balance.rb +40 -17
  158. data/lib/merge_hris_client/models/time_off_request.rb +36 -21
  159. data/lib/merge_hris_client/version.rb +1 -1
  160. data/lib/merge_hris_client.rb +31 -0
  161. data/spec/api/async_passthrough_api_spec.rb +59 -0
  162. data/spec/api/bank_info_api_spec.rb +8 -6
  163. data/spec/api/benefits_api_spec.rb +3 -3
  164. data/spec/api/common_model_scopes_api_spec.rb +58 -0
  165. data/spec/api/companies_api_spec.rb +2 -2
  166. data/spec/api/delete_account_api_spec.rb +2 -2
  167. data/spec/api/dependents_api_spec.rb +70 -0
  168. data/spec/api/employee_payroll_runs_api_spec.rb +2 -2
  169. data/spec/api/employees_api_spec.rb +13 -6
  170. data/spec/api/employer_benefits_api_spec.rb +68 -0
  171. data/spec/api/employments_api_spec.rb +7 -5
  172. data/spec/api/force_resync_api_spec.rb +1 -1
  173. data/spec/api/groups_api_spec.rb +7 -4
  174. data/spec/api/issues_api_spec.rb +3 -3
  175. data/spec/api/linked_accounts_api_spec.rb +1 -1
  176. data/spec/api/locations_api_spec.rb +6 -4
  177. data/spec/api/pay_groups_api_spec.rb +2 -2
  178. data/spec/api/payroll_runs_api_spec.rb +7 -5
  179. data/spec/api/selective_sync_api_spec.rb +72 -0
  180. data/spec/api/sync_status_api_spec.rb +1 -1
  181. data/spec/api/teams_api_spec.rb +2 -2
  182. data/spec/api/time_off_api_spec.rb +8 -6
  183. data/spec/api/time_off_balances_api_spec.rb +7 -5
  184. data/spec/models/account_integration_spec.rb +12 -0
  185. data/spec/models/async_passthrough_reciept_spec.rb +34 -0
  186. data/spec/models/bank_info_spec.rb +14 -2
  187. data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
  188. data/spec/models/benefit_spec.rb +31 -1
  189. data/spec/models/common_model_scope_data_spec.rb +40 -0
  190. data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
  191. data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
  192. data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
  193. data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
  194. data/spec/models/common_model_scopes_spec.rb +40 -0
  195. data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
  196. data/spec/models/company_spec.rb +14 -2
  197. data/spec/models/condition_schema_spec.rb +70 -0
  198. data/spec/models/condition_type_enum_spec.rb +28 -0
  199. data/spec/models/deduction_spec.rb +20 -2
  200. data/spec/models/dependent_spec.rb +130 -0
  201. data/spec/models/earning_spec.rb +24 -0
  202. data/spec/models/employee_payroll_run_spec.rb +14 -2
  203. data/spec/models/employee_request_spec.rb +5 -11
  204. data/spec/models/employee_spec.rb +15 -3
  205. data/spec/models/employer_benefit_spec.rb +88 -0
  206. data/spec/models/employment_spec.rb +14 -2
  207. data/spec/models/enabled_actions_enum_spec.rb +28 -0
  208. data/spec/models/end_user_details_request_spec.rb +6 -0
  209. data/spec/models/group_spec.rb +14 -2
  210. data/spec/models/issue_spec.rb +6 -0
  211. data/spec/models/linked_account_condition_request_spec.rb +46 -0
  212. data/spec/models/linked_account_condition_spec.rb +64 -0
  213. data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
  214. data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
  215. data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
  216. data/spec/models/location_spec.rb +14 -2
  217. data/spec/models/meta_response_spec.rb +6 -0
  218. data/spec/models/operator_schema_spec.rb +40 -0
  219. data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
  220. data/spec/models/paginated_dependent_list_spec.rb +46 -0
  221. data/spec/models/paginated_employer_benefit_list_spec.rb +46 -0
  222. data/spec/models/pay_group_spec.rb +14 -2
  223. data/spec/models/payroll_run_spec.rb +14 -2
  224. data/spec/models/relationship_enum_spec.rb +28 -0
  225. data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
  226. data/spec/models/sync_status_spec.rb +6 -0
  227. data/spec/models/tax_spec.rb +24 -0
  228. data/spec/models/team_spec.rb +14 -2
  229. data/spec/models/time_off_balance_spec.rb +14 -2
  230. data/spec/models/time_off_request_spec.rb +12 -6
  231. data/spec/models/time_off_spec.rb +14 -2
  232. metadata +225 -105
@@ -30,7 +30,7 @@ end
30
30
 
31
31
  api_instance = MergeHRISClient::LinkedAccountsApi.new
32
32
  opts = {
33
- category: 'accounting', # String |
33
+ category: 'accounting', # String | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage') * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage
34
34
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
35
35
  end_user_email_address: 'end_user_email_address_example', # String | If provided, will only return linked accounts associated with the given email address.
36
36
  end_user_organization_name: 'end_user_organization_name_example', # String | If provided, will only return linked accounts associated with the given organization name.
@@ -76,7 +76,7 @@ end
76
76
 
77
77
  | Name | Type | Description | Notes |
78
78
  | ---- | ---- | ----------- | ----- |
79
- | **category** | **String** | | [optional] |
79
+ | **category** | **String** | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage') * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage | [optional] |
80
80
  | **cursor** | **String** | The pagination cursor value. | [optional] |
81
81
  | **end_user_email_address** | **String** | If provided, will only return linked accounts associated with the given email address. | [optional] |
82
82
  | **end_user_organization_name** | **String** | If provided, will only return linked accounts associated with the given organization name. | [optional] |
data/docs/Location.md CHANGED
@@ -13,10 +13,12 @@
13
13
  | **city** | **String** | The location's city. | [optional] |
14
14
  | **state** | **String** | The location's state. Represents a region if outside of the US. | [optional] |
15
15
  | **zip_code** | **String** | The location's zip code or postal code. | [optional] |
16
- | **country** | [**CountryEnum**](CountryEnum.md) | The location's country. | [optional] |
17
- | **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | The location's type. Can be either WORK or HOME | [optional] |
18
- | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
16
+ | **country** | [**CountryEnum**](CountryEnum.md) | The location's country. * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia (Federated States of) * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe | [optional] |
17
+ | **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | The location's type. Can be either WORK or HOME * `HOME` - HOME * `WORK` - WORK | [optional] |
19
18
  | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
19
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
20
+ | **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
21
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
20
22
 
21
23
  ## Example
22
24
 
@@ -33,10 +35,12 @@ instance = MergeHRISClient::Location.new(
33
35
  city: New York ,
34
36
  state: NY,
35
37
  zip_code: 10027,
36
- country: USA,
38
+ country: US,
37
39
  location_type: WORK,
38
- remote_data: [{"path":"/locations","data":["Varies by platform"]}],
39
- remote_was_deleted: null
40
+ remote_was_deleted: null,
41
+ modified_at: 2021-10-16T00:00Z,
42
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
43
+ remote_data: [{"path":"/locations","data":["Varies by platform"]}]
40
44
  )
41
45
  ```
42
46
 
data/docs/LocationsApi.md CHANGED
@@ -37,11 +37,12 @@ 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
- remote_fields: 'location_type', # String | Which fields should be returned in non-normalized form.
44
- remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
43
+ remote_fields: 'location_type', # String | Deprecated. Use show_enum_origins.
44
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
45
+ show_enum_origins: 'location_type' # String | Which fields should be returned in non-normalized form.
45
46
  }
46
47
 
47
48
  begin
@@ -81,11 +82,12 @@ end
81
82
  | **cursor** | **String** | The pagination cursor value. | [optional] |
82
83
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
83
84
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
84
- | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
85
- | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
85
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
86
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
86
87
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
87
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
88
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
88
89
  | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
90
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
89
91
 
90
92
  ### Return type
91
93
 
@@ -127,7 +129,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
127
129
  id = TODO # String |
128
130
  opts = {
129
131
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
130
- remote_fields: 'location_type' # String | Which fields should be returned in non-normalized form.
132
+ remote_fields: 'location_type', # String | Deprecated. Use show_enum_origins.
133
+ show_enum_origins: 'location_type' # String | Which fields should be returned in non-normalized form.
131
134
  }
132
135
 
133
136
  begin
@@ -164,7 +167,8 @@ end
164
167
  | **x_account_token** | **String** | Token identifying the end user. | |
165
168
  | **id** | [**String**](.md) | | |
166
169
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
167
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
170
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
171
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
168
172
 
169
173
  ### Return type
170
174
 
data/docs/MetaResponse.md CHANGED
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **request_schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
8
+ | **remote_field_classes** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
8
9
  | **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) | | [optional] |
9
10
  | **has_conditional_params** | **Boolean** | | |
10
11
  | **has_required_linked_account_params** | **Boolean** | | |
@@ -16,6 +17,7 @@ require 'merge_hris_client'
16
17
 
17
18
  instance = MergeHRISClient::MetaResponse.new(
18
19
  request_schema: null,
20
+ remote_field_classes: null,
19
21
  status: null,
20
22
  has_conditional_params: null,
21
23
  has_required_linked_account_params: null
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | The name of the form field | |
8
8
  | **data** | **String** | The data for the form field. | |
9
- | **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined. | [optional] |
9
+ | **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined. * `RAW` - RAW * `BASE64` - BASE64 * `GZIP_BASE64` - GZIP_BASE64 | [optional] |
10
10
  | **file_name** | **String** | The file name of the form field, if the field is for a file. | [optional] |
11
11
  | **content_type** | **String** | The MIME type of the file, if the field is for a file. | [optional] |
12
12
 
@@ -0,0 +1,20 @@
1
+ # MergeHRISClient::OperatorSchema
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **operator** | **String** | The operator for which an operator schema is defined. | [optional][readonly] |
8
+ | **is_unique** | **Boolean** | Whether the operator can be repeated multiple times. | [optional][readonly] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'merge_hris_client'
14
+
15
+ instance = MergeHRISClient::OperatorSchema.new(
16
+ operator: null,
17
+ is_unique: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::PaginatedConditionSchemaList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array<ConditionSchema>**](ConditionSchema.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::PaginatedConditionSchemaList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::PaginatedDependentList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array<Dependent>**](Dependent.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::PaginatedDependentList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::PaginatedEmployerBenefitList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array<EmployerBenefit>**](EmployerBenefit.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::PaginatedEmployerBenefitList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
data/docs/PayGroup.md CHANGED
@@ -7,8 +7,10 @@
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
9
  | **pay_group_name** | **String** | The pay group name. | [optional] |
10
- | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
11
10
  | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
11
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
12
+ | **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
13
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
12
14
 
13
15
  ## Example
14
16
 
@@ -19,8 +21,10 @@ instance = MergeHRISClient::PayGroup.new(
19
21
  id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d,
20
22
  remote_id: 800293,
21
23
  pay_group_name: contractor,
22
- remote_data: [{"path":"/pay-group","data":["Varies by platform"]}],
23
- remote_was_deleted: null
24
+ remote_was_deleted: null,
25
+ modified_at: 2021-10-16T00:00Z,
26
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
27
+ remote_data: [{"path":"/pay-group","data":["Varies by platform"]}]
24
28
  )
25
29
  ```
26
30
 
data/docs/PayGroupsApi.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/PayrollRun.md CHANGED
@@ -6,13 +6,15 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
- | **run_state** | [**RunStateEnum**](RunStateEnum.md) | The state of the payroll run | [optional] |
10
- | **run_type** | [**RunTypeEnum**](RunTypeEnum.md) | The type of the payroll run | [optional] |
9
+ | **run_state** | [**RunStateEnum**](RunStateEnum.md) | The state of the payroll run * `PAID` - PAID * `DRAFT` - DRAFT * `APPROVED` - APPROVED * `FAILED` - FAILED * `CLOSED` - CLOSED | [optional] |
10
+ | **run_type** | [**RunTypeEnum**](RunTypeEnum.md) | The type of the payroll run * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS | [optional] |
11
11
  | **start_date** | **Time** | The day and time the payroll run started. | [optional] |
12
12
  | **end_date** | **Time** | The day and time the payroll run ended. | [optional] |
13
13
  | **check_date** | **Time** | The day and time the payroll run was checked. | [optional] |
14
- | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
15
14
  | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
15
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
16
+ | **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
17
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
16
18
 
17
19
  ## Example
18
20
 
@@ -27,8 +29,10 @@ instance = MergeHRISClient::PayrollRun.new(
27
29
  start_date: 2020-11-08T00:00Z,
28
30
  end_date: 2020-11-15T00:00Z,
29
31
  check_date: 2020-11-15T00:00Z,
30
- remote_data: [{"path":"/payroll","data":["Varies by platform"]}],
31
- remote_was_deleted: null
32
+ remote_was_deleted: null,
33
+ modified_at: 2021-10-16T00:00Z,
34
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
35
+ remote_data: [{"path":"/payroll","data":["Varies by platform"]}]
32
36
  )
33
37
  ```
34
38
 
@@ -39,12 +39,13 @@ opts = {
39
39
  ended_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs ended before this datetime.
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
- remote_fields: 'run_state', # String | Which fields should be returned in non-normalized form.
45
+ remote_fields: 'run_state', # String | Deprecated. Use show_enum_origins.
46
46
  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
47
- run_type: 'CORRECTION', # String | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
47
+ run_type: 'CORRECTION', # String | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS
48
+ show_enum_origins: 'run_state', # String | Which fields should be returned in non-normalized form.
48
49
  started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs started after this datetime.
49
50
  started_before: Time.parse('2013-10-20T19:20:30+01:00') # Time | If provided, will only return payroll runs started before this datetime.
50
51
  }
@@ -88,12 +89,13 @@ end
88
89
  | **ended_before** | **Time** | If provided, will only return payroll runs ended before this datetime. | [optional] |
89
90
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
90
91
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
91
- | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
92
- | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
92
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
93
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
93
94
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
94
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
95
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
95
96
  | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
96
- | **run_type** | **String** | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') | [optional] |
97
+ | **run_type** | **String** | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS | [optional] |
98
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
97
99
  | **started_after** | **Time** | If provided, will only return payroll runs started after this datetime. | [optional] |
98
100
  | **started_before** | **Time** | If provided, will only return payroll runs started before this datetime. | [optional] |
99
101
 
@@ -137,7 +139,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
137
139
  id = TODO # String |
138
140
  opts = {
139
141
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
140
- remote_fields: 'run_state' # String | Which fields should be returned in non-normalized form.
142
+ remote_fields: 'run_state', # String | Deprecated. Use show_enum_origins.
143
+ show_enum_origins: 'run_state' # String | Which fields should be returned in non-normalized form.
141
144
  }
142
145
 
143
146
  begin
@@ -174,7 +177,8 @@ end
174
177
  | **x_account_token** | **String** | Token identifying the end user. | |
175
178
  | **id** | [**String**](.md) | | |
176
179
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
177
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
180
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
181
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
178
182
 
179
183
  ### Return type
180
184
 
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::RelationshipEnum
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::RelationshipEnum.new()
14
+ ```
15
+
data/docs/RemoteData.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **path** | **String** | | |
8
- | **data** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
8
+ | **data** | [**AnyType**](.md) | | [optional][readonly] |
9
9
 
10
10
  ## Example
11
11
 
@@ -0,0 +1,233 @@
1
+ # MergeHRISClient::SelectiveSyncApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**selective_sync_configurations_list**](SelectiveSyncApi.md#selective_sync_configurations_list) | **GET** /selective-sync/configurations | |
8
+ | [**selective_sync_configurations_update**](SelectiveSyncApi.md#selective_sync_configurations_update) | **PUT** /selective-sync/configurations | |
9
+ | [**selective_sync_meta_list**](SelectiveSyncApi.md#selective_sync_meta_list) | **GET** /selective-sync/meta | |
10
+
11
+
12
+ ## selective_sync_configurations_list
13
+
14
+ > <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_list(x_account_token)
15
+
16
+
17
+
18
+ Get a linked account's selective syncs.
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'merge_hris_client'
25
+ # setup authorization
26
+ MergeHRISClient.configure do |config|
27
+ # Configure API key authorization: tokenAuth
28
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = MergeHRISClient::SelectiveSyncApi.new
34
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
35
+
36
+ begin
37
+
38
+ result = api_instance.selective_sync_configurations_list(x_account_token)
39
+ p result
40
+ rescue MergeHRISClient::ApiError => e
41
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list: #{e}"
42
+ end
43
+ ```
44
+
45
+ #### Using the selective_sync_configurations_list_with_http_info variant
46
+
47
+ This returns an Array which contains the response data, status code and headers.
48
+
49
+ > <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_list_with_http_info(x_account_token)
50
+
51
+ ```ruby
52
+ begin
53
+
54
+ data, status_code, headers = api_instance.selective_sync_configurations_list_with_http_info(x_account_token)
55
+ p status_code # => 2xx
56
+ p headers # => { ... }
57
+ p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
58
+ rescue MergeHRISClient::ApiError => e
59
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list_with_http_info: #{e}"
60
+ end
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ | Name | Type | Description | Notes |
66
+ | ---- | ---- | ----------- | ----- |
67
+ | **x_account_token** | **String** | Token identifying the end user. | |
68
+
69
+ ### Return type
70
+
71
+ [**Array&lt;LinkedAccountSelectiveSyncConfiguration&gt;**](LinkedAccountSelectiveSyncConfiguration.md)
72
+
73
+ ### Authorization
74
+
75
+ [tokenAuth](../README.md#tokenAuth)
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: Not defined
80
+ - **Accept**: application/json
81
+
82
+
83
+ ## selective_sync_configurations_update
84
+
85
+ > <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
86
+
87
+
88
+
89
+ Replace a linked account's selective syncs.
90
+
91
+ ### Examples
92
+
93
+ ```ruby
94
+ require 'time'
95
+ require 'merge_hris_client'
96
+ # setup authorization
97
+ MergeHRISClient.configure do |config|
98
+ # Configure API key authorization: tokenAuth
99
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
102
+ end
103
+
104
+ api_instance = MergeHRISClient::SelectiveSyncApi.new
105
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
106
+ linked_account_selective_sync_configuration_list_request = MergeHRISClient::LinkedAccountSelectiveSyncConfigurationListRequest.new({sync_configurations: [MergeHRISClient::LinkedAccountSelectiveSyncConfigurationRequest.new({linked_account_conditions: [MergeHRISClient::LinkedAccountConditionRequest.new({condition_schema_id: 'condition_schema_id_example', operator: 'operator_example', value: TODO})]})]}) # LinkedAccountSelectiveSyncConfigurationListRequest |
107
+
108
+ begin
109
+
110
+ result = api_instance.selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
111
+ p result
112
+ rescue MergeHRISClient::ApiError => e
113
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update: #{e}"
114
+ end
115
+ ```
116
+
117
+ #### Using the selective_sync_configurations_update_with_http_info variant
118
+
119
+ This returns an Array which contains the response data, status code and headers.
120
+
121
+ > <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
122
+
123
+ ```ruby
124
+ begin
125
+
126
+ data, status_code, headers = api_instance.selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
130
+ rescue MergeHRISClient::ApiError => e
131
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **x_account_token** | **String** | Token identifying the end user. | |
140
+ | **linked_account_selective_sync_configuration_list_request** | [**LinkedAccountSelectiveSyncConfigurationListRequest**](LinkedAccountSelectiveSyncConfigurationListRequest.md) | | |
141
+
142
+ ### Return type
143
+
144
+ [**Array&lt;LinkedAccountSelectiveSyncConfiguration&gt;**](LinkedAccountSelectiveSyncConfiguration.md)
145
+
146
+ ### Authorization
147
+
148
+ [tokenAuth](../README.md#tokenAuth)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: application/json
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## selective_sync_meta_list
157
+
158
+ > <PaginatedConditionSchemaList> selective_sync_meta_list(x_account_token, opts)
159
+
160
+
161
+
162
+ Get metadata for the conditions available to a linked account.
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'merge_hris_client'
169
+ # setup authorization
170
+ MergeHRISClient.configure do |config|
171
+ # Configure API key authorization: tokenAuth
172
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
173
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
174
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
175
+ end
176
+
177
+ api_instance = MergeHRISClient::SelectiveSyncApi.new
178
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
179
+ opts = {
180
+ common_model: 'common_model_example', # String |
181
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
182
+ page_size: 56 # Integer | Number of results to return per page.
183
+ }
184
+
185
+ begin
186
+
187
+ result = api_instance.selective_sync_meta_list(x_account_token, opts)
188
+ p result
189
+ rescue MergeHRISClient::ApiError => e
190
+ puts "Error when calling SelectiveSyncApi->selective_sync_meta_list: #{e}"
191
+ end
192
+ ```
193
+
194
+ #### Using the selective_sync_meta_list_with_http_info variant
195
+
196
+ This returns an Array which contains the response data, status code and headers.
197
+
198
+ > <Array(<PaginatedConditionSchemaList>, Integer, Hash)> selective_sync_meta_list_with_http_info(x_account_token, opts)
199
+
200
+ ```ruby
201
+ begin
202
+
203
+ data, status_code, headers = api_instance.selective_sync_meta_list_with_http_info(x_account_token, opts)
204
+ p status_code # => 2xx
205
+ p headers # => { ... }
206
+ p data # => <PaginatedConditionSchemaList>
207
+ rescue MergeHRISClient::ApiError => e
208
+ puts "Error when calling SelectiveSyncApi->selective_sync_meta_list_with_http_info: #{e}"
209
+ end
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ | Name | Type | Description | Notes |
215
+ | ---- | ---- | ----------- | ----- |
216
+ | **x_account_token** | **String** | Token identifying the end user. | |
217
+ | **common_model** | **String** | | [optional] |
218
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
219
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
220
+
221
+ ### Return type
222
+
223
+ [**PaginatedConditionSchemaList**](PaginatedConditionSchemaList.md)
224
+
225
+ ### Authorization
226
+
227
+ [tokenAuth](../README.md#tokenAuth)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: Not defined
232
+ - **Accept**: application/json
233
+