merge_hris_client 1.0.1

data/docs/Benefit.md

@@ -0,0 +1,32 @@
+# MergeHRISClient::Benefit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **employee** | **String** | The employee on the plan. | [optional] |
+| **provider_name** | **String** | The name of the benefit provider. | [optional] |
+| **benefit_plan_type** | [**BenefitPlanTypeEnum**](BenefitPlanTypeEnum.md) | The type of benefit plan | [optional] |
+| **employee_contribution** | **Float** | The employee's contribution. | [optional] |
+| **company_contribution** | **Float** | The company's contribution. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::Benefit.new(
+  id: 3fe5ae7a-f1ba-4529-b7af-84e86dc6d232,
+  remote_id: 19202938,
+  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
+  provider_name: Blue Shield of California,
+  benefit_plan_type: MEDICAL,
+  employee_contribution: 23.65,
+  company_contribution: 150.0,
+  remote_data: [{"path":"/benefits","data":["Varies by platform"]}]
+)
+```
+

data/docs/BenefitPlanTypeEnum.md

@@ -0,0 +1,15 @@
+# MergeHRISClient::BenefitPlanTypeEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::BenefitPlanTypeEnum.new()
+```
+

data/docs/BenefitsApi.md

@@ -0,0 +1,181 @@
+# MergeHRISClient::BenefitsApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**benefits_list**](BenefitsApi.md#benefits_list) | **GET** /benefits |  |
+| [**benefits_retrieve**](BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} |  |
+
+
+## benefits_list
+
+> <PaginatedBenefitList> benefits_list(x_account_token, opts)
+
+
+
+Returns a list of `Benefit` objects.
+
+### 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::BenefitsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
+  expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.benefits_list(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling BenefitsApi->benefits_list: #{e}"
+end
+```
+
+#### Using the benefits_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedBenefitList>, Integer, Hash)> benefits_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.benefits_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedBenefitList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling BenefitsApi->benefits_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedBenefitList**](PaginatedBenefitList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## benefits_retrieve
+
+> <Benefit> benefits_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Benefit` object with the given `id`.
+
+### 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::BenefitsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.benefits_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling BenefitsApi->benefits_retrieve: #{e}"
+end
+```
+
+#### Using the benefits_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Benefit>, Integer, Hash)> benefits_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.benefits_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Benefit>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling BenefitsApi->benefits_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**Benefit**](Benefit.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CompaniesApi.md

@@ -0,0 +1,175 @@
+# MergeHRISClient::CompaniesApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**companies_list**](CompaniesApi.md#companies_list) | **GET** /companies |  |
+| [**companies_retrieve**](CompaniesApi.md#companies_retrieve) | **GET** /companies/{id} |  |
+
+
+## companies_list
+
+> <PaginatedCompanyList> companies_list(x_account_token, opts)
+
+
+
+Returns a list of `Company` objects.
+
+### 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::CompaniesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.companies_list(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling CompaniesApi->companies_list: #{e}"
+end
+```
+
+#### Using the companies_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedCompanyList>, Integer, Hash)> companies_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.companies_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedCompanyList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling CompaniesApi->companies_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedCompanyList**](PaginatedCompanyList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_retrieve
+
+> <Company> companies_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Company` object with the given `id`.
+
+### 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::CompaniesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.companies_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling CompaniesApi->companies_retrieve: #{e}"
+end
+```
+
+#### Using the companies_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Company>, Integer, Hash)> companies_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.companies_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Company>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling CompaniesApi->companies_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**Company**](Company.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Company.md

@@ -0,0 +1,28 @@
+# MergeHRISClient::Company
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **legal_name** | **String** | The company's legal name. | [optional] |
+| **display_name** | **String** | The company's display name. | [optional] |
+| **eins** | **Array<String>** | The company's Employer Identification Numbers. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::Company.new(
+  id: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
+  remote_id: 19202938,
+  legal_name: We Love Integrations Inc.,
+  display_name: We Love Integrations,
+  eins: ["12-3456789","12-3451111","11-0011000"],
+  remote_data: [{"path":"/companies","data":["Varies by platform"]}]
+)
+```
+

data/docs/CountryEnum.md

@@ -0,0 +1,15 @@
+# MergeHRISClient::CountryEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::CountryEnum.new()
+```
+