merge_hris_client 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +33 -9
- 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/AccountTypeEnum.md +15 -0
- data/docs/BankInfo.md +34 -0
- data/docs/BankInfoApi.md +193 -0
- data/docs/BenefitsApi.md +2 -78
- data/docs/{StateEnum.md → CategoriesEnum.md} +2 -2
- data/docs/{NullEnum.md → CategoryEnum.md} +2 -2
- data/docs/CompaniesApi.md +3 -1
- data/docs/DataPassthroughRequest.md +5 -3
- data/docs/DeductionsApi.md +179 -0
- data/docs/Employee.md +12 -8
- data/docs/EmployeePayrollRun.md +3 -3
- data/docs/EmployeePayrollRunsApi.md +13 -3
- data/docs/EmployeesApi.md +12 -82
- data/docs/Employment.md +3 -1
- data/docs/EmploymentsApi.md +7 -78
- data/docs/EndUserDetailsRequest.md +1 -1
- data/docs/ErrorValidationProblem.md +24 -0
- data/docs/ForceResyncApi.md +79 -0
- data/docs/IssuesApi.md +11 -10
- data/docs/LinkedAccountsApi.md +103 -0
- data/docs/Location.md +2 -0
- data/docs/LocationsApi.md +2 -0
- data/docs/PaginatedAccountDetailsAndActionsList.md +22 -0
- data/docs/PaginatedBankInfoList.md +22 -0
- data/docs/PaginatedDeductionList.md +22 -0
- data/docs/PaginatedIssueList.md +2 -2
- data/docs/PaginatedPayGroupList.md +22 -0
- data/docs/PaginatedSyncStatusList.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 +13 -1
- data/docs/PolicyTypeEnum.md +15 -0
- data/docs/RequestFormatEnum.md +15 -0
- data/docs/SyncStatusApi.md +3 -74
- data/docs/TeamsApi.md +7 -2
- data/docs/TimeOff.md +3 -3
- data/docs/TimeOffApi.md +88 -4
- data/docs/TimeOffBalance.md +4 -2
- data/docs/{TimeOffBalanceApi.md → TimeOffBalancesApi.md} +26 -22
- data/docs/TimeOffEndpointRequest.md +18 -0
- data/docs/TimeOffRequest.md +36 -0
- data/docs/TimeOffResponse.md +22 -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 +222 -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 +18 -75
- 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/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 -4
- data/lib/merge_hris_client/api/teams_api.rb +17 -0
- data/lib/merge_hris_client/api/time_off_api.rb +92 -2
- data/lib/merge_hris_client/api/time_off_balances_api.rb +206 -0
- 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 +36 -0
- data/lib/merge_hris_client/models/account_integration.rb +1 -1
- data/lib/merge_hris_client/models/account_type_enum.rb +35 -0
- data/lib/merge_hris_client/models/bank_info.rb +323 -0
- data/lib/merge_hris_client/models/categories_enum.rb +36 -0
- data/lib/merge_hris_client/models/category_enum.rb +36 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +66 -9
- data/lib/merge_hris_client/models/employee.rb +32 -8
- data/lib/merge_hris_client/models/employment.rb +12 -1
- data/lib/merge_hris_client/models/end_user_details_request.rb +73 -1
- data/lib/merge_hris_client/models/error_validation_problem.rb +260 -0
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +19 -0
- data/lib/merge_hris_client/models/location.rb +12 -1
- data/lib/merge_hris_client/models/marital_status_enum.rb +1 -1
- 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_deduction_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_pay_group_list.rb +240 -0
- data/lib/merge_hris_client/models/{benefit_request.rb → pay_group.rb} +31 -54
- data/lib/merge_hris_client/models/policy_type_enum.rb +39 -0
- data/lib/merge_hris_client/models/remote_data_request.rb +19 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +19 -0
- data/lib/merge_hris_client/models/request_format_enum.rb +35 -0
- data/lib/merge_hris_client/models/request_type_enum.rb +2 -1
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -0
- data/lib/merge_hris_client/models/time_off_balance.rb +14 -3
- 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} +80 -69
- data/lib/merge_hris_client/models/time_off_response.rb +255 -0
- 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 +28 -4
- 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 +76 -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 +9 -1
- data/spec/api/employments_api_spec.rb +7 -1
- data/spec/api/force_resync_api_spec.rb +46 -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 +20 -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/{benefit_request_spec.rb → account_details_spec.rb} +18 -12
- 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/{state_enum_spec.rb → category_enum_spec.rb} +7 -7
- 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 +7 -1
- data/spec/models/deduction_spec.rb +7 -1
- data/spec/models/earning_spec.rb +7 -1
- data/spec/models/employee_payroll_run_spec.rb +7 -1
- data/spec/models/employee_spec.rb +31 -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/end_user_details_request_spec.rb +7 -5
- data/spec/models/{end_user_details_spec.rb → error_validation_problem_spec.rb} +11 -15
- 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/link_token_spec.rb +1 -1
- data/spec/models/location_spec.rb +13 -1
- 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/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_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/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/{remote_key_for_regeneration_spec.rb → time_off_endpoint_request_spec.rb} +8 -8
- data/spec/models/time_off_request_spec.rb +88 -0
- data/spec/models/time_off_response_spec.rb +46 -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 +115 -33
- data/docs/BenefitRequest.md +0 -28
- data/docs/DataPassthrough.md +0 -24
- data/docs/EmployeeRequest.md +0 -62
- data/docs/EmploymentRequest.md +0 -34
- data/docs/EndUserDetails.md +0 -24
- data/docs/RemoteKeyForRegeneration.md +0 -18
- data/lib/merge_hris_client/models/employee_request.rb +0 -523
- data/merge_hris_client-1.0.0.gem +0 -0
- data/merge_hris_client-1.0.1.gem +0 -0
- data/spec/models/employee_request_spec.rb +0 -160
@@ -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** | The employee requesting time off. | [optional] |
|
9
|
+
| **approver** | **String** | The employee approving the time off request. | [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
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeHRISClient::TimeOffResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**TimeOff**](TimeOff.md) | | |
|
8
|
+
| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
|
9
|
+
| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_hris_client'
|
15
|
+
|
16
|
+
instance = MergeHRISClient::TimeOffResponse.new(
|
17
|
+
model: null,
|
18
|
+
warnings: null,
|
19
|
+
errors: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeHRISClient::ValidationProblemSource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **pointer** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_hris_client'
|
13
|
+
|
14
|
+
instance = MergeHRISClient::ValidationProblemSource.new(
|
15
|
+
pointer: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeHRISClient::WarningValidationProblem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **source** | [**ValidationProblemSource**](ValidationProblemSource.md) | | [optional] |
|
8
|
+
| **title** | **String** | | |
|
9
|
+
| **detail** | **String** | | |
|
10
|
+
| **problem_type** | **String** | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_hris_client'
|
16
|
+
|
17
|
+
instance = MergeHRISClient::WarningValidationProblem.new(
|
18
|
+
source: null,
|
19
|
+
title: Unrecognized Field,
|
20
|
+
detail: An unrecognized field, age, was passed in with request data.,
|
21
|
+
problem_type: UNRECOGNIZED_FIELD
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,77 @@
|
|
1
|
+
=begin
|
2
|
+
#Merge HRIS API
|
3
|
+
|
4
|
+
#The unified API for building rich integrations with multiple HR Information System platforms.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0
|
7
|
+
Contact: hello@merge.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.1.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module MergeHRISClient
|
16
|
+
class AccountDetailsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Get details for a linked account.
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @return [AccountDetails]
|
25
|
+
def account_details_retrieve(opts = {})
|
26
|
+
data, _status_code, _headers = account_details_retrieve_with_http_info(opts)
|
27
|
+
data
|
28
|
+
end
|
29
|
+
|
30
|
+
# Get details for a linked account.
|
31
|
+
# @param [Hash] opts the optional parameters
|
32
|
+
# @return [Array<(AccountDetails, Integer, Hash)>] AccountDetails data, response status code and response headers
|
33
|
+
def account_details_retrieve_with_http_info(opts = {})
|
34
|
+
if @api_client.config.debugging
|
35
|
+
@api_client.config.logger.debug 'Calling API: AccountDetailsApi.account_details_retrieve ...'
|
36
|
+
end
|
37
|
+
# resource path
|
38
|
+
local_var_path = '/account-details'
|
39
|
+
|
40
|
+
# query parameters
|
41
|
+
query_params = opts[:query_params] || {}
|
42
|
+
|
43
|
+
# header parameters
|
44
|
+
header_params = opts[:header_params] || {}
|
45
|
+
# HTTP header 'Accept' (if needed)
|
46
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
47
|
+
|
48
|
+
# form parameters
|
49
|
+
form_params = opts[:form_params] || {}
|
50
|
+
|
51
|
+
# http body (model)
|
52
|
+
post_body = opts[:debug_body]
|
53
|
+
|
54
|
+
# return_type
|
55
|
+
return_type = opts[:debug_return_type] || 'AccountDetails'
|
56
|
+
|
57
|
+
# auth_names
|
58
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
59
|
+
|
60
|
+
new_options = opts.merge(
|
61
|
+
:operation => :"AccountDetailsApi.account_details_retrieve",
|
62
|
+
:header_params => header_params,
|
63
|
+
:query_params => query_params,
|
64
|
+
:form_params => form_params,
|
65
|
+
:body => post_body,
|
66
|
+
:auth_names => auth_names,
|
67
|
+
:return_type => return_type
|
68
|
+
)
|
69
|
+
|
70
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
71
|
+
if @api_client.config.debugging
|
72
|
+
@api_client.config.logger.debug "API called: AccountDetailsApi#account_details_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
73
|
+
end
|
74
|
+
return data, status_code, headers
|
75
|
+
end
|
76
|
+
end
|
77
|
+
end
|
@@ -0,0 +1,222 @@
|
|
1
|
+
=begin
|
2
|
+
#Merge HRIS API
|
3
|
+
|
4
|
+
#The unified API for building rich integrations with multiple HR Information System platforms.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0
|
7
|
+
Contact: hello@merge.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.1.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module MergeHRISClient
|
16
|
+
class BankInfoApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Returns a list of `BankInfo` objects.
|
23
|
+
# @param x_account_token [String] Token identifying the end user.
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [String] :account_type The bank account type
|
26
|
+
# @option opts [String] :bank_name
|
27
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
28
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
29
|
+
# @option opts [String] :cursor The pagination cursor value.
|
30
|
+
# @option opts [String] :employee If provided, will only return bank accounts for this employee.
|
31
|
+
# @option opts [String] :employee_id If provided, will only return bank accounts for this employee.
|
32
|
+
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
33
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
|
34
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
35
|
+
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
36
|
+
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
37
|
+
# @option opts [String] :order_by Overrides the default ordering for this endpoint.
|
38
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
39
|
+
# @option opts [Time] :remote_created_at
|
40
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
41
|
+
# @return [PaginatedBankInfoList]
|
42
|
+
def bank_info_list(x_account_token, opts = {})
|
43
|
+
data, _status_code, _headers = bank_info_list_with_http_info(x_account_token, opts)
|
44
|
+
data
|
45
|
+
end
|
46
|
+
|
47
|
+
# Returns a list of `BankInfo` objects.
|
48
|
+
# @param x_account_token [String] Token identifying the end user.
|
49
|
+
# @param [Hash] opts the optional parameters
|
50
|
+
# @option opts [String] :account_type The bank account type
|
51
|
+
# @option opts [String] :bank_name
|
52
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
53
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
54
|
+
# @option opts [String] :cursor The pagination cursor value.
|
55
|
+
# @option opts [String] :employee If provided, will only return bank accounts for this employee.
|
56
|
+
# @option opts [String] :employee_id If provided, will only return bank accounts for this employee.
|
57
|
+
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
58
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
|
59
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
60
|
+
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
61
|
+
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
62
|
+
# @option opts [String] :order_by Overrides the default ordering for this endpoint.
|
63
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
64
|
+
# @option opts [Time] :remote_created_at
|
65
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
66
|
+
# @return [Array<(PaginatedBankInfoList, Integer, Hash)>] PaginatedBankInfoList data, response status code and response headers
|
67
|
+
def bank_info_list_with_http_info(x_account_token, opts = {})
|
68
|
+
if @api_client.config.debugging
|
69
|
+
@api_client.config.logger.debug 'Calling API: BankInfoApi.bank_info_list ...'
|
70
|
+
end
|
71
|
+
# verify the required parameter 'x_account_token' is set
|
72
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
73
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling BankInfoApi.bank_info_list"
|
74
|
+
end
|
75
|
+
allowable_values = ["CHECKING", "SAVINGS"]
|
76
|
+
if @api_client.config.client_side_validation && opts[:'account_type'] && !allowable_values.include?(opts[:'account_type'])
|
77
|
+
fail ArgumentError, "invalid value for \"account_type\", must be one of #{allowable_values}"
|
78
|
+
end
|
79
|
+
allowable_values = ["employee"]
|
80
|
+
if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
|
81
|
+
fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
|
82
|
+
end
|
83
|
+
allowable_values = ["-remote_created_at", "remote_created_at"]
|
84
|
+
if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
|
85
|
+
fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
|
86
|
+
end
|
87
|
+
# resource path
|
88
|
+
local_var_path = '/bank-info'
|
89
|
+
|
90
|
+
# query parameters
|
91
|
+
query_params = opts[:query_params] || {}
|
92
|
+
query_params[:'account_type'] = opts[:'account_type'] if !opts[:'account_type'].nil?
|
93
|
+
query_params[:'bank_name'] = opts[:'bank_name'] if !opts[:'bank_name'].nil?
|
94
|
+
query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
95
|
+
query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
96
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
97
|
+
query_params[:'employee'] = opts[:'employee'] if !opts[:'employee'].nil?
|
98
|
+
query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
|
99
|
+
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
100
|
+
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
101
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
102
|
+
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
103
|
+
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
104
|
+
query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
105
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
106
|
+
query_params[:'remote_created_at'] = opts[:'remote_created_at'] if !opts[:'remote_created_at'].nil?
|
107
|
+
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
108
|
+
|
109
|
+
# header parameters
|
110
|
+
header_params = opts[:header_params] || {}
|
111
|
+
# HTTP header 'Accept' (if needed)
|
112
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
113
|
+
header_params[:'X-Account-Token'] = x_account_token
|
114
|
+
|
115
|
+
# form parameters
|
116
|
+
form_params = opts[:form_params] || {}
|
117
|
+
|
118
|
+
# http body (model)
|
119
|
+
post_body = opts[:debug_body]
|
120
|
+
|
121
|
+
# return_type
|
122
|
+
return_type = opts[:debug_return_type] || 'PaginatedBankInfoList'
|
123
|
+
|
124
|
+
# auth_names
|
125
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
126
|
+
|
127
|
+
new_options = opts.merge(
|
128
|
+
:operation => :"BankInfoApi.bank_info_list",
|
129
|
+
:header_params => header_params,
|
130
|
+
:query_params => query_params,
|
131
|
+
:form_params => form_params,
|
132
|
+
:body => post_body,
|
133
|
+
:auth_names => auth_names,
|
134
|
+
:return_type => return_type
|
135
|
+
)
|
136
|
+
|
137
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
138
|
+
if @api_client.config.debugging
|
139
|
+
@api_client.config.logger.debug "API called: BankInfoApi#bank_info_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
140
|
+
end
|
141
|
+
return data, status_code, headers
|
142
|
+
end
|
143
|
+
|
144
|
+
# Returns a `BankInfo` object with the given `id`.
|
145
|
+
# @param x_account_token [String] Token identifying the end user.
|
146
|
+
# @param id [String]
|
147
|
+
# @param [Hash] opts the optional parameters
|
148
|
+
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
149
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
150
|
+
# @return [BankInfo]
|
151
|
+
def bank_info_retrieve(x_account_token, id, opts = {})
|
152
|
+
data, _status_code, _headers = bank_info_retrieve_with_http_info(x_account_token, id, opts)
|
153
|
+
data
|
154
|
+
end
|
155
|
+
|
156
|
+
# Returns a `BankInfo` object with the given `id`.
|
157
|
+
# @param x_account_token [String] Token identifying the end user.
|
158
|
+
# @param id [String]
|
159
|
+
# @param [Hash] opts the optional parameters
|
160
|
+
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
161
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
162
|
+
# @return [Array<(BankInfo, Integer, Hash)>] BankInfo data, response status code and response headers
|
163
|
+
def bank_info_retrieve_with_http_info(x_account_token, id, opts = {})
|
164
|
+
if @api_client.config.debugging
|
165
|
+
@api_client.config.logger.debug 'Calling API: BankInfoApi.bank_info_retrieve ...'
|
166
|
+
end
|
167
|
+
# verify the required parameter 'x_account_token' is set
|
168
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
169
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling BankInfoApi.bank_info_retrieve"
|
170
|
+
end
|
171
|
+
# verify the required parameter 'id' is set
|
172
|
+
if @api_client.config.client_side_validation && id.nil?
|
173
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling BankInfoApi.bank_info_retrieve"
|
174
|
+
end
|
175
|
+
allowable_values = ["employee"]
|
176
|
+
if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
|
177
|
+
fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
|
178
|
+
end
|
179
|
+
# resource path
|
180
|
+
local_var_path = '/bank-info/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
181
|
+
|
182
|
+
# query parameters
|
183
|
+
query_params = opts[:query_params] || {}
|
184
|
+
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
185
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
186
|
+
|
187
|
+
# header parameters
|
188
|
+
header_params = opts[:header_params] || {}
|
189
|
+
# HTTP header 'Accept' (if needed)
|
190
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
191
|
+
header_params[:'X-Account-Token'] = x_account_token
|
192
|
+
|
193
|
+
# form parameters
|
194
|
+
form_params = opts[:form_params] || {}
|
195
|
+
|
196
|
+
# http body (model)
|
197
|
+
post_body = opts[:debug_body]
|
198
|
+
|
199
|
+
# return_type
|
200
|
+
return_type = opts[:debug_return_type] || 'BankInfo'
|
201
|
+
|
202
|
+
# auth_names
|
203
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
204
|
+
|
205
|
+
new_options = opts.merge(
|
206
|
+
:operation => :"BankInfoApi.bank_info_retrieve",
|
207
|
+
:header_params => header_params,
|
208
|
+
:query_params => query_params,
|
209
|
+
:form_params => form_params,
|
210
|
+
:body => post_body,
|
211
|
+
:auth_names => auth_names,
|
212
|
+
:return_type => return_type
|
213
|
+
)
|
214
|
+
|
215
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
216
|
+
if @api_client.config.debugging
|
217
|
+
@api_client.config.logger.debug "API called: BankInfoApi#bank_info_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
218
|
+
end
|
219
|
+
return data, status_code, headers
|
220
|
+
end
|
221
|
+
end
|
222
|
+
end
|