merge_hris_client 2.0.5 → 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_details_and_actions_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/account_integration.rb +30 -8
- data/lib/merge_hris_client/models/account_type_enum.rb +1 -1
- 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 +4 -2
- data/lib/merge_hris_client/models/category_enum.rb +4 -2
- 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/country_enum.rb +1 -1
- 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/earning_type_enum.rb +1 -1
- 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/employment_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/employment_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_hris_client/models/encoding_enum.rb +1 -1
- data/lib/merge_hris_client/models/end_user_details_request.rb +20 -7
- data/lib/merge_hris_client/models/ethnicity_enum.rb +1 -1
- data/lib/merge_hris_client/models/flsa_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/gender_enum.rb +1 -1
- data/lib/merge_hris_client/models/group.rb +38 -16
- data/lib/merge_hris_client/models/group_type_enum.rb +3 -2
- 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/location_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/marital_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/meta_response.rb +12 -1
- data/lib/merge_hris_client/models/method_enum.rb +1 -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_currency_enum.rb +1 -1
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +3 -2
- data/lib/merge_hris_client/models/pay_group.rb +37 -15
- data/lib/merge_hris_client/models/pay_period_enum.rb +3 -2
- data/lib/merge_hris_client/models/payroll_run.rb +39 -17
- data/lib/merge_hris_client/models/policy_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/reason_enum.rb +1 -1
- data/lib/merge_hris_client/models/request_format_enum.rb +1 -1
- data/lib/merge_hris_client/models/request_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/response_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
- data/lib/merge_hris_client/models/run_type_enum.rb +1 -1
- 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/sync_status_status_enum.rb +1 -1
- 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/models/time_off_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/units_enum.rb +1 -1
- 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
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,
|
41
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
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,
|
84
|
-
| **modified_before** | **Time** | If provided,
|
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
|
+
| **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::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
|
-
|
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":"/payroll","data":["Varies by platform"]}]
|
32
36
|
)
|
33
37
|
```
|
34
38
|
|
data/docs/PayrollRunsApi.md
CHANGED
@@ -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,
|
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
|
-
remote_fields: 'run_state', # String |
|
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,
|
92
|
-
| **modified_before** | **Time** | If provided,
|
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** |
|
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 |
|
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** |
|
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,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<LinkedAccountSelectiveSyncConfiguration>**](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<LinkedAccountSelectiveSyncConfiguration>**](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
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeHRISClient::SelectiveSyncConfigurationsUsageEnum
|
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::SelectiveSyncConfigurationsUsageEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/SyncStatus.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **next_sync_start** | **Time** | | [optional] |
|
11
11
|
| **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) | | |
|
12
12
|
| **is_initial_sync** | **Boolean** | | |
|
13
|
+
| **selective_sync_configurations_usage** | [**SelectiveSyncConfigurationsUsageEnum**](SelectiveSyncConfigurationsUsageEnum.md) | | [optional] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -17,12 +18,13 @@
|
|
17
18
|
require 'merge_hris_client'
|
18
19
|
|
19
20
|
instance = MergeHRISClient::SyncStatus.new(
|
20
|
-
model_name:
|
21
|
-
model_id:
|
21
|
+
model_name: Employee,
|
22
|
+
model_id: hris.Employee,
|
22
23
|
last_sync_start: 2021-03-30T19:44:18.695973Z,
|
23
24
|
next_sync_start: 2021-03-30T20:44:18.662942Z,
|
24
25
|
status: SYNCING,
|
25
|
-
is_initial_sync: true
|
26
|
+
is_initial_sync: true,
|
27
|
+
selective_sync_configurations_usage: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
data/docs/Tax.md
CHANGED
@@ -5,11 +5,15 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
9
|
| **employee_payroll_run** | **String** | | [optional] |
|
9
10
|
| **name** | **String** | The tax's name. | [optional] |
|
10
11
|
| **amount** | **Float** | The tax amount. | [optional] |
|
11
12
|
| **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
|
12
13
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
14
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
16
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
13
17
|
|
14
18
|
## Example
|
15
19
|
|
@@ -18,11 +22,15 @@ require 'merge_hris_client'
|
|
18
22
|
|
19
23
|
instance = MergeHRISClient::Tax.new(
|
20
24
|
id: e3a825fd-c38d-4095-a717-df98c4cb9ebc,
|
25
|
+
remote_id: 26806834,
|
21
26
|
employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
22
27
|
name: California State Income Tax,
|
23
28
|
amount: 100.25,
|
24
29
|
employer_tax: false,
|
25
|
-
remote_was_deleted: null
|
30
|
+
remote_was_deleted: null,
|
31
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
32
|
+
modified_at: 2021-10-16T00:00Z,
|
33
|
+
remote_data: null
|
26
34
|
)
|
27
35
|
```
|
28
36
|
|
data/docs/Team.md
CHANGED
@@ -7,9 +7,11 @@
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **name** | **String** | The team's name. | [optional] |
|
10
|
-
| **parent_team** | **String** |
|
11
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
|
+
| **parent_team** | **String** | The team's parent team. | [optional] |
|
12
11
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
12
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
13
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
14
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
13
15
|
|
14
16
|
## Example
|
15
17
|
|
@@ -21,8 +23,10 @@ instance = MergeHRISClient::Team.new(
|
|
21
23
|
remote_id: 19202938,
|
22
24
|
name: Engineering,
|
23
25
|
parent_team: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
|
24
|
-
|
25
|
-
|
26
|
+
remote_was_deleted: null,
|
27
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
28
|
+
modified_at: 2021-10-16T00:00Z,
|
29
|
+
remote_data: [{"path":"/teams","data":["Varies by platform"]}]
|
26
30
|
)
|
27
31
|
```
|
28
32
|
|
data/docs/TeamsApi.md
CHANGED
@@ -38,8 +38,8 @@ opts = {
|
|
38
38
|
expand: 'parent_team', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
39
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
42
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
41
|
+
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.
|
42
|
+
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.
|
43
43
|
page_size: 56, # Integer | Number of results to return per page.
|
44
44
|
parent_team_id: 'parent_team_id_example', # String | If provided, will only return teams with this parent team.
|
45
45
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
@@ -83,8 +83,8 @@ end
|
|
83
83
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
84
84
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
85
85
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
86
|
-
| **modified_after** | **Time** | If provided,
|
87
|
-
| **modified_before** | **Time** | If provided,
|
86
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
87
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
88
88
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
89
89
|
| **parent_team_id** | **String** | If provided, will only return teams with this parent team. | [optional] |
|
90
90
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
data/docs/TimeOff.md
CHANGED
@@ -6,17 +6,19 @@
|
|
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** |
|
10
|
-
| **approver** | **String** |
|
11
|
-
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
|
9
|
+
| **employee** | **String** | The employee requesting time off. | [optional] |
|
10
|
+
| **approver** | **String** | The Merge ID of the employee with the ability to approve the time off request. | [optional] |
|
11
|
+
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
|
12
12
|
| **employee_note** | **String** | The employee note for this time off request. | [optional] |
|
13
|
-
| **units** | [**UnitsEnum**](UnitsEnum.md) | The
|
14
|
-
| **amount** | **Float** | The
|
15
|
-
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
|
13
|
+
| **units** | [**UnitsEnum**](UnitsEnum.md) | The measurement that the third-party integration uses to count time requested. * `HOURS` - HOURS * `DAYS` - DAYS | [optional] |
|
14
|
+
| **amount** | **Float** | The time off quantity measured by the prescribed “units”. | [optional] |
|
15
|
+
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
16
16
|
| **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
|
17
17
|
| **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
|
18
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
19
18
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
19
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
20
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
21
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
20
22
|
|
21
23
|
## Example
|
22
24
|
|
@@ -35,8 +37,10 @@ instance = MergeHRISClient::TimeOff.new(
|
|
35
37
|
request_type: VACATION,
|
36
38
|
start_time: 2020-11-10T00:00Z,
|
37
39
|
end_time: 2020-11-17T00:00Z,
|
38
|
-
|
39
|
-
|
40
|
+
remote_was_deleted: null,
|
41
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
42
|
+
modified_at: 2021-10-16T00:00Z,
|
43
|
+
remote_data: [{"path":"/leave","data":["Varies by platform"]}]
|
40
44
|
)
|
41
45
|
```
|
42
46
|
|
data/docs/TimeOffApi.md
CHANGED
@@ -121,13 +121,14 @@ opts = {
|
|
121
121
|
expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
122
122
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
123
123
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
124
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
125
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
124
|
+
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.
|
125
|
+
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.
|
126
126
|
page_size: 56, # Integer | Number of results to return per page.
|
127
|
-
remote_fields: 'request_type', # String |
|
127
|
+
remote_fields: 'request_type', # String | Deprecated. Use show_enum_origins.
|
128
128
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
129
|
-
request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
130
|
-
|
129
|
+
request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
|
130
|
+
show_enum_origins: 'request_type', # String | Which fields should be returned in non-normalized form.
|
131
|
+
status: 'APPROVED' # String | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED
|
131
132
|
}
|
132
133
|
|
133
134
|
begin
|
@@ -170,13 +171,14 @@ end
|
|
170
171
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
171
172
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
172
173
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
173
|
-
| **modified_after** | **Time** | If provided,
|
174
|
-
| **modified_before** | **Time** | If provided,
|
174
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
175
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
175
176
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
176
|
-
| **remote_fields** | **String** |
|
177
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
177
178
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
178
|
-
| **request_type** | **String** | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
|
179
|
-
| **
|
179
|
+
| **request_type** | **String** | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
180
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
181
|
+
| **status** | **String** | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
|
180
182
|
|
181
183
|
### Return type
|
182
184
|
|
@@ -290,7 +292,8 @@ id = TODO # String |
|
|
290
292
|
opts = {
|
291
293
|
expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
292
294
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
293
|
-
remote_fields: 'request_type' # String |
|
295
|
+
remote_fields: 'request_type', # String | Deprecated. Use show_enum_origins.
|
296
|
+
show_enum_origins: 'request_type' # String | Which fields should be returned in non-normalized form.
|
294
297
|
}
|
295
298
|
|
296
299
|
begin
|
@@ -328,7 +331,8 @@ end
|
|
328
331
|
| **id** | [**String**](.md) | | |
|
329
332
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
330
333
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
331
|
-
| **remote_fields** | **String** |
|
334
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
335
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
332
336
|
|
333
337
|
### Return type
|
334
338
|
|
data/docs/TimeOffBalance.md
CHANGED
@@ -6,12 +6,14 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **employee** | **String** |
|
10
|
-
| **balance** | **Float** | The current remaining PTO balance
|
9
|
+
| **employee** | **String** | The employee the balance belongs to. | [optional] |
|
10
|
+
| **balance** | **Float** | The current remaining PTO balance, always measured in terms of hours. | [optional] |
|
11
11
|
| **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
|
12
|
-
| **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. | [optional] |
|
13
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
|
+
| **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
14
13
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
14
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
16
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
15
17
|
|
16
18
|
## Example
|
17
19
|
|
@@ -25,8 +27,10 @@ instance = MergeHRISClient::TimeOffBalance.new(
|
|
25
27
|
balance: 60.0,
|
26
28
|
used: 45.0,
|
27
29
|
policy_type: VACATION,
|
28
|
-
|
29
|
-
|
30
|
+
remote_was_deleted: null,
|
31
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
32
|
+
modified_at: 2021-10-16T00:00Z,
|
33
|
+
remote_data: [{"path":"/leave","data":["Varies by platform"]}]
|
30
34
|
)
|
31
35
|
```
|
32
36
|
|