merge_hris_client 1.0.1

data/docs/RegenerateKeyApi.md

@@ -0,0 +1,79 @@
+# MergeHRISClient::RegenerateKeyApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**regenerate_key_create**](RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key |  |
+
+
+## regenerate_key_create
+
+> <RemoteKey> regenerate_key_create(remote_key_for_regeneration_request)
+
+
+
+Exchange remote keys.
+
+### 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::RegenerateKeyApi.new
+remote_key_for_regeneration_request = MergeHRISClient::RemoteKeyForRegenerationRequest.new({name: 'Remote Deployment Key 1'}) # RemoteKeyForRegenerationRequest | 
+
+begin
+  
+  result = api_instance.regenerate_key_create(remote_key_for_regeneration_request)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling RegenerateKeyApi->regenerate_key_create: #{e}"
+end
+```
+
+#### Using the regenerate_key_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteKey>, Integer, Hash)> regenerate_key_create_with_http_info(remote_key_for_regeneration_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.regenerate_key_create_with_http_info(remote_key_for_regeneration_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteKey>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling RegenerateKeyApi->regenerate_key_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_key_for_regeneration_request** | [**RemoteKeyForRegenerationRequest**](RemoteKeyForRegenerationRequest.md) |  |  |
+
+### Return type
+
+[**RemoteKey**](RemoteKey.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/RemoteData.md

@@ -0,0 +1,20 @@
+# MergeHRISClient::RemoteData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+| **data** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::RemoteData.new(
+  path: null,
+  data: null
+)
+```
+

data/docs/RemoteKey.md

@@ -0,0 +1,20 @@
+# MergeHRISClient::RemoteKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **key** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::RemoteKey.new(
+  name: Remote Deployment Key 1,
+  key: hXY57W0g0WkdRHjCaPvwijK63fwfN-o_Wh7f30SLTq_uPCOLo-WFcA
+)
+```
+

data/docs/RemoteKeyForRegeneration.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::RemoteKeyForRegeneration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::RemoteKeyForRegeneration.new(
+  name: Remote Deployment Key 1
+)
+```
+

data/docs/RemoteKeyForRegenerationRequest.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::RemoteKeyForRegenerationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::RemoteKeyForRegenerationRequest.new(
+  name: Remote Deployment Key 1
+)
+```
+

data/docs/RemoteResponse.md

@@ -0,0 +1,26 @@
+# MergeHRISClient::RemoteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | **String** |  |  |
+| **path** | **String** |  |  |
+| **status** | **Integer** |  |  |
+| **response** | [**Hash<String, AnyType>**](AnyType.md) |  |  |
+| **headers** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::RemoteResponse.new(
+  method: GET,
+  path: /scooters,
+  status: 200,
+  response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
+  headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
+)
+```
+

data/docs/RequestTypeEnum.md

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

data/docs/RunStateEnum.md

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

data/docs/RunTypeEnum.md

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

data/docs/StateEnum.md

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

data/docs/SyncStatus.md

@@ -0,0 +1,28 @@
+# MergeHRISClient::SyncStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_name** | **String** |  |  |
+| **model_id** | **String** |  |  |
+| **last_sync_start** | **Time** |  |  |
+| **next_sync_start** | **Time** |  |  |
+| **status** | **String** |  |  |
+| **is_initial_sync** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::SyncStatus.new(
+  model_name: Candidate,
+  model_id: ats.Candidate,
+  last_sync_start: 2021-03-30T19:44:18.695973Z,
+  next_sync_start: 2021-03-30T20:44:18.662942Z,
+  status: SYNCING,
+  is_initial_sync: true
+)
+```
+

data/docs/SyncStatusApi.md

@@ -0,0 +1,79 @@
+# MergeHRISClient::SyncStatusApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**sync_status_retrieve**](SyncStatusApi.md#sync_status_retrieve) | **GET** /sync-status |  |
+
+
+## sync_status_retrieve
+
+> <SyncStatus> sync_status_retrieve(x_account_token)
+
+
+
+Get syncing status.
+
+### 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::SyncStatusApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.sync_status_retrieve(x_account_token)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling SyncStatusApi->sync_status_retrieve: #{e}"
+end
+```
+
+#### Using the sync_status_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SyncStatus>, Integer, Hash)> sync_status_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.sync_status_retrieve_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SyncStatus>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling SyncStatusApi->sync_status_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**SyncStatus**](SyncStatus.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Tax.md

@@ -0,0 +1,28 @@
+# MergeHRISClient::Tax
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **employee_payroll_run** | **String** | The tax's employee payroll run. | [optional] |
+| **name** | **String** | The tax's name. | [optional] |
+| **amount** | **Float** | The tax amount. | [optional] |
+| **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
+| **remote_data** | **Array<Hash<String, AnyType>>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::Tax.new(
+  id: e3a825fd-c38d-4095-a717-df98c4cb9ebc,
+  employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
+  name: California State Income Tax,
+  amount: 100.25,
+  employer_tax: false,
+  remote_data: [{"path":"/tax","data":["Varies by platform"]}]
+)
+```
+

data/docs/Team.md

@@ -0,0 +1,24 @@
+# MergeHRISClient::Team
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **name** | **String** | The team's name. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::Team.new(
+  id: 13a72919-9fae-4f54-81ca-ddfd8712a1ba,
+  remote_id: 19202938,
+  name: Engineering,
+  remote_data: [{"path":"/teams","data":["Varies by platform"]}]
+)
+```
+

data/docs/TeamsApi.md

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