merge_hris_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce447e67b6e49001e207324bf54dd2c3a096014dedbea70d52ba2adbd0b1175a
+  data.tar.gz: e8131a1f4d6b97732359e562ac97a3a171559fb3e822f11de87b0fe6e88bad85
+SHA512:
+  metadata.gz: c45b577c3f9d7fa8ae80c76e3a366f0a6b9993b41de4b656fcc86f2ea0ba1fc8f1b0d64473c3aa52f135c9460ce252f083fdaa675aed9f09fd32ef8822307356
+  data.tar.gz: 1c297672d94189bd8fe933151dda3aac052b94247988e6e5bd5eb4a72de1ecdc8ace51f139b46b5f5ee7b88a355d0d3034e674563fcd6cdf169f17317fa367ce

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,179 @@
+# merge_hris_client
+
+MergeHRISClient - the Ruby gem for the Merge HRIS API
+
+The unified API for building rich integrations with multiple HR Information System platforms.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build merge_hris_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./merge_hris_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./merge_hris_client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'merge_hris_client', '~> 1.0.0'
+
+### Install from Git
+
+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:
+
+    gem 'merge_hris_client', :git => 'https://github.com/merge-api/merge-hris-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'merge_hris_client'
+
+# Setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::AccountTokenApi.new
+public_token = 'public_token_example' # String | 
+
+begin
+  result = api_instance.account_token_retrieve(public_token)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Exception when calling AccountTokenApi->account_token_retrieve: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MergeHRISClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} | 
+*MergeHRISClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions | 
+*MergeHRISClient::BenefitsApi* | [**benefits_list**](docs/BenefitsApi.md#benefits_list) | **GET** /benefits | 
+*MergeHRISClient::BenefitsApi* | [**benefits_retrieve**](docs/BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} | 
+*MergeHRISClient::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /companies | 
+*MergeHRISClient::CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id} | 
+*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_list**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs | 
+*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_retrieve**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} | 
+*MergeHRISClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /employees | 
+*MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} | 
+*MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments | 
+*MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} | 
+*MergeHRISClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key | 
+*MergeHRISClient::LinkTokenApi* | [**link_token_create**](docs/LinkTokenApi.md#link_token_create) | **POST** /link-token | 
+*MergeHRISClient::LocationsApi* | [**locations_list**](docs/LocationsApi.md#locations_list) | **GET** /locations | 
+*MergeHRISClient::LocationsApi* | [**locations_retrieve**](docs/LocationsApi.md#locations_retrieve) | **GET** /locations/{id} | 
+*MergeHRISClient::PassthroughApi* | [**passthrough_create**](docs/PassthroughApi.md#passthrough_create) | **POST** /passthrough | 
+*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_list**](docs/PayrollRunsApi.md#payroll_runs_list) | **GET** /payroll-runs | 
+*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_retrieve**](docs/PayrollRunsApi.md#payroll_runs_retrieve) | **GET** /payroll-runs/{id} | 
+*MergeHRISClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key | 
+*MergeHRISClient::SyncStatusApi* | [**sync_status_retrieve**](docs/SyncStatusApi.md#sync_status_retrieve) | **GET** /sync-status | 
+*MergeHRISClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams | 
+*MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} | 
+*MergeHRISClient::TimeOffApi* | [**time_off_list**](docs/TimeOffApi.md#time_off_list) | **GET** /time-off | 
+*MergeHRISClient::TimeOffApi* | [**time_off_retrieve**](docs/TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} | 
+
+
+## Documentation for Models
+
+ - [MergeHRISClient::AccountIntegration](docs/AccountIntegration.md)
+ - [MergeHRISClient::AccountToken](docs/AccountToken.md)
+ - [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
+ - [MergeHRISClient::Benefit](docs/Benefit.md)
+ - [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
+ - [MergeHRISClient::Company](docs/Company.md)
+ - [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
+ - [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
+ - [MergeHRISClient::Deduction](docs/Deduction.md)
+ - [MergeHRISClient::Earning](docs/Earning.md)
+ - [MergeHRISClient::Employee](docs/Employee.md)
+ - [MergeHRISClient::EmployeePayrollRun](docs/EmployeePayrollRun.md)
+ - [MergeHRISClient::Employment](docs/Employment.md)
+ - [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
+ - [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
+ - [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
+ - [MergeHRISClient::EthnicityEnum](docs/EthnicityEnum.md)
+ - [MergeHRISClient::FlsaStatusEnum](docs/FlsaStatusEnum.md)
+ - [MergeHRISClient::GenderEnum](docs/GenderEnum.md)
+ - [MergeHRISClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
+ - [MergeHRISClient::LinkToken](docs/LinkToken.md)
+ - [MergeHRISClient::Location](docs/Location.md)
+ - [MergeHRISClient::MaritalStatusEnum](docs/MaritalStatusEnum.md)
+ - [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
+ - [MergeHRISClient::ModelOperation](docs/ModelOperation.md)
+ - [MergeHRISClient::PaginatedBenefitList](docs/PaginatedBenefitList.md)
+ - [MergeHRISClient::PaginatedCompanyList](docs/PaginatedCompanyList.md)
+ - [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
+ - [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
+ - [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
+ - [MergeHRISClient::PaginatedLocationList](docs/PaginatedLocationList.md)
+ - [MergeHRISClient::PaginatedPayrollRunList](docs/PaginatedPayrollRunList.md)
+ - [MergeHRISClient::PaginatedTeamList](docs/PaginatedTeamList.md)
+ - [MergeHRISClient::PaginatedTimeOffList](docs/PaginatedTimeOffList.md)
+ - [MergeHRISClient::PayCurrencyEnum](docs/PayCurrencyEnum.md)
+ - [MergeHRISClient::PayFrequencyEnum](docs/PayFrequencyEnum.md)
+ - [MergeHRISClient::PayPeriodEnum](docs/PayPeriodEnum.md)
+ - [MergeHRISClient::PayrollRun](docs/PayrollRun.md)
+ - [MergeHRISClient::RemoteData](docs/RemoteData.md)
+ - [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
+ - [MergeHRISClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
+ - [MergeHRISClient::RemoteResponse](docs/RemoteResponse.md)
+ - [MergeHRISClient::RequestTypeEnum](docs/RequestTypeEnum.md)
+ - [MergeHRISClient::RunStateEnum](docs/RunStateEnum.md)
+ - [MergeHRISClient::RunTypeEnum](docs/RunTypeEnum.md)
+ - [MergeHRISClient::StateEnum](docs/StateEnum.md)
+ - [MergeHRISClient::SyncStatus](docs/SyncStatus.md)
+ - [MergeHRISClient::Tax](docs/Tax.md)
+ - [MergeHRISClient::Team](docs/Team.md)
+ - [MergeHRISClient::TimeOff](docs/TimeOff.md)
+ - [MergeHRISClient::TimeOffStatusEnum](docs/TimeOffStatusEnum.md)
+ - [MergeHRISClient::TypeEnum](docs/TypeEnum.md)
+ - [MergeHRISClient::UnitsEnum](docs/UnitsEnum.md)
+
+
+## Documentation for Authorization
+
+
+### tokenAuth
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/config.json

@@ -0,0 +1 @@
+{"gemName": "merge_hris_client", "moduleName": "MergeHRISClient", "gitHost": "github.com", "gitUserId": "merge-api", "gitRepoId": "merge-hris-ruby"}

data/docs/AccountIntegration.md

@@ -0,0 +1,28 @@
+# MergeHRISClient::AccountIntegration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Company name. |  |
+| **categories** | **Array<String>** | Category or categories this integration belongs to. | [optional] |
+| **image** | **String** | Company logo in rectangular shape. | [optional] |
+| **square_image** | **String** | Company logo in square shape. | [optional] |
+| **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. | [optional] |
+| **slug** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::AccountIntegration.new(
+  name: null,
+  categories: null,
+  image: null,
+  square_image: null,
+  color: null,
+  slug: null
+)
+```
+

data/docs/AccountToken.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::AccountToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_token** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::AccountToken.new(
+  account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB
+)
+```
+

data/docs/AccountTokenApi.md

@@ -0,0 +1,79 @@
+# MergeHRISClient::AccountTokenApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**account_token_retrieve**](AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |  |
+
+
+## account_token_retrieve
+
+> <AccountToken> account_token_retrieve(public_token)
+
+
+
+Returns the account token for the end user with the provided public token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::AccountTokenApi.new
+public_token = 'public_token_example' # String | 
+
+begin
+  
+  result = api_instance.account_token_retrieve(public_token)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AccountTokenApi->account_token_retrieve: #{e}"
+end
+```
+
+#### Using the account_token_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountToken>, Integer, Hash)> account_token_retrieve_with_http_info(public_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.account_token_retrieve_with_http_info(public_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountToken>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AccountTokenApi->account_token_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_token** | **String** |  |  |
+
+### Return type
+
+[**AccountToken**](AccountToken.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AvailableActions.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::AvailableActions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration** | [**AccountIntegration**](AccountIntegration.md) |  |  |
+| **passthrough_available** | **Boolean** |  |  |
+| **available_model_operations** | [**Array<ModelOperation>**](ModelOperation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::AvailableActions.new(
+  integration: null,
+  passthrough_available: true,
+  available_model_operations: [{"model_name":"Candidate","available_operations":["FETCH","CREATE"]}]
+)
+```
+

data/docs/AvailableActionsApi.md

@@ -0,0 +1,79 @@
+# MergeHRISClient::AvailableActionsApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**available_actions_retrieve**](AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions |  |
+
+
+## available_actions_retrieve
+
+> <AvailableActions> available_actions_retrieve(x_account_token)
+
+
+
+Returns a list of models and actions available for an account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::AvailableActionsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.available_actions_retrieve(x_account_token)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AvailableActionsApi->available_actions_retrieve: #{e}"
+end
+```
+
+#### Using the available_actions_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AvailableActions>, Integer, Hash)> available_actions_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.available_actions_retrieve_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AvailableActions>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AvailableActionsApi->available_actions_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**AvailableActions**](AvailableActions.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+