ultracart_api 3.11.14 → 3.11.16

data/docs/DatawarehouseApi.md

@@ -4,18 +4,75 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
 [**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
 [**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
+[**execute_custom_report**](DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report
 [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
+[**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
+[**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
+[**get_custom_reports**](DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
 [**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
 [**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
 [**get_report_data_set_page**](DatawarehouseApi.md#get_report_data_set_page) | **GET** /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page
 [**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
 [**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
+[**insert_custom_report**](DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
 [**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
+[**update_custom_report**](DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
+[**update_custom_report_account_config**](DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config
 [**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
 
 
+# **delete_custom_report**
+> delete_custom_report(custom_report_oid)
+
+Delete a custom report
+
+Delete a custom report on the UltraCart account. 
+
+### 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::DatawarehouseApi.new_using_api_key(simple_key, false, false)
+
+
+custom_report_oid = 56 # Integer | The report oid to delete.
+
+
+begin
+  #Delete a custom report
+  api_instance.delete_custom_report(custom_report_oid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->delete_custom_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **custom_report_oid** | **Integer**| The report oid to delete. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **delete_report**
 > delete_report(report_oid)
 
@@ -115,6 +172,59 @@ Name | Type | Description  | Notes
 
 
 
+# **execute_custom_report**
+> CustomReportResponse execute_custom_report(execution_request, custom_report_oid)
+
+Execute a custom report
+
+Execute a custom report on the UltraCart account. 
+
+### 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::DatawarehouseApi.new_using_api_key(simple_key, false, false)
+
+
+execution_request = UltracartClient::CustomReportExecutionRequest.new # CustomReportExecutionRequest | Request to execute custom report
+
+custom_report_oid = 56 # Integer | The report oid to execute.
+
+
+begin
+  #Execute a custom report
+  result = api_instance.execute_custom_report(execution_request, custom_report_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->execute_custom_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **execution_request** | [**CustomReportExecutionRequest**](CustomReportExecutionRequest.md)| Request to execute custom report | 
+ **custom_report_oid** | **Integer**| The report oid to execute. | 
+
+### Return type
+
+[**CustomReportResponse**](CustomReportResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **execute_report_queries**
 > execute_report_queries(query_request)
 
@@ -164,6 +274,146 @@ nil (empty response body)
 
 
 
+# **get_custom_report**
+> CustomReportResponse get_custom_report(custom_report_oid)
+
+Get a custom report
+
+Retrieve a custom report 
+
+### 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::DatawarehouseApi.new_using_api_key(simple_key, false, false)
+
+
+custom_report_oid = 56 # Integer | 
+
+
+begin
+  #Get a custom report
+  result = api_instance.get_custom_report(custom_report_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->get_custom_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **custom_report_oid** | **Integer**|  | 
+
+### Return type
+
+[**CustomReportResponse**](CustomReportResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_custom_report_account_config**
+> CustomReportAccountConfigResponse get_custom_report_account_config
+
+Get custom report account configuration
+
+Retrieve a custom report account configuration 
+
+### 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::DatawarehouseApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Get custom report account configuration
+  result = api_instance.get_custom_report_account_config
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->get_custom_report_account_config: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_custom_reports**
+> CustomReportsResponse get_custom_reports
+
+Get custom reports
+
+Retrieve a custom reports 
+
+### 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::DatawarehouseApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Get custom reports
+  result = api_instance.get_custom_reports
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->get_custom_reports: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CustomReportsResponse**](CustomReportsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_report**
 > ReportResponse get_report(report_oid)
 
@@ -407,6 +657,56 @@ This endpoint does not need any parameter.
 
 
 
+# **insert_custom_report**
+> CustomReportResponse insert_custom_report(report)
+
+Create a custom report
+
+Create a new custom report on the UltraCart account. 
+
+### 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::DatawarehouseApi.new_using_api_key(simple_key, false, false)
+
+
+report = UltracartClient::CustomReport.new # CustomReport | Report to create
+
+
+begin
+  #Create a custom report
+  result = api_instance.insert_custom_report(report)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->insert_custom_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **report** | [**CustomReport**](CustomReport.md)| Report to create | 
+
+### Return type
+
+[**CustomReportResponse**](CustomReportResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **insert_report**
 > ReportResponse insert_report(report)
 
@@ -457,6 +757,109 @@ Name | Type | Description  | Notes
 
 
 
+# **update_custom_report**
+> CustomReportResponse update_custom_report(report, custom_report_oid)
+
+Update a custom report
+
+Update a custom report on the UltraCart account. 
+
+### 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::DatawarehouseApi.new_using_api_key(simple_key, false, false)
+
+
+report = UltracartClient::CustomReport.new # CustomReport | Report to custom update
+
+custom_report_oid = 56 # Integer | The report oid to custom update.
+
+
+begin
+  #Update a custom report
+  result = api_instance.update_custom_report(report, custom_report_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->update_custom_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **report** | [**CustomReport**](CustomReport.md)| Report to custom update | 
+ **custom_report_oid** | **Integer**| The report oid to custom update. | 
+
+### Return type
+
+[**CustomReportResponse**](CustomReportResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **update_custom_report_account_config**
+> CustomReportAccountConfigResponse update_custom_report_account_config(account_config)
+
+Update custom report account config
+
+Update custom report account config. 
+
+### 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::DatawarehouseApi.new_using_api_key(simple_key, false, false)
+
+
+account_config = UltracartClient::CustomReportAccountConfig.new # CustomReportAccountConfig | Account config to update
+
+
+begin
+  #Update custom report account config
+  result = api_instance.update_custom_report_account_config(account_config)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->update_custom_report_account_config: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_config** | [**CustomReportAccountConfig**](CustomReportAccountConfig.md)| Account config to update | 
+
+### Return type
+
+[**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **update_report**
 > ReportResponse update_report(report, report_oid)
 

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]