merge_hris_client 3.0.0 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +27 -8
- data/docs/AccountIntegration.md +6 -2
- data/docs/BankInfo.md +9 -5
- data/docs/BankInfoApi.md +15 -11
- data/docs/Benefit.md +8 -4
- data/docs/BenefitsApi.md +6 -6
- data/docs/CommonModelScopeData.md +20 -0
- data/docs/CommonModelScopes.md +20 -0
- data/docs/CommonModelScopesApi.md +157 -0
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/CommonModelScopesDisabledModels.md +26 -0
- data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
- data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
- data/docs/CommonModelScopesUpdateSerializer.md +18 -0
- data/docs/CompaniesApi.md +4 -4
- data/docs/Company.md +7 -3
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/Deduction.md +11 -5
- data/docs/Earning.md +10 -2
- data/docs/Employee.md +19 -15
- data/docs/EmployeePayrollRun.md +11 -7
- data/docs/EmployeePayrollRunsApi.md +4 -4
- data/docs/EmployeeRequest.md +16 -18
- data/docs/EmployeesApi.md +31 -18
- data/docs/Employment.md +14 -10
- data/docs/EmploymentsApi.md +13 -9
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +5 -3
- data/docs/ForceResyncApi.md +1 -1
- data/docs/Group.md +8 -4
- data/docs/GroupsApi.md +15 -9
- data/docs/Issue.md +10 -8
- data/docs/IssuesApi.md +6 -6
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountCondition.md +28 -0
- data/docs/LinkedAccountConditionRequest.md +22 -0
- data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +9 -5
- data/docs/LocationsApi.md +13 -9
- data/docs/MetaResponse.md +2 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/PayGroup.md +7 -3
- data/docs/PayGroupsApi.md +4 -4
- data/docs/PayrollRun.md +9 -5
- data/docs/PayrollRunsApi.md +14 -10
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +5 -3
- data/docs/Tax.md +9 -1
- data/docs/Team.md +8 -4
- data/docs/TeamsApi.md +4 -4
- data/docs/TimeOff.md +13 -9
- data/docs/TimeOffApi.md +16 -12
- data/docs/TimeOffBalance.md +10 -6
- data/docs/TimeOffBalancesApi.md +15 -11
- data/docs/TimeOffRequest.md +11 -9
- data/lib/merge_hris_client/api/bank_info_api.rb +24 -10
- data/lib/merge_hris_client/api/benefits_api.rb +6 -6
- data/lib/merge_hris_client/api/common_model_scopes_api.rb +146 -0
- data/lib/merge_hris_client/api/companies_api.rb +4 -4
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +4 -4
- data/lib/merge_hris_client/api/employees_api.rb +44 -17
- data/lib/merge_hris_client/api/employments_api.rb +22 -8
- data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
- data/lib/merge_hris_client/api/groups_api.rb +25 -8
- data/lib/merge_hris_client/api/issues_api.rb +6 -6
- data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_hris_client/api/locations_api.rb +22 -8
- data/lib/merge_hris_client/api/pay_groups_api.rb +4 -4
- data/lib/merge_hris_client/api/payroll_runs_api.rb +24 -10
- data/lib/merge_hris_client/api/selective_sync_api.rb +225 -0
- data/lib/merge_hris_client/api/teams_api.rb +4 -4
- data/lib/merge_hris_client/api/time_off_api.rb +26 -12
- data/lib/merge_hris_client/api/time_off_balances_api.rb +24 -10
- data/lib/merge_hris_client/models/account_integration.rb +30 -8
- data/lib/merge_hris_client/models/bank_info.rb +39 -16
- data/lib/merge_hris_client/models/benefit.rb +38 -15
- data/lib/merge_hris_client/models/categories_enum.rb +3 -1
- data/lib/merge_hris_client/models/category_enum.rb +3 -1
- data/lib/merge_hris_client/models/common_model_scope_data.rb +234 -0
- data/lib/merge_hris_client/models/common_model_scopes.rb +234 -0
- data/lib/merge_hris_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_hris_client/models/common_model_scopes_disabled_models.rb +283 -0
- data/lib/merge_hris_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
- data/lib/merge_hris_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
- data/lib/merge_hris_client/models/common_model_scopes_update_serializer.rb +226 -0
- data/lib/merge_hris_client/models/company.rb +37 -15
- data/lib/merge_hris_client/models/condition_schema.rb +298 -0
- data/lib/merge_hris_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_hris_client/models/deduction.rb +50 -17
- data/lib/merge_hris_client/models/earning.rb +51 -6
- data/lib/merge_hris_client/models/employee.rb +51 -23
- data/lib/merge_hris_client/models/employee_payroll_run.rb +41 -17
- data/lib/merge_hris_client/models/employee_request.rb +34 -39
- data/lib/merge_hris_client/models/employment.rb +44 -20
- data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_hris_client/models/end_user_details_request.rb +20 -7
- data/lib/merge_hris_client/models/group.rb +38 -16
- data/lib/merge_hris_client/models/group_type_enum.rb +2 -1
- data/lib/merge_hris_client/models/issue.rb +16 -4
- data/lib/merge_hris_client/models/link_token.rb +0 -5
- data/lib/merge_hris_client/models/linked_account_condition.rb +282 -0
- data/lib/merge_hris_client/models/linked_account_condition_request.rb +269 -0
- data/lib/merge_hris_client/models/linked_account_selective_sync_configuration.rb +221 -0
- data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
- data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
- data/lib/merge_hris_client/models/location.rb +39 -17
- data/lib/merge_hris_client/models/meta_response.rb +12 -1
- data/lib/merge_hris_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_hris_client/models/operator_schema.rb +229 -0
- data/lib/merge_hris_client/models/paginated_condition_schema_list.rb +240 -0
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +2 -1
- data/lib/merge_hris_client/models/pay_group.rb +37 -15
- data/lib/merge_hris_client/models/pay_period_enum.rb +2 -1
- data/lib/merge_hris_client/models/payroll_run.rb +39 -17
- data/lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_hris_client/models/sync_status.rb +13 -4
- data/lib/merge_hris_client/models/tax.rb +50 -5
- data/lib/merge_hris_client/models/team.rb +38 -15
- data/lib/merge_hris_client/models/time_off.rb +43 -19
- data/lib/merge_hris_client/models/time_off_balance.rb +40 -17
- data/lib/merge_hris_client/models/time_off_request.rb +36 -21
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +20 -3
- data/spec/api/bank_info_api_spec.rb +7 -5
- data/spec/api/benefits_api_spec.rb +3 -3
- data/spec/api/common_model_scopes_api_spec.rb +58 -0
- data/spec/api/companies_api_spec.rb +2 -2
- data/spec/api/employee_payroll_runs_api_spec.rb +2 -2
- data/spec/api/employees_api_spec.rb +13 -6
- data/spec/api/employments_api_spec.rb +6 -4
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/groups_api_spec.rb +7 -4
- data/spec/api/issues_api_spec.rb +3 -3
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/locations_api_spec.rb +6 -4
- data/spec/api/pay_groups_api_spec.rb +2 -2
- data/spec/api/payroll_runs_api_spec.rb +7 -5
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/api/teams_api_spec.rb +2 -2
- data/spec/api/time_off_api_spec.rb +8 -6
- data/spec/api/time_off_balances_api_spec.rb +7 -5
- data/spec/models/account_integration_spec.rb +12 -0
- data/spec/models/bank_info_spec.rb +14 -2
- data/spec/models/benefit_spec.rb +14 -2
- data/spec/models/common_model_scope_data_spec.rb +40 -0
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
- data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
- data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_spec.rb +40 -0
- data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
- data/spec/models/company_spec.rb +14 -2
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/deduction_spec.rb +20 -2
- data/spec/models/earning_spec.rb +24 -0
- data/spec/models/employee_payroll_run_spec.rb +14 -2
- data/spec/models/employee_request_spec.rb +5 -11
- data/spec/models/employee_spec.rb +15 -3
- data/spec/models/employment_spec.rb +14 -2
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/group_spec.rb +14 -2
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/linked_account_condition_request_spec.rb +46 -0
- data/spec/models/linked_account_condition_spec.rb +64 -0
- data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
- data/spec/models/location_spec.rb +14 -2
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/pay_group_spec.rb +14 -2
- data/spec/models/payroll_run_spec.rb +14 -2
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tax_spec.rb +24 -0
- data/spec/models/team_spec.rb +14 -2
- data/spec/models/time_off_balance_spec.rb +14 -2
- data/spec/models/time_off_request_spec.rb +12 -6
- data/spec/models/time_off_spec.rb +14 -2
- metadata +183 -103
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 37be8cbce0a618f7c9ac4b3c25c10dfdee66c94d6ac8783afdc0361d4b6f9963
|
4
|
+
data.tar.gz: 11752653e7ba05abcdd7ba431532f30a88e487b7ddb24ec3ff9fe3b508837b9d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 63a814a5809d1c45e1939b0519063e846fa7048e697e3da2e9e6b7d266035ae34d5feb3262fac049ab1c48480d715d9b9925393954b39fc834ca9ee8f3749624
|
7
|
+
data.tar.gz: db8918dd91a6156cc4fe7e483f19243317fac6e440ec1830e3313a9ca85eee2496a1a1b5e8f7eb12cec05fc633af257672a04a8e13ee87513f1b905a467d1fc4
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple HR Information Syst
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version: 3.
|
10
|
+
- Package version: 3.1.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build merge_hris_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./merge_hris_client-3.
|
27
|
+
gem install ./merge_hris_client-3.1.0.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./merge_hris_client-3.
|
30
|
+
(for development, run `gem install --dev ./merge_hris_client-3.1.0.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'merge_hris_client', '~> 3.
|
36
|
+
gem 'merge_hris_client', '~> 3.1.0'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -90,10 +90,10 @@ Class | Method | HTTP request | Description
|
|
90
90
|
*MergeHRISClient::BankInfoApi* | [**bank_info_retrieve**](docs/BankInfoApi.md#bank_info_retrieve) | **GET** /bank-info/{id} |
|
91
91
|
*MergeHRISClient::BenefitsApi* | [**benefits_list**](docs/BenefitsApi.md#benefits_list) | **GET** /benefits |
|
92
92
|
*MergeHRISClient::BenefitsApi* | [**benefits_retrieve**](docs/BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} |
|
93
|
+
*MergeHRISClient::CommonModelScopesApi* | [**common_model_scopes_create**](docs/CommonModelScopesApi.md#common_model_scopes_create) | **POST** /common-model-scopes |
|
94
|
+
*MergeHRISClient::CommonModelScopesApi* | [**common_model_scopes_retrieve**](docs/CommonModelScopesApi.md#common_model_scopes_retrieve) | **GET** /common-model-scopes |
|
93
95
|
*MergeHRISClient::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /companies |
|
94
96
|
*MergeHRISClient::CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id} |
|
95
|
-
*MergeHRISClient::DeductionsApi* | [**deductions_list**](docs/DeductionsApi.md#deductions_list) | **GET** /deductions |
|
96
|
-
*MergeHRISClient::DeductionsApi* | [**deductions_retrieve**](docs/DeductionsApi.md#deductions_retrieve) | **GET** /deductions/{id} |
|
97
97
|
*MergeHRISClient::DeleteAccountApi* | [**delete_account_create**](docs/DeleteAccountApi.md#delete_account_create) | **POST** /delete-account |
|
98
98
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_list**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs |
|
99
99
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_retrieve**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} |
|
@@ -120,6 +120,9 @@ Class | Method | HTTP request | Description
|
|
120
120
|
*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_list**](docs/PayrollRunsApi.md#payroll_runs_list) | **GET** /payroll-runs |
|
121
121
|
*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_retrieve**](docs/PayrollRunsApi.md#payroll_runs_retrieve) | **GET** /payroll-runs/{id} |
|
122
122
|
*MergeHRISClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key |
|
123
|
+
*MergeHRISClient::SelectiveSyncApi* | [**selective_sync_configurations_list**](docs/SelectiveSyncApi.md#selective_sync_configurations_list) | **GET** /selective-sync/configurations |
|
124
|
+
*MergeHRISClient::SelectiveSyncApi* | [**selective_sync_configurations_update**](docs/SelectiveSyncApi.md#selective_sync_configurations_update) | **PUT** /selective-sync/configurations |
|
125
|
+
*MergeHRISClient::SelectiveSyncApi* | [**selective_sync_meta_list**](docs/SelectiveSyncApi.md#selective_sync_meta_list) | **GET** /selective-sync/meta |
|
123
126
|
*MergeHRISClient::SyncStatusApi* | [**sync_status_list**](docs/SyncStatusApi.md#sync_status_list) | **GET** /sync-status |
|
124
127
|
*MergeHRISClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams |
|
125
128
|
*MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} |
|
@@ -147,7 +150,16 @@ Class | Method | HTTP request | Description
|
|
147
150
|
- [MergeHRISClient::Benefit](docs/Benefit.md)
|
148
151
|
- [MergeHRISClient::CategoriesEnum](docs/CategoriesEnum.md)
|
149
152
|
- [MergeHRISClient::CategoryEnum](docs/CategoryEnum.md)
|
153
|
+
- [MergeHRISClient::CommonModelScopeData](docs/CommonModelScopeData.md)
|
154
|
+
- [MergeHRISClient::CommonModelScopes](docs/CommonModelScopes.md)
|
155
|
+
- [MergeHRISClient::CommonModelScopesBodyRequest](docs/CommonModelScopesBodyRequest.md)
|
156
|
+
- [MergeHRISClient::CommonModelScopesDisabledModels](docs/CommonModelScopesDisabledModels.md)
|
157
|
+
- [MergeHRISClient::CommonModelScopesDisabledModelsEnabledActionsEnum](docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md)
|
158
|
+
- [MergeHRISClient::CommonModelScopesPostInnerDeserializerRequest](docs/CommonModelScopesPostInnerDeserializerRequest.md)
|
159
|
+
- [MergeHRISClient::CommonModelScopesUpdateSerializer](docs/CommonModelScopesUpdateSerializer.md)
|
150
160
|
- [MergeHRISClient::Company](docs/Company.md)
|
161
|
+
- [MergeHRISClient::ConditionSchema](docs/ConditionSchema.md)
|
162
|
+
- [MergeHRISClient::ConditionTypeEnum](docs/ConditionTypeEnum.md)
|
151
163
|
- [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
|
152
164
|
- [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
|
153
165
|
- [MergeHRISClient::DebugModeLog](docs/DebugModeLog.md)
|
@@ -163,6 +175,7 @@ Class | Method | HTTP request | Description
|
|
163
175
|
- [MergeHRISClient::Employment](docs/Employment.md)
|
164
176
|
- [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
|
165
177
|
- [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
|
178
|
+
- [MergeHRISClient::EnabledActionsEnum](docs/EnabledActionsEnum.md)
|
166
179
|
- [MergeHRISClient::EncodingEnum](docs/EncodingEnum.md)
|
167
180
|
- [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
|
168
181
|
- [MergeHRISClient::ErrorValidationProblem](docs/ErrorValidationProblem.md)
|
@@ -172,11 +185,15 @@ Class | Method | HTTP request | Description
|
|
172
185
|
- [MergeHRISClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
|
173
186
|
- [MergeHRISClient::Group](docs/Group.md)
|
174
187
|
- [MergeHRISClient::GroupTypeEnum](docs/GroupTypeEnum.md)
|
175
|
-
- [MergeHRISClient::IgnoreCommonModel](docs/IgnoreCommonModel.md)
|
176
188
|
- [MergeHRISClient::IgnoreCommonModelRequest](docs/IgnoreCommonModelRequest.md)
|
177
189
|
- [MergeHRISClient::Issue](docs/Issue.md)
|
178
190
|
- [MergeHRISClient::IssueStatusEnum](docs/IssueStatusEnum.md)
|
179
191
|
- [MergeHRISClient::LinkToken](docs/LinkToken.md)
|
192
|
+
- [MergeHRISClient::LinkedAccountCondition](docs/LinkedAccountCondition.md)
|
193
|
+
- [MergeHRISClient::LinkedAccountConditionRequest](docs/LinkedAccountConditionRequest.md)
|
194
|
+
- [MergeHRISClient::LinkedAccountSelectiveSyncConfiguration](docs/LinkedAccountSelectiveSyncConfiguration.md)
|
195
|
+
- [MergeHRISClient::LinkedAccountSelectiveSyncConfigurationListRequest](docs/LinkedAccountSelectiveSyncConfigurationListRequest.md)
|
196
|
+
- [MergeHRISClient::LinkedAccountSelectiveSyncConfigurationRequest](docs/LinkedAccountSelectiveSyncConfigurationRequest.md)
|
180
197
|
- [MergeHRISClient::LinkedAccountStatus](docs/LinkedAccountStatus.md)
|
181
198
|
- [MergeHRISClient::Location](docs/Location.md)
|
182
199
|
- [MergeHRISClient::LocationTypeEnum](docs/LocationTypeEnum.md)
|
@@ -185,11 +202,12 @@ Class | Method | HTTP request | Description
|
|
185
202
|
- [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
|
186
203
|
- [MergeHRISClient::ModelOperation](docs/ModelOperation.md)
|
187
204
|
- [MergeHRISClient::MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)
|
205
|
+
- [MergeHRISClient::OperatorSchema](docs/OperatorSchema.md)
|
188
206
|
- [MergeHRISClient::PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
|
189
207
|
- [MergeHRISClient::PaginatedBankInfoList](docs/PaginatedBankInfoList.md)
|
190
208
|
- [MergeHRISClient::PaginatedBenefitList](docs/PaginatedBenefitList.md)
|
191
209
|
- [MergeHRISClient::PaginatedCompanyList](docs/PaginatedCompanyList.md)
|
192
|
-
- [MergeHRISClient::
|
210
|
+
- [MergeHRISClient::PaginatedConditionSchemaList](docs/PaginatedConditionSchemaList.md)
|
193
211
|
- [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
|
194
212
|
- [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
|
195
213
|
- [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
|
@@ -218,6 +236,7 @@ Class | Method | HTTP request | Description
|
|
218
236
|
- [MergeHRISClient::ResponseTypeEnum](docs/ResponseTypeEnum.md)
|
219
237
|
- [MergeHRISClient::RunStateEnum](docs/RunStateEnum.md)
|
220
238
|
- [MergeHRISClient::RunTypeEnum](docs/RunTypeEnum.md)
|
239
|
+
- [MergeHRISClient::SelectiveSyncConfigurationsUsageEnum](docs/SelectiveSyncConfigurationsUsageEnum.md)
|
221
240
|
- [MergeHRISClient::SyncStatus](docs/SyncStatus.md)
|
222
241
|
- [MergeHRISClient::SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)
|
223
242
|
- [MergeHRISClient::Tax](docs/Tax.md)
|
data/docs/AccountIntegration.md
CHANGED
@@ -5,11 +5,13 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **name** | **String** | Company name. | |
|
8
|
-
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | Category or categories this integration belongs to. Multiple categories should be comma separated
|
8
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris]. | [optional] |
|
9
9
|
| **image** | **String** | Company logo in rectangular shape. <b>Upload an image with a clear background.</b> | [optional] |
|
10
10
|
| **square_image** | **String** | Company logo in square shape. <b>Upload an image with a white background.</b> | [optional] |
|
11
11
|
| **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. <b>Choose a darker, saturated color.</b> | [optional] |
|
12
12
|
| **slug** | **String** | | [optional][readonly] |
|
13
|
+
| **is_in_beta** | **Boolean** | If checked, this integration will not appear in the linking flow, and will appear elsewhere with a Beta tag. | [optional] |
|
14
|
+
| **api_endpoints_to_documentation_urls** | [**Hash<String, AnyType>**](AnyType.md) | Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []} | [optional] |
|
13
15
|
|
14
16
|
## Example
|
15
17
|
|
@@ -22,7 +24,9 @@ instance = MergeHRISClient::AccountIntegration.new(
|
|
22
24
|
image: null,
|
23
25
|
square_image: null,
|
24
26
|
color: null,
|
25
|
-
slug: null
|
27
|
+
slug: null,
|
28
|
+
is_in_beta: null,
|
29
|
+
api_endpoints_to_documentation_urls: null
|
26
30
|
)
|
27
31
|
```
|
28
32
|
|
data/docs/BankInfo.md
CHANGED
@@ -6,14 +6,16 @@
|
|
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** |
|
9
|
+
| **employee** | **String** | The employee with this bank account. | [optional] |
|
10
10
|
| **account_number** | **String** | The account number. | [optional] |
|
11
11
|
| **routing_number** | **String** | The routing number. | [optional] |
|
12
12
|
| **bank_name** | **String** | The bank name. | [optional] |
|
13
|
-
| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type | [optional] |
|
13
|
+
| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING | [optional] |
|
14
14
|
| **remote_created_at** | **Time** | When the matching bank object was created in the third party system. | [optional] |
|
15
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
15
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
16
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
18
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
19
|
|
18
20
|
## Example
|
19
21
|
|
@@ -29,8 +31,10 @@ instance = MergeHRISClient::BankInfo.new(
|
|
29
31
|
bank_name: Chase,
|
30
32
|
account_type: CHECKING,
|
31
33
|
remote_created_at: 2021-12-06T10:11:26Z,
|
32
|
-
|
33
|
-
|
34
|
+
remote_was_deleted: null,
|
35
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
36
|
+
modified_at: 2021-10-16T00:00Z,
|
37
|
+
remote_data: [{"path":"/bank-info","data":["Varies by platform"]}]
|
34
38
|
)
|
35
39
|
```
|
36
40
|
|
data/docs/BankInfoApi.md
CHANGED
@@ -32,7 +32,7 @@ end
|
|
32
32
|
api_instance = MergeHRISClient::BankInfoApi.new
|
33
33
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
34
|
opts = {
|
35
|
-
account_type: 'CHECKING', # String | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
|
35
|
+
account_type: 'CHECKING', # String | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING
|
36
36
|
bank_name: 'bank_name_example', # String | If provided, will only return BankInfo's with this bank name.
|
37
37
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
38
38
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
@@ -41,12 +41,13 @@ opts = {
|
|
41
41
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
42
42
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
43
43
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
44
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
45
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
44
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
45
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
46
46
|
order_by: '-remote_created_at', # String | Overrides the default ordering for this endpoint.
|
47
47
|
page_size: 56, # Integer | Number of results to return per page.
|
48
|
-
remote_fields: 'account_type', # String |
|
49
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
48
|
+
remote_fields: 'account_type', # String | Deprecated. Use show_enum_origins.
|
49
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
50
|
+
show_enum_origins: 'account_type' # String | Which fields should be returned in non-normalized form.
|
50
51
|
}
|
51
52
|
|
52
53
|
begin
|
@@ -81,7 +82,7 @@ end
|
|
81
82
|
| Name | Type | Description | Notes |
|
82
83
|
| ---- | ---- | ----------- | ----- |
|
83
84
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
84
|
-
| **account_type** | **String** | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') | [optional] |
|
85
|
+
| **account_type** | **String** | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING | [optional] |
|
85
86
|
| **bank_name** | **String** | If provided, will only return BankInfo's with this bank name. | [optional] |
|
86
87
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
87
88
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
@@ -90,12 +91,13 @@ end
|
|
90
91
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
91
92
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
92
93
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
93
|
-
| **modified_after** | **Time** | If provided,
|
94
|
-
| **modified_before** | **Time** | If provided,
|
94
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
95
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
95
96
|
| **order_by** | **String** | Overrides the default ordering for this endpoint. | [optional] |
|
96
97
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
97
|
-
| **remote_fields** | **String** |
|
98
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
98
99
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
100
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
99
101
|
|
100
102
|
### Return type
|
101
103
|
|
@@ -138,7 +140,8 @@ id = TODO # String |
|
|
138
140
|
opts = {
|
139
141
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
140
142
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
141
|
-
remote_fields: 'account_type' # String |
|
143
|
+
remote_fields: 'account_type', # String | Deprecated. Use show_enum_origins.
|
144
|
+
show_enum_origins: 'account_type' # String | Which fields should be returned in non-normalized form.
|
142
145
|
}
|
143
146
|
|
144
147
|
begin
|
@@ -176,7 +179,8 @@ end
|
|
176
179
|
| **id** | [**String**](.md) | | |
|
177
180
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
178
181
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
179
|
-
| **remote_fields** | **String** |
|
182
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
183
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
180
184
|
|
181
185
|
### Return type
|
182
186
|
|
data/docs/Benefit.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
|
-
| **employee** | **String** |
|
9
|
+
| **employee** | **String** | The employee on the plan. | [optional] |
|
10
10
|
| **provider_name** | **String** | The name of the benefit provider. | [optional] |
|
11
11
|
| **benefit_plan_type** | **String** | The type of benefit plan | [optional] |
|
12
12
|
| **employee_contribution** | **Float** | The employee's contribution. | [optional] |
|
13
13
|
| **company_contribution** | **Float** | The company's contribution. | [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
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
16
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
17
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
18
|
|
17
19
|
## Example
|
18
20
|
|
@@ -27,8 +29,10 @@ instance = MergeHRISClient::Benefit.new(
|
|
27
29
|
benefit_plan_type: MEDICAL,
|
28
30
|
employee_contribution: 23.65,
|
29
31
|
company_contribution: 150.0,
|
30
|
-
|
31
|
-
|
32
|
+
remote_was_deleted: null,
|
33
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
34
|
+
modified_at: 2021-10-16T00:00Z,
|
35
|
+
remote_data: [{"path":"/benefits","data":["Varies by platform"]}]
|
32
36
|
)
|
33
37
|
```
|
34
38
|
|
data/docs/BenefitsApi.md
CHANGED
@@ -35,12 +35,12 @@ opts = {
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
-
employee_id: 'employee_id_example', # String | If provided, will
|
38
|
+
employee_id: 'employee_id_example', # String | If provided, will return the benefits associated with the employee.
|
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,
|
43
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
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
45
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
46
46
|
}
|
@@ -80,12 +80,12 @@ end
|
|
80
80
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
81
81
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
82
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
83
|
-
| **employee_id** | **String** | If provided, will
|
83
|
+
| **employee_id** | **String** | If provided, will return the benefits associated with the employee. | [optional] |
|
84
84
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
85
85
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
86
86
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
87
|
-
| **modified_after** | **Time** | If provided,
|
88
|
-
| **modified_before** | **Time** | If provided,
|
87
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
88
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
89
89
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
90
90
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
91
91
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeHRISClient::CommonModelScopeData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **common_models** | [**Array<CommonModelScopesDisabledModels>**](CommonModelScopesDisabledModels.md) | | |
|
8
|
+
| **linked_account_id** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_hris_client'
|
14
|
+
|
15
|
+
instance = MergeHRISClient::CommonModelScopeData.new(
|
16
|
+
common_models: null,
|
17
|
+
linked_account_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeHRISClient::CommonModelScopes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **organization_level_scopes** | [**CommonModelScopeData**](CommonModelScopeData.md) | | [optional] |
|
8
|
+
| **scope_overrides** | [**Array<CommonModelScopeData>**](CommonModelScopeData.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_hris_client'
|
14
|
+
|
15
|
+
instance = MergeHRISClient::CommonModelScopes.new(
|
16
|
+
organization_level_scopes: null,
|
17
|
+
scope_overrides: [{"linked_account_id":"c640b80b-fac9-409f-aa19-1f9221aec445","common_models":[{"model_name":"Employee","model_id":"hris.Employee","enabled_actions":["READ","WRITE"],"is_disabled":false,"disabled_fields":["employment"]},{"model_name":"Employment","model_id":"hris.Employment","enabled_actions":[],"is_disabled":true,"disabled_fields":[]}]}]
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,157 @@
|
|
1
|
+
# MergeHRISClient::CommonModelScopesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**common_model_scopes_create**](CommonModelScopesApi.md#common_model_scopes_create) | **POST** /common-model-scopes | |
|
8
|
+
| [**common_model_scopes_retrieve**](CommonModelScopesApi.md#common_model_scopes_retrieve) | **GET** /common-model-scopes | |
|
9
|
+
|
10
|
+
|
11
|
+
## common_model_scopes_create
|
12
|
+
|
13
|
+
> <CommonModelScopes> common_model_scopes_create(common_model_scopes_update_serializer, opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
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.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'merge_hris_client'
|
24
|
+
# setup authorization
|
25
|
+
MergeHRISClient.configure do |config|
|
26
|
+
# Configure API key authorization: tokenAuth
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = MergeHRISClient::CommonModelScopesApi.new
|
33
|
+
common_model_scopes_update_serializer = MergeHRISClient::CommonModelScopesUpdateSerializer.new({common_models: [MergeHRISClient::CommonModelScopesPostInnerDeserializerRequest.new({model_id: 'hris.Employee', enabled_actions: [MergeHRISClient::EnabledActionsEnum::READ], disabled_fields: ['disabled_fields_example']})]}) # CommonModelScopesUpdateSerializer |
|
34
|
+
opts = {
|
35
|
+
linked_account_id: 'linked_account_id_example' # String | ID of specific linked account to fetch
|
36
|
+
}
|
37
|
+
|
38
|
+
begin
|
39
|
+
|
40
|
+
result = api_instance.common_model_scopes_create(common_model_scopes_update_serializer, opts)
|
41
|
+
p result
|
42
|
+
rescue MergeHRISClient::ApiError => e
|
43
|
+
puts "Error when calling CommonModelScopesApi->common_model_scopes_create: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
#### Using the common_model_scopes_create_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
50
|
+
|
51
|
+
> <Array(<CommonModelScopes>, Integer, Hash)> common_model_scopes_create_with_http_info(common_model_scopes_update_serializer, opts)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
begin
|
55
|
+
|
56
|
+
data, status_code, headers = api_instance.common_model_scopes_create_with_http_info(common_model_scopes_update_serializer, opts)
|
57
|
+
p status_code # => 2xx
|
58
|
+
p headers # => { ... }
|
59
|
+
p data # => <CommonModelScopes>
|
60
|
+
rescue MergeHRISClient::ApiError => e
|
61
|
+
puts "Error when calling CommonModelScopesApi->common_model_scopes_create_with_http_info: #{e}"
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
|
67
|
+
| Name | Type | Description | Notes |
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
69
|
+
| **common_model_scopes_update_serializer** | [**CommonModelScopesUpdateSerializer**](CommonModelScopesUpdateSerializer.md) | | |
|
70
|
+
| **linked_account_id** | **String** | ID of specific linked account to fetch | [optional] |
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
[**CommonModelScopes**](CommonModelScopes.md)
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
[tokenAuth](../README.md#tokenAuth)
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
83
|
+
- **Accept**: application/json
|
84
|
+
|
85
|
+
|
86
|
+
## common_model_scopes_retrieve
|
87
|
+
|
88
|
+
> <CommonModelScopes> common_model_scopes_retrieve(opts)
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
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.
|
93
|
+
|
94
|
+
### Examples
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
require 'time'
|
98
|
+
require 'merge_hris_client'
|
99
|
+
# setup authorization
|
100
|
+
MergeHRISClient.configure do |config|
|
101
|
+
# Configure API key authorization: tokenAuth
|
102
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
103
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
104
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
105
|
+
end
|
106
|
+
|
107
|
+
api_instance = MergeHRISClient::CommonModelScopesApi.new
|
108
|
+
opts = {
|
109
|
+
linked_account_id: 'linked_account_id_example' # String | ID of specific linked account to fetch
|
110
|
+
}
|
111
|
+
|
112
|
+
begin
|
113
|
+
|
114
|
+
result = api_instance.common_model_scopes_retrieve(opts)
|
115
|
+
p result
|
116
|
+
rescue MergeHRISClient::ApiError => e
|
117
|
+
puts "Error when calling CommonModelScopesApi->common_model_scopes_retrieve: #{e}"
|
118
|
+
end
|
119
|
+
```
|
120
|
+
|
121
|
+
#### Using the common_model_scopes_retrieve_with_http_info variant
|
122
|
+
|
123
|
+
This returns an Array which contains the response data, status code and headers.
|
124
|
+
|
125
|
+
> <Array(<CommonModelScopes>, Integer, Hash)> common_model_scopes_retrieve_with_http_info(opts)
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
begin
|
129
|
+
|
130
|
+
data, status_code, headers = api_instance.common_model_scopes_retrieve_with_http_info(opts)
|
131
|
+
p status_code # => 2xx
|
132
|
+
p headers # => { ... }
|
133
|
+
p data # => <CommonModelScopes>
|
134
|
+
rescue MergeHRISClient::ApiError => e
|
135
|
+
puts "Error when calling CommonModelScopesApi->common_model_scopes_retrieve_with_http_info: #{e}"
|
136
|
+
end
|
137
|
+
```
|
138
|
+
|
139
|
+
### Parameters
|
140
|
+
|
141
|
+
| Name | Type | Description | Notes |
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
143
|
+
| **linked_account_id** | **String** | ID of specific linked account to fetch | [optional] |
|
144
|
+
|
145
|
+
### Return type
|
146
|
+
|
147
|
+
[**CommonModelScopes**](CommonModelScopes.md)
|
148
|
+
|
149
|
+
### Authorization
|
150
|
+
|
151
|
+
[tokenAuth](../README.md#tokenAuth)
|
152
|
+
|
153
|
+
### HTTP request headers
|
154
|
+
|
155
|
+
- **Content-Type**: Not defined
|
156
|
+
- **Accept**: application/json
|
157
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeHRISClient::CommonModelScopesBodyRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model_id** | **String** | | |
|
8
|
+
| **enabled_actions** | [**Array<EnabledActionsEnum>**](EnabledActionsEnum.md) | | |
|
9
|
+
| **disabled_fields** | **Array<String>** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_hris_client'
|
15
|
+
|
16
|
+
instance = MergeHRISClient::CommonModelScopesBodyRequest.new(
|
17
|
+
model_id: hris.Employee,
|
18
|
+
enabled_actions: ["READ","WRITE"],
|
19
|
+
disabled_fields: ["first_name"]
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# MergeHRISClient::CommonModelScopesDisabledModels
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model_name** | **String** | | |
|
8
|
+
| **model_id** | **String** | | |
|
9
|
+
| **enabled_actions** | [**Array<CommonModelScopesDisabledModelsEnabledActionsEnum>**](CommonModelScopesDisabledModelsEnabledActionsEnum.md) | | |
|
10
|
+
| **is_disabled** | **Boolean** | | |
|
11
|
+
| **disabled_fields** | **Array<String>** | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'merge_hris_client'
|
17
|
+
|
18
|
+
instance = MergeHRISClient::CommonModelScopesDisabledModels.new(
|
19
|
+
model_name: null,
|
20
|
+
model_id: null,
|
21
|
+
enabled_actions: null,
|
22
|
+
is_disabled: null,
|
23
|
+
disabled_fields: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeHRISClient::CommonModelScopesDisabledModelsEnabledActionsEnum
|
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::CommonModelScopesDisabledModelsEnabledActionsEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeHRISClient::CommonModelScopesPostInnerDeserializerRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model_id** | **String** | | |
|
8
|
+
| **enabled_actions** | [**Array<EnabledActionsEnum>**](EnabledActionsEnum.md) | | |
|
9
|
+
| **disabled_fields** | **Array<String>** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_hris_client'
|
15
|
+
|
16
|
+
instance = MergeHRISClient::CommonModelScopesPostInnerDeserializerRequest.new(
|
17
|
+
model_id: hris.Employee,
|
18
|
+
enabled_actions: ["READ","WRITE"],
|
19
|
+
disabled_fields: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeHRISClient::CommonModelScopesUpdateSerializer
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **common_models** | [**Array<CommonModelScopesPostInnerDeserializerRequest>**](CommonModelScopesPostInnerDeserializerRequest.md) | The common model scopes to update. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_hris_client'
|
13
|
+
|
14
|
+
instance = MergeHRISClient::CommonModelScopesUpdateSerializer.new(
|
15
|
+
common_models: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|