ultracart_api 3.11.14 → 3.11.15

data/docs/Item.md

@@ -34,7 +34,7 @@ Name | Type | Description | Notes
 **merchant_item_oid** | **Integer** | Unique object identifier for this item | [optional] 
 **options** | [**Array<ItemOption>**](ItemOption.md) | Options | [optional] 
 **parent_category_id** | **Integer** | Parent category of the item.  Zero indicates the root folder. | [optional] 
-**parent_category_path** | **String** | Parent category path.  / indicates the root folder. | [optional] 
+**parent_category_path** | **String** | Parent category path.  / indicates the root folder.  This is the folder structure within item management. | [optional] 
 **payment_processing** | [**ItemPaymentProcessing**](ItemPaymentProcessing.md) |  | [optional] 
 **physical** | [**ItemPhysical**](ItemPhysical.md) |  | [optional] 
 **pricing** | [**ItemPricing**](ItemPricing.md) |  | [optional] 

data/docs/OrderApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**adjust_order_total**](OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
+[**block_refund_on_order**](OrderApi.md#block_refund_on_order) | **POST** /order/orders/{order_id}/refund_block | Set a refund block on an order
 [**cancel_order**](OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
 [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
 [**duplicate_order**](OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
@@ -29,6 +30,7 @@ Method | HTTP request | Description
 [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
 [**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
 [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
+[**unblock_refund_on_order**](OrderApi.md#unblock_refund_on_order) | **POST** /order/orders/{order_id}/refund_unblock | Remove a refund block on an order
 [**update_accounts_receivable_retry_config**](OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
 [**update_order**](OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
 [**validate_order**](OrderApi.md#validate_order) | **POST** /order/validate | Validate
@@ -87,6 +89,59 @@ Name | Type | Description  | Notes
 
 
 
+# **block_refund_on_order**
+> block_refund_on_order(order_id, opts)
+
+Set a refund block on an order
+
+Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+order_id = 'order_id_example' # String | The order id to block a refund on.
+
+opts = { 
+  block_reason: 'block_reason_example' # String | Block reason code (optional)
+}
+
+begin
+  #Set a refund block on an order
+  api_instance.block_refund_on_order(order_id, opts)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling OrderApi->block_refund_on_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The order id to block a refund on. | 
+ **block_reason** | **String**| Block reason code (optional) | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **cancel_order**
 > BaseResponse cancel_order(order_id, opts)
 
@@ -1434,6 +1489,55 @@ Name | Type | Description  | Notes
 
 
 
+# **unblock_refund_on_order**
+> unblock_refund_on_order(order_id)
+
+Remove a refund block on an order
+
+Removes a refund block on an order to prevent a user from performing a refund. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+order_id = 'order_id_example' # String | The order id to unblock a refund on.
+
+
+begin
+  #Remove a refund block on an order
+  api_instance.unblock_refund_on_order(order_id)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling OrderApi->unblock_refund_on_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The order id to unblock a refund on. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **update_accounts_receivable_retry_config**
 > BaseResponse update_accounts_receivable_retry_config(retry_config)
 

data/lib/ultracart_api/api/datawarehouse_api.rb

@@ -32,6 +32,60 @@ module UltracartClient
       UltracartClient::DatawarehouseApi.new(api_client)
     end
 
+    # Delete a custom report
+    # Delete a custom report on the UltraCart account. 
+    # @param custom_report_oid The report oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_custom_report(custom_report_oid, opts = {})
+      delete_custom_report_with_http_info(custom_report_oid, opts)
+      nil
+    end
+
+    # Delete a custom report
+    # Delete a custom report on the UltraCart account. 
+    # @param custom_report_oid The report oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_custom_report_with_http_info(custom_report_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_custom_report ...'
+      end
+      # verify the required parameter 'custom_report_oid' is set
+      if @api_client.config.client_side_validation && custom_report_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.delete_custom_report"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}'.sub('{' + 'custom_report_oid' + '}', custom_report_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#delete_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Delete a report
     # Delete a report on the UltraCart account. 
     # @param report_oid The report oid to delete.
@@ -141,6 +195,67 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Execute a custom report
+    # Execute a custom report on the UltraCart account. 
+    # @param execution_request Request to execute custom report
+    # @param custom_report_oid The report oid to execute.
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportResponse]
+    def execute_custom_report(execution_request, custom_report_oid, opts = {})
+      data, _status_code, _headers = execute_custom_report_with_http_info(execution_request, custom_report_oid, opts)
+      data
+    end
+
+    # Execute a custom report
+    # Execute a custom report on the UltraCart account. 
+    # @param execution_request Request to execute custom report
+    # @param custom_report_oid The report oid to execute.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportResponse, Fixnum, Hash)>] CustomReportResponse data, response status code and response headers
+    def execute_custom_report_with_http_info(execution_request, custom_report_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_custom_report ...'
+      end
+      # verify the required parameter 'execution_request' is set
+      if @api_client.config.client_side_validation && execution_request.nil?
+        fail ArgumentError, "Missing the required parameter 'execution_request' when calling DatawarehouseApi.execute_custom_report"
+      end
+      # verify the required parameter 'custom_report_oid' is set
+      if @api_client.config.client_side_validation && custom_report_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.execute_custom_report"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/execute'.sub('{' + 'custom_report_oid' + '}', custom_report_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(execution_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomReportResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#execute_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Execute the report queries
     # Execute the report queries 
     # @param query_request Query request
@@ -195,6 +310,110 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get a custom report
+    # Retrieve a custom report 
+    # @param custom_report_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportResponse]
+    def get_custom_report(custom_report_oid, opts = {})
+      data, _status_code, _headers = get_custom_report_with_http_info(custom_report_oid, opts)
+      data
+    end
+
+    # Get a custom report
+    # Retrieve a custom report 
+    # @param custom_report_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportResponse, Fixnum, Hash)>] CustomReportResponse data, response status code and response headers
+    def get_custom_report_with_http_info(custom_report_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report ...'
+      end
+      # verify the required parameter 'custom_report_oid' is set
+      if @api_client.config.client_side_validation && custom_report_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.get_custom_report"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}'.sub('{' + 'custom_report_oid' + '}', custom_report_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomReportResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get custom report account configuration
+    # Retrieve a custom report account configuration 
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportAccountConfigResponse]
+    def get_custom_report_account_config(opts = {})
+      data, _status_code, _headers = get_custom_report_account_config_with_http_info(opts)
+      data
+    end
+
+    # Get custom report account configuration
+    # Retrieve a custom report account configuration 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportAccountConfigResponse, Fixnum, Hash)>] CustomReportAccountConfigResponse data, response status code and response headers
+    def get_custom_report_account_config_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report_account_config ...'
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/account_config'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomReportAccountConfigResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_report_account_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get a report
     # Retrieve a report 
     # @param report_oid 
@@ -464,6 +683,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Create a custom report
+    # Create a new custom report on the UltraCart account. 
+    # @param report Report to create
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportResponse]
+    def insert_custom_report(report, opts = {})
+      data, _status_code, _headers = insert_custom_report_with_http_info(report, opts)
+      data
+    end
+
+    # Create a custom report
+    # Create a new custom report on the UltraCart account. 
+    # @param report Report to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportResponse, Fixnum, Hash)>] CustomReportResponse data, response status code and response headers
+    def insert_custom_report_with_http_info(report, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_custom_report ...'
+      end
+      # verify the required parameter 'report' is set
+      if @api_client.config.client_side_validation && report.nil?
+        fail ArgumentError, "Missing the required parameter 'report' when calling DatawarehouseApi.insert_custom_report"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(report)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomReportResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#insert_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Create a report
     # Create a new report on the UltraCart account. 
     # @param report Report to create
@@ -519,6 +793,122 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update a custom report
+    # Update a custom report on the UltraCart account. 
+    # @param report Report to custom update
+    # @param custom_report_oid The report oid to custom update.
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportResponse]
+    def update_custom_report(report, custom_report_oid, opts = {})
+      data, _status_code, _headers = update_custom_report_with_http_info(report, custom_report_oid, opts)
+      data
+    end
+
+    # Update a custom report
+    # Update a custom report on the UltraCart account. 
+    # @param report Report to custom update
+    # @param custom_report_oid The report oid to custom update.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportResponse, Fixnum, Hash)>] CustomReportResponse data, response status code and response headers
+    def update_custom_report_with_http_info(report, custom_report_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_report ...'
+      end
+      # verify the required parameter 'report' is set
+      if @api_client.config.client_side_validation && report.nil?
+        fail ArgumentError, "Missing the required parameter 'report' when calling DatawarehouseApi.update_custom_report"
+      end
+      # verify the required parameter 'custom_report_oid' is set
+      if @api_client.config.client_side_validation && custom_report_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.update_custom_report"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}'.sub('{' + 'custom_report_oid' + '}', custom_report_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(report)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomReportResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Update custom report account config
+    # Update custom report account config. 
+    # @param account_config Account config to update
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportAccountConfigResponse]
+    def update_custom_report_account_config(account_config, opts = {})
+      data, _status_code, _headers = update_custom_report_account_config_with_http_info(account_config, opts)
+      data
+    end
+
+    # Update custom report account config
+    # Update custom report account config. 
+    # @param account_config Account config to update
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportAccountConfigResponse, Fixnum, Hash)>] CustomReportAccountConfigResponse data, response status code and response headers
+    def update_custom_report_account_config_with_http_info(account_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_report_account_config ...'
+      end
+      # verify the required parameter 'account_config' is set
+      if @api_client.config.client_side_validation && account_config.nil?
+        fail ArgumentError, "Missing the required parameter 'account_config' when calling DatawarehouseApi.update_custom_report_account_config"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/account_config'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(account_config)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomReportAccountConfigResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_report_account_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a report
     # Update a report on the UltraCart account. 
     # @param report Report to update