merge_hris_client 3.1.0 → 3.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +18 -13
- data/docs/AsyncPassthroughApi.md +155 -0
- data/docs/AsyncPassthroughReciept.md +18 -0
- data/docs/BankInfo.md +2 -2
- data/docs/BankInfoApi.md +2 -2
- data/docs/Benefit.md +9 -3
- data/docs/BenefitPlanTypeEnum.md +15 -0
- data/docs/Company.md +2 -2
- data/docs/Deduction.md +2 -2
- data/docs/DeleteAccountApi.md +9 -9
- data/docs/Dependent.md +50 -0
- data/docs/DependentsApi.md +181 -0
- data/docs/Earning.md +2 -2
- data/docs/Employee.md +2 -2
- data/docs/EmployeePayrollRun.md +2 -2
- data/docs/EmployerBenefit.md +36 -0
- data/docs/EmployerBenefitsApi.md +177 -0
- data/docs/Employment.md +2 -2
- data/docs/EmploymentsApi.md +2 -2
- data/docs/EndUserDetailsRequest.md +1 -1
- data/docs/Group.md +2 -2
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +3 -3
- data/docs/PaginatedDependentList.md +22 -0
- data/docs/PaginatedEmployerBenefitList.md +22 -0
- data/docs/PayGroup.md +2 -2
- data/docs/PayrollRun.md +2 -2
- data/docs/RelationshipEnum.md +15 -0
- data/docs/RemoteData.md +1 -1
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +2 -2
- data/docs/Team.md +2 -2
- data/docs/TimeOff.md +2 -2
- data/docs/TimeOffBalance.md +2 -2
- data/lib/merge_hris_client/api/async_passthrough_api.rb +160 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +2 -2
- data/lib/merge_hris_client/api/delete_account_api.rb +7 -7
- data/lib/merge_hris_client/api/dependents_api.rb +188 -0
- data/lib/merge_hris_client/api/employer_benefits_api.rb +182 -0
- data/lib/merge_hris_client/api/employments_api.rb +2 -2
- data/lib/merge_hris_client/api/linked_accounts_api.rb +2 -2
- data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
- data/lib/merge_hris_client/models/async_passthrough_reciept.rb +223 -0
- data/lib/merge_hris_client/models/bank_info.rb +10 -10
- data/lib/merge_hris_client/models/benefit.rb +42 -9
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +48 -0
- data/lib/merge_hris_client/models/company.rb +10 -10
- data/lib/merge_hris_client/models/deduction.rb +10 -10
- data/lib/merge_hris_client/models/dependent.rb +470 -0
- data/lib/merge_hris_client/models/earning.rb +10 -10
- data/lib/merge_hris_client/models/employee.rb +10 -10
- data/lib/merge_hris_client/models/employee_payroll_run.rb +10 -10
- data/lib/merge_hris_client/models/employer_benefit.rb +363 -0
- data/lib/merge_hris_client/models/employment.rb +10 -10
- data/lib/merge_hris_client/models/end_user_details_request.rb +1 -1
- data/lib/merge_hris_client/models/group.rb +10 -10
- data/lib/merge_hris_client/models/location.rb +10 -10
- data/lib/merge_hris_client/models/paginated_dependent_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employer_benefit_list.rb +240 -0
- data/lib/merge_hris_client/models/pay_group.rb +10 -10
- data/lib/merge_hris_client/models/payroll_run.rb +10 -10
- data/lib/merge_hris_client/models/relationship_enum.rb +46 -0
- data/lib/merge_hris_client/models/remote_data.rb +3 -4
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -1
- data/lib/merge_hris_client/models/tax.rb +10 -10
- data/lib/merge_hris_client/models/team.rb +10 -10
- data/lib/merge_hris_client/models/time_off.rb +10 -10
- data/lib/merge_hris_client/models/time_off_balance.rb +10 -10
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +16 -2
- data/spec/api/async_passthrough_api_spec.rb +59 -0
- data/spec/api/bank_info_api_spec.rb +1 -1
- data/spec/api/delete_account_api_spec.rb +2 -2
- data/spec/api/dependents_api_spec.rb +70 -0
- data/spec/api/employer_benefits_api_spec.rb +68 -0
- data/spec/api/employments_api_spec.rb +1 -1
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/models/async_passthrough_reciept_spec.rb +34 -0
- data/spec/models/bank_info_spec.rb +2 -2
- data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
- data/spec/models/benefit_spec.rb +19 -1
- data/spec/models/company_spec.rb +2 -2
- data/spec/models/deduction_spec.rb +2 -2
- data/spec/models/dependent_spec.rb +130 -0
- data/spec/models/earning_spec.rb +2 -2
- data/spec/models/employee_payroll_run_spec.rb +2 -2
- data/spec/models/employee_spec.rb +2 -2
- data/spec/models/employer_benefit_spec.rb +88 -0
- data/spec/models/employment_spec.rb +2 -2
- data/spec/models/group_spec.rb +2 -2
- data/spec/models/location_spec.rb +2 -2
- data/spec/models/paginated_dependent_list_spec.rb +46 -0
- data/spec/models/paginated_employer_benefit_list_spec.rb +46 -0
- data/spec/models/pay_group_spec.rb +2 -2
- data/spec/models/payroll_run_spec.rb +2 -2
- data/spec/models/relationship_enum_spec.rb +28 -0
- data/spec/models/tax_spec.rb +2 -2
- data/spec/models/team_spec.rb +2 -2
- data/spec/models/time_off_balance_spec.rb +2 -2
- data/spec/models/time_off_spec.rb +2 -2
- metadata +161 -121
data/docs/PayGroup.md
CHANGED
@@ -8,8 +8,8 @@
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **pay_group_name** | **String** | The pay group name. | [optional] |
|
10
10
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
11
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
12
11
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
12
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
13
13
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
14
14
|
|
15
15
|
## Example
|
@@ -22,8 +22,8 @@ instance = MergeHRISClient::PayGroup.new(
|
|
22
22
|
remote_id: 800293,
|
23
23
|
pay_group_name: contractor,
|
24
24
|
remote_was_deleted: null,
|
25
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
26
25
|
modified_at: 2021-10-16T00:00Z,
|
26
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
27
27
|
remote_data: [{"path":"/pay-group","data":["Varies by platform"]}]
|
28
28
|
)
|
29
29
|
```
|
data/docs/PayrollRun.md
CHANGED
@@ -12,8 +12,8 @@
|
|
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
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
15
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
16
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
17
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
18
18
|
|
19
19
|
## Example
|
@@ -30,8 +30,8 @@ instance = MergeHRISClient::PayrollRun.new(
|
|
30
30
|
end_date: 2020-11-15T00:00Z,
|
31
31
|
check_date: 2020-11-15T00:00Z,
|
32
32
|
remote_was_deleted: null,
|
33
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
34
33
|
modified_at: 2021-10-16T00:00Z,
|
34
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
35
35
|
remote_data: [{"path":"/payroll","data":["Varies by platform"]}]
|
36
36
|
)
|
37
37
|
```
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeHRISClient::RelationshipEnum
|
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::RelationshipEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/RemoteData.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **path** | **String** | | |
|
8
|
-
| **data** | [**
|
8
|
+
| **data** | [**AnyType**](.md) | | [optional][readonly] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/SyncStatusApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
13
13
|
|
14
14
|
|
15
15
|
|
16
|
-
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
|
16
|
+
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
data/docs/Tax.md
CHANGED
@@ -11,8 +11,8 @@
|
|
11
11
|
| **amount** | **Float** | The tax amount. | [optional] |
|
12
12
|
| **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
|
13
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
14
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
15
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
16
16
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
17
|
|
18
18
|
## Example
|
@@ -28,8 +28,8 @@ instance = MergeHRISClient::Tax.new(
|
|
28
28
|
amount: 100.25,
|
29
29
|
employer_tax: false,
|
30
30
|
remote_was_deleted: null,
|
31
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
32
31
|
modified_at: 2021-10-16T00:00Z,
|
32
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
33
33
|
remote_data: null
|
34
34
|
)
|
35
35
|
```
|
data/docs/Team.md
CHANGED
@@ -9,8 +9,8 @@
|
|
9
9
|
| **name** | **String** | The team's name. | [optional] |
|
10
10
|
| **parent_team** | **String** | The team's parent team. | [optional] |
|
11
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
12
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
13
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
14
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
15
15
|
|
16
16
|
## Example
|
@@ -24,8 +24,8 @@ instance = MergeHRISClient::Team.new(
|
|
24
24
|
name: Engineering,
|
25
25
|
parent_team: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
|
26
26
|
remote_was_deleted: null,
|
27
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
28
27
|
modified_at: 2021-10-16T00:00Z,
|
28
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
29
29
|
remote_data: [{"path":"/teams","data":["Varies by platform"]}]
|
30
30
|
)
|
31
31
|
```
|
data/docs/TimeOff.md
CHANGED
@@ -16,8 +16,8 @@
|
|
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
18
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
19
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
20
19
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
20
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
21
21
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
22
22
|
|
23
23
|
## Example
|
@@ -38,8 +38,8 @@ instance = MergeHRISClient::TimeOff.new(
|
|
38
38
|
start_time: 2020-11-10T00:00Z,
|
39
39
|
end_time: 2020-11-17T00:00Z,
|
40
40
|
remote_was_deleted: null,
|
41
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
42
41
|
modified_at: 2021-10-16T00:00Z,
|
42
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
43
43
|
remote_data: [{"path":"/leave","data":["Varies by platform"]}]
|
44
44
|
)
|
45
45
|
```
|
data/docs/TimeOffBalance.md
CHANGED
@@ -11,8 +11,8 @@
|
|
11
11
|
| **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
|
12
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] |
|
13
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
14
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
15
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
16
16
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
17
|
|
18
18
|
## Example
|
@@ -28,8 +28,8 @@ instance = MergeHRISClient::TimeOffBalance.new(
|
|
28
28
|
used: 45.0,
|
29
29
|
policy_type: VACATION,
|
30
30
|
remote_was_deleted: null,
|
31
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
32
31
|
modified_at: 2021-10-16T00:00Z,
|
32
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
33
33
|
remote_data: [{"path":"/leave","data":["Varies by platform"]}]
|
34
34
|
)
|
35
35
|
```
|
@@ -0,0 +1,160 @@
|
|
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 AsyncPassthroughApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Asynchronously pull data from an endpoint not currently supported by Merge.
|
23
|
+
# @param x_account_token [String] Token identifying the end user.
|
24
|
+
# @param data_passthrough_request [DataPassthroughRequest]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [AsyncPassthroughReciept]
|
27
|
+
def async_passthrough_create(x_account_token, data_passthrough_request, opts = {})
|
28
|
+
data, _status_code, _headers = async_passthrough_create_with_http_info(x_account_token, data_passthrough_request, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Asynchronously pull data from an endpoint not currently supported by Merge.
|
33
|
+
# @param x_account_token [String] Token identifying the end user.
|
34
|
+
# @param data_passthrough_request [DataPassthroughRequest]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(AsyncPassthroughReciept, Integer, Hash)>] AsyncPassthroughReciept data, response status code and response headers
|
37
|
+
def async_passthrough_create_with_http_info(x_account_token, data_passthrough_request, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: AsyncPassthroughApi.async_passthrough_create ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'x_account_token' is set
|
42
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling AsyncPassthroughApi.async_passthrough_create"
|
44
|
+
end
|
45
|
+
# verify the required parameter 'data_passthrough_request' is set
|
46
|
+
if @api_client.config.client_side_validation && data_passthrough_request.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'data_passthrough_request' when calling AsyncPassthroughApi.async_passthrough_create"
|
48
|
+
end
|
49
|
+
# resource path
|
50
|
+
local_var_path = '/async-passthrough'
|
51
|
+
|
52
|
+
# query parameters
|
53
|
+
query_params = opts[:query_params] || {}
|
54
|
+
|
55
|
+
# header parameters
|
56
|
+
header_params = opts[:header_params] || {}
|
57
|
+
# HTTP header 'Accept' (if needed)
|
58
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
59
|
+
# HTTP header 'Content-Type'
|
60
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
61
|
+
header_params[:'X-Account-Token'] = x_account_token
|
62
|
+
|
63
|
+
# form parameters
|
64
|
+
form_params = opts[:form_params] || {}
|
65
|
+
|
66
|
+
# http body (model)
|
67
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(data_passthrough_request)
|
68
|
+
|
69
|
+
# return_type
|
70
|
+
return_type = opts[:debug_return_type] || 'AsyncPassthroughReciept'
|
71
|
+
|
72
|
+
# auth_names
|
73
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
74
|
+
|
75
|
+
new_options = opts.merge(
|
76
|
+
:operation => :"AsyncPassthroughApi.async_passthrough_create",
|
77
|
+
:header_params => header_params,
|
78
|
+
:query_params => query_params,
|
79
|
+
:form_params => form_params,
|
80
|
+
:body => post_body,
|
81
|
+
:auth_names => auth_names,
|
82
|
+
:return_type => return_type
|
83
|
+
)
|
84
|
+
|
85
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug "API called: AsyncPassthroughApi#async_passthrough_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
88
|
+
end
|
89
|
+
return data, status_code, headers
|
90
|
+
end
|
91
|
+
|
92
|
+
# Retrieves data from earlier async-passthrough POST request
|
93
|
+
# @param x_account_token [String] Token identifying the end user.
|
94
|
+
# @param async_passthrough_receipt_id [String]
|
95
|
+
# @param [Hash] opts the optional parameters
|
96
|
+
# @return [RemoteResponse]
|
97
|
+
def async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id, opts = {})
|
98
|
+
data, _status_code, _headers = async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id, opts)
|
99
|
+
data
|
100
|
+
end
|
101
|
+
|
102
|
+
# Retrieves data from earlier async-passthrough POST request
|
103
|
+
# @param x_account_token [String] Token identifying the end user.
|
104
|
+
# @param async_passthrough_receipt_id [String]
|
105
|
+
# @param [Hash] opts the optional parameters
|
106
|
+
# @return [Array<(RemoteResponse, Integer, Hash)>] RemoteResponse data, response status code and response headers
|
107
|
+
def async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id, opts = {})
|
108
|
+
if @api_client.config.debugging
|
109
|
+
@api_client.config.logger.debug 'Calling API: AsyncPassthroughApi.async_passthrough_retrieve ...'
|
110
|
+
end
|
111
|
+
# verify the required parameter 'x_account_token' is set
|
112
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
113
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling AsyncPassthroughApi.async_passthrough_retrieve"
|
114
|
+
end
|
115
|
+
# verify the required parameter 'async_passthrough_receipt_id' is set
|
116
|
+
if @api_client.config.client_side_validation && async_passthrough_receipt_id.nil?
|
117
|
+
fail ArgumentError, "Missing the required parameter 'async_passthrough_receipt_id' when calling AsyncPassthroughApi.async_passthrough_retrieve"
|
118
|
+
end
|
119
|
+
# resource path
|
120
|
+
local_var_path = '/async-passthrough/{async_passthrough_receipt_id}'.sub('{' + 'async_passthrough_receipt_id' + '}', CGI.escape(async_passthrough_receipt_id.to_s))
|
121
|
+
|
122
|
+
# query parameters
|
123
|
+
query_params = opts[:query_params] || {}
|
124
|
+
|
125
|
+
# header parameters
|
126
|
+
header_params = opts[:header_params] || {}
|
127
|
+
# HTTP header 'Accept' (if needed)
|
128
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
129
|
+
header_params[:'X-Account-Token'] = x_account_token
|
130
|
+
|
131
|
+
# form parameters
|
132
|
+
form_params = opts[:form_params] || {}
|
133
|
+
|
134
|
+
# http body (model)
|
135
|
+
post_body = opts[:debug_body]
|
136
|
+
|
137
|
+
# return_type
|
138
|
+
return_type = opts[:debug_return_type] || 'RemoteResponse'
|
139
|
+
|
140
|
+
# auth_names
|
141
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
142
|
+
|
143
|
+
new_options = opts.merge(
|
144
|
+
:operation => :"AsyncPassthroughApi.async_passthrough_retrieve",
|
145
|
+
:header_params => header_params,
|
146
|
+
:query_params => query_params,
|
147
|
+
:form_params => form_params,
|
148
|
+
:body => post_body,
|
149
|
+
:auth_names => auth_names,
|
150
|
+
:return_type => return_type
|
151
|
+
)
|
152
|
+
|
153
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
154
|
+
if @api_client.config.debugging
|
155
|
+
@api_client.config.logger.debug "API called: AsyncPassthroughApi#async_passthrough_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
156
|
+
end
|
157
|
+
return data, status_code, headers
|
158
|
+
end
|
159
|
+
end
|
160
|
+
end
|
@@ -33,7 +33,7 @@ module MergeHRISClient
|
|
33
33
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
34
34
|
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
35
35
|
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
36
|
-
# @option opts [String] :order_by Overrides the default ordering for this endpoint.
|
36
|
+
# @option opts [String] :order_by Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
|
37
37
|
# @option opts [Integer] :page_size Number of results to return per page.
|
38
38
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
39
39
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
@@ -58,7 +58,7 @@ module MergeHRISClient
|
|
58
58
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
59
59
|
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
60
60
|
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
61
|
-
# @option opts [String] :order_by Overrides the default ordering for this endpoint.
|
61
|
+
# @option opts [String] :order_by Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
|
62
62
|
# @option opts [Integer] :page_size Number of results to return per page.
|
63
63
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
64
64
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
@@ -23,8 +23,8 @@ module MergeHRISClient
|
|
23
23
|
# @param x_account_token [String] Token identifying the end user.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @return [nil]
|
26
|
-
def
|
27
|
-
|
26
|
+
def delete_account_delete(x_account_token, opts = {})
|
27
|
+
delete_account_delete_with_http_info(x_account_token, opts)
|
28
28
|
nil
|
29
29
|
end
|
30
30
|
|
@@ -32,13 +32,13 @@ module MergeHRISClient
|
|
32
32
|
# @param x_account_token [String] Token identifying the end user.
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
34
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
35
|
-
def
|
35
|
+
def delete_account_delete_with_http_info(x_account_token, opts = {})
|
36
36
|
if @api_client.config.debugging
|
37
|
-
@api_client.config.logger.debug 'Calling API: DeleteAccountApi.
|
37
|
+
@api_client.config.logger.debug 'Calling API: DeleteAccountApi.delete_account_delete ...'
|
38
38
|
end
|
39
39
|
# verify the required parameter 'x_account_token' is set
|
40
40
|
if @api_client.config.client_side_validation && x_account_token.nil?
|
41
|
-
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling DeleteAccountApi.
|
41
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling DeleteAccountApi.delete_account_delete"
|
42
42
|
end
|
43
43
|
# resource path
|
44
44
|
local_var_path = '/delete-account'
|
@@ -63,7 +63,7 @@ module MergeHRISClient
|
|
63
63
|
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
64
64
|
|
65
65
|
new_options = opts.merge(
|
66
|
-
:operation => :"DeleteAccountApi.
|
66
|
+
:operation => :"DeleteAccountApi.delete_account_delete",
|
67
67
|
:header_params => header_params,
|
68
68
|
:query_params => query_params,
|
69
69
|
:form_params => form_params,
|
@@ -74,7 +74,7 @@ module MergeHRISClient
|
|
74
74
|
|
75
75
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
76
76
|
if @api_client.config.debugging
|
77
|
-
@api_client.config.logger.debug "API called: DeleteAccountApi#
|
77
|
+
@api_client.config.logger.debug "API called: DeleteAccountApi#delete_account_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
78
|
end
|
79
79
|
return data, status_code, headers
|
80
80
|
end
|
@@ -0,0 +1,188 @@
|
|
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 DependentsApi
|
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 `Dependent` objects.
|
23
|
+
# @param x_account_token [String] Token identifying the end user.
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
26
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
27
|
+
# @option opts [String] :cursor The pagination cursor value.
|
28
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
29
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
30
|
+
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
31
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
32
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
33
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
34
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
35
|
+
# @return [PaginatedDependentList]
|
36
|
+
def dependents_list(x_account_token, opts = {})
|
37
|
+
data, _status_code, _headers = dependents_list_with_http_info(x_account_token, opts)
|
38
|
+
data
|
39
|
+
end
|
40
|
+
|
41
|
+
# Returns a list of `Dependent` objects.
|
42
|
+
# @param x_account_token [String] Token identifying the end user.
|
43
|
+
# @param [Hash] opts the optional parameters
|
44
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
45
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
46
|
+
# @option opts [String] :cursor The pagination cursor value.
|
47
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
48
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
49
|
+
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
50
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
51
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
52
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
53
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
54
|
+
# @return [Array<(PaginatedDependentList, Integer, Hash)>] PaginatedDependentList data, response status code and response headers
|
55
|
+
def dependents_list_with_http_info(x_account_token, opts = {})
|
56
|
+
if @api_client.config.debugging
|
57
|
+
@api_client.config.logger.debug 'Calling API: DependentsApi.dependents_list ...'
|
58
|
+
end
|
59
|
+
# verify the required parameter 'x_account_token' is set
|
60
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
61
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling DependentsApi.dependents_list"
|
62
|
+
end
|
63
|
+
# resource path
|
64
|
+
local_var_path = '/dependents'
|
65
|
+
|
66
|
+
# query parameters
|
67
|
+
query_params = opts[:query_params] || {}
|
68
|
+
query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
69
|
+
query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
70
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
71
|
+
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
72
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
73
|
+
query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
|
74
|
+
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
75
|
+
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
76
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
77
|
+
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
78
|
+
|
79
|
+
# header parameters
|
80
|
+
header_params = opts[:header_params] || {}
|
81
|
+
# HTTP header 'Accept' (if needed)
|
82
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
83
|
+
header_params[:'X-Account-Token'] = x_account_token
|
84
|
+
|
85
|
+
# form parameters
|
86
|
+
form_params = opts[:form_params] || {}
|
87
|
+
|
88
|
+
# http body (model)
|
89
|
+
post_body = opts[:debug_body]
|
90
|
+
|
91
|
+
# return_type
|
92
|
+
return_type = opts[:debug_return_type] || 'PaginatedDependentList'
|
93
|
+
|
94
|
+
# auth_names
|
95
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
96
|
+
|
97
|
+
new_options = opts.merge(
|
98
|
+
:operation => :"DependentsApi.dependents_list",
|
99
|
+
:header_params => header_params,
|
100
|
+
:query_params => query_params,
|
101
|
+
:form_params => form_params,
|
102
|
+
:body => post_body,
|
103
|
+
:auth_names => auth_names,
|
104
|
+
:return_type => return_type
|
105
|
+
)
|
106
|
+
|
107
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
108
|
+
if @api_client.config.debugging
|
109
|
+
@api_client.config.logger.debug "API called: DependentsApi#dependents_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
110
|
+
end
|
111
|
+
return data, status_code, headers
|
112
|
+
end
|
113
|
+
|
114
|
+
# Returns a `Dependent` object with the given `id`.
|
115
|
+
# @param x_account_token [String] Token identifying the end user.
|
116
|
+
# @param id [String]
|
117
|
+
# @param [Hash] opts the optional parameters
|
118
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
119
|
+
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
120
|
+
# @return [Dependent]
|
121
|
+
def dependents_retrieve(x_account_token, id, opts = {})
|
122
|
+
data, _status_code, _headers = dependents_retrieve_with_http_info(x_account_token, id, opts)
|
123
|
+
data
|
124
|
+
end
|
125
|
+
|
126
|
+
# Returns a `Dependent` object with the given `id`.
|
127
|
+
# @param x_account_token [String] Token identifying the end user.
|
128
|
+
# @param id [String]
|
129
|
+
# @param [Hash] opts the optional parameters
|
130
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
131
|
+
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
132
|
+
# @return [Array<(Dependent, Integer, Hash)>] Dependent data, response status code and response headers
|
133
|
+
def dependents_retrieve_with_http_info(x_account_token, id, opts = {})
|
134
|
+
if @api_client.config.debugging
|
135
|
+
@api_client.config.logger.debug 'Calling API: DependentsApi.dependents_retrieve ...'
|
136
|
+
end
|
137
|
+
# verify the required parameter 'x_account_token' is set
|
138
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
139
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling DependentsApi.dependents_retrieve"
|
140
|
+
end
|
141
|
+
# verify the required parameter 'id' is set
|
142
|
+
if @api_client.config.client_side_validation && id.nil?
|
143
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DependentsApi.dependents_retrieve"
|
144
|
+
end
|
145
|
+
# resource path
|
146
|
+
local_var_path = '/dependents/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
147
|
+
|
148
|
+
# query parameters
|
149
|
+
query_params = opts[:query_params] || {}
|
150
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
151
|
+
query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
|
152
|
+
|
153
|
+
# header parameters
|
154
|
+
header_params = opts[:header_params] || {}
|
155
|
+
# HTTP header 'Accept' (if needed)
|
156
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
157
|
+
header_params[:'X-Account-Token'] = x_account_token
|
158
|
+
|
159
|
+
# form parameters
|
160
|
+
form_params = opts[:form_params] || {}
|
161
|
+
|
162
|
+
# http body (model)
|
163
|
+
post_body = opts[:debug_body]
|
164
|
+
|
165
|
+
# return_type
|
166
|
+
return_type = opts[:debug_return_type] || 'Dependent'
|
167
|
+
|
168
|
+
# auth_names
|
169
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
170
|
+
|
171
|
+
new_options = opts.merge(
|
172
|
+
:operation => :"DependentsApi.dependents_retrieve",
|
173
|
+
:header_params => header_params,
|
174
|
+
:query_params => query_params,
|
175
|
+
:form_params => form_params,
|
176
|
+
:body => post_body,
|
177
|
+
:auth_names => auth_names,
|
178
|
+
:return_type => return_type
|
179
|
+
)
|
180
|
+
|
181
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
182
|
+
if @api_client.config.debugging
|
183
|
+
@api_client.config.logger.debug "API called: DependentsApi#dependents_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
184
|
+
end
|
185
|
+
return data, status_code, headers
|
186
|
+
end
|
187
|
+
end
|
188
|
+
end
|