merge_hris_client 1.0.1

data/docs/PaginatedEmployeePayrollRunList.md

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

data/docs/PaginatedEmploymentList.md

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

data/docs/PaginatedLocationList.md

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

data/docs/PaginatedPayrollRunList.md

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

data/docs/PaginatedTeamList.md

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

data/docs/PaginatedTimeOffList.md

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

data/docs/PassthroughApi.md

@@ -0,0 +1,81 @@
+# MergeHRISClient::PassthroughApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**passthrough_create**](PassthroughApi.md#passthrough_create) | **POST** /passthrough |  |
+
+
+## passthrough_create
+
+> <RemoteResponse> passthrough_create(x_account_token, data_passthrough_request)
+
+
+
+Pull data from an endpoint not currently supported by Merge.
+
+### 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::PassthroughApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+data_passthrough_request = MergeHRISClient::DataPassthroughRequest.new({method: MergeHRISClient::MethodEnum::GET, path: '/scooters'}) # DataPassthroughRequest | 
+
+begin
+  
+  result = api_instance.passthrough_create(x_account_token, data_passthrough_request)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling PassthroughApi->passthrough_create: #{e}"
+end
+```
+
+#### Using the passthrough_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteResponse>, Integer, Hash)> passthrough_create_with_http_info(x_account_token, data_passthrough_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.passthrough_create_with_http_info(x_account_token, data_passthrough_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteResponse>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling PassthroughApi->passthrough_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **data_passthrough_request** | [**DataPassthroughRequest**](DataPassthroughRequest.md) |  |  |
+
+### Return type
+
+[**RemoteResponse**](RemoteResponse.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/PayCurrencyEnum.md

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

data/docs/PayFrequencyEnum.md

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

data/docs/PayPeriodEnum.md

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

data/docs/PayrollRun.md

@@ -0,0 +1,32 @@
+# MergeHRISClient::PayrollRun
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **run_state** | [**RunStateEnum**](RunStateEnum.md) | The state of the payroll run | [optional] |
+| **run_type** | [**RunTypeEnum**](RunTypeEnum.md) | The type of the payroll run | [optional] |
+| **start_date** | **Time** | The day and time the payroll run started. | [optional] |
+| **end_date** | **Time** | The day and time the payroll run ended. | [optional] |
+| **check_date** | **Time** | The day and time the payroll run was checked. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PayrollRun.new(
+  id: 37336947-b3d4-4a4c-a310-ab6ab510e079,
+  remote_id: 19202938,
+  run_state: PAID,
+  run_type: REGULAR,
+  start_date: null,
+  end_date: null,
+  check_date: null,
+  remote_data: [{"path":"/payroll","data":["Varies by platform"]}]
+)
+```
+

data/docs/PayrollRunsApi.md

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