merge_hris_client 1.0.1

data/docs/Employment.md

@@ -0,0 +1,38 @@
+# MergeHRISClient::Employment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **job_title** | **String** | The position's title. | [optional] |
+| **pay_rate** | **Float** | The position's pay rate in dollars. | [optional] |
+| **pay_period** | [**PayPeriodEnum**](PayPeriodEnum.md) | The time period this pay rate encompasses. | [optional] |
+| **pay_frequency** | [**PayFrequencyEnum**](PayFrequencyEnum.md) | The position's pay frequency. | [optional] |
+| **pay_currency** | [**PayCurrencyEnum**](PayCurrencyEnum.md) | The position's currency code. | [optional] |
+| **flsa_status** | [**FlsaStatusEnum**](FlsaStatusEnum.md) | The position's FLSA status. | [optional] |
+| **effective_date** | **Time** | The position's effective date. | [optional] |
+| **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | The position's type of employment. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::Employment.new(
+  id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982,
+  remote_id: 19202938,
+  job_title: Software Engineer,
+  pay_rate: 80000.00,
+  pay_period: YEAR,
+  pay_frequency: BIWEEKLY,
+  pay_currency: USD,
+  flsa_status: EXEMPT,
+  effective_date: null,
+  employment_type: FULL TIME,
+  remote_data: [{"path":"/jobs","data":["Varies by platform"]}]
+)
+```
+

data/docs/EmploymentStatusEnum.md

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

data/docs/EmploymentTypeEnum.md

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

data/docs/EmploymentsApi.md

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

data/docs/EndUserDetails.md

@@ -0,0 +1,24 @@
+# MergeHRISClient::EndUserDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_email_address** | **String** |  |  |
+| **end_user_organization_name** | **String** |  |  |
+| **end_user_origin_id** | **String** |  |  |
+| **categories** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::EndUserDetails.new(
+  end_user_email_address: null,
+  end_user_organization_name: null,
+  end_user_origin_id: null,
+  categories: null
+)
+```
+

data/docs/EndUserDetailsRequest.md

@@ -0,0 +1,26 @@
+# MergeHRISClient::EndUserDetailsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_email_address** | **String** |  |  |
+| **end_user_organization_name** | **String** |  |  |
+| **end_user_origin_id** | **String** |  |  |
+| **categories** | **Array<String>** |  |  |
+| **integration** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::EndUserDetailsRequest.new(
+  end_user_email_address: null,
+  end_user_organization_name: null,
+  end_user_origin_id: null,
+  categories: null,
+  integration: null
+)
+```
+

data/docs/EthnicityEnum.md

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

data/docs/FlsaStatusEnum.md

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

data/docs/GenderEnum.md

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

data/docs/GenerateKeyApi.md

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

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