merge_hris_client 1.0.2 → 2.0.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 +59 -19
- data/docs/AccountDetails.md +30 -0
- data/docs/AccountDetailsAndActions.md +32 -0
- data/docs/AccountDetailsAndActionsIntegration.md +32 -0
- data/docs/AccountDetailsAndActionsStatusEnum.md +15 -0
- data/docs/AccountDetailsApi.md +76 -0
- data/docs/AccountIntegration.md +4 -4
- data/docs/AccountTokenApi.md +2 -2
- data/docs/AccountTypeEnum.md +15 -0
- data/docs/AvailableActionsApi.md +2 -2
- data/docs/BankInfo.md +34 -0
- data/docs/BankInfoApi.md +189 -0
- data/docs/Benefit.md +2 -2
- data/docs/BenefitsApi.md +6 -82
- data/docs/CategoriesEnum.md +15 -0
- data/docs/{StateEnum.md → CategoryEnum.md} +2 -2
- data/docs/CompaniesApi.md +6 -4
- data/docs/DataPassthroughRequest.md +7 -3
- data/docs/DebugModeLog.md +22 -0
- data/docs/DebugModelLogSummary.md +22 -0
- data/docs/Deduction.md +2 -2
- data/docs/DeductionsApi.md +179 -0
- data/docs/DeleteAccountApi.md +3 -2
- data/docs/Earning.md +3 -3
- data/docs/EarningTypeEnum.md +15 -0
- data/docs/Employee.md +20 -14
- data/docs/EmployeeEndpointRequest.md +18 -0
- data/docs/EmployeePayrollRun.md +5 -5
- data/docs/EmployeePayrollRunsApi.md +17 -7
- data/docs/EmployeeRequest.md +21 -13
- data/docs/EmployeeResponse.md +24 -0
- data/docs/EmployeesApi.md +101 -17
- data/docs/Employment.md +3 -1
- data/docs/EmploymentsApi.md +12 -82
- data/docs/EncodingEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +4 -2
- data/docs/ErrorValidationProblem.md +24 -0
- data/docs/ForceResyncApi.md +79 -0
- data/docs/GenerateKeyApi.md +2 -2
- data/docs/Group.md +28 -0
- data/docs/GroupTypeEnum.md +15 -0
- data/docs/GroupsApi.md +177 -0
- data/docs/IgnoreCommonModel.md +20 -0
- data/docs/IgnoreCommonModelRequest.md +20 -0
- data/docs/IssuesApi.md +16 -14
- data/docs/LinkTokenApi.md +3 -3
- data/docs/LinkedAccountsApi.md +103 -0
- data/docs/Location.md +4 -0
- data/docs/LocationTypeEnum.md +15 -0
- data/docs/LocationsApi.md +6 -4
- data/docs/MultipartFormFieldRequest.md +26 -0
- data/docs/PaginatedAccountDetailsAndActionsList.md +22 -0
- data/docs/PaginatedBankInfoList.md +22 -0
- data/docs/PaginatedDeductionList.md +22 -0
- data/docs/PaginatedGroupList.md +22 -0
- data/docs/PaginatedIssueList.md +2 -2
- data/docs/PaginatedPayGroupList.md +22 -0
- data/docs/PaginatedSyncStatusList.md +2 -2
- data/docs/PassthroughApi.md +2 -2
- data/docs/PayGroup.md +24 -0
- data/docs/PayGroupsApi.md +177 -0
- data/docs/PayrollRun.md +3 -3
- data/docs/PayrollRunsApi.md +17 -5
- data/docs/PolicyTypeEnum.md +15 -0
- data/docs/{NullEnum.md → ReasonEnum.md} +2 -2
- data/docs/RegenerateKeyApi.md +2 -2
- data/docs/RequestFormatEnum.md +15 -0
- data/docs/SyncStatusApi.md +3 -75
- data/docs/Tax.md +2 -2
- data/docs/Team.md +1 -1
- data/docs/TeamsApi.md +12 -6
- data/docs/TimeOff.md +5 -5
- data/docs/TimeOffApi.md +92 -6
- data/docs/TimeOffBalance.md +5 -3
- data/docs/{TimeOffBalanceApi.md → TimeOffBalancesApi.md} +26 -22
- data/docs/TimeOffEndpointRequest.md +18 -0
- data/docs/TimeOffRequest.md +36 -0
- data/docs/TimeOffResponse.md +24 -0
- data/docs/ValidationProblemSource.md +18 -0
- data/docs/WarningValidationProblem.md +24 -0
- data/lib/merge_hris_client/api/account_details_api.rb +77 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +217 -0
- data/lib/merge_hris_client/api/benefits_api.rb +3 -69
- data/lib/merge_hris_client/api/companies_api.rb +3 -0
- data/lib/merge_hris_client/api/deductions_api.rb +185 -0
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +17 -2
- data/lib/merge_hris_client/api/employees_api.rb +103 -15
- data/lib/merge_hris_client/api/employments_api.rb +24 -69
- data/lib/merge_hris_client/api/force_resync_api.rb +84 -0
- data/lib/merge_hris_client/api/groups_api.rb +182 -0
- data/lib/merge_hris_client/api/issues_api.rb +10 -10
- data/lib/merge_hris_client/api/linked_accounts_api.rb +117 -0
- data/lib/merge_hris_client/api/locations_api.rb +3 -0
- data/lib/merge_hris_client/api/pay_groups_api.rb +182 -0
- data/lib/merge_hris_client/api/payroll_runs_api.rb +22 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +4 -66
- data/lib/merge_hris_client/api/teams_api.rb +17 -0
- data/lib/merge_hris_client/api/time_off_api.rb +95 -2
- data/lib/merge_hris_client/api/time_off_balances_api.rb +206 -0
- data/lib/merge_hris_client/configuration.rb +6 -4
- data/lib/merge_hris_client/models/account_details.rb +273 -0
- data/lib/merge_hris_client/models/account_details_and_actions.rb +302 -0
- data/lib/merge_hris_client/models/account_details_and_actions_integration.rb +310 -0
- data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +37 -0
- data/lib/merge_hris_client/models/account_integration.rb +6 -28
- data/lib/merge_hris_client/models/account_token.rb +1 -1
- data/lib/merge_hris_client/models/account_type_enum.rb +36 -0
- data/lib/merge_hris_client/models/available_actions.rb +1 -1
- data/lib/merge_hris_client/models/bank_info.rb +322 -0
- data/lib/merge_hris_client/models/benefit.rb +2 -3
- data/lib/merge_hris_client/models/categories_enum.rb +37 -0
- data/lib/merge_hris_client/models/category_enum.rb +37 -0
- data/lib/merge_hris_client/models/company.rb +1 -1
- data/lib/merge_hris_client/models/country_enum.rb +1 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +79 -9
- data/lib/merge_hris_client/models/debug_mode_log.rb +251 -0
- data/lib/merge_hris_client/models/debug_model_log_summary.rb +251 -0
- data/lib/merge_hris_client/models/deduction.rb +1 -2
- data/lib/merge_hris_client/models/earning.rb +4 -8
- data/lib/merge_hris_client/models/earning_type_enum.rb +38 -0
- data/lib/merge_hris_client/models/employee.rb +43 -14
- data/lib/merge_hris_client/models/employee_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -3
- data/lib/merge_hris_client/models/employee_request.rb +55 -14
- data/lib/merge_hris_client/models/employee_response.rb +266 -0
- data/lib/merge_hris_client/models/employment.rb +12 -2
- 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/encoding_enum.rb +36 -0
- data/lib/merge_hris_client/models/end_user_details_request.rb +113 -28
- data/lib/merge_hris_client/models/error_validation_problem.rb +260 -0
- 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/generate_remote_key_request.rb +20 -1
- data/lib/merge_hris_client/models/{benefit_request.rb → group.rb} +48 -49
- data/lib/merge_hris_client/models/group_type_enum.rb +38 -0
- data/lib/merge_hris_client/models/ignore_common_model.rb +247 -0
- data/lib/merge_hris_client/models/ignore_common_model_request.rb +256 -0
- data/lib/merge_hris_client/models/issue.rb +1 -1
- data/lib/merge_hris_client/models/issue_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/link_token.rb +1 -1
- data/lib/merge_hris_client/models/location.rb +24 -2
- data/lib/merge_hris_client/models/location_type_enum.rb +36 -0
- data/lib/merge_hris_client/models/marital_status_enum.rb +2 -2
- data/lib/merge_hris_client/models/method_enum.rb +1 -1
- data/lib/merge_hris_client/models/model_operation.rb +1 -1
- data/lib/merge_hris_client/models/multipart_form_field_request.rb +341 -0
- data/lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_bank_info_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_benefit_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_company_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_deduction_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employee_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_employment_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_group_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_issue_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_location_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_pay_group_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_payroll_run_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_sync_status_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_team_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_time_off_balance_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_time_off_list.rb +1 -1
- data/lib/merge_hris_client/models/pay_currency_enum.rb +1 -1
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +1 -2
- data/lib/merge_hris_client/models/pay_group.rb +253 -0
- data/lib/merge_hris_client/models/pay_period_enum.rb +1 -1
- data/lib/merge_hris_client/models/payroll_run.rb +1 -1
- data/lib/merge_hris_client/models/policy_type_enum.rb +40 -0
- data/lib/merge_hris_client/models/reason_enum.rb +37 -0
- data/lib/merge_hris_client/models/remote_data.rb +1 -1
- data/lib/merge_hris_client/models/remote_data_request.rb +20 -1
- data/lib/merge_hris_client/models/remote_key.rb +1 -1
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +20 -1
- data/lib/merge_hris_client/models/remote_response.rb +1 -1
- data/lib/merge_hris_client/models/request_format_enum.rb +37 -0
- data/lib/merge_hris_client/models/request_type_enum.rb +3 -1
- data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
- data/lib/merge_hris_client/models/run_type_enum.rb +1 -11
- data/lib/merge_hris_client/models/sync_status.rb +1 -1
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +3 -2
- data/lib/merge_hris_client/models/tax.rb +3 -7
- data/lib/merge_hris_client/models/team.rb +1 -2
- data/lib/merge_hris_client/models/time_off.rb +1 -3
- data/lib/merge_hris_client/models/time_off_balance.rb +15 -5
- data/lib/merge_hris_client/models/time_off_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/{employment_request.rb → time_off_request.rb} +79 -70
- data/lib/merge_hris_client/models/time_off_response.rb +266 -0
- 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/models/validation_problem_source.rb +223 -0
- data/lib/merge_hris_client/models/warning_validation_problem.rb +260 -0
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +43 -5
- data/pull_request_template.md +3 -1
- data/spec/api/account_details_api_spec.rb +45 -0
- data/spec/api/account_token_api_spec.rb +1 -1
- data/spec/api/available_actions_api_spec.rb +1 -1
- data/spec/api/bank_info_api_spec.rb +74 -0
- data/spec/api/benefits_api_spec.rb +4 -1
- data/spec/api/companies_api_spec.rb +4 -1
- data/spec/api/deductions_api_spec.rb +69 -0
- data/spec/api/employee_payroll_runs_api_spec.rb +9 -2
- data/spec/api/employees_api_spec.rb +35 -1
- data/spec/api/employments_api_spec.rb +7 -1
- data/spec/api/force_resync_api_spec.rb +46 -0
- data/spec/api/groups_api_spec.rb +68 -0
- data/spec/api/issues_api_spec.rb +5 -5
- data/spec/api/link_token_api_spec.rb +2 -2
- data/spec/api/linked_accounts_api_spec.rb +57 -0
- data/spec/api/locations_api_spec.rb +4 -1
- data/spec/api/passthrough_api_spec.rb +2 -3
- data/spec/api/pay_groups_api_spec.rb +68 -0
- data/spec/api/payroll_runs_api_spec.rb +9 -1
- data/spec/api/regenerate_key_api_spec.rb +2 -2
- data/spec/api/sync_status_api_spec.rb +2 -13
- data/spec/api/teams_api_spec.rb +7 -1
- data/spec/api/time_off_api_spec.rb +21 -2
- data/spec/api/{time_off_balance_api_spec.rb → time_off_balances_api_spec.rb} +13 -11
- data/spec/models/account_details_and_actions_integration_spec.rb +76 -0
- data/spec/models/account_details_and_actions_spec.rb +76 -0
- data/spec/models/account_details_and_actions_status_enum_spec.rb +28 -0
- data/spec/models/account_details_spec.rb +70 -0
- data/spec/models/account_integration_spec.rb +7 -1
- data/spec/models/account_token_spec.rb +7 -1
- data/spec/models/account_type_enum_spec.rb +28 -0
- data/spec/models/available_actions_spec.rb +13 -1
- data/spec/models/{employment_request_spec.rb → bank_info_spec.rb} +15 -15
- data/spec/models/benefit_plan_type_enum_spec.rb +1 -1
- data/spec/models/benefit_spec.rb +7 -1
- data/spec/models/categories_enum_spec.rb +28 -0
- data/spec/models/category_enum_spec.rb +28 -0
- data/spec/models/company_spec.rb +7 -1
- data/spec/models/country_enum_spec.rb +1 -1
- data/spec/models/data_passthrough_request_spec.rb +13 -1
- data/spec/models/debug_mode_log_spec.rb +46 -0
- data/spec/models/debug_model_log_summary_spec.rb +46 -0
- data/spec/models/deduction_spec.rb +7 -1
- data/spec/models/earning_spec.rb +7 -1
- data/spec/models/earning_type_enum_spec.rb +28 -0
- data/spec/models/{remote_key_for_regeneration_spec.rb → employee_endpoint_request_spec.rb} +8 -8
- data/spec/models/employee_payroll_run_spec.rb +7 -1
- data/spec/models/employee_request_spec.rb +30 -0
- data/spec/models/{end_user_details_spec.rb → employee_response_spec.rb} +11 -15
- data/spec/models/employee_spec.rb +37 -1
- data/spec/models/employment_spec.rb +13 -1
- data/spec/models/employment_status_enum_spec.rb +1 -1
- data/spec/models/employment_type_enum_spec.rb +1 -1
- data/spec/models/encoding_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +13 -5
- data/spec/models/error_validation_problem_spec.rb +52 -0
- data/spec/models/ethnicity_enum_spec.rb +1 -1
- data/spec/models/flsa_status_enum_spec.rb +1 -1
- data/spec/models/gender_enum_spec.rb +1 -1
- data/spec/models/{benefit_request_spec.rb → group_spec.rb} +12 -12
- data/spec/models/group_type_enum_spec.rb +28 -0
- data/spec/models/ignore_common_model_request_spec.rb +40 -0
- data/spec/models/ignore_common_model_spec.rb +40 -0
- data/spec/models/link_token_spec.rb +1 -1
- data/spec/models/location_spec.rb +19 -1
- data/spec/models/location_type_enum_spec.rb +28 -0
- data/spec/models/marital_status_enum_spec.rb +1 -1
- data/spec/models/method_enum_spec.rb +1 -1
- data/spec/models/model_operation_spec.rb +13 -1
- data/spec/models/multipart_form_field_request_spec.rb +58 -0
- data/spec/models/paginated_account_details_and_actions_list_spec.rb +46 -0
- data/spec/models/paginated_bank_info_list_spec.rb +46 -0
- data/spec/models/paginated_benefit_list_spec.rb +1 -1
- data/spec/models/paginated_company_list_spec.rb +1 -1
- data/spec/models/paginated_deduction_list_spec.rb +46 -0
- data/spec/models/paginated_employee_list_spec.rb +1 -1
- data/spec/models/paginated_employee_payroll_run_list_spec.rb +1 -1
- data/spec/models/paginated_employment_list_spec.rb +1 -1
- data/spec/models/paginated_group_list_spec.rb +46 -0
- data/spec/models/paginated_location_list_spec.rb +1 -1
- data/spec/models/paginated_pay_group_list_spec.rb +46 -0
- data/spec/models/paginated_payroll_run_list_spec.rb +1 -1
- data/spec/models/paginated_team_list_spec.rb +1 -1
- data/spec/models/paginated_time_off_list_spec.rb +1 -1
- data/spec/models/pay_currency_enum_spec.rb +1 -1
- data/spec/models/pay_frequency_enum_spec.rb +1 -1
- data/spec/models/{data_passthrough_spec.rb → pay_group_spec.rb} +11 -11
- data/spec/models/pay_period_enum_spec.rb +1 -1
- data/spec/models/payroll_run_spec.rb +7 -1
- data/spec/models/policy_type_enum_spec.rb +28 -0
- data/spec/models/{state_enum_spec.rb → reason_enum_spec.rb} +7 -7
- data/spec/models/remote_data_spec.rb +1 -1
- data/spec/models/remote_key_for_regeneration_request_spec.rb +1 -1
- data/spec/models/remote_key_spec.rb +1 -1
- data/spec/models/remote_response_spec.rb +1 -1
- data/spec/models/request_format_enum_spec.rb +28 -0
- data/spec/models/request_type_enum_spec.rb +1 -1
- data/spec/models/run_state_enum_spec.rb +1 -1
- data/spec/models/run_type_enum_spec.rb +1 -1
- data/spec/models/tax_spec.rb +7 -1
- data/spec/models/team_spec.rb +13 -1
- data/spec/models/time_off_balance_spec.rb +6 -0
- data/spec/models/time_off_endpoint_request_spec.rb +34 -0
- data/spec/models/time_off_request_spec.rb +88 -0
- data/spec/models/time_off_response_spec.rb +52 -0
- data/spec/models/time_off_spec.rb +19 -1
- data/spec/models/time_off_status_enum_spec.rb +1 -1
- data/spec/models/type_enum_spec.rb +1 -1
- data/spec/models/units_enum_spec.rb +1 -1
- data/spec/models/validation_problem_source_spec.rb +34 -0
- data/spec/models/warning_validation_problem_spec.rb +52 -0
- data/test_ruby.rb +11 -14
- metadata +175 -29
- data/docs/BenefitRequest.md +0 -28
- data/docs/DataPassthrough.md +0 -24
- data/docs/EmploymentRequest.md +0 -34
- data/docs/EndUserDetails.md +0 -24
- data/docs/RemoteKeyForRegeneration.md +0 -18
- data/merge_hris_client-1.0.0.gem +0 -0
- data/merge_hris_client-1.0.1.gem +0 -0
data/docs/RegenerateKeyApi.md
CHANGED
@@ -23,9 +23,9 @@ require 'merge_hris_client'
|
|
23
23
|
# setup authorization
|
24
24
|
MergeHRISClient.configure do |config|
|
25
25
|
# Configure API key authorization: tokenAuth
|
26
|
-
config.api_key['
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
27
27
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
-
# config.api_key_prefix['
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
29
29
|
end
|
30
30
|
|
31
31
|
api_instance = MergeHRISClient::RegenerateKeyApi.new
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeHRISClient::RequestFormatEnum
|
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::RequestFormatEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/SyncStatusApi.md
CHANGED
@@ -5,7 +5,6 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**sync_status_list**](SyncStatusApi.md#sync_status_list) | **GET** /sync-status | |
|
8
|
-
| [**sync_status_resync_create**](SyncStatusApi.md#sync_status_resync_create) | **POST** /sync-status/resync | |
|
9
8
|
|
10
9
|
|
11
10
|
## sync_status_list
|
@@ -14,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
14
13
|
|
15
14
|
|
16
15
|
|
17
|
-
Get syncing status.
|
16
|
+
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
|
18
17
|
|
19
18
|
### Examples
|
20
19
|
|
@@ -32,7 +31,7 @@ end
|
|
32
31
|
api_instance = MergeHRISClient::SyncStatusApi.new
|
33
32
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
33
|
opts = {
|
35
|
-
cursor:
|
34
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
36
35
|
page_size: 56 # Integer | Number of results to return per page.
|
37
36
|
}
|
38
37
|
|
@@ -68,7 +67,7 @@ end
|
|
68
67
|
| Name | Type | Description | Notes |
|
69
68
|
| ---- | ---- | ----------- | ----- |
|
70
69
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
71
|
-
| **cursor** | **
|
70
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
72
71
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
73
72
|
|
74
73
|
### Return type
|
@@ -84,74 +83,3 @@ end
|
|
84
83
|
- **Content-Type**: Not defined
|
85
84
|
- **Accept**: application/json
|
86
85
|
|
87
|
-
|
88
|
-
## sync_status_resync_create
|
89
|
-
|
90
|
-
> <SyncStatus> sync_status_resync_create(x_account_token)
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
Force resync of all models.
|
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::SyncStatusApi.new
|
110
|
-
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
111
|
-
|
112
|
-
begin
|
113
|
-
|
114
|
-
result = api_instance.sync_status_resync_create(x_account_token)
|
115
|
-
p result
|
116
|
-
rescue MergeHRISClient::ApiError => e
|
117
|
-
puts "Error when calling SyncStatusApi->sync_status_resync_create: #{e}"
|
118
|
-
end
|
119
|
-
```
|
120
|
-
|
121
|
-
#### Using the sync_status_resync_create_with_http_info variant
|
122
|
-
|
123
|
-
This returns an Array which contains the response data, status code and headers.
|
124
|
-
|
125
|
-
> <Array(<SyncStatus>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
|
126
|
-
|
127
|
-
```ruby
|
128
|
-
begin
|
129
|
-
|
130
|
-
data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
|
131
|
-
p status_code # => 2xx
|
132
|
-
p headers # => { ... }
|
133
|
-
p data # => <SyncStatus>
|
134
|
-
rescue MergeHRISClient::ApiError => e
|
135
|
-
puts "Error when calling SyncStatusApi->sync_status_resync_create_with_http_info: #{e}"
|
136
|
-
end
|
137
|
-
```
|
138
|
-
|
139
|
-
### Parameters
|
140
|
-
|
141
|
-
| Name | Type | Description | Notes |
|
142
|
-
| ---- | ---- | ----------- | ----- |
|
143
|
-
| **x_account_token** | **String** | Token identifying the end user. | |
|
144
|
-
|
145
|
-
### Return type
|
146
|
-
|
147
|
-
[**SyncStatus**](SyncStatus.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
|
-
|
data/docs/Tax.md
CHANGED
@@ -5,11 +5,11 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
|
-
| **employee_payroll_run** | **String** |
|
8
|
+
| **employee_payroll_run** | **String** | | [optional] |
|
9
9
|
| **name** | **String** | The tax's name. | [optional] |
|
10
10
|
| **amount** | **Float** | The tax amount. | [optional] |
|
11
11
|
| **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
|
12
|
-
| **remote_data** | **
|
12
|
+
| **remote_data** | **String** | | [optional][readonly] |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
data/docs/Team.md
CHANGED
@@ -7,7 +7,7 @@
|
|
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** |
|
10
|
+
| **parent_team** | **String** | | [optional] |
|
11
11
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
12
|
|
13
13
|
## Example
|
data/docs/TeamsApi.md
CHANGED
@@ -24,9 +24,9 @@ require 'merge_hris_client'
|
|
24
24
|
# setup authorization
|
25
25
|
MergeHRISClient.configure do |config|
|
26
26
|
# Configure API key authorization: tokenAuth
|
27
|
-
config.api_key['
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
-
# config.api_key_prefix['
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
30
|
end
|
31
31
|
|
32
32
|
api_instance = MergeHRISClient::TeamsApi.new
|
@@ -35,11 +35,13 @@ 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
|
+
expand: 'parent_team', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
38
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
39
41
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
40
42
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
41
43
|
page_size: 56, # Integer | Number of results to return per page.
|
42
|
-
parent_team_id:
|
44
|
+
parent_team_id: 'parent_team_id_example', # String | If provided, will only return teams with this parent team.
|
43
45
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
44
46
|
}
|
45
47
|
|
@@ -78,11 +80,13 @@ end
|
|
78
80
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
81
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
83
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
84
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
81
85
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
82
86
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
83
87
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
84
88
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
85
|
-
| **parent_team_id** |
|
89
|
+
| **parent_team_id** | **String** | If provided, will only return teams with this parent team. | [optional] |
|
86
90
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
87
91
|
|
88
92
|
### Return type
|
@@ -115,15 +119,16 @@ require 'merge_hris_client'
|
|
115
119
|
# setup authorization
|
116
120
|
MergeHRISClient.configure do |config|
|
117
121
|
# Configure API key authorization: tokenAuth
|
118
|
-
config.api_key['
|
122
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
119
123
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
120
|
-
# config.api_key_prefix['
|
124
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
121
125
|
end
|
122
126
|
|
123
127
|
api_instance = MergeHRISClient::TeamsApi.new
|
124
128
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
125
129
|
id = TODO # String |
|
126
130
|
opts = {
|
131
|
+
expand: 'parent_team', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
127
132
|
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
128
133
|
}
|
129
134
|
|
@@ -160,6 +165,7 @@ end
|
|
160
165
|
| ---- | ---- | ----------- | ----- |
|
161
166
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
162
167
|
| **id** | [**String**](.md) | | |
|
168
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
163
169
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
164
170
|
|
165
171
|
### Return type
|
data/docs/TimeOff.md
CHANGED
@@ -6,8 +6,8 @@
|
|
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** |
|
9
|
+
| **employee** | **String** | | [optional] |
|
10
|
+
| **approver** | **String** | | [optional] |
|
11
11
|
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
|
12
12
|
| **employee_note** | **String** | The employee note for this time off request. | [optional] |
|
13
13
|
| **units** | [**UnitsEnum**](UnitsEnum.md) | The unit of time requested. | [optional] |
|
@@ -30,10 +30,10 @@ instance = MergeHRISClient::TimeOff.new(
|
|
30
30
|
status: APPROVED,
|
31
31
|
employee_note: Trip to Iowa. Miss those cornfields!,
|
32
32
|
units: DAYS,
|
33
|
-
amount:
|
33
|
+
amount: 7,
|
34
34
|
request_type: VACATION,
|
35
|
-
start_time:
|
36
|
-
end_time:
|
35
|
+
start_time: 2020-11-10T00:00Z,
|
36
|
+
end_time: 2020-11-17T00:00Z,
|
37
37
|
remote_data: [{"path":"/leave","data":["Varies by platform"]}]
|
38
38
|
)
|
39
39
|
```
|
data/docs/TimeOffApi.md
CHANGED
@@ -4,10 +4,90 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**time_off_create**](TimeOffApi.md#time_off_create) | **POST** /time-off | |
|
7
8
|
| [**time_off_list**](TimeOffApi.md#time_off_list) | **GET** /time-off | |
|
8
9
|
| [**time_off_retrieve**](TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} | |
|
9
10
|
|
10
11
|
|
12
|
+
## time_off_create
|
13
|
+
|
14
|
+
> <TimeOffResponse> time_off_create(x_account_token, time_off_endpoint_request, opts)
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
Creates a `TimeOff` object with the given values.
|
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::TimeOffApi.new
|
34
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
+
time_off_endpoint_request = MergeHRISClient::TimeOffEndpointRequest.new({model: MergeHRISClient::TimeOffRequest.new}) # TimeOffEndpointRequest |
|
36
|
+
opts = {
|
37
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
38
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
|
43
|
+
result = api_instance.time_off_create(x_account_token, time_off_endpoint_request, opts)
|
44
|
+
p result
|
45
|
+
rescue MergeHRISClient::ApiError => e
|
46
|
+
puts "Error when calling TimeOffApi->time_off_create: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the time_off_create_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
53
|
+
|
54
|
+
> <Array(<TimeOffResponse>, Integer, Hash)> time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
|
59
|
+
data, status_code, headers = api_instance.time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <TimeOffResponse>
|
63
|
+
rescue MergeHRISClient::ApiError => e
|
64
|
+
puts "Error when calling TimeOffApi->time_off_create_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
73
|
+
| **time_off_endpoint_request** | [**TimeOffEndpointRequest**](TimeOffEndpointRequest.md) | | |
|
74
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
75
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
76
|
+
|
77
|
+
### Return type
|
78
|
+
|
79
|
+
[**TimeOffResponse**](TimeOffResponse.md)
|
80
|
+
|
81
|
+
### Authorization
|
82
|
+
|
83
|
+
[tokenAuth](../README.md#tokenAuth)
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
90
|
+
|
11
91
|
## time_off_list
|
12
92
|
|
13
93
|
> <PaginatedTimeOffList> time_off_list(x_account_token, opts)
|
@@ -24,9 +104,9 @@ require 'merge_hris_client'
|
|
24
104
|
# setup authorization
|
25
105
|
MergeHRISClient.configure do |config|
|
26
106
|
# Configure API key authorization: tokenAuth
|
27
|
-
config.api_key['
|
107
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
108
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
-
# config.api_key_prefix['
|
109
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
110
|
end
|
31
111
|
|
32
112
|
api_instance = MergeHRISClient::TimeOffApi.new
|
@@ -38,11 +118,14 @@ opts = {
|
|
38
118
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
39
119
|
employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
|
40
120
|
expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
121
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
41
122
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
123
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
43
124
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
44
125
|
page_size: 56, # Integer | Number of results to return per page.
|
45
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
126
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
127
|
+
request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
128
|
+
status: 'APPROVED' # String | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')
|
46
129
|
}
|
47
130
|
|
48
131
|
begin
|
@@ -83,11 +166,14 @@ end
|
|
83
166
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
84
167
|
| **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
|
85
168
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
169
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
86
170
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
87
171
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
88
172
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
89
173
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
90
174
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
175
|
+
| **request_type** | **String** | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
|
176
|
+
| **status** | **String** | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') | [optional] |
|
91
177
|
|
92
178
|
### Return type
|
93
179
|
|
@@ -109,7 +195,7 @@ end
|
|
109
195
|
|
110
196
|
|
111
197
|
|
112
|
-
Returns
|
198
|
+
Returns a `TimeOff` object with the given `id`.
|
113
199
|
|
114
200
|
### Examples
|
115
201
|
|
@@ -119,9 +205,9 @@ require 'merge_hris_client'
|
|
119
205
|
# setup authorization
|
120
206
|
MergeHRISClient.configure do |config|
|
121
207
|
# Configure API key authorization: tokenAuth
|
122
|
-
config.api_key['
|
208
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
123
209
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
124
|
-
# config.api_key_prefix['
|
210
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
125
211
|
end
|
126
212
|
|
127
213
|
api_instance = MergeHRISClient::TimeOffApi.new
|
data/docs/TimeOffBalance.md
CHANGED
@@ -6,9 +6,10 @@
|
|
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 PTO balance. | [optional] |
|
11
|
-
| **used** | **Float** | The amount of PTO used. | [optional] |
|
9
|
+
| **employee** | **String** | | [optional] |
|
10
|
+
| **balance** | **Float** | The current PTO balance in terms of hours. | [optional] |
|
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] |
|
12
13
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
13
14
|
|
14
15
|
## Example
|
@@ -22,6 +23,7 @@ instance = MergeHRISClient::TimeOffBalance.new(
|
|
22
23
|
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
23
24
|
balance: 60.0,
|
24
25
|
used: 45.0,
|
26
|
+
policy_type: VACATION,
|
25
27
|
remote_data: [{"path":"/leave","data":["Varies by platform"]}]
|
26
28
|
)
|
27
29
|
```
|
@@ -1,16 +1,16 @@
|
|
1
|
-
# MergeHRISClient::
|
1
|
+
# MergeHRISClient::TimeOffBalancesApi
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
8
|
-
| [**
|
7
|
+
| [**time_off_balances_list**](TimeOffBalancesApi.md#time_off_balances_list) | **GET** /time-off-balances | |
|
8
|
+
| [**time_off_balances_retrieve**](TimeOffBalancesApi.md#time_off_balances_retrieve) | **GET** /time-off-balances/{id} | |
|
9
9
|
|
10
10
|
|
11
|
-
##
|
11
|
+
## time_off_balances_list
|
12
12
|
|
13
|
-
> <PaginatedTimeOffBalanceList>
|
13
|
+
> <PaginatedTimeOffBalanceList> time_off_balances_list(x_account_token, opts)
|
14
14
|
|
15
15
|
|
16
16
|
|
@@ -29,7 +29,7 @@ MergeHRISClient.configure do |config|
|
|
29
29
|
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
30
|
end
|
31
31
|
|
32
|
-
api_instance = MergeHRISClient::
|
32
|
+
api_instance = MergeHRISClient::TimeOffBalancesApi.new
|
33
33
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
34
|
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.
|
@@ -37,37 +37,39 @@ opts = {
|
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
employee_id: 'employee_id_example', # String | If provided, will only return time off balances for this employee.
|
39
39
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
40
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
40
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
42
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
43
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
43
44
|
page_size: 56, # Integer | Number of results to return per page.
|
45
|
+
policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
44
46
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
45
47
|
}
|
46
48
|
|
47
49
|
begin
|
48
50
|
|
49
|
-
result = api_instance.
|
51
|
+
result = api_instance.time_off_balances_list(x_account_token, opts)
|
50
52
|
p result
|
51
53
|
rescue MergeHRISClient::ApiError => e
|
52
|
-
puts "Error when calling
|
54
|
+
puts "Error when calling TimeOffBalancesApi->time_off_balances_list: #{e}"
|
53
55
|
end
|
54
56
|
```
|
55
57
|
|
56
|
-
#### Using the
|
58
|
+
#### Using the time_off_balances_list_with_http_info variant
|
57
59
|
|
58
60
|
This returns an Array which contains the response data, status code and headers.
|
59
61
|
|
60
|
-
> <Array(<PaginatedTimeOffBalanceList>, Integer, Hash)>
|
62
|
+
> <Array(<PaginatedTimeOffBalanceList>, Integer, Hash)> time_off_balances_list_with_http_info(x_account_token, opts)
|
61
63
|
|
62
64
|
```ruby
|
63
65
|
begin
|
64
66
|
|
65
|
-
data, status_code, headers = api_instance.
|
67
|
+
data, status_code, headers = api_instance.time_off_balances_list_with_http_info(x_account_token, opts)
|
66
68
|
p status_code # => 2xx
|
67
69
|
p headers # => { ... }
|
68
70
|
p data # => <PaginatedTimeOffBalanceList>
|
69
71
|
rescue MergeHRISClient::ApiError => e
|
70
|
-
puts "Error when calling
|
72
|
+
puts "Error when calling TimeOffBalancesApi->time_off_balances_list_with_http_info: #{e}"
|
71
73
|
end
|
72
74
|
```
|
73
75
|
|
@@ -81,10 +83,12 @@ end
|
|
81
83
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
84
|
| **employee_id** | **String** | If provided, will only return time off balances for this employee. | [optional] |
|
83
85
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
86
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
84
87
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
88
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
89
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
87
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
91
|
+
| **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
|
88
92
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
89
93
|
|
90
94
|
### Return type
|
@@ -101,13 +105,13 @@ end
|
|
101
105
|
- **Accept**: application/json
|
102
106
|
|
103
107
|
|
104
|
-
##
|
108
|
+
## time_off_balances_retrieve
|
105
109
|
|
106
|
-
> <TimeOffBalance>
|
110
|
+
> <TimeOffBalance> time_off_balances_retrieve(x_account_token, id, opts)
|
107
111
|
|
108
112
|
|
109
113
|
|
110
|
-
Returns
|
114
|
+
Returns a `TimeOffBalance` object with the given `id`.
|
111
115
|
|
112
116
|
### Examples
|
113
117
|
|
@@ -122,7 +126,7 @@ MergeHRISClient.configure do |config|
|
|
122
126
|
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
123
127
|
end
|
124
128
|
|
125
|
-
api_instance = MergeHRISClient::
|
129
|
+
api_instance = MergeHRISClient::TimeOffBalancesApi.new
|
126
130
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
127
131
|
id = TODO # String |
|
128
132
|
opts = {
|
@@ -132,28 +136,28 @@ opts = {
|
|
132
136
|
|
133
137
|
begin
|
134
138
|
|
135
|
-
result = api_instance.
|
139
|
+
result = api_instance.time_off_balances_retrieve(x_account_token, id, opts)
|
136
140
|
p result
|
137
141
|
rescue MergeHRISClient::ApiError => e
|
138
|
-
puts "Error when calling
|
142
|
+
puts "Error when calling TimeOffBalancesApi->time_off_balances_retrieve: #{e}"
|
139
143
|
end
|
140
144
|
```
|
141
145
|
|
142
|
-
#### Using the
|
146
|
+
#### Using the time_off_balances_retrieve_with_http_info variant
|
143
147
|
|
144
148
|
This returns an Array which contains the response data, status code and headers.
|
145
149
|
|
146
|
-
> <Array(<TimeOffBalance>, Integer, Hash)>
|
150
|
+
> <Array(<TimeOffBalance>, Integer, Hash)> time_off_balances_retrieve_with_http_info(x_account_token, id, opts)
|
147
151
|
|
148
152
|
```ruby
|
149
153
|
begin
|
150
154
|
|
151
|
-
data, status_code, headers = api_instance.
|
155
|
+
data, status_code, headers = api_instance.time_off_balances_retrieve_with_http_info(x_account_token, id, opts)
|
152
156
|
p status_code # => 2xx
|
153
157
|
p headers # => { ... }
|
154
158
|
p data # => <TimeOffBalance>
|
155
159
|
rescue MergeHRISClient::ApiError => e
|
156
|
-
puts "Error when calling
|
160
|
+
puts "Error when calling TimeOffBalancesApi->time_off_balances_retrieve_with_http_info: #{e}"
|
157
161
|
end
|
158
162
|
```
|
159
163
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeHRISClient::TimeOffEndpointRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**TimeOffRequest**](TimeOffRequest.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_hris_client'
|
13
|
+
|
14
|
+
instance = MergeHRISClient::TimeOffEndpointRequest.new(
|
15
|
+
model: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# MergeHRISClient::TimeOffRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
|
+
| **employee** | **String** | | [optional] |
|
9
|
+
| **approver** | **String** | | [optional] |
|
10
|
+
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
|
11
|
+
| **employee_note** | **String** | The employee note for this time off request. | [optional] |
|
12
|
+
| **units** | [**UnitsEnum**](UnitsEnum.md) | The unit of time requested. | [optional] |
|
13
|
+
| **amount** | **Float** | The number of time off units requested. | [optional] |
|
14
|
+
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
|
15
|
+
| **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
|
16
|
+
| **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'merge_hris_client'
|
22
|
+
|
23
|
+
instance = MergeHRISClient::TimeOffRequest.new(
|
24
|
+
remote_id: 19202938,
|
25
|
+
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
26
|
+
approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
|
27
|
+
status: APPROVED,
|
28
|
+
employee_note: Trip to Iowa. Miss those cornfields!,
|
29
|
+
units: DAYS,
|
30
|
+
amount: 7,
|
31
|
+
request_type: VACATION,
|
32
|
+
start_time: 2020-11-10T00:00Z,
|
33
|
+
end_time: 2020-11-17T00:00Z
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|