merge_hris_client 3.2.1 → 3.2.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +49 -16
- data/docs/AccountDetails.md +3 -1
- data/docs/AccountDetailsAndActions.md +7 -3
- data/docs/AccountIntegration.md +8 -4
- data/docs/AdvancedMetadata.md +28 -0
- data/docs/AuditLogEvent.md +32 -0
- data/docs/AuditTrailApi.md +91 -0
- data/docs/BankInfo.md +6 -4
- data/docs/BankInfoApi.md +4 -4
- data/docs/Benefit.md +6 -4
- data/docs/CommonModelScopeAPI.md +18 -0
- data/docs/Company.md +6 -4
- data/docs/CreateFieldMappingRequest.md +28 -0
- data/docs/DataPassthroughRequest.md +4 -4
- data/docs/DebugModelLogSummary.md +1 -1
- data/docs/Deduction.md +6 -4
- data/docs/Dependent.md +6 -4
- data/docs/Earning.md +6 -4
- data/docs/Employee.md +7 -3
- data/docs/EmployeePayrollRun.md +6 -4
- data/docs/EmployeeRequest.md +2 -0
- data/docs/EmployeesApi.md +10 -4
- data/docs/EmployerBenefit.md +6 -4
- data/docs/Employment.md +6 -4
- data/docs/EmploymentsApi.md +4 -4
- data/docs/EndUserDetailsRequest.md +13 -7
- data/docs/EventTypeEnum.md +15 -0
- data/docs/ExternalTargetFieldAPI.md +22 -0
- data/docs/ExternalTargetFieldAPIResponse.md +48 -0
- data/docs/FieldMappingApi.md +455 -0
- data/docs/FieldMappingApiInstance.md +24 -0
- data/docs/FieldMappingApiInstanceRemoteField.md +22 -0
- data/docs/FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md +22 -0
- data/docs/FieldMappingApiInstanceResponse.md +48 -0
- data/docs/FieldMappingApiInstanceTargetField.md +22 -0
- data/docs/FieldMappingInstanceResponse.md +24 -0
- data/docs/FieldPermissionDeserializer.md +20 -0
- data/docs/FieldPermissionDeserializerRequest.md +20 -0
- data/docs/ForceResyncApi.md +1 -1
- data/docs/GenerateRemoteKeyRequest.md +1 -1
- data/docs/Group.md +9 -5
- data/docs/GroupsApi.md +8 -4
- data/docs/IndividualCommonModelScopeDeserializer.md +22 -0
- data/docs/IndividualCommonModelScopeDeserializerRequest.md +22 -0
- data/docs/Issue.md +1 -1
- data/docs/IssuesApi.md +5 -3
- data/docs/LinkTokenApi.md +1 -1
- data/docs/LinkedAccountCommonModelScopeDeserializerRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +6 -4
- data/docs/LocationsApi.md +6 -4
- data/docs/MetaResponse.md +1 -1
- data/docs/ModelPermissionDeserializer.md +18 -0
- data/docs/ModelPermissionDeserializerRequest.md +18 -0
- data/docs/PaginatedAuditLogEventList.md +22 -0
- data/docs/PaginatedTimesheetEntryList.md +22 -0
- data/docs/PatchedEditFieldMappingRequest.md +22 -0
- data/docs/PayGroup.md +6 -4
- data/docs/PayrollRun.md +6 -4
- data/docs/PayrollRunsApi.md +4 -4
- data/docs/RemoteEndpointInfo.md +22 -0
- data/docs/RemoteFieldAPI.md +28 -0
- data/docs/RemoteFieldAPIResponse.md +48 -0
- data/docs/RemoteKeyForRegenerationRequest.md +1 -1
- data/docs/RoleEnum.md +15 -0
- data/docs/ScopesApi.md +222 -0
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +6 -4
- data/docs/Team.md +6 -4
- data/docs/TimeOff.md +5 -3
- data/docs/TimeOffApi.md +12 -4
- data/docs/TimeOffBalance.md +6 -4
- data/docs/TimeOffBalancesApi.md +4 -4
- data/docs/TimesheetEntriesApi.md +341 -0
- data/docs/TimesheetEntry.md +38 -0
- data/docs/TimesheetEntryEndpointRequest.md +18 -0
- data/docs/TimesheetEntryRequest.md +28 -0
- data/docs/TimesheetEntryResponse.md +24 -0
- data/lib/merge_hris_client/api/audit_trail_api.rb +95 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +4 -4
- data/lib/merge_hris_client/api/employees_api.rb +13 -4
- data/lib/merge_hris_client/api/employments_api.rb +4 -4
- data/lib/merge_hris_client/api/field_mapping_api.rb +424 -0
- data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
- data/lib/merge_hris_client/api/groups_api.rb +10 -4
- data/lib/merge_hris_client/api/issues_api.rb +7 -4
- data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_hris_client/api/locations_api.rb +11 -4
- data/lib/merge_hris_client/api/payroll_runs_api.rb +4 -4
- data/lib/merge_hris_client/api/scopes_api.rb +209 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
- data/lib/merge_hris_client/api/time_off_api.rb +16 -4
- data/lib/merge_hris_client/api/time_off_balances_api.rb +4 -4
- data/lib/merge_hris_client/api/timesheet_entries_api.rb +342 -0
- data/lib/merge_hris_client/configuration.rb +4 -0
- data/lib/merge_hris_client/models/account_details.rb +14 -5
- data/lib/merge_hris_client/models/account_details_and_actions.rb +28 -4
- data/lib/merge_hris_client/models/account_integration.rb +36 -14
- data/lib/merge_hris_client/models/advanced_metadata.rb +270 -0
- data/lib/merge_hris_client/models/audit_log_event.rb +356 -0
- data/lib/merge_hris_client/models/bank_info.rb +24 -16
- data/lib/merge_hris_client/models/benefit.rb +24 -16
- data/lib/merge_hris_client/models/common_model_scope_api.rb +226 -0
- data/lib/merge_hris_client/models/company.rb +24 -16
- data/lib/merge_hris_client/models/create_field_mapping_request.rb +396 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +3 -0
- data/lib/merge_hris_client/models/deduction.rb +24 -16
- data/lib/merge_hris_client/models/dependent.rb +24 -16
- data/lib/merge_hris_client/models/earning.rb +24 -16
- data/lib/merge_hris_client/models/employee.rb +34 -15
- data/lib/merge_hris_client/models/employee_payroll_run.rb +24 -16
- data/lib/merge_hris_client/models/employee_request.rb +12 -1
- data/lib/merge_hris_client/models/employer_benefit.rb +24 -16
- data/lib/merge_hris_client/models/employment.rb +24 -16
- data/lib/merge_hris_client/models/end_user_details_request.rb +67 -6
- data/lib/merge_hris_client/models/event_type_enum.rb +81 -0
- data/lib/merge_hris_client/models/external_target_field_api.rb +239 -0
- data/lib/merge_hris_client/models/external_target_field_api_response.rb +385 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance.rb +247 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field.rb +253 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field_remote_endpoint_info.rb +241 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_response.rb +385 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_target_field.rb +251 -0
- data/lib/merge_hris_client/models/field_mapping_instance_response.rb +266 -0
- data/lib/merge_hris_client/models/field_permission_deserializer.rb +231 -0
- data/lib/merge_hris_client/models/field_permission_deserializer_request.rb +231 -0
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -0
- data/lib/merge_hris_client/models/group.rb +34 -15
- data/lib/merge_hris_client/models/individual_common_model_scope_deserializer.rb +243 -0
- data/lib/merge_hris_client/models/individual_common_model_scope_deserializer_request.rb +262 -0
- data/lib/merge_hris_client/models/linked_account_common_model_scope_deserializer_request.rb +226 -0
- data/lib/merge_hris_client/models/location.rb +24 -16
- data/lib/merge_hris_client/models/model_permission_deserializer.rb +218 -0
- data/lib/merge_hris_client/models/model_permission_deserializer_request.rb +218 -0
- data/lib/merge_hris_client/models/paginated_audit_log_event_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_timesheet_entry_list.rb +240 -0
- data/lib/merge_hris_client/models/patched_edit_field_mapping_request.rb +271 -0
- data/lib/merge_hris_client/models/pay_group.rb +24 -16
- data/lib/merge_hris_client/models/payroll_run.rb +24 -16
- data/lib/merge_hris_client/models/remote_endpoint_info.rb +253 -0
- data/lib/merge_hris_client/models/remote_field_api.rb +285 -0
- data/lib/merge_hris_client/models/remote_field_api_response.rb +385 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -0
- data/lib/merge_hris_client/models/role_enum.rb +49 -0
- data/lib/merge_hris_client/models/tax.rb +24 -16
- data/lib/merge_hris_client/models/team.rb +24 -16
- data/lib/merge_hris_client/models/time_off.rb +23 -15
- data/lib/merge_hris_client/models/time_off_balance.rb +24 -16
- data/lib/merge_hris_client/models/timesheet_entry.rb +326 -0
- data/lib/merge_hris_client/models/timesheet_entry_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/timesheet_entry_request.rb +278 -0
- data/lib/merge_hris_client/models/timesheet_entry_response.rb +266 -0
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +35 -21
- data/spec/api/audit_trail_api_spec.rb +51 -0
- data/spec/api/bank_info_api_spec.rb +2 -2
- data/spec/api/employees_api_spec.rb +5 -2
- data/spec/api/employments_api_spec.rb +2 -2
- data/spec/api/field_mapping_api_spec.rb +107 -0
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/groups_api_spec.rb +4 -2
- data/spec/api/issues_api_spec.rb +3 -2
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/locations_api_spec.rb +3 -2
- data/spec/api/payroll_runs_api_spec.rb +2 -2
- data/spec/api/scopes_api_spec.rb +68 -0
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/time_off_api_spec.rb +6 -2
- data/spec/api/time_off_balances_api_spec.rb +2 -2
- data/spec/api/timesheet_entries_api_spec.rb +99 -0
- data/spec/models/account_details_and_actions_spec.rb +12 -0
- data/spec/models/account_details_spec.rb +6 -0
- data/spec/models/account_integration_spec.rb +14 -2
- data/spec/models/advanced_metadata_spec.rb +64 -0
- data/spec/models/audit_log_event_spec.rb +76 -0
- data/spec/models/bank_info_spec.rb +12 -6
- data/spec/models/benefit_spec.rb +12 -6
- data/spec/models/common_model_scope_api_spec.rb +34 -0
- data/spec/models/company_spec.rb +11 -5
- data/spec/models/create_field_mapping_request_spec.rb +64 -0
- data/spec/models/deduction_spec.rb +12 -6
- data/spec/models/dependent_spec.rb +12 -6
- data/spec/models/earning_spec.rb +11 -5
- data/spec/models/employee_payroll_run_spec.rb +12 -6
- data/spec/models/employee_request_spec.rb +6 -0
- data/spec/models/employee_spec.rb +18 -6
- data/spec/models/employer_benefit_spec.rb +12 -6
- data/spec/models/employment_spec.rb +12 -6
- data/spec/models/end_user_details_request_spec.rb +18 -0
- data/spec/models/event_type_enum_spec.rb +28 -0
- data/spec/models/external_target_field_api_response_spec.rb +124 -0
- data/spec/models/external_target_field_api_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_remote_field_remote_endpoint_info_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_remote_field_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_response_spec.rb +124 -0
- data/spec/models/field_mapping_api_instance_spec.rb +52 -0
- data/spec/models/field_mapping_api_instance_target_field_spec.rb +46 -0
- data/spec/models/field_mapping_instance_response_spec.rb +52 -0
- data/spec/models/field_permission_deserializer_request_spec.rb +40 -0
- data/spec/models/field_permission_deserializer_spec.rb +40 -0
- data/spec/models/group_spec.rb +13 -1
- data/spec/models/individual_common_model_scope_deserializer_request_spec.rb +46 -0
- data/spec/models/individual_common_model_scope_deserializer_spec.rb +46 -0
- data/spec/models/linked_account_common_model_scope_deserializer_request_spec.rb +34 -0
- data/spec/models/location_spec.rb +12 -6
- data/spec/models/model_permission_deserializer_request_spec.rb +34 -0
- data/spec/models/model_permission_deserializer_spec.rb +34 -0
- data/spec/models/paginated_audit_log_event_list_spec.rb +46 -0
- data/spec/models/paginated_timesheet_entry_list_spec.rb +46 -0
- data/spec/models/patched_edit_field_mapping_request_spec.rb +46 -0
- data/spec/models/pay_group_spec.rb +9 -3
- data/spec/models/payroll_run_spec.rb +12 -6
- data/spec/models/remote_endpoint_info_spec.rb +46 -0
- data/spec/models/remote_field_api_response_spec.rb +124 -0
- data/spec/models/remote_field_api_spec.rb +64 -0
- data/spec/models/role_enum_spec.rb +28 -0
- data/spec/models/tax_spec.rb +12 -6
- data/spec/models/team_spec.rb +10 -4
- data/spec/models/time_off_balance_spec.rb +12 -6
- data/spec/models/time_off_spec.rb +12 -6
- data/spec/models/timesheet_entry_endpoint_request_spec.rb +34 -0
- data/spec/models/timesheet_entry_request_spec.rb +64 -0
- data/spec/models/timesheet_entry_response_spec.rb +52 -0
- data/spec/models/timesheet_entry_spec.rb +94 -0
- metadata +266 -126
@@ -0,0 +1,455 @@
|
|
1
|
+
# MergeHRISClient::FieldMappingApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**field_mappings_create**](FieldMappingApi.md#field_mappings_create) | **POST** /field-mappings | |
|
8
|
+
| [**field_mappings_destroy**](FieldMappingApi.md#field_mappings_destroy) | **DELETE** /field-mappings/{field_mapping_id} | |
|
9
|
+
| [**field_mappings_partial_update**](FieldMappingApi.md#field_mappings_partial_update) | **PATCH** /field-mappings/{field_mapping_id} | |
|
10
|
+
| [**field_mappings_retrieve**](FieldMappingApi.md#field_mappings_retrieve) | **GET** /field-mappings | |
|
11
|
+
| [**remote_fields_retrieve**](FieldMappingApi.md#remote_fields_retrieve) | **GET** /remote-fields | |
|
12
|
+
| [**target_fields_retrieve**](FieldMappingApi.md#target_fields_retrieve) | **GET** /target-fields | |
|
13
|
+
|
14
|
+
|
15
|
+
## field_mappings_create
|
16
|
+
|
17
|
+
> <FieldMappingInstanceResponse> field_mappings_create(x_account_token, create_field_mapping_request)
|
18
|
+
|
19
|
+
|
20
|
+
|
21
|
+
Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
|
22
|
+
|
23
|
+
### Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'time'
|
27
|
+
require 'merge_hris_client'
|
28
|
+
# setup authorization
|
29
|
+
MergeHRISClient.configure do |config|
|
30
|
+
# Configure API key authorization: tokenAuth
|
31
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
33
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = MergeHRISClient::FieldMappingApi.new
|
37
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
38
|
+
create_field_mapping_request = MergeHRISClient::CreateFieldMappingRequest.new({target_field_name: 'example_target_field_name', target_field_description: 'this is a example description of the target field', remote_field_traversal_path: [TODO], remote_method: 'GET', remote_url_path: '/example-url-path', common_model_name: 'ExampleCommonModel'}) # CreateFieldMappingRequest |
|
39
|
+
|
40
|
+
begin
|
41
|
+
|
42
|
+
result = api_instance.field_mappings_create(x_account_token, create_field_mapping_request)
|
43
|
+
p result
|
44
|
+
rescue MergeHRISClient::ApiError => e
|
45
|
+
puts "Error when calling FieldMappingApi->field_mappings_create: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
#### Using the field_mappings_create_with_http_info variant
|
50
|
+
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
52
|
+
|
53
|
+
> <Array(<FieldMappingInstanceResponse>, Integer, Hash)> field_mappings_create_with_http_info(x_account_token, create_field_mapping_request)
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
begin
|
57
|
+
|
58
|
+
data, status_code, headers = api_instance.field_mappings_create_with_http_info(x_account_token, create_field_mapping_request)
|
59
|
+
p status_code # => 2xx
|
60
|
+
p headers # => { ... }
|
61
|
+
p data # => <FieldMappingInstanceResponse>
|
62
|
+
rescue MergeHRISClient::ApiError => e
|
63
|
+
puts "Error when calling FieldMappingApi->field_mappings_create_with_http_info: #{e}"
|
64
|
+
end
|
65
|
+
```
|
66
|
+
|
67
|
+
### Parameters
|
68
|
+
|
69
|
+
| Name | Type | Description | Notes |
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
71
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
72
|
+
| **create_field_mapping_request** | [**CreateFieldMappingRequest**](CreateFieldMappingRequest.md) | | |
|
73
|
+
|
74
|
+
### Return type
|
75
|
+
|
76
|
+
[**FieldMappingInstanceResponse**](FieldMappingInstanceResponse.md)
|
77
|
+
|
78
|
+
### Authorization
|
79
|
+
|
80
|
+
[tokenAuth](../README.md#tokenAuth)
|
81
|
+
|
82
|
+
### HTTP request headers
|
83
|
+
|
84
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
85
|
+
- **Accept**: application/json
|
86
|
+
|
87
|
+
|
88
|
+
## field_mappings_destroy
|
89
|
+
|
90
|
+
> <FieldMappingInstanceResponse> field_mappings_destroy(x_account_token, field_mapping_id)
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
|
95
|
+
|
96
|
+
### Examples
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
require 'time'
|
100
|
+
require 'merge_hris_client'
|
101
|
+
# setup authorization
|
102
|
+
MergeHRISClient.configure do |config|
|
103
|
+
# Configure API key authorization: tokenAuth
|
104
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
105
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
106
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
107
|
+
end
|
108
|
+
|
109
|
+
api_instance = MergeHRISClient::FieldMappingApi.new
|
110
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
111
|
+
field_mapping_id = TODO # String |
|
112
|
+
|
113
|
+
begin
|
114
|
+
|
115
|
+
result = api_instance.field_mappings_destroy(x_account_token, field_mapping_id)
|
116
|
+
p result
|
117
|
+
rescue MergeHRISClient::ApiError => e
|
118
|
+
puts "Error when calling FieldMappingApi->field_mappings_destroy: #{e}"
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
#### Using the field_mappings_destroy_with_http_info variant
|
123
|
+
|
124
|
+
This returns an Array which contains the response data, status code and headers.
|
125
|
+
|
126
|
+
> <Array(<FieldMappingInstanceResponse>, Integer, Hash)> field_mappings_destroy_with_http_info(x_account_token, field_mapping_id)
|
127
|
+
|
128
|
+
```ruby
|
129
|
+
begin
|
130
|
+
|
131
|
+
data, status_code, headers = api_instance.field_mappings_destroy_with_http_info(x_account_token, field_mapping_id)
|
132
|
+
p status_code # => 2xx
|
133
|
+
p headers # => { ... }
|
134
|
+
p data # => <FieldMappingInstanceResponse>
|
135
|
+
rescue MergeHRISClient::ApiError => e
|
136
|
+
puts "Error when calling FieldMappingApi->field_mappings_destroy_with_http_info: #{e}"
|
137
|
+
end
|
138
|
+
```
|
139
|
+
|
140
|
+
### Parameters
|
141
|
+
|
142
|
+
| Name | Type | Description | Notes |
|
143
|
+
| ---- | ---- | ----------- | ----- |
|
144
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
145
|
+
| **field_mapping_id** | [**String**](.md) | | |
|
146
|
+
|
147
|
+
### Return type
|
148
|
+
|
149
|
+
[**FieldMappingInstanceResponse**](FieldMappingInstanceResponse.md)
|
150
|
+
|
151
|
+
### Authorization
|
152
|
+
|
153
|
+
[tokenAuth](../README.md#tokenAuth)
|
154
|
+
|
155
|
+
### HTTP request headers
|
156
|
+
|
157
|
+
- **Content-Type**: Not defined
|
158
|
+
- **Accept**: application/json
|
159
|
+
|
160
|
+
|
161
|
+
## field_mappings_partial_update
|
162
|
+
|
163
|
+
> <FieldMappingInstanceResponse> field_mappings_partial_update(x_account_token, field_mapping_id, opts)
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
|
168
|
+
|
169
|
+
### Examples
|
170
|
+
|
171
|
+
```ruby
|
172
|
+
require 'time'
|
173
|
+
require 'merge_hris_client'
|
174
|
+
# setup authorization
|
175
|
+
MergeHRISClient.configure do |config|
|
176
|
+
# Configure API key authorization: tokenAuth
|
177
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
178
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
179
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
180
|
+
end
|
181
|
+
|
182
|
+
api_instance = MergeHRISClient::FieldMappingApi.new
|
183
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
184
|
+
field_mapping_id = TODO # String |
|
185
|
+
opts = {
|
186
|
+
patched_edit_field_mapping_request: MergeHRISClient::PatchedEditFieldMappingRequest.new # PatchedEditFieldMappingRequest |
|
187
|
+
}
|
188
|
+
|
189
|
+
begin
|
190
|
+
|
191
|
+
result = api_instance.field_mappings_partial_update(x_account_token, field_mapping_id, opts)
|
192
|
+
p result
|
193
|
+
rescue MergeHRISClient::ApiError => e
|
194
|
+
puts "Error when calling FieldMappingApi->field_mappings_partial_update: #{e}"
|
195
|
+
end
|
196
|
+
```
|
197
|
+
|
198
|
+
#### Using the field_mappings_partial_update_with_http_info variant
|
199
|
+
|
200
|
+
This returns an Array which contains the response data, status code and headers.
|
201
|
+
|
202
|
+
> <Array(<FieldMappingInstanceResponse>, Integer, Hash)> field_mappings_partial_update_with_http_info(x_account_token, field_mapping_id, opts)
|
203
|
+
|
204
|
+
```ruby
|
205
|
+
begin
|
206
|
+
|
207
|
+
data, status_code, headers = api_instance.field_mappings_partial_update_with_http_info(x_account_token, field_mapping_id, opts)
|
208
|
+
p status_code # => 2xx
|
209
|
+
p headers # => { ... }
|
210
|
+
p data # => <FieldMappingInstanceResponse>
|
211
|
+
rescue MergeHRISClient::ApiError => e
|
212
|
+
puts "Error when calling FieldMappingApi->field_mappings_partial_update_with_http_info: #{e}"
|
213
|
+
end
|
214
|
+
```
|
215
|
+
|
216
|
+
### Parameters
|
217
|
+
|
218
|
+
| Name | Type | Description | Notes |
|
219
|
+
| ---- | ---- | ----------- | ----- |
|
220
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
221
|
+
| **field_mapping_id** | [**String**](.md) | | |
|
222
|
+
| **patched_edit_field_mapping_request** | [**PatchedEditFieldMappingRequest**](PatchedEditFieldMappingRequest.md) | | [optional] |
|
223
|
+
|
224
|
+
### Return type
|
225
|
+
|
226
|
+
[**FieldMappingInstanceResponse**](FieldMappingInstanceResponse.md)
|
227
|
+
|
228
|
+
### Authorization
|
229
|
+
|
230
|
+
[tokenAuth](../README.md#tokenAuth)
|
231
|
+
|
232
|
+
### HTTP request headers
|
233
|
+
|
234
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
235
|
+
- **Accept**: application/json
|
236
|
+
|
237
|
+
|
238
|
+
## field_mappings_retrieve
|
239
|
+
|
240
|
+
> <FieldMappingApiInstanceResponse> field_mappings_retrieve(x_account_token)
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
|
245
|
+
|
246
|
+
### Examples
|
247
|
+
|
248
|
+
```ruby
|
249
|
+
require 'time'
|
250
|
+
require 'merge_hris_client'
|
251
|
+
# setup authorization
|
252
|
+
MergeHRISClient.configure do |config|
|
253
|
+
# Configure API key authorization: tokenAuth
|
254
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
255
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
256
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
257
|
+
end
|
258
|
+
|
259
|
+
api_instance = MergeHRISClient::FieldMappingApi.new
|
260
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
261
|
+
|
262
|
+
begin
|
263
|
+
|
264
|
+
result = api_instance.field_mappings_retrieve(x_account_token)
|
265
|
+
p result
|
266
|
+
rescue MergeHRISClient::ApiError => e
|
267
|
+
puts "Error when calling FieldMappingApi->field_mappings_retrieve: #{e}"
|
268
|
+
end
|
269
|
+
```
|
270
|
+
|
271
|
+
#### Using the field_mappings_retrieve_with_http_info variant
|
272
|
+
|
273
|
+
This returns an Array which contains the response data, status code and headers.
|
274
|
+
|
275
|
+
> <Array(<FieldMappingApiInstanceResponse>, Integer, Hash)> field_mappings_retrieve_with_http_info(x_account_token)
|
276
|
+
|
277
|
+
```ruby
|
278
|
+
begin
|
279
|
+
|
280
|
+
data, status_code, headers = api_instance.field_mappings_retrieve_with_http_info(x_account_token)
|
281
|
+
p status_code # => 2xx
|
282
|
+
p headers # => { ... }
|
283
|
+
p data # => <FieldMappingApiInstanceResponse>
|
284
|
+
rescue MergeHRISClient::ApiError => e
|
285
|
+
puts "Error when calling FieldMappingApi->field_mappings_retrieve_with_http_info: #{e}"
|
286
|
+
end
|
287
|
+
```
|
288
|
+
|
289
|
+
### Parameters
|
290
|
+
|
291
|
+
| Name | Type | Description | Notes |
|
292
|
+
| ---- | ---- | ----------- | ----- |
|
293
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
294
|
+
|
295
|
+
### Return type
|
296
|
+
|
297
|
+
[**FieldMappingApiInstanceResponse**](FieldMappingApiInstanceResponse.md)
|
298
|
+
|
299
|
+
### Authorization
|
300
|
+
|
301
|
+
[tokenAuth](../README.md#tokenAuth)
|
302
|
+
|
303
|
+
### HTTP request headers
|
304
|
+
|
305
|
+
- **Content-Type**: Not defined
|
306
|
+
- **Accept**: application/json
|
307
|
+
|
308
|
+
|
309
|
+
## remote_fields_retrieve
|
310
|
+
|
311
|
+
> <RemoteFieldAPIResponse> remote_fields_retrieve(x_account_token, opts)
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
|
316
|
+
|
317
|
+
### Examples
|
318
|
+
|
319
|
+
```ruby
|
320
|
+
require 'time'
|
321
|
+
require 'merge_hris_client'
|
322
|
+
# setup authorization
|
323
|
+
MergeHRISClient.configure do |config|
|
324
|
+
# Configure API key authorization: tokenAuth
|
325
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
326
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
327
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
328
|
+
end
|
329
|
+
|
330
|
+
api_instance = MergeHRISClient::FieldMappingApi.new
|
331
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
332
|
+
opts = {
|
333
|
+
common_models: 'common_models_example', # String | A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
|
334
|
+
include_example_values: 'include_example_values_example' # String | If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
|
335
|
+
}
|
336
|
+
|
337
|
+
begin
|
338
|
+
|
339
|
+
result = api_instance.remote_fields_retrieve(x_account_token, opts)
|
340
|
+
p result
|
341
|
+
rescue MergeHRISClient::ApiError => e
|
342
|
+
puts "Error when calling FieldMappingApi->remote_fields_retrieve: #{e}"
|
343
|
+
end
|
344
|
+
```
|
345
|
+
|
346
|
+
#### Using the remote_fields_retrieve_with_http_info variant
|
347
|
+
|
348
|
+
This returns an Array which contains the response data, status code and headers.
|
349
|
+
|
350
|
+
> <Array(<RemoteFieldAPIResponse>, Integer, Hash)> remote_fields_retrieve_with_http_info(x_account_token, opts)
|
351
|
+
|
352
|
+
```ruby
|
353
|
+
begin
|
354
|
+
|
355
|
+
data, status_code, headers = api_instance.remote_fields_retrieve_with_http_info(x_account_token, opts)
|
356
|
+
p status_code # => 2xx
|
357
|
+
p headers # => { ... }
|
358
|
+
p data # => <RemoteFieldAPIResponse>
|
359
|
+
rescue MergeHRISClient::ApiError => e
|
360
|
+
puts "Error when calling FieldMappingApi->remote_fields_retrieve_with_http_info: #{e}"
|
361
|
+
end
|
362
|
+
```
|
363
|
+
|
364
|
+
### Parameters
|
365
|
+
|
366
|
+
| Name | Type | Description | Notes |
|
367
|
+
| ---- | ---- | ----------- | ----- |
|
368
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
369
|
+
| **common_models** | **String** | A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. | [optional] |
|
370
|
+
| **include_example_values** | **String** | If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. | [optional] |
|
371
|
+
|
372
|
+
### Return type
|
373
|
+
|
374
|
+
[**RemoteFieldAPIResponse**](RemoteFieldAPIResponse.md)
|
375
|
+
|
376
|
+
### Authorization
|
377
|
+
|
378
|
+
[tokenAuth](../README.md#tokenAuth)
|
379
|
+
|
380
|
+
### HTTP request headers
|
381
|
+
|
382
|
+
- **Content-Type**: Not defined
|
383
|
+
- **Accept**: application/json
|
384
|
+
|
385
|
+
|
386
|
+
## target_fields_retrieve
|
387
|
+
|
388
|
+
> <ExternalTargetFieldAPIResponse> target_fields_retrieve(x_account_token)
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
|
393
|
+
|
394
|
+
### Examples
|
395
|
+
|
396
|
+
```ruby
|
397
|
+
require 'time'
|
398
|
+
require 'merge_hris_client'
|
399
|
+
# setup authorization
|
400
|
+
MergeHRISClient.configure do |config|
|
401
|
+
# Configure API key authorization: tokenAuth
|
402
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
403
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
404
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
405
|
+
end
|
406
|
+
|
407
|
+
api_instance = MergeHRISClient::FieldMappingApi.new
|
408
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
409
|
+
|
410
|
+
begin
|
411
|
+
|
412
|
+
result = api_instance.target_fields_retrieve(x_account_token)
|
413
|
+
p result
|
414
|
+
rescue MergeHRISClient::ApiError => e
|
415
|
+
puts "Error when calling FieldMappingApi->target_fields_retrieve: #{e}"
|
416
|
+
end
|
417
|
+
```
|
418
|
+
|
419
|
+
#### Using the target_fields_retrieve_with_http_info variant
|
420
|
+
|
421
|
+
This returns an Array which contains the response data, status code and headers.
|
422
|
+
|
423
|
+
> <Array(<ExternalTargetFieldAPIResponse>, Integer, Hash)> target_fields_retrieve_with_http_info(x_account_token)
|
424
|
+
|
425
|
+
```ruby
|
426
|
+
begin
|
427
|
+
|
428
|
+
data, status_code, headers = api_instance.target_fields_retrieve_with_http_info(x_account_token)
|
429
|
+
p status_code # => 2xx
|
430
|
+
p headers # => { ... }
|
431
|
+
p data # => <ExternalTargetFieldAPIResponse>
|
432
|
+
rescue MergeHRISClient::ApiError => e
|
433
|
+
puts "Error when calling FieldMappingApi->target_fields_retrieve_with_http_info: #{e}"
|
434
|
+
end
|
435
|
+
```
|
436
|
+
|
437
|
+
### Parameters
|
438
|
+
|
439
|
+
| Name | Type | Description | Notes |
|
440
|
+
| ---- | ---- | ----------- | ----- |
|
441
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
442
|
+
|
443
|
+
### Return type
|
444
|
+
|
445
|
+
[**ExternalTargetFieldAPIResponse**](ExternalTargetFieldAPIResponse.md)
|
446
|
+
|
447
|
+
### Authorization
|
448
|
+
|
449
|
+
[tokenAuth](../README.md#tokenAuth)
|
450
|
+
|
451
|
+
### HTTP request headers
|
452
|
+
|
453
|
+
- **Content-Type**: Not defined
|
454
|
+
- **Accept**: application/json
|
455
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeHRISClient::FieldMappingApiInstance
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **is_integration_wide** | **Boolean** | | [optional][readonly] |
|
9
|
+
| **target_field** | [**FieldMappingApiInstanceTargetField**](FieldMappingApiInstanceTargetField.md) | | [optional] |
|
10
|
+
| **remote_field** | [**FieldMappingApiInstanceRemoteField**](FieldMappingApiInstanceRemoteField.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_hris_client'
|
16
|
+
|
17
|
+
instance = MergeHRISClient::FieldMappingApiInstance.new(
|
18
|
+
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
|
19
|
+
is_integration_wide: null,
|
20
|
+
target_field: null,
|
21
|
+
remote_field: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeHRISClient::FieldMappingApiInstanceRemoteField
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_key_name** | **String** | | |
|
8
|
+
| **schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
|
9
|
+
| **remote_endpoint_info** | [**FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo**](FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_hris_client'
|
15
|
+
|
16
|
+
instance = MergeHRISClient::FieldMappingApiInstanceRemoteField.new(
|
17
|
+
remote_key_name: null,
|
18
|
+
schema: null,
|
19
|
+
remote_endpoint_info: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeHRISClient::FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **method** | **String** | | |
|
8
|
+
| **url_path** | **String** | | |
|
9
|
+
| **field_traversal_path** | **Array<String>** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_hris_client'
|
15
|
+
|
16
|
+
instance = MergeHRISClient::FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.new(
|
17
|
+
method: null,
|
18
|
+
url_path: null,
|
19
|
+
field_traversal_path: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# MergeHRISClient::FieldMappingApiInstanceResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **benefit** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
8
|
+
| **employer_benefit** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
9
|
+
| **company** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
10
|
+
| **employee_payroll_run** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
11
|
+
| **employee** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
12
|
+
| **employment** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
13
|
+
| **location** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
14
|
+
| **payroll_run** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
15
|
+
| **team** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
16
|
+
| **time_off** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
17
|
+
| **time_off_balance** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
18
|
+
| **bank_info** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
19
|
+
| **pay_group** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
20
|
+
| **group** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
21
|
+
| **dependent** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
22
|
+
| **timesheet_entry** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
|
23
|
+
|
24
|
+
## Example
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
require 'merge_hris_client'
|
28
|
+
|
29
|
+
instance = MergeHRISClient::FieldMappingApiInstanceResponse.new(
|
30
|
+
benefit: null,
|
31
|
+
employer_benefit: null,
|
32
|
+
company: null,
|
33
|
+
employee_payroll_run: null,
|
34
|
+
employee: null,
|
35
|
+
employment: null,
|
36
|
+
location: null,
|
37
|
+
payroll_run: null,
|
38
|
+
team: null,
|
39
|
+
time_off: null,
|
40
|
+
time_off_balance: null,
|
41
|
+
bank_info: null,
|
42
|
+
pay_group: null,
|
43
|
+
group: null,
|
44
|
+
dependent: null,
|
45
|
+
timesheet_entry: null
|
46
|
+
)
|
47
|
+
```
|
48
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeHRISClient::FieldMappingApiInstanceTargetField
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | |
|
8
|
+
| **description** | **String** | | |
|
9
|
+
| **is_organization_wide** | **Boolean** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_hris_client'
|
15
|
+
|
16
|
+
instance = MergeHRISClient::FieldMappingApiInstanceTargetField.new(
|
17
|
+
name: null,
|
18
|
+
description: null,
|
19
|
+
is_organization_wide: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeHRISClient::FieldMappingInstanceResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**FieldMappingApiInstance**](FieldMappingApiInstance.md) | | |
|
8
|
+
| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
|
9
|
+
| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
|
10
|
+
| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_hris_client'
|
16
|
+
|
17
|
+
instance = MergeHRISClient::FieldMappingInstanceResponse.new(
|
18
|
+
model: null,
|
19
|
+
warnings: null,
|
20
|
+
errors: null,
|
21
|
+
logs: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeHRISClient::FieldPermissionDeserializer
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **enabled** | [**Array<AnyType>**](AnyType.md) | | [optional] |
|
8
|
+
| **disabled** | [**Array<AnyType>**](AnyType.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_hris_client'
|
14
|
+
|
15
|
+
instance = MergeHRISClient::FieldPermissionDeserializer.new(
|
16
|
+
enabled: null,
|
17
|
+
disabled: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeHRISClient::FieldPermissionDeserializerRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **enabled** | [**Array<AnyType>**](AnyType.md) | | [optional] |
|
8
|
+
| **disabled** | [**Array<AnyType>**](AnyType.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_hris_client'
|
14
|
+
|
15
|
+
instance = MergeHRISClient::FieldPermissionDeserializerRequest.new(
|
16
|
+
enabled: null,
|
17
|
+
disabled: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/ForceResyncApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
13
13
|
|
14
14
|
|
15
15
|
|
16
|
-
Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the
|
16
|
+
Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|