ultracart_api 4.1.14 → 4.1.16

data/docs/DatawarehouseApi.md

@@ -4,18 +4,79 @@ 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. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the delete_custom_report_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_custom_report_with_http_info(custom_report_oid)
+
+```ruby
+begin
+  # Delete a custom report
+  data, status_code, headers = api_instance.delete_custom_report_with_http_info(custom_report_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->delete_custom_report_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
 ## delete_report
 
 > delete_report(report_oid)
@@ -124,6 +185,60 @@ end
 - **Accept**: application/json
 
 
+## execute_custom_report
+
+> <CustomReportResponse> execute_custom_report(custom_report_oid, execution_request)
+
+Execute a custom report
+
+Execute a custom report on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the execute_custom_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportResponse>, Integer, Hash)> execute_custom_report_with_http_info(custom_report_oid, execution_request)
+
+```ruby
+begin
+  # Execute a custom report
+  data, status_code, headers = api_instance.execute_custom_report_with_http_info(custom_report_oid, execution_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->execute_custom_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_report_oid** | **Integer** | The report oid to execute. |  |
+| **execution_request** | [**CustomReportExecutionRequest**](CustomReportExecutionRequest.md) | Request to execute custom report |  |
+
+### 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)
@@ -178,6 +293,161 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## get_custom_report
+
+> <CustomReportResponse> get_custom_report(custom_report_oid)
+
+Get a custom report
+
+Retrieve a custom report 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_custom_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportResponse>, Integer, Hash)> get_custom_report_with_http_info(custom_report_oid)
+
+```ruby
+begin
+  # Get a custom report
+  data, status_code, headers = api_instance.get_custom_report_with_http_info(custom_report_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->get_custom_report_with_http_info: #{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**: Not defined
+- **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 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_custom_report_account_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportAccountConfigResponse>, Integer, Hash)> get_custom_report_account_config_with_http_info
+
+```ruby
+begin
+  # Get custom report account configuration
+  data, status_code, headers = api_instance.get_custom_report_account_config_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportAccountConfigResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->get_custom_report_account_config_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
+## get_custom_reports
+
+> <CustomReportsResponse> get_custom_reports
+
+Get custom reports
+
+Retrieve a custom reports 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_custom_reports_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportsResponse>, Integer, Hash)> get_custom_reports_with_http_info
+
+```ruby
+begin
+  # Get custom reports
+  data, status_code, headers = api_instance.get_custom_reports_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->get_custom_reports_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
 ## get_report
 
 > <ReportResponse> get_report(report_oid)
@@ -445,6 +715,59 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## insert_custom_report
+
+> <CustomReportResponse> insert_custom_report(report)
+
+Create a custom report
+
+Create a new custom report on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the insert_custom_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportResponse>, Integer, Hash)> insert_custom_report_with_http_info(report)
+
+```ruby
+begin
+  # Create a custom report
+  data, status_code, headers = api_instance.insert_custom_report_with_http_info(report)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->insert_custom_report_with_http_info: #{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)
@@ -499,6 +822,113 @@ end
 - **Accept**: application/json
 
 
+## update_custom_report
+
+> <CustomReportResponse> update_custom_report(custom_report_oid, report)
+
+Update a custom report
+
+Update a custom report on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_custom_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportResponse>, Integer, Hash)> update_custom_report_with_http_info(custom_report_oid, report)
+
+```ruby
+begin
+  # Update a custom report
+  data, status_code, headers = api_instance.update_custom_report_with_http_info(custom_report_oid, report)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->update_custom_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_report_oid** | **Integer** | The report oid to custom update. |  |
+| **report** | [**CustomReport**](CustomReport.md) | Report 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. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_custom_report_account_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportAccountConfigResponse>, Integer, Hash)> update_custom_report_account_config_with_http_info(account_config)
+
+```ruby
+begin
+  # Update custom report account config
+  data, status_code, headers = api_instance.update_custom_report_account_config_with_http_info(account_config)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportAccountConfigResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->update_custom_report_account_config_with_http_info: #{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_oid, report)

data/docs/Item.md

@@ -35,7 +35,7 @@
 | **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] |