merge_hris_client 1.0.4 → 2.0.2

data/docs/TimeOffApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
 | ------ | ------------ | ----------- |
 | [**time_off_create**](TimeOffApi.md#time_off_create) | **POST** /time-off |  |
 | [**time_off_list**](TimeOffApi.md#time_off_list) | **GET** /time-off |  |
+| [**time_off_meta_post_retrieve**](TimeOffApi.md#time_off_meta_post_retrieve) | **GET** /time-off/meta/post |  |
 | [**time_off_retrieve**](TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} |  |
 
 
@@ -25,15 +26,16 @@ 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['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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
 end
 
 api_instance = MergeHRISClient::TimeOffApi.new
 x_account_token = 'x_account_token_example' # String | Token identifying the end user.
 time_off_endpoint_request = MergeHRISClient::TimeOffEndpointRequest.new({model: MergeHRISClient::TimeOffRequest.new}) # TimeOffEndpointRequest | 
 opts = {
+  is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
   run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
 }
 
@@ -70,6 +72,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **x_account_token** | **String** | Token identifying the end user. |  |
 | **time_off_endpoint_request** | [**TimeOffEndpointRequest**](TimeOffEndpointRequest.md) |  |  |
+| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
 | **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
 
 ### Return type
@@ -102,9 +105,9 @@ 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['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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
 end
 
 api_instance = MergeHRISClient::TimeOffApi.new
@@ -187,6 +190,77 @@ end
 - **Accept**: application/json
 
 
+## time_off_meta_post_retrieve
+
+> <MetaResponse> time_off_meta_post_retrieve(x_account_token)
+
+
+
+Returns metadata for `TimeOff` POSTs.
+
+### 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::TimeOffApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.time_off_meta_post_retrieve(x_account_token)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffApi->time_off_meta_post_retrieve: #{e}"
+end
+```
+
+#### Using the time_off_meta_post_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetaResponse>, Integer, Hash)> time_off_meta_post_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.time_off_meta_post_retrieve_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetaResponse>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffApi->time_off_meta_post_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**MetaResponse**](MetaResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## time_off_retrieve
 
 > <TimeOff> time_off_retrieve(x_account_token, id, opts)
@@ -203,9 +277,9 @@ 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['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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
 end
 
 api_instance = MergeHRISClient::TimeOffApi.new

data/docs/TimeOffBalance.md

@@ -6,8 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee** | **String** | The employee the balance belongs to. | [optional] |
-| **balance** | **Float** | The current PTO balance in terms of hours. | [optional] |
+| **employee** | **String** |  | [optional] |
+| **balance** | **Float** | The current remaining PTO balance in terms of hours. This does not represent the starting PTO balance. If the API provider only provides PTO balance in terms of days, we estimate 8 hours per day. | [optional] |
 | **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
 | **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. | [optional] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |

data/docs/TimeOffRequest.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee** | **String** | The employee requesting time off. | [optional] |
-| **approver** | **String** | The employee approving the time off request. | [optional] |
+| **employee** | **String** |  | [optional] |
+| **approver** | **String** |  | [optional] |
 | **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
 | **employee_note** | **String** | The employee note for this time off request. | [optional] |
 | **units** | [**UnitsEnum**](UnitsEnum.md) | The unit of time requested. | [optional] |
@@ -25,9 +25,9 @@ instance = MergeHRISClient::TimeOffRequest.new(
   employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
   approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
   status: APPROVED,
-  employee_note: Trip to Iowa. Miss those cornfields!,
+  employee_note: Moving into the new apartment Kendall Roy gave me!,
   units: DAYS,
-  amount: 7,
+  amount: 3,
   request_type: VACATION,
   start_time: 2020-11-10T00:00Z,
   end_time: 2020-11-17T00:00Z

data/docs/TimeOffResponse.md

@@ -7,6 +7,7 @@
 | **model** | [**TimeOff**](TimeOff.md) |  |  |
 | **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) |  |  |
 | **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) |  |  |
+| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) |  | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'merge_hris_client'
 instance = MergeHRISClient::TimeOffResponse.new(
   model: null,
   warnings: null,
-  errors: null
+  errors: null,
+  logs: null
 )
 ```
 

data/docs/WebhookReceiver.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::WebhookReceiver
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **is_active** | **Boolean** |  |  |
+| **key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::WebhookReceiver.new(
+  event: null,
+  is_active: null,
+  key: null
+)
+```
+

data/docs/WebhookReceiverRequest.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::WebhookReceiverRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **is_active** | **Boolean** |  |  |
+| **key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::WebhookReceiverRequest.new(
+  event: null,
+  is_active: null,
+  key: null
+)
+```
+

data/docs/WebhookReceiversApi.md

@@ -0,0 +1,153 @@
+# MergeHRISClient::WebhookReceiversApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**webhook_receivers_create**](WebhookReceiversApi.md#webhook_receivers_create) | **POST** /webhook-receivers |  |
+| [**webhook_receivers_list**](WebhookReceiversApi.md#webhook_receivers_list) | **GET** /webhook-receivers |  |
+
+
+## webhook_receivers_create
+
+> <WebhookReceiver> webhook_receivers_create(x_account_token, webhook_receiver_request)
+
+
+
+Creates a `WebhookReceiver` 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::WebhookReceiversApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+webhook_receiver_request = MergeHRISClient::WebhookReceiverRequest.new({event: 'event_example', is_active: false}) # WebhookReceiverRequest | 
+
+begin
+  
+  result = api_instance.webhook_receivers_create(x_account_token, webhook_receiver_request)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_create: #{e}"
+end
+```
+
+#### Using the webhook_receivers_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookReceiver>, Integer, Hash)> webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookReceiver>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **webhook_receiver_request** | [**WebhookReceiverRequest**](WebhookReceiverRequest.md) |  |  |
+
+### Return type
+
+[**WebhookReceiver**](WebhookReceiver.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## webhook_receivers_list
+
+> <Array<WebhookReceiver>> webhook_receivers_list(x_account_token)
+
+
+
+Returns a list of `WebhookReceiver` objects.
+
+### 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::WebhookReceiversApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.webhook_receivers_list(x_account_token)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_list: #{e}"
+end
+```
+
+#### Using the webhook_receivers_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<WebhookReceiver>>, Integer, Hash)> webhook_receivers_list_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.webhook_receivers_list_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<WebhookReceiver>>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**Array&lt;WebhookReceiver&gt;**](WebhookReceiver.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/lib/merge_hris_client/api/account_details_api.rb

@@ -20,20 +20,26 @@ module MergeHRISClient
       @api_client = api_client
     end
     # Get details for a linked account.
+    # @param x_account_token [String] Token identifying the end user.
     # @param [Hash] opts the optional parameters
     # @return [AccountDetails]
-    def account_details_retrieve(opts = {})
-      data, _status_code, _headers = account_details_retrieve_with_http_info(opts)
+    def account_details_retrieve(x_account_token, opts = {})
+      data, _status_code, _headers = account_details_retrieve_with_http_info(x_account_token, opts)
       data
     end
 
     # Get details for a linked account.
+    # @param x_account_token [String] Token identifying the end user.
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountDetails, Integer, Hash)>] AccountDetails data, response status code and response headers
-    def account_details_retrieve_with_http_info(opts = {})
+    def account_details_retrieve_with_http_info(x_account_token, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AccountDetailsApi.account_details_retrieve ...'
       end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling AccountDetailsApi.account_details_retrieve"
+      end
       # resource path
       local_var_path = '/account-details'
 
@@ -44,6 +50,7 @@ module MergeHRISClient
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Account-Token'] = x_account_token
 
       # form parameters
       form_params = opts[:form_params] || {}

data/lib/merge_hris_client/api/bank_info_api.rb

@@ -22,12 +22,11 @@ module MergeHRISClient
     # Returns a list of `BankInfo` objects.
     # @param x_account_token [String] Token identifying the end user.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :account_type The bank account type
-    # @option opts [String] :bank_name 
+    # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
+    # @option opts [String] :bank_name If provided, will only return BankInfo's with this bank name.
     # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
     # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
     # @option opts [String] :cursor The pagination cursor value.
-    # @option opts [String] :employee If provided, will only return bank accounts for this employee.
     # @option opts [String] :employee_id If provided, will only return bank accounts for this employee.
     # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
     # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
@@ -36,7 +35,6 @@ module MergeHRISClient
     # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
     # @option opts [String] :order_by Overrides the default ordering for this endpoint.
     # @option opts [Integer] :page_size Number of results to return per page.
-    # @option opts [Time] :remote_created_at 
     # @option opts [String] :remote_id The API provider's ID for the given object.
     # @return [PaginatedBankInfoList]
     def bank_info_list(x_account_token, opts = {})
@@ -47,12 +45,11 @@ module MergeHRISClient
     # Returns a list of `BankInfo` objects.
     # @param x_account_token [String] Token identifying the end user.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :account_type The bank account type
-    # @option opts [String] :bank_name 
+    # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
+    # @option opts [String] :bank_name If provided, will only return BankInfo's with this bank name.
     # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
     # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
     # @option opts [String] :cursor The pagination cursor value.
-    # @option opts [String] :employee If provided, will only return bank accounts for this employee.
     # @option opts [String] :employee_id If provided, will only return bank accounts for this employee.
     # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
     # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
@@ -61,7 +58,6 @@ module MergeHRISClient
     # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
     # @option opts [String] :order_by Overrides the default ordering for this endpoint.
     # @option opts [Integer] :page_size Number of results to return per page.
-    # @option opts [Time] :remote_created_at 
     # @option opts [String] :remote_id The API provider's ID for the given object.
     # @return [Array<(PaginatedBankInfoList, Integer, Hash)>] PaginatedBankInfoList data, response status code and response headers
     def bank_info_list_with_http_info(x_account_token, opts = {})
@@ -103,7 +99,6 @@ module MergeHRISClient
       query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
       query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
       query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
-      query_params[:'remote_created_at'] = opts[:'remote_created_at'] if !opts[:'remote_created_at'].nil?
       query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
 
       # header parameters