merge_hris_client 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +179 -0
- data/Rakefile +10 -0
- data/config.json +1 -0
- data/docs/AccountIntegration.md +28 -0
- data/docs/AccountToken.md +18 -0
- data/docs/AccountTokenApi.md +79 -0
- data/docs/AvailableActions.md +22 -0
- data/docs/AvailableActionsApi.md +79 -0
- data/docs/Benefit.md +32 -0
- data/docs/BenefitPlanTypeEnum.md +15 -0
- data/docs/BenefitsApi.md +181 -0
- data/docs/CompaniesApi.md +175 -0
- data/docs/Company.md +28 -0
- data/docs/CountryEnum.md +15 -0
- data/docs/DataPassthrough.md +24 -0
- data/docs/DataPassthroughRequest.md +26 -0
- data/docs/Deduction.md +28 -0
- data/docs/Earning.md +26 -0
- data/docs/Employee.md +66 -0
- data/docs/EmployeePayrollRun.md +42 -0
- data/docs/EmployeePayrollRunsApi.md +183 -0
- data/docs/EmployeesApi.md +187 -0
- data/docs/Employment.md +38 -0
- data/docs/EmploymentStatusEnum.md +15 -0
- data/docs/EmploymentTypeEnum.md +15 -0
- data/docs/EmploymentsApi.md +177 -0
- data/docs/EndUserDetails.md +24 -0
- data/docs/EndUserDetailsRequest.md +26 -0
- data/docs/EthnicityEnum.md +15 -0
- data/docs/FlsaStatusEnum.md +15 -0
- data/docs/GenderEnum.md +15 -0
- data/docs/GenerateKeyApi.md +79 -0
- data/docs/GenerateRemoteKeyRequest.md +18 -0
- data/docs/LinkToken.md +20 -0
- data/docs/LinkTokenApi.md +79 -0
- data/docs/Location.md +36 -0
- data/docs/LocationsApi.md +175 -0
- data/docs/MaritalStatusEnum.md +15 -0
- data/docs/MethodEnum.md +15 -0
- data/docs/ModelOperation.md +22 -0
- data/docs/NullEnum.md +15 -0
- data/docs/PaginatedBenefitList.md +22 -0
- data/docs/PaginatedCompanyList.md +22 -0
- data/docs/PaginatedEmployeeList.md +22 -0
- data/docs/PaginatedEmployeePayrollRunList.md +22 -0
- data/docs/PaginatedEmploymentList.md +22 -0
- data/docs/PaginatedLocationList.md +22 -0
- data/docs/PaginatedPayrollRunList.md +22 -0
- data/docs/PaginatedTeamList.md +22 -0
- data/docs/PaginatedTimeOffList.md +22 -0
- data/docs/PassthroughApi.md +81 -0
- data/docs/PayCurrencyEnum.md +15 -0
- data/docs/PayFrequencyEnum.md +15 -0
- data/docs/PayPeriodEnum.md +15 -0
- data/docs/PayrollRun.md +32 -0
- data/docs/PayrollRunsApi.md +175 -0
- data/docs/RegenerateKeyApi.md +79 -0
- data/docs/RemoteData.md +20 -0
- data/docs/RemoteKey.md +20 -0
- data/docs/RemoteKeyForRegeneration.md +18 -0
- data/docs/RemoteKeyForRegenerationRequest.md +18 -0
- data/docs/RemoteResponse.md +26 -0
- data/docs/RequestTypeEnum.md +15 -0
- data/docs/RunStateEnum.md +15 -0
- data/docs/RunTypeEnum.md +15 -0
- data/docs/StateEnum.md +15 -0
- data/docs/SyncStatus.md +28 -0
- data/docs/SyncStatusApi.md +79 -0
- data/docs/Tax.md +28 -0
- data/docs/Team.md +24 -0
- data/docs/TeamsApi.md +175 -0
- data/docs/TimeOff.md +36 -0
- data/docs/TimeOffApi.md +183 -0
- data/docs/TimeOffStatusEnum.md +15 -0
- data/docs/TypeEnum.md +15 -0
- data/docs/UnitsEnum.md +15 -0
- data/git_push.sh +58 -0
- data/lib/merge_hris_client.rb +110 -0
- data/lib/merge_hris_client/api/account_token_api.rb +83 -0
- data/lib/merge_hris_client/api/available_actions_api.rb +84 -0
- data/lib/merge_hris_client/api/benefits_api.rb +196 -0
- data/lib/merge_hris_client/api/companies_api.rb +179 -0
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +199 -0
- data/lib/merge_hris_client/api/employees_api.rb +205 -0
- data/lib/merge_hris_client/api/employments_api.rb +182 -0
- data/lib/merge_hris_client/api/generate_key_api.rb +85 -0
- data/lib/merge_hris_client/api/link_token_api.rb +85 -0
- data/lib/merge_hris_client/api/locations_api.rb +179 -0
- data/lib/merge_hris_client/api/passthrough_api.rb +92 -0
- data/lib/merge_hris_client/api/payroll_runs_api.rb +179 -0
- data/lib/merge_hris_client/api/regenerate_key_api.rb +85 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +84 -0
- data/lib/merge_hris_client/api/teams_api.rb +179 -0
- data/lib/merge_hris_client/api/time_off_api.rb +199 -0
- data/lib/merge_hris_client/api_client.rb +390 -0
- data/lib/merge_hris_client/api_error.rb +57 -0
- data/lib/merge_hris_client/configuration.rb +279 -0
- data/lib/merge_hris_client/models/account_integration.rb +325 -0
- data/lib/merge_hris_client/models/account_token.rb +223 -0
- data/lib/merge_hris_client/models/available_actions.rb +249 -0
- data/lib/merge_hris_client/models/benefit.rb +297 -0
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +56 -0
- data/lib/merge_hris_client/models/company.rb +277 -0
- data/lib/merge_hris_client/models/country_enum.rb +282 -0
- data/lib/merge_hris_client/models/data_passthrough.rb +262 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +271 -0
- data/lib/merge_hris_client/models/deduction.rb +275 -0
- data/lib/merge_hris_client/models/earning.rb +264 -0
- data/lib/merge_hris_client/models/employee.rb +544 -0
- data/lib/merge_hris_client/models/employee_payroll_run.rb +352 -0
- data/lib/merge_hris_client/models/employment.rb +330 -0
- data/lib/merge_hris_client/models/employment_status_enum.rb +37 -0
- data/lib/merge_hris_client/models/employment_type_enum.rb +39 -0
- data/lib/merge_hris_client/models/end_user_details.rb +289 -0
- data/lib/merge_hris_client/models/end_user_details_request.rb +298 -0
- data/lib/merge_hris_client/models/ethnicity_enum.rb +42 -0
- data/lib/merge_hris_client/models/flsa_status_enum.rb +38 -0
- data/lib/merge_hris_client/models/gender_enum.rb +39 -0
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +224 -0
- data/lib/merge_hris_client/models/link_token.rb +237 -0
- data/lib/merge_hris_client/models/location.rb +319 -0
- data/lib/merge_hris_client/models/marital_status_enum.rb +39 -0
- data/lib/merge_hris_client/models/method_enum.rb +41 -0
- data/lib/merge_hris_client/models/model_operation.rb +256 -0
- data/lib/merge_hris_client/models/paginated_benefit_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_company_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employee_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employment_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_location_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_payroll_run_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_team_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_time_off_list.rb +240 -0
- data/lib/merge_hris_client/models/pay_currency_enum.rb +340 -0
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +43 -0
- data/lib/merge_hris_client/models/pay_period_enum.rb +42 -0
- data/lib/merge_hris_client/models/payroll_run.rb +297 -0
- data/lib/merge_hris_client/models/remote_data.rb +234 -0
- data/lib/merge_hris_client/models/remote_key.rb +238 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration.rb +224 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +224 -0
- data/lib/merge_hris_client/models/remote_response.rb +279 -0
- data/lib/merge_hris_client/models/request_type_enum.rb +38 -0
- data/lib/merge_hris_client/models/run_state_enum.rb +39 -0
- data/lib/merge_hris_client/models/run_type_enum.rb +49 -0
- data/lib/merge_hris_client/models/state_enum.rb +93 -0
- data/lib/merge_hris_client/models/sync_status.rb +294 -0
- data/lib/merge_hris_client/models/tax.rb +275 -0
- data/lib/merge_hris_client/models/team.rb +253 -0
- data/lib/merge_hris_client/models/time_off.rb +319 -0
- data/lib/merge_hris_client/models/time_off_status_enum.rb +39 -0
- data/lib/merge_hris_client/models/type_enum.rb +38 -0
- data/lib/merge_hris_client/models/units_enum.rb +36 -0
- data/lib/merge_hris_client/version.rb +15 -0
- data/merge_hris_client-1.0.0.gem +0 -0
- data/merge_hris_client.gemspec +38 -0
- data/pull_request_template.md +20 -0
- data/spec/api/account_token_api_spec.rb +46 -0
- data/spec/api/available_actions_api_spec.rb +46 -0
- data/spec/api/benefits_api_spec.rb +68 -0
- data/spec/api/companies_api_spec.rb +65 -0
- data/spec/api/employee_payroll_runs_api_spec.rb +69 -0
- data/spec/api/employees_api_spec.rb +71 -0
- data/spec/api/employments_api_spec.rb +66 -0
- data/spec/api/link_token_api_spec.rb +46 -0
- data/spec/api/locations_api_spec.rb +65 -0
- data/spec/api/passthrough_api_spec.rb +48 -0
- data/spec/api/payroll_runs_api_spec.rb +65 -0
- data/spec/api/regenerate_key_api_spec.rb +46 -0
- data/spec/api/teams_api_spec.rb +65 -0
- data/spec/api/time_off_api_spec.rb +69 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_integration_spec.rb +58 -0
- data/spec/models/account_token_spec.rb +34 -0
- data/spec/models/available_actions_spec.rb +34 -0
- data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
- data/spec/models/benefit_spec.rb +70 -0
- data/spec/models/company_spec.rb +58 -0
- data/spec/models/country_enum_spec.rb +28 -0
- data/spec/models/data_passthrough_request_spec.rb +58 -0
- data/spec/models/data_passthrough_spec.rb +52 -0
- data/spec/models/deduction_spec.rb +58 -0
- data/spec/models/earning_spec.rb +52 -0
- data/spec/models/employee_payroll_run_spec.rb +100 -0
- data/spec/models/employee_spec.rb +166 -0
- data/spec/models/employment_spec.rb +88 -0
- data/spec/models/employment_status_enum_spec.rb +28 -0
- data/spec/models/employment_type_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +56 -0
- data/spec/models/end_user_details_spec.rb +56 -0
- data/spec/models/ethnicity_enum_spec.rb +28 -0
- data/spec/models/flsa_status_enum_spec.rb +28 -0
- data/spec/models/gender_enum_spec.rb +28 -0
- data/spec/models/link_token_spec.rb +40 -0
- data/spec/models/location_spec.rb +82 -0
- data/spec/models/marital_status_enum_spec.rb +28 -0
- data/spec/models/method_enum_spec.rb +28 -0
- data/spec/models/model_operation_spec.rb +40 -0
- data/spec/models/paginated_benefit_list_spec.rb +46 -0
- data/spec/models/paginated_company_list_spec.rb +46 -0
- data/spec/models/paginated_employee_list_spec.rb +46 -0
- data/spec/models/paginated_employee_payroll_run_list_spec.rb +46 -0
- data/spec/models/paginated_employment_list_spec.rb +46 -0
- data/spec/models/paginated_location_list_spec.rb +46 -0
- data/spec/models/paginated_payroll_run_list_spec.rb +46 -0
- data/spec/models/paginated_team_list_spec.rb +46 -0
- data/spec/models/paginated_time_off_list_spec.rb +46 -0
- data/spec/models/pay_currency_enum_spec.rb +28 -0
- data/spec/models/pay_frequency_enum_spec.rb +28 -0
- data/spec/models/pay_period_enum_spec.rb +28 -0
- data/spec/models/payroll_run_spec.rb +70 -0
- data/spec/models/remote_data_spec.rb +40 -0
- data/spec/models/remote_key_for_regeneration_request_spec.rb +34 -0
- data/spec/models/remote_key_for_regeneration_spec.rb +34 -0
- data/spec/models/remote_key_spec.rb +40 -0
- data/spec/models/remote_response_spec.rb +58 -0
- data/spec/models/request_type_enum_spec.rb +28 -0
- data/spec/models/run_state_enum_spec.rb +28 -0
- data/spec/models/run_type_enum_spec.rb +28 -0
- data/spec/models/state_enum_spec.rb +28 -0
- data/spec/models/tax_spec.rb +58 -0
- data/spec/models/team_spec.rb +46 -0
- data/spec/models/time_off_spec.rb +82 -0
- data/spec/models/time_off_status_enum_spec.rb +28 -0
- data/spec/models/type_enum_spec.rb +28 -0
- data/spec/models/units_enum_spec.rb +28 -0
- data/spec/spec_helper.rb +111 -0
- data/test_ruby.rb +30 -0
- metadata +385 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ce447e67b6e49001e207324bf54dd2c3a096014dedbea70d52ba2adbd0b1175a
|
4
|
+
data.tar.gz: e8131a1f4d6b97732359e562ac97a3a171559fb3e822f11de87b0fe6e88bad85
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c45b577c3f9d7fa8ae80c76e3a366f0a6b9993b41de4b656fcc86f2ea0ba1fc8f1b0d64473c3aa52f135c9460ce252f083fdaa675aed9f09fd32ef8822307356
|
7
|
+
data.tar.gz: 1c297672d94189bd8fe933151dda3aac052b94247988e6e5bd5eb4a72de1ecdc8ace51f139b46b5f5ee7b88a355d0d3034e674563fcd6cdf169f17317fa367ce
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,179 @@
|
|
1
|
+
# merge_hris_client
|
2
|
+
|
3
|
+
MergeHRISClient - the Ruby gem for the Merge HRIS API
|
4
|
+
|
5
|
+
The unified API for building rich integrations with multiple HR Information System platforms.
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 1.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build merge_hris_client.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./merge_hris_client-1.0.0.gem
|
28
|
+
```
|
29
|
+
|
30
|
+
(for development, run `gem install --dev ./merge_hris_client-1.0.0.gem` to install the development dependencies)
|
31
|
+
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
|
+
|
34
|
+
Finally add this to the Gemfile:
|
35
|
+
|
36
|
+
gem 'merge_hris_client', '~> 1.0.0'
|
37
|
+
|
38
|
+
### Install from Git
|
39
|
+
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/merge-api/merge-hris-ruby, then add the following in the Gemfile:
|
41
|
+
|
42
|
+
gem 'merge_hris_client', :git => 'https://github.com/merge-api/merge-hris-ruby.git'
|
43
|
+
|
44
|
+
### Include the Ruby code directly
|
45
|
+
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
47
|
+
|
48
|
+
```shell
|
49
|
+
ruby -Ilib script.rb
|
50
|
+
```
|
51
|
+
|
52
|
+
## Getting Started
|
53
|
+
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# Load the gem
|
58
|
+
require 'merge_hris_client'
|
59
|
+
|
60
|
+
# Setup authorization
|
61
|
+
MergeHRISClient.configure do |config|
|
62
|
+
# Configure API key authorization: tokenAuth
|
63
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
64
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
65
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
66
|
+
end
|
67
|
+
|
68
|
+
api_instance = MergeHRISClient::AccountTokenApi.new
|
69
|
+
public_token = 'public_token_example' # String |
|
70
|
+
|
71
|
+
begin
|
72
|
+
result = api_instance.account_token_retrieve(public_token)
|
73
|
+
p result
|
74
|
+
rescue MergeHRISClient::ApiError => e
|
75
|
+
puts "Exception when calling AccountTokenApi->account_token_retrieve: #{e}"
|
76
|
+
end
|
77
|
+
|
78
|
+
```
|
79
|
+
|
80
|
+
## Documentation for API Endpoints
|
81
|
+
|
82
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
83
|
+
|
84
|
+
Class | Method | HTTP request | Description
|
85
|
+
------------ | ------------- | ------------- | -------------
|
86
|
+
*MergeHRISClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |
|
87
|
+
*MergeHRISClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions |
|
88
|
+
*MergeHRISClient::BenefitsApi* | [**benefits_list**](docs/BenefitsApi.md#benefits_list) | **GET** /benefits |
|
89
|
+
*MergeHRISClient::BenefitsApi* | [**benefits_retrieve**](docs/BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} |
|
90
|
+
*MergeHRISClient::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /companies |
|
91
|
+
*MergeHRISClient::CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id} |
|
92
|
+
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_list**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs |
|
93
|
+
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_retrieve**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} |
|
94
|
+
*MergeHRISClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /employees |
|
95
|
+
*MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} |
|
96
|
+
*MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments |
|
97
|
+
*MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} |
|
98
|
+
*MergeHRISClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |
|
99
|
+
*MergeHRISClient::LinkTokenApi* | [**link_token_create**](docs/LinkTokenApi.md#link_token_create) | **POST** /link-token |
|
100
|
+
*MergeHRISClient::LocationsApi* | [**locations_list**](docs/LocationsApi.md#locations_list) | **GET** /locations |
|
101
|
+
*MergeHRISClient::LocationsApi* | [**locations_retrieve**](docs/LocationsApi.md#locations_retrieve) | **GET** /locations/{id} |
|
102
|
+
*MergeHRISClient::PassthroughApi* | [**passthrough_create**](docs/PassthroughApi.md#passthrough_create) | **POST** /passthrough |
|
103
|
+
*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_list**](docs/PayrollRunsApi.md#payroll_runs_list) | **GET** /payroll-runs |
|
104
|
+
*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_retrieve**](docs/PayrollRunsApi.md#payroll_runs_retrieve) | **GET** /payroll-runs/{id} |
|
105
|
+
*MergeHRISClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key |
|
106
|
+
*MergeHRISClient::SyncStatusApi* | [**sync_status_retrieve**](docs/SyncStatusApi.md#sync_status_retrieve) | **GET** /sync-status |
|
107
|
+
*MergeHRISClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams |
|
108
|
+
*MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} |
|
109
|
+
*MergeHRISClient::TimeOffApi* | [**time_off_list**](docs/TimeOffApi.md#time_off_list) | **GET** /time-off |
|
110
|
+
*MergeHRISClient::TimeOffApi* | [**time_off_retrieve**](docs/TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} |
|
111
|
+
|
112
|
+
|
113
|
+
## Documentation for Models
|
114
|
+
|
115
|
+
- [MergeHRISClient::AccountIntegration](docs/AccountIntegration.md)
|
116
|
+
- [MergeHRISClient::AccountToken](docs/AccountToken.md)
|
117
|
+
- [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
|
118
|
+
- [MergeHRISClient::Benefit](docs/Benefit.md)
|
119
|
+
- [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
|
120
|
+
- [MergeHRISClient::Company](docs/Company.md)
|
121
|
+
- [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
|
122
|
+
- [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
|
123
|
+
- [MergeHRISClient::Deduction](docs/Deduction.md)
|
124
|
+
- [MergeHRISClient::Earning](docs/Earning.md)
|
125
|
+
- [MergeHRISClient::Employee](docs/Employee.md)
|
126
|
+
- [MergeHRISClient::EmployeePayrollRun](docs/EmployeePayrollRun.md)
|
127
|
+
- [MergeHRISClient::Employment](docs/Employment.md)
|
128
|
+
- [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
|
129
|
+
- [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
|
130
|
+
- [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
|
131
|
+
- [MergeHRISClient::EthnicityEnum](docs/EthnicityEnum.md)
|
132
|
+
- [MergeHRISClient::FlsaStatusEnum](docs/FlsaStatusEnum.md)
|
133
|
+
- [MergeHRISClient::GenderEnum](docs/GenderEnum.md)
|
134
|
+
- [MergeHRISClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
|
135
|
+
- [MergeHRISClient::LinkToken](docs/LinkToken.md)
|
136
|
+
- [MergeHRISClient::Location](docs/Location.md)
|
137
|
+
- [MergeHRISClient::MaritalStatusEnum](docs/MaritalStatusEnum.md)
|
138
|
+
- [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
|
139
|
+
- [MergeHRISClient::ModelOperation](docs/ModelOperation.md)
|
140
|
+
- [MergeHRISClient::PaginatedBenefitList](docs/PaginatedBenefitList.md)
|
141
|
+
- [MergeHRISClient::PaginatedCompanyList](docs/PaginatedCompanyList.md)
|
142
|
+
- [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
|
143
|
+
- [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
|
144
|
+
- [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
|
145
|
+
- [MergeHRISClient::PaginatedLocationList](docs/PaginatedLocationList.md)
|
146
|
+
- [MergeHRISClient::PaginatedPayrollRunList](docs/PaginatedPayrollRunList.md)
|
147
|
+
- [MergeHRISClient::PaginatedTeamList](docs/PaginatedTeamList.md)
|
148
|
+
- [MergeHRISClient::PaginatedTimeOffList](docs/PaginatedTimeOffList.md)
|
149
|
+
- [MergeHRISClient::PayCurrencyEnum](docs/PayCurrencyEnum.md)
|
150
|
+
- [MergeHRISClient::PayFrequencyEnum](docs/PayFrequencyEnum.md)
|
151
|
+
- [MergeHRISClient::PayPeriodEnum](docs/PayPeriodEnum.md)
|
152
|
+
- [MergeHRISClient::PayrollRun](docs/PayrollRun.md)
|
153
|
+
- [MergeHRISClient::RemoteData](docs/RemoteData.md)
|
154
|
+
- [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
|
155
|
+
- [MergeHRISClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
|
156
|
+
- [MergeHRISClient::RemoteResponse](docs/RemoteResponse.md)
|
157
|
+
- [MergeHRISClient::RequestTypeEnum](docs/RequestTypeEnum.md)
|
158
|
+
- [MergeHRISClient::RunStateEnum](docs/RunStateEnum.md)
|
159
|
+
- [MergeHRISClient::RunTypeEnum](docs/RunTypeEnum.md)
|
160
|
+
- [MergeHRISClient::StateEnum](docs/StateEnum.md)
|
161
|
+
- [MergeHRISClient::SyncStatus](docs/SyncStatus.md)
|
162
|
+
- [MergeHRISClient::Tax](docs/Tax.md)
|
163
|
+
- [MergeHRISClient::Team](docs/Team.md)
|
164
|
+
- [MergeHRISClient::TimeOff](docs/TimeOff.md)
|
165
|
+
- [MergeHRISClient::TimeOffStatusEnum](docs/TimeOffStatusEnum.md)
|
166
|
+
- [MergeHRISClient::TypeEnum](docs/TypeEnum.md)
|
167
|
+
- [MergeHRISClient::UnitsEnum](docs/UnitsEnum.md)
|
168
|
+
|
169
|
+
|
170
|
+
## Documentation for Authorization
|
171
|
+
|
172
|
+
|
173
|
+
### tokenAuth
|
174
|
+
|
175
|
+
|
176
|
+
- **Type**: API key
|
177
|
+
- **API key parameter name**: Authorization
|
178
|
+
- **Location**: HTTP header
|
179
|
+
|
data/Rakefile
ADDED
data/config.json
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
{"gemName": "merge_hris_client", "moduleName": "MergeHRISClient", "gitHost": "github.com", "gitUserId": "merge-api", "gitRepoId": "merge-hris-ruby"}
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MergeHRISClient::AccountIntegration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Company name. | |
|
8
|
+
| **categories** | **Array<String>** | Category or categories this integration belongs to. | [optional] |
|
9
|
+
| **image** | **String** | Company logo in rectangular shape. | [optional] |
|
10
|
+
| **square_image** | **String** | Company logo in square shape. | [optional] |
|
11
|
+
| **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. | [optional] |
|
12
|
+
| **slug** | **String** | | [optional][readonly] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'merge_hris_client'
|
18
|
+
|
19
|
+
instance = MergeHRISClient::AccountIntegration.new(
|
20
|
+
name: null,
|
21
|
+
categories: null,
|
22
|
+
image: null,
|
23
|
+
square_image: null,
|
24
|
+
color: null,
|
25
|
+
slug: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeHRISClient::AccountToken
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account_token** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_hris_client'
|
13
|
+
|
14
|
+
instance = MergeHRISClient::AccountToken.new(
|
15
|
+
account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,79 @@
|
|
1
|
+
# MergeHRISClient::AccountTokenApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**account_token_retrieve**](AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} | |
|
8
|
+
|
9
|
+
|
10
|
+
## account_token_retrieve
|
11
|
+
|
12
|
+
> <AccountToken> account_token_retrieve(public_token)
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
Returns the account token for the end user with the provided public token.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'merge_hris_client'
|
23
|
+
# setup authorization
|
24
|
+
MergeHRISClient.configure do |config|
|
25
|
+
# Configure API key authorization: tokenAuth
|
26
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = MergeHRISClient::AccountTokenApi.new
|
32
|
+
public_token = 'public_token_example' # String |
|
33
|
+
|
34
|
+
begin
|
35
|
+
|
36
|
+
result = api_instance.account_token_retrieve(public_token)
|
37
|
+
p result
|
38
|
+
rescue MergeHRISClient::ApiError => e
|
39
|
+
puts "Error when calling AccountTokenApi->account_token_retrieve: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
#### Using the account_token_retrieve_with_http_info variant
|
44
|
+
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
46
|
+
|
47
|
+
> <Array(<AccountToken>, Integer, Hash)> account_token_retrieve_with_http_info(public_token)
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
begin
|
51
|
+
|
52
|
+
data, status_code, headers = api_instance.account_token_retrieve_with_http_info(public_token)
|
53
|
+
p status_code # => 2xx
|
54
|
+
p headers # => { ... }
|
55
|
+
p data # => <AccountToken>
|
56
|
+
rescue MergeHRISClient::ApiError => e
|
57
|
+
puts "Error when calling AccountTokenApi->account_token_retrieve_with_http_info: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
| Name | Type | Description | Notes |
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
65
|
+
| **public_token** | **String** | | |
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**AccountToken**](AccountToken.md)
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[tokenAuth](../README.md#tokenAuth)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeHRISClient::AvailableActions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **integration** | [**AccountIntegration**](AccountIntegration.md) | | |
|
8
|
+
| **passthrough_available** | **Boolean** | | |
|
9
|
+
| **available_model_operations** | [**Array<ModelOperation>**](ModelOperation.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_hris_client'
|
15
|
+
|
16
|
+
instance = MergeHRISClient::AvailableActions.new(
|
17
|
+
integration: null,
|
18
|
+
passthrough_available: true,
|
19
|
+
available_model_operations: [{"model_name":"Candidate","available_operations":["FETCH","CREATE"]}]
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,79 @@
|
|
1
|
+
# MergeHRISClient::AvailableActionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**available_actions_retrieve**](AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions | |
|
8
|
+
|
9
|
+
|
10
|
+
## available_actions_retrieve
|
11
|
+
|
12
|
+
> <AvailableActions> available_actions_retrieve(x_account_token)
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
Returns a list of models and actions available for an account.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'merge_hris_client'
|
23
|
+
# setup authorization
|
24
|
+
MergeHRISClient.configure do |config|
|
25
|
+
# Configure API key authorization: tokenAuth
|
26
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = MergeHRISClient::AvailableActionsApi.new
|
32
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
33
|
+
|
34
|
+
begin
|
35
|
+
|
36
|
+
result = api_instance.available_actions_retrieve(x_account_token)
|
37
|
+
p result
|
38
|
+
rescue MergeHRISClient::ApiError => e
|
39
|
+
puts "Error when calling AvailableActionsApi->available_actions_retrieve: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
#### Using the available_actions_retrieve_with_http_info variant
|
44
|
+
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
46
|
+
|
47
|
+
> <Array(<AvailableActions>, Integer, Hash)> available_actions_retrieve_with_http_info(x_account_token)
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
begin
|
51
|
+
|
52
|
+
data, status_code, headers = api_instance.available_actions_retrieve_with_http_info(x_account_token)
|
53
|
+
p status_code # => 2xx
|
54
|
+
p headers # => { ... }
|
55
|
+
p data # => <AvailableActions>
|
56
|
+
rescue MergeHRISClient::ApiError => e
|
57
|
+
puts "Error when calling AvailableActionsApi->available_actions_retrieve_with_http_info: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
| Name | Type | Description | Notes |
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
65
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**AvailableActions**](AvailableActions.md)
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[tokenAuth](../README.md#tokenAuth)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: application/json
|
79
|
+
|