docs/DatawarehouseApi.md in ultracart_api-3.10.127 vs docs/DatawarehouseApi.md in ultracart_api-3.10.128

- old
+ new

@@ -3,10 +3,11 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2* Method | HTTP request | Description ------------- | ------------- | ------------- [**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_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries [**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 @@ -50,9 +51,59 @@ **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 + + + +# **dry_run_report_queries** +> ReportDryRunQueriesResponse dry_run_report_queries(query_request) + +Dry run the report queries + +Dry run the report queries + +### 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) + + +query_request = UltracartClient::ReportDryRunQueriesRequest.new # ReportDryRunQueriesRequest | Dry run request + + +begin + #Dry run the report queries + result = api_instance.dry_run_report_queries(query_request) + p result +rescue UltracartClient::ApiError => e + puts "Exception when calling DatawarehouseApi->dry_run_report_queries: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_request** | [**ReportDryRunQueriesRequest**](ReportDryRunQueriesRequest.md)| Dry run request | + +### Return type + +[**ReportDryRunQueriesResponse**](ReportDryRunQueriesResponse.md) ### Authorization [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)