merge_hris_client 1.0.1 → 1.0.2

data/docs/EmployeesApi.md

@@ -4,10 +4,88 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**employees_create**](EmployeesApi.md#employees_create) | **POST** /employees |  |
 | [**employees_list**](EmployeesApi.md#employees_list) | **GET** /employees |  |
 | [**employees_retrieve**](EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} |  |
 
 
+## employees_create
+
+> <Employee> employees_create(x_account_token, opts)
+
+
+
+Creates an `Employee` object with the given values.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = '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['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::EmployeesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
+  employee_request: MergeHRISClient::EmployeeRequest.new # EmployeeRequest | 
+}
+
+begin
+  
+  result = api_instance.employees_create(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling EmployeesApi->employees_create: #{e}"
+end
+```
+
+#### Using the employees_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Employee>, Integer, Hash)> employees_create_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.employees_create_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Employee>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling EmployeesApi->employees_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
+| **employee_request** | [**EmployeeRequest**](EmployeeRequest.md) |  | [optional] |
+
+### Return type
+
+[**Employee**](Employee.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## employees_list
 
 > <PaginatedEmployeeList> employees_list(x_account_token, opts)
@@ -38,6 +116,7 @@ opts = {
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
   expand: 'company', # 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.
+  include_sensitive_fields: true, # Boolean | Whether to include sensetive fields (such as social security numbers) in the response.
   manager_id: 'manager_id_example', # String | If provided, will only return employees for this manager.
   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.
@@ -85,6 +164,7 @@ end
 | **cursor** | **String** | The pagination cursor value. | [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] |
+| **include_sensitive_fields** | **Boolean** | Whether to include sensetive fields (such as social security numbers) in the response. | [optional] |
 | **manager_id** | **String** | If provided, will only return employees for this manager. | [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] |
@@ -133,7 +213,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
 id = TODO # String | 
 opts = {
   expand: 'company', # 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.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  include_sensitive_fields: true # Boolean | Whether to include sensetive fields (such as social security numbers) in the response.
 }
 
 begin
@@ -171,6 +252,7 @@ end
 | **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] |
+| **include_sensitive_fields** | **Boolean** | Whether to include sensetive fields (such as social security numbers) in the response. | [optional] |
 
 ### Return type
 

data/docs/EmploymentRequest.md

@@ -0,0 +1,34 @@
+# MergeHRISClient::EmploymentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::EmploymentRequest.new(
+  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
+)
+```
+

data/docs/EmploymentsApi.md

@@ -4,10 +4,88 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**employments_create**](EmploymentsApi.md#employments_create) | **POST** /employments |  |
 | [**employments_list**](EmploymentsApi.md#employments_list) | **GET** /employments |  |
 | [**employments_retrieve**](EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} |  |
 
 
+## employments_create
+
+> <Employment> employments_create(x_account_token, opts)
+
+
+
+Creates an `Employment` object with the given values.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = '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['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::EmploymentsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
+  employment_request: MergeHRISClient::EmploymentRequest.new # EmploymentRequest | 
+}
+
+begin
+  
+  result = api_instance.employments_create(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling EmploymentsApi->employments_create: #{e}"
+end
+```
+
+#### Using the employments_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Employment>, Integer, Hash)> employments_create_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.employments_create_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Employment>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling EmploymentsApi->employments_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
+| **employment_request** | [**EmploymentRequest**](EmploymentRequest.md) |  | [optional] |
+
+### Return type
+
+[**Employment**](Employment.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## employments_list
 
 > <PaginatedEmploymentList> employments_list(x_account_token, opts)

data/docs/EndUserDetailsRequest.md

@@ -7,7 +7,7 @@
 | **end_user_email_address** | **String** |  |  |
 | **end_user_organization_name** | **String** |  |  |
 | **end_user_origin_id** | **String** |  |  |
-| **categories** | **Array<String>** |  |  |
+| **categories** | **Array<String>** |  | [optional] |
 | **integration** | **String** |  | [optional] |
 
 ## Example

data/docs/Issue.md

@@ -0,0 +1,30 @@
+# MergeHRISClient::Issue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) |  | [optional] |
+| **error_description** | **String** |  |  |
+| **end_user** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **first_incident_time** | **Time** |  | [optional] |
+| **last_incident_time** | **Time** |  | [optional] |
+| **is_muted** | **Boolean** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::Issue.new(
+  id: null,
+  status: null,
+  error_description: null,
+  end_user: null,
+  first_incident_time: null,
+  last_incident_time: null,
+  is_muted: null
+)
+```
+

data/docs/IssueStatusEnum.md

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

data/docs/IssuesApi.md

@@ -0,0 +1,167 @@
+# MergeHRISClient::IssuesApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**issues_list**](IssuesApi.md#issues_list) | **GET** /issues |  |
+| [**issues_retrieve**](IssuesApi.md#issues_retrieve) | **GET** /issues/{id} |  |
+
+
+## issues_list
+
+> <PaginatedIssueList> issues_list(opts)
+
+
+
+Gets issues.
+
+### 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'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::IssuesApi.new
+opts = {
+  account_token: 'account_token_example', # String | account_token
+  cursor: 56, # Integer | The pagination cursor value.
+  end_date: 'end_date_example', # String | If included, will only include issues whose most recent action occurred before this time
+  end_user_organization_name: 'end_user_organization_name_example', # String | end_user_organization_name
+  include_muted: 'include_muted_example', # String | If True, will include muted issues
+  integration_name: 'integration_name_example', # String | integration_name
+  page_size: 56, # Integer | Number of results to return per page.
+  start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
+  status: 'ONGOING' # String | status
+}
+
+begin
+  
+  result = api_instance.issues_list(opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_list: #{e}"
+end
+```
+
+#### Using the issues_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedIssueList>, Integer, Hash)> issues_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.issues_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedIssueList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_token** | **String** | account_token | [optional] |
+| **cursor** | **Integer** | The pagination cursor value. | [optional] |
+| **end_date** | **String** | If included, will only include issues whose most recent action occurred before this time | [optional] |
+| **end_user_organization_name** | **String** | end_user_organization_name | [optional] |
+| **include_muted** | **String** | If True, will include muted issues | [optional] |
+| **integration_name** | **String** | integration_name | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
+| **status** | **String** | status | [optional] |
+
+### Return type
+
+[**PaginatedIssueList**](PaginatedIssueList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## issues_retrieve
+
+> <Issue> issues_retrieve(id)
+
+
+
+Get a specific issue.
+
+### 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'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::IssuesApi.new
+id = TODO # String | 
+
+begin
+  
+  result = api_instance.issues_retrieve(id)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_retrieve: #{e}"
+end
+```
+
+#### Using the issues_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Issue>, Integer, Hash)> issues_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.issues_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Issue>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**String**](.md) |  |  |
+
+### Return type
+
+[**Issue**](Issue.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+