merge_hris_client 1.0.1

data/docs/LinkToken.md

@@ -0,0 +1,20 @@
+# MergeHRISClient::LinkToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **link_token** | **String** |  |  |
+| **integration_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::LinkToken.new(
+  link_token: necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0,
+  integration_name: Lever
+)
+```
+

data/docs/LinkTokenApi.md

@@ -0,0 +1,79 @@
+# MergeHRISClient::LinkTokenApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**link_token_create**](LinkTokenApi.md#link_token_create) | **POST** /link-token |  |
+
+
+## link_token_create
+
+> <LinkToken> link_token_create(end_user_details_request)
+
+
+
+Creates a link token to be used when linking a new end user.
+
+### 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::LinkTokenApi.new
+end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: ['hris']}) # EndUserDetailsRequest | 
+
+begin
+  
+  result = api_instance.link_token_create(end_user_details_request)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling LinkTokenApi->link_token_create: #{e}"
+end
+```
+
+#### Using the link_token_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LinkToken>, Integer, Hash)> link_token_create_with_http_info(end_user_details_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.link_token_create_with_http_info(end_user_details_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LinkToken>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling LinkTokenApi->link_token_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_details_request** | [**EndUserDetailsRequest**](EndUserDetailsRequest.md) |  |  |
+
+### Return type
+
+[**LinkToken**](LinkToken.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/Location.md

@@ -0,0 +1,36 @@
+# MergeHRISClient::Location
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **phone_number** | **String** | The location's phone number. | [optional] |
+| **street_1** | **String** | Line 1 of the location's street address. | [optional] |
+| **street_2** | **String** | Line 2 of the location's street address. | [optional] |
+| **city** | **String** | The location's city. | [optional] |
+| **state** | [**StateEnum**](StateEnum.md) | The location's state. | [optional] |
+| **zip_code** | **String** | The location's zip code. | [optional] |
+| **country** | [**CountryEnum**](CountryEnum.md) | The location's country. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::Location.new(
+  id: null,
+  remote_id: 93018402,
+  phone_number: +1111111111,
+  street_1: 2920 Broadway,
+  street_2: 2nd Floor,
+  city: New York ,
+  state: NY,
+  zip_code: 10027,
+  country: USA,
+  remote_data: [{"path":"/locations","data":["Varies by platform"]}]
+)
+```
+

data/docs/LocationsApi.md

@@ -0,0 +1,175 @@
+# MergeHRISClient::LocationsApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**locations_list**](LocationsApi.md#locations_list) | **GET** /locations |  |
+| [**locations_retrieve**](LocationsApi.md#locations_retrieve) | **GET** /locations/{id} |  |
+
+
+## locations_list
+
+> <PaginatedLocationList> locations_list(x_account_token, opts)
+
+
+
+Returns a list of `Location` 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::LocationsApi.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.locations_list(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling LocationsApi->locations_list: #{e}"
+end
+```
+
+#### Using the locations_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedLocationList>, Integer, Hash)> locations_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.locations_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedLocationList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling LocationsApi->locations_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
+
+[**PaginatedLocationList**](PaginatedLocationList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## locations_retrieve
+
+> <Location> locations_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Location` 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::LocationsApi.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.locations_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling LocationsApi->locations_retrieve: #{e}"
+end
+```
+
+#### Using the locations_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Location>, Integer, Hash)> locations_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.locations_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Location>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling LocationsApi->locations_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
+
+[**Location**](Location.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MaritalStatusEnum.md

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

data/docs/MethodEnum.md

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

data/docs/ModelOperation.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::ModelOperation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_name** | **String** |  |  |
+| **available_operations** | **Array<String>** |  |  |
+| **required_post_parameters** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ModelOperation.new(
+  model_name: Candidate,
+  available_operations: ["FETCH","CREATE"],
+  required_post_parameters: ["remote_user_id"]
+)
+```
+

data/docs/NullEnum.md

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

data/docs/PaginatedBenefitList.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::PaginatedBenefitList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<Benefit>**](Benefit.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PaginatedBenefitList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedCompanyList.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::PaginatedCompanyList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<Company>**](Company.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PaginatedCompanyList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedEmployeeList.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::PaginatedEmployeeList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<Employee>**](Employee.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PaginatedEmployeeList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+