merge_hris_client 1.0.2 → 2.0.0

data/docs/TimeOffResponse.md

@@ -0,0 +1,24 @@
+# MergeHRISClient::TimeOffResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**TimeOff**](TimeOff.md) |  |  |
+| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) |  |  |
+| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) |  |  |
+| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::TimeOffResponse.new(
+  model: null,
+  warnings: null,
+  errors: null,
+  logs: null
+)
+```
+

data/docs/ValidationProblemSource.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::ValidationProblemSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pointer** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ValidationProblemSource.new(
+  pointer: null
+)
+```
+

data/docs/WarningValidationProblem.md

@@ -0,0 +1,24 @@
+# MergeHRISClient::WarningValidationProblem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | [**ValidationProblemSource**](ValidationProblemSource.md) |  | [optional] |
+| **title** | **String** |  |  |
+| **detail** | **String** |  |  |
+| **problem_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::WarningValidationProblem.new(
+  source: null,
+  title: Unrecognized Field,
+  detail: An unrecognized field, age, was passed in with request data.,
+  problem_type: UNRECOGNIZED_FIELD
+)
+```
+

data/lib/merge_hris_client/api/account_details_api.rb

@@ -0,0 +1,77 @@
+=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.1.1
+
+=end
+
+require 'cgi'
+
+module MergeHRISClient
+  class AccountDetailsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get details for a linked account.
+    # @param [Hash] opts the optional parameters
+    # @return [AccountDetails]
+    def account_details_retrieve(opts = {})
+      data, _status_code, _headers = account_details_retrieve_with_http_info(opts)
+      data
+    end
+
+    # Get details for a linked account.
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDetailsApi.account_details_retrieve ...'
+      end
+      # resource path
+      local_var_path = '/account-details'
+
+      # 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] || 'AccountDetails'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountDetailsApi.account_details_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: AccountDetailsApi#account_details_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_hris_client/api/bank_info_api.rb

@@ -0,0 +1,217 @@
+=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.1.1
+
+=end
+
+require 'cgi'
+
+module MergeHRISClient
+  class BankInfoApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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 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_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.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
+    # @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 [String] :remote_id The API provider's ID for the given object.
+    # @return [PaginatedBankInfoList]
+    def bank_info_list(x_account_token, opts = {})
+      data, _status_code, _headers = bank_info_list_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # 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 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_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.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
+    # @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 [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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BankInfoApi.bank_info_list ...'
+      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 BankInfoApi.bank_info_list"
+      end
+      allowable_values = ["CHECKING", "SAVINGS"]
+      if @api_client.config.client_side_validation && opts[:'account_type'] && !allowable_values.include?(opts[:'account_type'])
+        fail ArgumentError, "invalid value for \"account_type\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["employee"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["-remote_created_at", "remote_created_at"]
+      if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
+        fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/bank-info'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'account_type'] = opts[:'account_type'] if !opts[:'account_type'].nil?
+      query_params[:'bank_name'] = opts[:'bank_name'] if !opts[:'bank_name'].nil?
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'employee'] = opts[:'employee'] if !opts[:'employee'].nil?
+      query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
+      query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
+      query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
+      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_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
+
+      # header parameters
+      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] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedBankInfoList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"BankInfoApi.bank_info_list",
+        :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: BankInfoApi#bank_info_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a `BankInfo` object with the given `id`.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @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_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [BankInfo]
+    def bank_info_retrieve(x_account_token, id, opts = {})
+      data, _status_code, _headers = bank_info_retrieve_with_http_info(x_account_token, id, opts)
+      data
+    end
+
+    # Returns a &#x60;BankInfo&#x60; object with the given &#x60;id&#x60;.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @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_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Array<(BankInfo, Integer, Hash)>] BankInfo data, response status code and response headers
+    def bank_info_retrieve_with_http_info(x_account_token, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BankInfoApi.bank_info_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 BankInfoApi.bank_info_retrieve"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling BankInfoApi.bank_info_retrieve"
+      end
+      allowable_values = ["employee"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/bank-info/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
+
+      # header parameters
+      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] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BankInfo'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"BankInfoApi.bank_info_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: BankInfoApi#bank_info_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_hris_client/api/benefits_api.rb

@@ -19,75 +19,6 @@ module MergeHRISClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Creates a `Benefit` object with the given values.
-    # @param x_account_token [String] Token identifying the end user.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
-    # @option opts [BenefitRequest] :benefit_request 
-    # @return [Benefit]
-    def benefits_create(x_account_token, opts = {})
-      data, _status_code, _headers = benefits_create_with_http_info(x_account_token, opts)
-      data
-    end
-
-    # Creates a `Benefit` object with the given values.
-    # @param x_account_token [String] Token identifying the end user.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
-    # @option opts [BenefitRequest] :benefit_request 
-    # @return [Array<(Benefit, Integer, Hash)>] Benefit data, response status code and response headers
-    def benefits_create_with_http_info(x_account_token, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: BenefitsApi.benefits_create ...'
-      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 BenefitsApi.benefits_create"
-      end
-      # resource path
-      local_var_path = '/benefits'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
-      header_params[:'X-Account-Token'] = x_account_token
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'benefit_request'])
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Benefit'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['tokenAuth']
-
-      new_options = opts.merge(
-        :operation => :"BenefitsApi.benefits_create",
-        :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(:POST, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: BenefitsApi#benefits_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Returns a list of `Benefit` objects.
     # @param x_account_token [String] Token identifying the end user.
     # @param [Hash] opts the optional parameters
@@ -96,6 +27,7 @@ module MergeHRISClient
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [String] :employee_id If provided, will only return time off 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.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
     # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -115,6 +47,7 @@ module MergeHRISClient
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [String] :employee_id If provided, will only return time off 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.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
     # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -143,6 +76,7 @@ module MergeHRISClient
       query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
       query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
       query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
       query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
       query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
       query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?

data/lib/merge_hris_client/api/companies_api.rb

@@ -25,6 +25,7 @@ module MergeHRISClient
     # @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 [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
     # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -42,6 +43,7 @@ module MergeHRISClient
     # @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 [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
     # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -64,6 +66,7 @@ module MergeHRISClient
       query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
       query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
       query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
       query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
       query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
       query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?