merge_hris_client 3.0.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 +33 -9
- data/docs/AccountIntegration.md +6 -2
- data/docs/AsyncPassthroughApi.md +155 -0
- data/docs/AsyncPassthroughReciept.md +18 -0
- data/docs/BankInfo.md +9 -5
- data/docs/BankInfoApi.md +17 -13
- data/docs/Benefit.md +15 -5
- data/docs/BenefitPlanTypeEnum.md +15 -0
- data/docs/BenefitsApi.md +6 -6
- data/docs/CommonModelScopeData.md +20 -0
- data/docs/CommonModelScopes.md +20 -0
- data/docs/CommonModelScopesApi.md +157 -0
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/CommonModelScopesDisabledModels.md +26 -0
- data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
- data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
- data/docs/CommonModelScopesUpdateSerializer.md +18 -0
- data/docs/CompaniesApi.md +4 -4
- data/docs/Company.md +7 -3
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/Deduction.md +11 -5
- data/docs/DeleteAccountApi.md +9 -9
- data/docs/Dependent.md +50 -0
- data/docs/DependentsApi.md +181 -0
- data/docs/Earning.md +10 -2
- data/docs/Employee.md +19 -15
- data/docs/EmployeePayrollRun.md +11 -7
- data/docs/EmployeePayrollRunsApi.md +4 -4
- data/docs/EmployeeRequest.md +16 -18
- data/docs/EmployeesApi.md +31 -18
- data/docs/EmployerBenefit.md +36 -0
- data/docs/EmployerBenefitsApi.md +177 -0
- data/docs/Employment.md +14 -10
- data/docs/EmploymentsApi.md +15 -11
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +6 -4
- data/docs/ForceResyncApi.md +1 -1
- data/docs/Group.md +8 -4
- data/docs/GroupsApi.md +15 -9
- data/docs/Issue.md +10 -8
- data/docs/IssuesApi.md +6 -6
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountCondition.md +28 -0
- data/docs/LinkedAccountConditionRequest.md +22 -0
- data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +10 -6
- data/docs/LocationsApi.md +13 -9
- data/docs/MetaResponse.md +2 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/PaginatedDependentList.md +22 -0
- data/docs/PaginatedEmployerBenefitList.md +22 -0
- data/docs/PayGroup.md +7 -3
- data/docs/PayGroupsApi.md +4 -4
- data/docs/PayrollRun.md +9 -5
- data/docs/PayrollRunsApi.md +14 -10
- data/docs/RelationshipEnum.md +15 -0
- data/docs/RemoteData.md +1 -1
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +5 -3
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +9 -1
- data/docs/Team.md +8 -4
- data/docs/TeamsApi.md +4 -4
- data/docs/TimeOff.md +13 -9
- data/docs/TimeOffApi.md +16 -12
- data/docs/TimeOffBalance.md +10 -6
- data/docs/TimeOffBalancesApi.md +15 -11
- data/docs/TimeOffRequest.md +11 -9
- data/lib/merge_hris_client/api/async_passthrough_api.rb +160 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +26 -12
- data/lib/merge_hris_client/api/benefits_api.rb +6 -6
- data/lib/merge_hris_client/api/common_model_scopes_api.rb +146 -0
- data/lib/merge_hris_client/api/companies_api.rb +4 -4
- data/lib/merge_hris_client/api/delete_account_api.rb +7 -7
- data/lib/merge_hris_client/api/dependents_api.rb +188 -0
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +4 -4
- data/lib/merge_hris_client/api/employees_api.rb +44 -17
- data/lib/merge_hris_client/api/employer_benefits_api.rb +182 -0
- data/lib/merge_hris_client/api/employments_api.rb +24 -10
- data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
- data/lib/merge_hris_client/api/groups_api.rb +25 -8
- data/lib/merge_hris_client/api/issues_api.rb +6 -6
- data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_hris_client/api/locations_api.rb +22 -8
- data/lib/merge_hris_client/api/pay_groups_api.rb +4 -4
- data/lib/merge_hris_client/api/payroll_runs_api.rb +24 -10
- data/lib/merge_hris_client/api/selective_sync_api.rb +225 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
- data/lib/merge_hris_client/api/teams_api.rb +4 -4
- data/lib/merge_hris_client/api/time_off_api.rb +26 -12
- data/lib/merge_hris_client/api/time_off_balances_api.rb +24 -10
- data/lib/merge_hris_client/models/account_integration.rb +30 -8
- data/lib/merge_hris_client/models/async_passthrough_reciept.rb +223 -0
- data/lib/merge_hris_client/models/bank_info.rb +39 -16
- data/lib/merge_hris_client/models/benefit.rb +70 -14
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +48 -0
- data/lib/merge_hris_client/models/categories_enum.rb +3 -1
- data/lib/merge_hris_client/models/category_enum.rb +3 -1
- data/lib/merge_hris_client/models/common_model_scope_data.rb +234 -0
- data/lib/merge_hris_client/models/common_model_scopes.rb +234 -0
- data/lib/merge_hris_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_hris_client/models/common_model_scopes_disabled_models.rb +283 -0
- data/lib/merge_hris_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
- data/lib/merge_hris_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
- data/lib/merge_hris_client/models/common_model_scopes_update_serializer.rb +226 -0
- data/lib/merge_hris_client/models/company.rb +37 -15
- data/lib/merge_hris_client/models/condition_schema.rb +298 -0
- data/lib/merge_hris_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_hris_client/models/deduction.rb +50 -17
- data/lib/merge_hris_client/models/dependent.rb +470 -0
- data/lib/merge_hris_client/models/earning.rb +51 -6
- data/lib/merge_hris_client/models/employee.rb +51 -23
- data/lib/merge_hris_client/models/employee_payroll_run.rb +41 -17
- data/lib/merge_hris_client/models/employee_request.rb +34 -39
- data/lib/merge_hris_client/models/employer_benefit.rb +363 -0
- data/lib/merge_hris_client/models/employment.rb +44 -20
- data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_hris_client/models/end_user_details_request.rb +21 -8
- data/lib/merge_hris_client/models/group.rb +38 -16
- data/lib/merge_hris_client/models/group_type_enum.rb +2 -1
- data/lib/merge_hris_client/models/issue.rb +16 -4
- data/lib/merge_hris_client/models/link_token.rb +0 -5
- data/lib/merge_hris_client/models/linked_account_condition.rb +282 -0
- data/lib/merge_hris_client/models/linked_account_condition_request.rb +269 -0
- data/lib/merge_hris_client/models/linked_account_selective_sync_configuration.rb +221 -0
- data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
- data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
- data/lib/merge_hris_client/models/location.rb +39 -17
- data/lib/merge_hris_client/models/meta_response.rb +12 -1
- data/lib/merge_hris_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_hris_client/models/operator_schema.rb +229 -0
- data/lib/merge_hris_client/models/paginated_condition_schema_list.rb +240 -0
- data/lib/merge_hris_client/models/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_frequency_enum.rb +2 -1
- data/lib/merge_hris_client/models/pay_group.rb +37 -15
- data/lib/merge_hris_client/models/pay_period_enum.rb +2 -1
- data/lib/merge_hris_client/models/payroll_run.rb +39 -17
- 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/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_hris_client/models/sync_status.rb +13 -4
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -1
- data/lib/merge_hris_client/models/tax.rb +50 -5
- data/lib/merge_hris_client/models/team.rb +38 -15
- data/lib/merge_hris_client/models/time_off.rb +43 -19
- data/lib/merge_hris_client/models/time_off_balance.rb +40 -17
- data/lib/merge_hris_client/models/time_off_request.rb +36 -21
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +31 -0
- data/spec/api/async_passthrough_api_spec.rb +59 -0
- data/spec/api/bank_info_api_spec.rb +8 -6
- data/spec/api/benefits_api_spec.rb +3 -3
- data/spec/api/common_model_scopes_api_spec.rb +58 -0
- data/spec/api/companies_api_spec.rb +2 -2
- data/spec/api/delete_account_api_spec.rb +2 -2
- data/spec/api/dependents_api_spec.rb +70 -0
- data/spec/api/employee_payroll_runs_api_spec.rb +2 -2
- data/spec/api/employees_api_spec.rb +13 -6
- data/spec/api/employer_benefits_api_spec.rb +68 -0
- data/spec/api/employments_api_spec.rb +7 -5
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/groups_api_spec.rb +7 -4
- data/spec/api/issues_api_spec.rb +3 -3
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/locations_api_spec.rb +6 -4
- data/spec/api/pay_groups_api_spec.rb +2 -2
- data/spec/api/payroll_runs_api_spec.rb +7 -5
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/teams_api_spec.rb +2 -2
- data/spec/api/time_off_api_spec.rb +8 -6
- data/spec/api/time_off_balances_api_spec.rb +7 -5
- data/spec/models/account_integration_spec.rb +12 -0
- data/spec/models/async_passthrough_reciept_spec.rb +34 -0
- data/spec/models/bank_info_spec.rb +14 -2
- data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
- data/spec/models/benefit_spec.rb +31 -1
- data/spec/models/common_model_scope_data_spec.rb +40 -0
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
- data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
- data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_spec.rb +40 -0
- data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
- data/spec/models/company_spec.rb +14 -2
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/deduction_spec.rb +20 -2
- data/spec/models/dependent_spec.rb +130 -0
- data/spec/models/earning_spec.rb +24 -0
- data/spec/models/employee_payroll_run_spec.rb +14 -2
- data/spec/models/employee_request_spec.rb +5 -11
- data/spec/models/employee_spec.rb +15 -3
- data/spec/models/employer_benefit_spec.rb +88 -0
- data/spec/models/employment_spec.rb +14 -2
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/group_spec.rb +14 -2
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/linked_account_condition_request_spec.rb +46 -0
- data/spec/models/linked_account_condition_spec.rb +64 -0
- data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
- data/spec/models/location_spec.rb +14 -2
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/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 +14 -2
- data/spec/models/payroll_run_spec.rb +14 -2
- data/spec/models/relationship_enum_spec.rb +28 -0
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tax_spec.rb +24 -0
- data/spec/models/team_spec.rb +14 -2
- data/spec/models/time_off_balance_spec.rb +14 -2
- data/spec/models/time_off_request_spec.rb +12 -6
- data/spec/models/time_off_spec.rb +14 -2
- metadata +225 -105
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# MergeHRISClient::SelectiveSyncConfigurationsUsageEnum
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'merge_hris_client'
|
|
12
|
+
|
|
13
|
+
instance = MergeHRISClient::SelectiveSyncConfigurationsUsageEnum.new()
|
|
14
|
+
```
|
|
15
|
+
|
data/docs/SyncStatus.md
CHANGED
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
| **next_sync_start** | **Time** | | [optional] |
|
|
11
11
|
| **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) | | |
|
|
12
12
|
| **is_initial_sync** | **Boolean** | | |
|
|
13
|
+
| **selective_sync_configurations_usage** | [**SelectiveSyncConfigurationsUsageEnum**](SelectiveSyncConfigurationsUsageEnum.md) | | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -17,12 +18,13 @@
|
|
|
17
18
|
require 'merge_hris_client'
|
|
18
19
|
|
|
19
20
|
instance = MergeHRISClient::SyncStatus.new(
|
|
20
|
-
model_name:
|
|
21
|
-
model_id:
|
|
21
|
+
model_name: Employee,
|
|
22
|
+
model_id: hris.Employee,
|
|
22
23
|
last_sync_start: 2021-03-30T19:44:18.695973Z,
|
|
23
24
|
next_sync_start: 2021-03-30T20:44:18.662942Z,
|
|
24
25
|
status: SYNCING,
|
|
25
|
-
is_initial_sync: true
|
|
26
|
+
is_initial_sync: true,
|
|
27
|
+
selective_sync_configurations_usage: null
|
|
26
28
|
)
|
|
27
29
|
```
|
|
28
30
|
|
data/docs/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
|
@@ -5,11 +5,15 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
8
9
|
| **employee_payroll_run** | **String** | | [optional] |
|
|
9
10
|
| **name** | **String** | The tax's name. | [optional] |
|
|
10
11
|
| **amount** | **Float** | The tax amount. | [optional] |
|
|
11
12
|
| **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
|
|
12
13
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
|
14
|
+
| **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<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
13
17
|
|
|
14
18
|
## Example
|
|
15
19
|
|
|
@@ -18,11 +22,15 @@ require 'merge_hris_client'
|
|
|
18
22
|
|
|
19
23
|
instance = MergeHRISClient::Tax.new(
|
|
20
24
|
id: e3a825fd-c38d-4095-a717-df98c4cb9ebc,
|
|
25
|
+
remote_id: 26806834,
|
|
21
26
|
employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
|
22
27
|
name: California State Income Tax,
|
|
23
28
|
amount: 100.25,
|
|
24
29
|
employer_tax: false,
|
|
25
|
-
remote_was_deleted: null
|
|
30
|
+
remote_was_deleted: null,
|
|
31
|
+
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
|
|
26
34
|
)
|
|
27
35
|
```
|
|
28
36
|
|
data/docs/Team.md
CHANGED
|
@@ -7,9 +7,11 @@
|
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
9
|
| **name** | **String** | The team's name. | [optional] |
|
|
10
|
-
| **parent_team** | **String** |
|
|
11
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
10
|
+
| **parent_team** | **String** | The team's parent team. | [optional] |
|
|
12
11
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
12
|
+
| **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
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
13
15
|
|
|
14
16
|
## Example
|
|
15
17
|
|
|
@@ -21,8 +23,10 @@ instance = MergeHRISClient::Team.new(
|
|
|
21
23
|
remote_id: 19202938,
|
|
22
24
|
name: Engineering,
|
|
23
25
|
parent_team: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
|
|
24
|
-
|
|
25
|
-
|
|
26
|
+
remote_was_deleted: null,
|
|
27
|
+
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
|
+
remote_data: [{"path":"/teams","data":["Varies by platform"]}]
|
|
26
30
|
)
|
|
27
31
|
```
|
|
28
32
|
|
data/docs/TeamsApi.md
CHANGED
|
@@ -38,8 +38,8 @@ opts = {
|
|
|
38
38
|
expand: 'parent_team', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
39
39
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
41
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
42
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
41
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
|
42
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
|
43
43
|
page_size: 56, # Integer | Number of results to return per page.
|
|
44
44
|
parent_team_id: 'parent_team_id_example', # String | If provided, will only return teams with this parent team.
|
|
45
45
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
|
@@ -83,8 +83,8 @@ end
|
|
|
83
83
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
84
84
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
85
85
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
86
|
-
| **modified_after** | **Time** | If provided,
|
|
87
|
-
| **modified_before** | **Time** | If provided,
|
|
86
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
|
87
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
|
88
88
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
89
89
|
| **parent_team_id** | **String** | If provided, will only return teams with this parent team. | [optional] |
|
|
90
90
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
data/docs/TimeOff.md
CHANGED
|
@@ -6,17 +6,19 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
|
-
| **employee** | **String** |
|
|
10
|
-
| **approver** | **String** |
|
|
11
|
-
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
|
|
9
|
+
| **employee** | **String** | The employee requesting time off. | [optional] |
|
|
10
|
+
| **approver** | **String** | The Merge ID of the employee with the ability to approve the time off request. | [optional] |
|
|
11
|
+
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
|
|
12
12
|
| **employee_note** | **String** | The employee note for this time off request. | [optional] |
|
|
13
|
-
| **units** | [**UnitsEnum**](UnitsEnum.md) | The
|
|
14
|
-
| **amount** | **Float** | The
|
|
15
|
-
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
|
|
13
|
+
| **units** | [**UnitsEnum**](UnitsEnum.md) | The measurement that the third-party integration uses to count time requested. * `HOURS` - HOURS * `DAYS` - DAYS | [optional] |
|
|
14
|
+
| **amount** | **Float** | The time off quantity measured by the prescribed “units”. | [optional] |
|
|
15
|
+
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
16
16
|
| **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
|
|
17
17
|
| **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
|
|
18
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
19
18
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
|
19
|
+
| **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
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
20
22
|
|
|
21
23
|
## Example
|
|
22
24
|
|
|
@@ -35,8 +37,10 @@ instance = MergeHRISClient::TimeOff.new(
|
|
|
35
37
|
request_type: VACATION,
|
|
36
38
|
start_time: 2020-11-10T00:00Z,
|
|
37
39
|
end_time: 2020-11-17T00:00Z,
|
|
38
|
-
|
|
39
|
-
|
|
40
|
+
remote_was_deleted: null,
|
|
41
|
+
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
|
+
remote_data: [{"path":"/leave","data":["Varies by platform"]}]
|
|
40
44
|
)
|
|
41
45
|
```
|
|
42
46
|
|
data/docs/TimeOffApi.md
CHANGED
|
@@ -121,13 +121,14 @@ opts = {
|
|
|
121
121
|
expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
122
122
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
|
123
123
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
124
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
125
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
124
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
|
125
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
|
126
126
|
page_size: 56, # Integer | Number of results to return per page.
|
|
127
|
-
remote_fields: 'request_type', # String |
|
|
127
|
+
remote_fields: 'request_type', # String | Deprecated. Use show_enum_origins.
|
|
128
128
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
|
129
|
-
request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
|
130
|
-
|
|
129
|
+
request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
|
|
130
|
+
show_enum_origins: 'request_type', # String | Which fields should be returned in non-normalized form.
|
|
131
|
+
status: 'APPROVED' # String | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED
|
|
131
132
|
}
|
|
132
133
|
|
|
133
134
|
begin
|
|
@@ -170,13 +171,14 @@ end
|
|
|
170
171
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
171
172
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
172
173
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
173
|
-
| **modified_after** | **Time** | If provided,
|
|
174
|
-
| **modified_before** | **Time** | If provided,
|
|
174
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
|
175
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
|
175
176
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
176
|
-
| **remote_fields** | **String** |
|
|
177
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
|
177
178
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
178
|
-
| **request_type** | **String** | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
|
|
179
|
-
| **
|
|
179
|
+
| **request_type** | **String** | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
180
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
181
|
+
| **status** | **String** | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
|
|
180
182
|
|
|
181
183
|
### Return type
|
|
182
184
|
|
|
@@ -290,7 +292,8 @@ id = TODO # String |
|
|
|
290
292
|
opts = {
|
|
291
293
|
expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
292
294
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
293
|
-
remote_fields: 'request_type' # String |
|
|
295
|
+
remote_fields: 'request_type', # String | Deprecated. Use show_enum_origins.
|
|
296
|
+
show_enum_origins: 'request_type' # String | Which fields should be returned in non-normalized form.
|
|
294
297
|
}
|
|
295
298
|
|
|
296
299
|
begin
|
|
@@ -328,7 +331,8 @@ end
|
|
|
328
331
|
| **id** | [**String**](.md) | | |
|
|
329
332
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
330
333
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
331
|
-
| **remote_fields** | **String** |
|
|
334
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
|
335
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
332
336
|
|
|
333
337
|
### Return type
|
|
334
338
|
|
data/docs/TimeOffBalance.md
CHANGED
|
@@ -6,12 +6,14 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
|
-
| **employee** | **String** |
|
|
10
|
-
| **balance** | **Float** | The current remaining PTO balance
|
|
9
|
+
| **employee** | **String** | The employee the balance belongs to. | [optional] |
|
|
10
|
+
| **balance** | **Float** | The current remaining PTO balance, always measured in terms of hours. | [optional] |
|
|
11
11
|
| **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
|
|
12
|
-
| **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. | [optional] |
|
|
13
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
12
|
+
| **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
14
13
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
14
|
+
| **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<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
15
17
|
|
|
16
18
|
## Example
|
|
17
19
|
|
|
@@ -25,8 +27,10 @@ instance = MergeHRISClient::TimeOffBalance.new(
|
|
|
25
27
|
balance: 60.0,
|
|
26
28
|
used: 45.0,
|
|
27
29
|
policy_type: VACATION,
|
|
28
|
-
|
|
29
|
-
|
|
30
|
+
remote_was_deleted: null,
|
|
31
|
+
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: [{"path":"/leave","data":["Varies by platform"]}]
|
|
30
34
|
)
|
|
31
35
|
```
|
|
32
36
|
|
data/docs/TimeOffBalancesApi.md
CHANGED
|
@@ -39,12 +39,13 @@ opts = {
|
|
|
39
39
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
40
40
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
|
41
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
42
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
43
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
42
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
|
43
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
|
44
44
|
page_size: 56, # Integer | Number of results to return per page.
|
|
45
|
-
policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
|
46
|
-
remote_fields: 'policy_type', # String |
|
|
47
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
|
45
|
+
policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
|
|
46
|
+
remote_fields: 'policy_type', # String | Deprecated. Use show_enum_origins.
|
|
47
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
|
48
|
+
show_enum_origins: 'policy_type' # String | Which fields should be returned in non-normalized form.
|
|
48
49
|
}
|
|
49
50
|
|
|
50
51
|
begin
|
|
@@ -86,12 +87,13 @@ end
|
|
|
86
87
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
87
88
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
88
89
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
89
|
-
| **modified_after** | **Time** | If provided,
|
|
90
|
-
| **modified_before** | **Time** | If provided,
|
|
90
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
|
91
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
|
91
92
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
92
|
-
| **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
|
|
93
|
-
| **remote_fields** | **String** |
|
|
93
|
+
| **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
94
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
|
94
95
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
96
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
95
97
|
|
|
96
98
|
### Return type
|
|
97
99
|
|
|
@@ -134,7 +136,8 @@ id = TODO # String |
|
|
|
134
136
|
opts = {
|
|
135
137
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
136
138
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
137
|
-
remote_fields: 'policy_type' # String |
|
|
139
|
+
remote_fields: 'policy_type', # String | Deprecated. Use show_enum_origins.
|
|
140
|
+
show_enum_origins: 'policy_type' # String | Which fields should be returned in non-normalized form.
|
|
138
141
|
}
|
|
139
142
|
|
|
140
143
|
begin
|
|
@@ -172,7 +175,8 @@ end
|
|
|
172
175
|
| **id** | [**String**](.md) | | |
|
|
173
176
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
174
177
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
175
|
-
| **remote_fields** | **String** |
|
|
178
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
|
179
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
176
180
|
|
|
177
181
|
### Return type
|
|
178
182
|
|
data/docs/TimeOffRequest.md
CHANGED
|
@@ -4,16 +4,17 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
10
|
-
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
|
|
7
|
+
| **employee** | **String** | The employee requesting time off. | [optional] |
|
|
8
|
+
| **approver** | **String** | The Merge ID of the employee with the ability to approve the time off request. | [optional] |
|
|
9
|
+
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
|
|
11
10
|
| **employee_note** | **String** | The employee note for this time off request. | [optional] |
|
|
12
|
-
| **units** | [**UnitsEnum**](UnitsEnum.md) | The
|
|
13
|
-
| **amount** | **Float** | The
|
|
14
|
-
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
|
|
11
|
+
| **units** | [**UnitsEnum**](UnitsEnum.md) | The measurement that the third-party integration uses to count time requested. * `HOURS` - HOURS * `DAYS` - DAYS | [optional] |
|
|
12
|
+
| **amount** | **Float** | The time off quantity measured by the prescribed “units”. | [optional] |
|
|
13
|
+
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
15
14
|
| **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
|
|
16
15
|
| **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
|
|
16
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
17
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -21,7 +22,6 @@
|
|
|
21
22
|
require 'merge_hris_client'
|
|
22
23
|
|
|
23
24
|
instance = MergeHRISClient::TimeOffRequest.new(
|
|
24
|
-
remote_id: 19202938,
|
|
25
25
|
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
|
26
26
|
approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
|
|
27
27
|
status: APPROVED,
|
|
@@ -30,7 +30,9 @@ instance = MergeHRISClient::TimeOffRequest.new(
|
|
|
30
30
|
amount: 3,
|
|
31
31
|
request_type: VACATION,
|
|
32
32
|
start_time: 2020-11-10T00:00Z,
|
|
33
|
-
end_time: 2020-11-17T00:00Z
|
|
33
|
+
end_time: 2020-11-17T00:00Z,
|
|
34
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
|
35
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
|
34
36
|
)
|
|
35
37
|
```
|
|
36
38
|
|
|
@@ -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
|