merge_hris_client 3.1.0 → 3.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
@@ -0,0 +1,181 @@
|
|
1
|
+
# MergeHRISClient::DependentsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**dependents_list**](DependentsApi.md#dependents_list) | **GET** /dependents | |
|
8
|
+
| [**dependents_retrieve**](DependentsApi.md#dependents_retrieve) | **GET** /dependents/{id} | |
|
9
|
+
|
10
|
+
|
11
|
+
## dependents_list
|
12
|
+
|
13
|
+
> <PaginatedDependentList> dependents_list(x_account_token, opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Returns a list of `Dependent` objects.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'merge_hris_client'
|
24
|
+
# setup authorization
|
25
|
+
MergeHRISClient.configure do |config|
|
26
|
+
# Configure API key authorization: tokenAuth
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = MergeHRISClient::DependentsApi.new
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
|
+
opts = {
|
35
|
+
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
|
+
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
39
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
|
+
include_sensitive_fields: true, # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
|
41
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
42
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
43
|
+
page_size: 56, # Integer | Number of results to return per page.
|
44
|
+
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
45
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
|
49
|
+
result = api_instance.dependents_list(x_account_token, opts)
|
50
|
+
p result
|
51
|
+
rescue MergeHRISClient::ApiError => e
|
52
|
+
puts "Error when calling DependentsApi->dependents_list: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
#### Using the dependents_list_with_http_info variant
|
57
|
+
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
59
|
+
|
60
|
+
> <Array(<PaginatedDependentList>, Integer, Hash)> dependents_list_with_http_info(x_account_token, opts)
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
begin
|
64
|
+
|
65
|
+
data, status_code, headers = api_instance.dependents_list_with_http_info(x_account_token, opts)
|
66
|
+
p status_code # => 2xx
|
67
|
+
p headers # => { ... }
|
68
|
+
p data # => <PaginatedDependentList>
|
69
|
+
rescue MergeHRISClient::ApiError => e
|
70
|
+
puts "Error when calling DependentsApi->dependents_list_with_http_info: #{e}"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Parameters
|
75
|
+
|
76
|
+
| Name | Type | Description | Notes |
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
78
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
79
|
+
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
80
|
+
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
83
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
84
|
+
| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
|
85
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
86
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
87
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
88
|
+
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
89
|
+
|
90
|
+
### Return type
|
91
|
+
|
92
|
+
[**PaginatedDependentList**](PaginatedDependentList.md)
|
93
|
+
|
94
|
+
### Authorization
|
95
|
+
|
96
|
+
[tokenAuth](../README.md#tokenAuth)
|
97
|
+
|
98
|
+
### HTTP request headers
|
99
|
+
|
100
|
+
- **Content-Type**: Not defined
|
101
|
+
- **Accept**: application/json
|
102
|
+
|
103
|
+
|
104
|
+
## dependents_retrieve
|
105
|
+
|
106
|
+
> <Dependent> dependents_retrieve(x_account_token, id, opts)
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
Returns a `Dependent` object with the given `id`.
|
111
|
+
|
112
|
+
### Examples
|
113
|
+
|
114
|
+
```ruby
|
115
|
+
require 'time'
|
116
|
+
require 'merge_hris_client'
|
117
|
+
# setup authorization
|
118
|
+
MergeHRISClient.configure do |config|
|
119
|
+
# Configure API key authorization: tokenAuth
|
120
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
121
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
122
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
123
|
+
end
|
124
|
+
|
125
|
+
api_instance = MergeHRISClient::DependentsApi.new
|
126
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
127
|
+
id = TODO # String |
|
128
|
+
opts = {
|
129
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
130
|
+
include_sensitive_fields: true # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
|
131
|
+
}
|
132
|
+
|
133
|
+
begin
|
134
|
+
|
135
|
+
result = api_instance.dependents_retrieve(x_account_token, id, opts)
|
136
|
+
p result
|
137
|
+
rescue MergeHRISClient::ApiError => e
|
138
|
+
puts "Error when calling DependentsApi->dependents_retrieve: #{e}"
|
139
|
+
end
|
140
|
+
```
|
141
|
+
|
142
|
+
#### Using the dependents_retrieve_with_http_info variant
|
143
|
+
|
144
|
+
This returns an Array which contains the response data, status code and headers.
|
145
|
+
|
146
|
+
> <Array(<Dependent>, Integer, Hash)> dependents_retrieve_with_http_info(x_account_token, id, opts)
|
147
|
+
|
148
|
+
```ruby
|
149
|
+
begin
|
150
|
+
|
151
|
+
data, status_code, headers = api_instance.dependents_retrieve_with_http_info(x_account_token, id, opts)
|
152
|
+
p status_code # => 2xx
|
153
|
+
p headers # => { ... }
|
154
|
+
p data # => <Dependent>
|
155
|
+
rescue MergeHRISClient::ApiError => e
|
156
|
+
puts "Error when calling DependentsApi->dependents_retrieve_with_http_info: #{e}"
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
### Parameters
|
161
|
+
|
162
|
+
| Name | Type | Description | Notes |
|
163
|
+
| ---- | ---- | ----------- | ----- |
|
164
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
165
|
+
| **id** | [**String**](.md) | | |
|
166
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
167
|
+
| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
|
168
|
+
|
169
|
+
### Return type
|
170
|
+
|
171
|
+
[**Dependent**](Dependent.md)
|
172
|
+
|
173
|
+
### Authorization
|
174
|
+
|
175
|
+
[tokenAuth](../README.md#tokenAuth)
|
176
|
+
|
177
|
+
### HTTP request headers
|
178
|
+
|
179
|
+
- **Content-Type**: Not defined
|
180
|
+
- **Accept**: application/json
|
181
|
+
|
data/docs/Earning.md
CHANGED
@@ -10,8 +10,8 @@
|
|
10
10
|
| **amount** | **Float** | The amount earned. | [optional] |
|
11
11
|
| **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. * `SALARY` - SALARY * `REIMBURSEMENT` - REIMBURSEMENT * `OVERTIME` - OVERTIME * `BONUS` - BONUS | [optional] |
|
12
12
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
13
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
13
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
14
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
16
|
|
17
17
|
## Example
|
@@ -26,8 +26,8 @@ instance = MergeHRISClient::Earning.new(
|
|
26
26
|
amount: 1002.34,
|
27
27
|
type: SALARY,
|
28
28
|
remote_was_deleted: null,
|
29
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
30
29
|
modified_at: 2021-10-16T00:00Z,
|
30
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
31
31
|
remote_data: null
|
32
32
|
)
|
33
33
|
```
|
data/docs/Employee.md
CHANGED
@@ -35,8 +35,8 @@
|
|
35
35
|
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
36
36
|
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
37
37
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
38
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
39
38
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
39
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
40
40
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
41
41
|
|
42
42
|
## Example
|
@@ -76,8 +76,8 @@ instance = MergeHRISClient::Employee.new(
|
|
76
76
|
avatar: http://alturl.com/h2h8m,
|
77
77
|
custom_fields: null,
|
78
78
|
remote_was_deleted: null,
|
79
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
80
79
|
modified_at: 2021-10-16T00:00Z,
|
80
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
81
81
|
remote_data: [{"path":"/people","data":["Varies by platform"]}]
|
82
82
|
)
|
83
83
|
```
|
data/docs/EmployeePayrollRun.md
CHANGED
@@ -17,8 +17,8 @@
|
|
17
17
|
| **deductions** | [**Array<Deduction>**](Deduction.md) | | [optional][readonly] |
|
18
18
|
| **taxes** | [**Array<Tax>**](Tax.md) | | [optional][readonly] |
|
19
19
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
20
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
21
20
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
21
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
22
22
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
23
23
|
|
24
24
|
## Example
|
@@ -40,8 +40,8 @@ instance = MergeHRISClient::EmployeePayrollRun.new(
|
|
40
40
|
deductions: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"Social Security","employee_deduction":34.54,"company_deduction":78.78}],
|
41
41
|
taxes: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":"False"}],
|
42
42
|
remote_was_deleted: null,
|
43
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
44
43
|
modified_at: 2021-10-16T00:00Z,
|
44
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
45
45
|
remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}]
|
46
46
|
)
|
47
47
|
```
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# MergeHRISClient::EmployerBenefit
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
+
| **benefit_plan_type** | [**BenefitPlanTypeEnum**](BenefitPlanTypeEnum.md) | The type of benefit plan. * `MEDICAL` - MEDICAL * `HEALTH_SAVINGS` - HEALTH_SAVINGS * `INSURANCE` - INSURANCE * `RETIREMENT` - RETIREMENT * `OTHER` - OTHER | [optional] |
|
10
|
+
| **name** | **String** | The employer benefit's name - typically the carrier or network name. | [optional] |
|
11
|
+
| **description** | **String** | The employer benefit's description. | [optional] |
|
12
|
+
| **deduction_code** | **String** | The employer benefit's deduction code. | [optional] |
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
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
|
+
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'merge_hris_client'
|
22
|
+
|
23
|
+
instance = MergeHRISClient::EmployerBenefit.new(
|
24
|
+
id: null,
|
25
|
+
remote_id: 19202939,
|
26
|
+
benefit_plan_type: MEDICAL,
|
27
|
+
name: Kaiser Permanente Medical Plan,
|
28
|
+
description: HDHP Silver Plan,
|
29
|
+
deduction_code: COL,
|
30
|
+
remote_was_deleted: null,
|
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
|
+
remote_data: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,177 @@
|
|
1
|
+
# MergeHRISClient::EmployerBenefitsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**employer_benefits_list**](EmployerBenefitsApi.md#employer_benefits_list) | **GET** /employer-benefits | |
|
8
|
+
| [**employer_benefits_retrieve**](EmployerBenefitsApi.md#employer_benefits_retrieve) | **GET** /employer-benefits/{id} | |
|
9
|
+
|
10
|
+
|
11
|
+
## employer_benefits_list
|
12
|
+
|
13
|
+
> <PaginatedEmployerBenefitList> employer_benefits_list(x_account_token, opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Returns a list of `EmployerBenefit` objects.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'merge_hris_client'
|
24
|
+
# setup authorization
|
25
|
+
MergeHRISClient.configure do |config|
|
26
|
+
# Configure API key authorization: tokenAuth
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = MergeHRISClient::EmployerBenefitsApi.new
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
|
+
opts = {
|
35
|
+
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
|
+
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
39
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
41
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
42
|
+
page_size: 56, # Integer | Number of results to return per page.
|
43
|
+
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
44
|
+
}
|
45
|
+
|
46
|
+
begin
|
47
|
+
|
48
|
+
result = api_instance.employer_benefits_list(x_account_token, opts)
|
49
|
+
p result
|
50
|
+
rescue MergeHRISClient::ApiError => e
|
51
|
+
puts "Error when calling EmployerBenefitsApi->employer_benefits_list: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
#### Using the employer_benefits_list_with_http_info variant
|
56
|
+
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
58
|
+
|
59
|
+
> <Array(<PaginatedEmployerBenefitList>, Integer, Hash)> employer_benefits_list_with_http_info(x_account_token, opts)
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
begin
|
63
|
+
|
64
|
+
data, status_code, headers = api_instance.employer_benefits_list_with_http_info(x_account_token, opts)
|
65
|
+
p status_code # => 2xx
|
66
|
+
p headers # => { ... }
|
67
|
+
p data # => <PaginatedEmployerBenefitList>
|
68
|
+
rescue MergeHRISClient::ApiError => e
|
69
|
+
puts "Error when calling EmployerBenefitsApi->employer_benefits_list_with_http_info: #{e}"
|
70
|
+
end
|
71
|
+
```
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
| Name | Type | Description | Notes |
|
76
|
+
| ---- | ---- | ----------- | ----- |
|
77
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
78
|
+
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
|
+
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
82
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
83
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
84
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
85
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
86
|
+
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
87
|
+
|
88
|
+
### Return type
|
89
|
+
|
90
|
+
[**PaginatedEmployerBenefitList**](PaginatedEmployerBenefitList.md)
|
91
|
+
|
92
|
+
### Authorization
|
93
|
+
|
94
|
+
[tokenAuth](../README.md#tokenAuth)
|
95
|
+
|
96
|
+
### HTTP request headers
|
97
|
+
|
98
|
+
- **Content-Type**: Not defined
|
99
|
+
- **Accept**: application/json
|
100
|
+
|
101
|
+
|
102
|
+
## employer_benefits_retrieve
|
103
|
+
|
104
|
+
> <EmployerBenefit> employer_benefits_retrieve(x_account_token, id, opts)
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
Returns an `EmployerBenefit` object with the given `id`.
|
109
|
+
|
110
|
+
### Examples
|
111
|
+
|
112
|
+
```ruby
|
113
|
+
require 'time'
|
114
|
+
require 'merge_hris_client'
|
115
|
+
# setup authorization
|
116
|
+
MergeHRISClient.configure do |config|
|
117
|
+
# Configure API key authorization: tokenAuth
|
118
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
119
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
120
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
121
|
+
end
|
122
|
+
|
123
|
+
api_instance = MergeHRISClient::EmployerBenefitsApi.new
|
124
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
125
|
+
id = TODO # String |
|
126
|
+
opts = {
|
127
|
+
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
128
|
+
}
|
129
|
+
|
130
|
+
begin
|
131
|
+
|
132
|
+
result = api_instance.employer_benefits_retrieve(x_account_token, id, opts)
|
133
|
+
p result
|
134
|
+
rescue MergeHRISClient::ApiError => e
|
135
|
+
puts "Error when calling EmployerBenefitsApi->employer_benefits_retrieve: #{e}"
|
136
|
+
end
|
137
|
+
```
|
138
|
+
|
139
|
+
#### Using the employer_benefits_retrieve_with_http_info variant
|
140
|
+
|
141
|
+
This returns an Array which contains the response data, status code and headers.
|
142
|
+
|
143
|
+
> <Array(<EmployerBenefit>, Integer, Hash)> employer_benefits_retrieve_with_http_info(x_account_token, id, opts)
|
144
|
+
|
145
|
+
```ruby
|
146
|
+
begin
|
147
|
+
|
148
|
+
data, status_code, headers = api_instance.employer_benefits_retrieve_with_http_info(x_account_token, id, opts)
|
149
|
+
p status_code # => 2xx
|
150
|
+
p headers # => { ... }
|
151
|
+
p data # => <EmployerBenefit>
|
152
|
+
rescue MergeHRISClient::ApiError => e
|
153
|
+
puts "Error when calling EmployerBenefitsApi->employer_benefits_retrieve_with_http_info: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
|
159
|
+
| Name | Type | Description | Notes |
|
160
|
+
| ---- | ---- | ----------- | ----- |
|
161
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
162
|
+
| **id** | [**String**](.md) | | |
|
163
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**EmployerBenefit**](EmployerBenefit.md)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
[tokenAuth](../README.md#tokenAuth)
|
172
|
+
|
173
|
+
### HTTP request headers
|
174
|
+
|
175
|
+
- **Content-Type**: Not defined
|
176
|
+
- **Accept**: application/json
|
177
|
+
|
data/docs/Employment.md
CHANGED
@@ -17,8 +17,8 @@
|
|
17
17
|
| **effective_date** | **Time** | The position's effective date. | [optional] |
|
18
18
|
| **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | The position's type of employment. * `FULL_TIME` - FULL_TIME * `PART_TIME` - PART_TIME * `INTERN` - INTERN * `CONTRACTOR` - CONTRACTOR * `FREELANCE` - FREELANCE | [optional] |
|
19
19
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
20
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
21
20
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
21
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
22
22
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
23
23
|
|
24
24
|
## Example
|
@@ -40,8 +40,8 @@ instance = MergeHRISClient::Employment.new(
|
|
40
40
|
effective_date: 2023-10-06T18:42:34Z,
|
41
41
|
employment_type: FULL TIME,
|
42
42
|
remote_was_deleted: null,
|
43
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
44
43
|
modified_at: 2021-10-16T00:00Z,
|
44
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
45
45
|
remote_data: [{"path":"/jobs","data":["Varies by platform"]}]
|
46
46
|
)
|
47
47
|
```
|
data/docs/EmploymentsApi.md
CHANGED
@@ -41,7 +41,7 @@ opts = {
|
|
41
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
42
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
43
43
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
44
|
-
order_by: '-effective_date', # String | Overrides the default ordering for this endpoint.
|
44
|
+
order_by: '-effective_date', # String | Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
|
45
45
|
page_size: 56, # Integer | Number of results to return per page.
|
46
46
|
remote_fields: 'employment_type', # String | Deprecated. Use show_enum_origins.
|
47
47
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
@@ -89,7 +89,7 @@ end
|
|
89
89
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
90
90
|
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
91
91
|
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
92
|
-
| **order_by** | **String** | Overrides the default ordering for this endpoint. | [optional] |
|
92
|
+
| **order_by** | **String** | Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. | [optional] |
|
93
93
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
94
94
|
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
95
95
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
@@ -10,7 +10,7 @@
|
|
10
10
|
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. | |
|
11
11
|
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/. | [optional] |
|
12
12
|
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
|
13
|
-
| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/
|
13
|
+
| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. | [optional][default to false] |
|
14
14
|
| **common_models** | [**Array<CommonModelScopesBodyRequest>**](CommonModelScopesBodyRequest.md) | An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. | [optional] |
|
15
15
|
|
16
16
|
## Example
|
data/docs/Group.md
CHANGED
@@ -10,8 +10,8 @@
|
|
10
10
|
| **name** | **String** | The group name. | [optional] |
|
11
11
|
| **type** | [**GroupTypeEnum**](GroupTypeEnum.md) | The group type * `TEAM` - TEAM * `DEPARTMENT` - DEPARTMENT * `COST_CENTER` - COST_CENTER * `BUSINESS_UNIT` - BUSINESS_UNIT * `GROUP` - GROUP | [optional] |
|
12
12
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
13
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
13
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
14
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
16
|
|
17
17
|
## Example
|
@@ -26,8 +26,8 @@ instance = MergeHRISClient::Group.new(
|
|
26
26
|
name: COST_CENTER_US,
|
27
27
|
type: COST_CENTER,
|
28
28
|
remote_was_deleted: null,
|
29
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
30
29
|
modified_at: 2021-10-16T00:00Z,
|
30
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
31
31
|
remote_data: [{"path":"/group","data":["Varies by platform"]}]
|
32
32
|
)
|
33
33
|
```
|
data/docs/LinkedAccountsApi.md
CHANGED
@@ -30,7 +30,7 @@ end
|
|
30
30
|
|
31
31
|
api_instance = MergeHRISClient::LinkedAccountsApi.new
|
32
32
|
opts = {
|
33
|
-
category: 'accounting', # String |
|
33
|
+
category: 'accounting', # String | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage') * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage
|
34
34
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
35
35
|
end_user_email_address: 'end_user_email_address_example', # String | If provided, will only return linked accounts associated with the given email address.
|
36
36
|
end_user_organization_name: 'end_user_organization_name_example', # String | If provided, will only return linked accounts associated with the given organization name.
|
@@ -76,7 +76,7 @@ end
|
|
76
76
|
|
77
77
|
| Name | Type | Description | Notes |
|
78
78
|
| ---- | ---- | ----------- | ----- |
|
79
|
-
| **category** | **String** |
|
79
|
+
| **category** | **String** | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage') * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage | [optional] |
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
81
|
| **end_user_email_address** | **String** | If provided, will only return linked accounts associated with the given email address. | [optional] |
|
82
82
|
| **end_user_organization_name** | **String** | If provided, will only return linked accounts associated with the given organization name. | [optional] |
|
data/docs/Location.md
CHANGED
@@ -16,8 +16,8 @@
|
|
16
16
|
| **country** | [**CountryEnum**](CountryEnum.md) | The location's country. * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia (Federated States of) * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe | [optional] |
|
17
17
|
| **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | The location's type. Can be either WORK or HOME * `HOME` - HOME * `WORK` - WORK | [optional] |
|
18
18
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [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
|
@@ -35,11 +35,11 @@ instance = MergeHRISClient::Location.new(
|
|
35
35
|
city: New York ,
|
36
36
|
state: NY,
|
37
37
|
zip_code: 10027,
|
38
|
-
country:
|
38
|
+
country: US,
|
39
39
|
location_type: WORK,
|
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":"/locations","data":["Varies by platform"]}]
|
44
44
|
)
|
45
45
|
```
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeHRISClient::PaginatedDependentList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_next** | **String** | | [optional] |
|
8
|
+
| **previous** | **String** | | [optional] |
|
9
|
+
| **results** | [**Array<Dependent>**](Dependent.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_hris_client'
|
15
|
+
|
16
|
+
instance = MergeHRISClient::PaginatedDependentList.new(
|
17
|
+
_next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
|
18
|
+
previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
|
19
|
+
results: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeHRISClient::PaginatedEmployerBenefitList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_next** | **String** | | [optional] |
|
8
|
+
| **previous** | **String** | | [optional] |
|
9
|
+
| **results** | [**Array<EmployerBenefit>**](EmployerBenefit.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_hris_client'
|
15
|
+
|
16
|
+
instance = MergeHRISClient::PaginatedEmployerBenefitList.new(
|
17
|
+
_next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
|
18
|
+
previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
|
19
|
+
results: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|