merge_hris_client 1.0.1

data/docs/TimeOff.md

@@ -0,0 +1,36 @@
+# MergeHRISClient::TimeOff
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **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] |
+| **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] |
+| **amount** | **Float** | The number of time off units requested. | [optional] |
+| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::TimeOff.new(
+  id: 91b2b905-e866-40c8-8be2-efe53827a0aa,
+  remote_id: 19202938,
+  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
+  approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
+  status: APPROVED,
+  employee_note: Trip to Iowa. Miss those cornfields!,
+  units: DAYS,
+  amount: 13,
+  request_type: VACATION,
+  remote_data: [{"path":"/leave","data":["Varies by platform"]}]
+)
+```
+

data/docs/TimeOffApi.md

@@ -0,0 +1,183 @@
+# MergeHRISClient::TimeOffApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**time_off_list**](TimeOffApi.md#time_off_list) | **GET** /time-off |  |
+| [**time_off_retrieve**](TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} |  |
+
+
+## time_off_list
+
+> <PaginatedTimeOffList> time_off_list(x_account_token, opts)
+
+
+
+Returns a list of `TimeOff` 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::TimeOffApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  approver_id: 'approver_id_example', # String | If provided, will only return time off for this approver.
+  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 time off for this employee.
+  expand: 'approver', # 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.
+  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.time_off_list(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffApi->time_off_list: #{e}"
+end
+```
+
+#### Using the time_off_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedTimeOffList>, Integer, Hash)> time_off_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.time_off_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedTimeOffList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffApi->time_off_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **approver_id** | **String** | If provided, will only return time off for this approver. | [optional] |
+| **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 time off for this employee. | [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] |
+| **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
+
+[**PaginatedTimeOffList**](PaginatedTimeOffList.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)
+
+
+
+Returns an `TimeOff` 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::TimeOffApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'approver', # 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.
+}
+
+begin
+  
+  result = api_instance.time_off_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffApi->time_off_retrieve: #{e}"
+end
+```
+
+#### Using the time_off_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TimeOff>, Integer, Hash)> time_off_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.time_off_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TimeOff>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffApi->time_off_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **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] |
+
+### Return type
+
+[**TimeOff**](TimeOff.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TimeOffStatusEnum.md

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

data/docs/TypeEnum.md

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

data/docs/UnitsEnum.md

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

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="merge-api"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="merge-hris-ruby"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/merge_hris_client.rb

@@ -0,0 +1,110 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0
+
+=end
+
+# Common files
+require 'merge_hris_client/api_client'
+require 'merge_hris_client/api_error'
+require 'merge_hris_client/version'
+require 'merge_hris_client/configuration'
+
+# Models
+require 'merge_hris_client/models/account_integration'
+require 'merge_hris_client/models/account_token'
+require 'merge_hris_client/models/available_actions'
+require 'merge_hris_client/models/benefit'
+require 'merge_hris_client/models/benefit_plan_type_enum'
+require 'merge_hris_client/models/company'
+require 'merge_hris_client/models/country_enum'
+require 'merge_hris_client/models/data_passthrough'
+require 'merge_hris_client/models/data_passthrough_request'
+require 'merge_hris_client/models/deduction'
+require 'merge_hris_client/models/earning'
+require 'merge_hris_client/models/employee'
+require 'merge_hris_client/models/employee_payroll_run'
+require 'merge_hris_client/models/employment'
+require 'merge_hris_client/models/employment_status_enum'
+require 'merge_hris_client/models/employment_type_enum'
+require 'merge_hris_client/models/end_user_details'
+require 'merge_hris_client/models/end_user_details_request'
+require 'merge_hris_client/models/ethnicity_enum'
+require 'merge_hris_client/models/flsa_status_enum'
+require 'merge_hris_client/models/gender_enum'
+require 'merge_hris_client/models/generate_remote_key_request'
+require 'merge_hris_client/models/link_token'
+require 'merge_hris_client/models/location'
+require 'merge_hris_client/models/marital_status_enum'
+require 'merge_hris_client/models/method_enum'
+require 'merge_hris_client/models/model_operation'
+require 'merge_hris_client/models/paginated_benefit_list'
+require 'merge_hris_client/models/paginated_company_list'
+require 'merge_hris_client/models/paginated_employee_list'
+require 'merge_hris_client/models/paginated_employee_payroll_run_list'
+require 'merge_hris_client/models/paginated_employment_list'
+require 'merge_hris_client/models/paginated_location_list'
+require 'merge_hris_client/models/paginated_payroll_run_list'
+require 'merge_hris_client/models/paginated_team_list'
+require 'merge_hris_client/models/paginated_time_off_list'
+require 'merge_hris_client/models/pay_currency_enum'
+require 'merge_hris_client/models/pay_frequency_enum'
+require 'merge_hris_client/models/pay_period_enum'
+require 'merge_hris_client/models/payroll_run'
+require 'merge_hris_client/models/remote_data'
+require 'merge_hris_client/models/remote_key'
+require 'merge_hris_client/models/remote_key_for_regeneration_request'
+require 'merge_hris_client/models/remote_response'
+require 'merge_hris_client/models/request_type_enum'
+require 'merge_hris_client/models/run_state_enum'
+require 'merge_hris_client/models/run_type_enum'
+require 'merge_hris_client/models/state_enum'
+require 'merge_hris_client/models/sync_status'
+require 'merge_hris_client/models/tax'
+require 'merge_hris_client/models/team'
+require 'merge_hris_client/models/time_off'
+require 'merge_hris_client/models/time_off_status_enum'
+require 'merge_hris_client/models/type_enum'
+require 'merge_hris_client/models/units_enum'
+
+# APIs
+require 'merge_hris_client/api/account_token_api'
+require 'merge_hris_client/api/available_actions_api'
+require 'merge_hris_client/api/benefits_api'
+require 'merge_hris_client/api/companies_api'
+require 'merge_hris_client/api/employee_payroll_runs_api'
+require 'merge_hris_client/api/employees_api'
+require 'merge_hris_client/api/employments_api'
+require 'merge_hris_client/api/generate_key_api'
+require 'merge_hris_client/api/link_token_api'
+require 'merge_hris_client/api/locations_api'
+require 'merge_hris_client/api/passthrough_api'
+require 'merge_hris_client/api/payroll_runs_api'
+require 'merge_hris_client/api/regenerate_key_api'
+require 'merge_hris_client/api/sync_status_api'
+require 'merge_hris_client/api/teams_api'
+require 'merge_hris_client/api/time_off_api'
+
+module MergeHRISClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   MergeHRISClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/merge_hris_client/api/account_token_api.rb

@@ -0,0 +1,83 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0
+
+=end
+
+require 'cgi'
+
+module MergeHRISClient
+  class AccountTokenApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns the account token for the end user with the provided public token.
+    # @param public_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountToken]
+    def account_token_retrieve(public_token, opts = {})
+      data, _status_code, _headers = account_token_retrieve_with_http_info(public_token, opts)
+      data
+    end
+
+    # Returns the account token for the end user with the provided public token.
+    # @param public_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountToken, Integer, Hash)>] AccountToken data, response status code and response headers
+    def account_token_retrieve_with_http_info(public_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountTokenApi.account_token_retrieve ...'
+      end
+      # verify the required parameter 'public_token' is set
+      if @api_client.config.client_side_validation && public_token.nil?
+        fail ArgumentError, "Missing the required parameter 'public_token' when calling AccountTokenApi.account_token_retrieve"
+      end
+      # resource path
+      local_var_path = '/account-token/{public_token}'.sub('{' + 'public_token' + '}', CGI.escape(public_token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountToken'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountTokenApi.account_token_retrieve",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountTokenApi#account_token_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end