ultracart_api 3.10.124 → 3.10.125

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deac586f8344990d9eb4363d9bbf7400a1e259f8a13a52bcdf34279a14085cbd
-  data.tar.gz: fd130300e4857d26b4ef6d26ab78da0cc55b09d99c0917db7ff9df604f764455
+  metadata.gz: bf58195910f46fde5ef8031b5cbc2558f7b9918a2e9488aa480130c14d356c48
+  data.tar.gz: e8072049e8bb737eccdeb5f3b152dd7e003e41a011caf016f1ee51a6e4fa21d5
 SHA512:
-  metadata.gz: d326d1cb418e1896eb3b42204c2eb935f85f00a44cb7791cbd0091634313e7ce9d171b08fde8489e5e927959470b50a06e5f60b477b28d553d10ddc18eba418a
-  data.tar.gz: 1777f4bc95307e710cb1fedcd09c1a659bd03a29292733393af856fc600762e234bf7d3d69c65b6d0b244ecef6e85b20c48a4933583f916d2dbff61408994bee
+  metadata.gz: 23f21a0fa71d9e4310d912059868b9803973eeb764eea3f383946f0080855c0106f2da05adaa6f1ba9d5022f765bc31ba1ba64f29e759e804d7bcfff79d93b8e
+  data.tar.gz: 94d3421051eea455f89c066d9a1007673094be93f32074b10629699967b153fae8d4b4b23cba8dc12472e93646fbae94f1c1525f2b29f2c03be962256d9abd53

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.124
+- Package version: 3.10.125
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.124.gem
+gem install ./ultracart_api-3.10.125.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.124.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.125.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.10.124'
+    gem 'ultracart_api', '~> 3.10.125'
 
 ### Install from Git
 
@@ -204,6 +204,15 @@ Class | Method | HTTP request | Description
 *UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
 *UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
 *UltracartClient::CustomerApi* | [**validate_email_verification_token**](docs/CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
+*UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
+*UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
+*UltracartClient::DatawarehouseApi* | [**get_report**](docs/DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
+*UltracartClient::DatawarehouseApi* | [**get_report_data_set**](docs/DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
+*UltracartClient::DatawarehouseApi* | [**get_report_data_set_page**](docs/DatawarehouseApi.md#get_report_data_set_page) | **GET** /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page
+*UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
+*UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
+*UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
+*UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
 *UltracartClient::FulfillmentApi* | [**acknowledge_orders**](docs/FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
 *UltracartClient::FulfillmentApi* | [**generate_packing_slip**](docs/FulfillmentApi.md#generate_packing_slip) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} | Generate a packing slip for this order for the given distribution center.
 *UltracartClient::FulfillmentApi* | [**get_distribution_center_orders**](docs/FulfillmentApi.md#get_distribution_center_orders) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders | Retrieve orders queued up for this distribution center.
@@ -1118,6 +1127,28 @@ Class | Method | HTTP request | Description
  - [UltracartClient::PublishLibraryItemRequest](docs/PublishLibraryItemRequest.md)
  - [UltracartClient::RegisterAffiliateClickRequest](docs/RegisterAffiliateClickRequest.md)
  - [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
+ - [UltracartClient::Report](docs/Report.md)
+ - [UltracartClient::ReportAuth](docs/ReportAuth.md)
+ - [UltracartClient::ReportAuthResponse](docs/ReportAuthResponse.md)
+ - [UltracartClient::ReportDataSet](docs/ReportDataSet.md)
+ - [UltracartClient::ReportDataSetColumn](docs/ReportDataSetColumn.md)
+ - [UltracartClient::ReportDataSetPage](docs/ReportDataSetPage.md)
+ - [UltracartClient::ReportDataSetPageResponse](docs/ReportDataSetPageResponse.md)
+ - [UltracartClient::ReportDataSetQuery](docs/ReportDataSetQuery.md)
+ - [UltracartClient::ReportDataSetResponse](docs/ReportDataSetResponse.md)
+ - [UltracartClient::ReportDataSetRow](docs/ReportDataSetRow.md)
+ - [UltracartClient::ReportDataSetSchema](docs/ReportDataSetSchema.md)
+ - [UltracartClient::ReportDataSource](docs/ReportDataSource.md)
+ - [UltracartClient::ReportDataSourceSchema](docs/ReportDataSourceSchema.md)
+ - [UltracartClient::ReportExecuteQueriesRequest](docs/ReportExecuteQueriesRequest.md)
+ - [UltracartClient::ReportFilter](docs/ReportFilter.md)
+ - [UltracartClient::ReportFilterConnection](docs/ReportFilterConnection.md)
+ - [UltracartClient::ReportPage](docs/ReportPage.md)
+ - [UltracartClient::ReportPageVisualization](docs/ReportPageVisualization.md)
+ - [UltracartClient::ReportPageVisualizationDimension](docs/ReportPageVisualizationDimension.md)
+ - [UltracartClient::ReportPageVisualizationMetric](docs/ReportPageVisualizationMetric.md)
+ - [UltracartClient::ReportResponse](docs/ReportResponse.md)
+ - [UltracartClient::ReportsResponse](docs/ReportsResponse.md)
  - [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
  - [UltracartClient::ResultSet](docs/ResultSet.md)
  - [UltracartClient::RulerValidationRequest](docs/RulerValidationRequest.md)
@@ -1307,6 +1338,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.125 | 03/22/2023 | dw initial framework |
 | 3.10.124 | 03/22/2023 | order api - refundable response added manual_because_multiple_charges boolean field |
 | 3.10.123 | 03/21/2023 | order api - new stage named Hold |
 | 3.10.122 | 03/14/2023 | order.getOrderEdiDocuments |

data/docs/DatawarehouseApi.md

@@ -0,0 +1,461 @@
+# UltracartClient::DatawarehouseApi
+
+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
+[**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
+[**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
+[**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
+[**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
+
+
+# **delete_report**
+> delete_report(report_oid)
+
+Delete a report
+
+Delete a 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_oid = 56 # Integer | The report oid to delete.
+
+
+begin
+  #Delete a report
+  api_instance.delete_report(report_oid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->delete_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+
+
+# **execute_report_queries**
+> execute_report_queries(query_request)
+
+Execute the report queries
+
+Execute 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::ReportExecuteQueriesRequest.new # ReportExecuteQueriesRequest | Query request
+
+
+begin
+  #Execute the report queries
+  api_instance.execute_report_queries(query_request)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->execute_report_queries: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query_request** | [**ReportExecuteQueriesRequest**](ReportExecuteQueriesRequest.md)| Query request | 
+
+### 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
+
+
+
+# **get_report**
+> ReportResponse get_report(report_oid)
+
+Get a report
+
+Retrieve a 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)
+
+
+report_oid = 56 # Integer | 
+
+
+begin
+  #Get a report
+  result = api_instance.get_report(report_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->get_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **report_oid** | **Integer**|  | 
+
+### Return type
+
+[**ReportResponse**](ReportResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_report_data_set**
+> ReportDataSetResponse get_report_data_set(dataset_uuid)
+
+Get a report data set
+
+Retrieve a report data set 
+
+### 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)
+
+
+dataset_uuid = 'dataset_uuid_example' # String | 
+
+
+begin
+  #Get a report data set
+  result = api_instance.get_report_data_set(dataset_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->get_report_data_set: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dataset_uuid** | **String**|  | 
+
+### Return type
+
+[**ReportDataSetResponse**](ReportDataSetResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_report_data_set_page**
+> ReportDataSetPageResponse get_report_data_set_page(dataset_uuid, page_number)
+
+Get a report data set page
+
+Retrieve a report data set page 
+
+### 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)
+
+
+dataset_uuid = 'dataset_uuid_example' # String | 
+
+page_number = 56 # Integer | 
+
+
+begin
+  #Get a report data set page
+  result = api_instance.get_report_data_set_page(dataset_uuid, page_number)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->get_report_data_set_page: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dataset_uuid** | **String**|  | 
+ **page_number** | **Integer**|  | 
+
+### Return type
+
+[**ReportDataSetPageResponse**](ReportDataSetPageResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_report_websocket_authorization**
+> ReportAuthResponse get_report_websocket_authorization
+
+Get report websocket authorization
+
+Retrieve a JWT to authorize a report to make a websocket connection. 
+
+### 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 report websocket authorization
+  result = api_instance.get_report_websocket_authorization
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->get_report_websocket_authorization: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ReportAuthResponse**](ReportAuthResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_reports**
+> ReportsResponse get_reports
+
+Get list of reports available
+
+Retrieve a list of reports available 
+
+### 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 list of reports available
+  result = api_instance.get_reports
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->get_reports: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ReportsResponse**](ReportsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **insert_report**
+> ReportResponse insert_report(report)
+
+Create a report
+
+Create a new 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::Report.new # Report | Report to create
+
+
+begin
+  #Create a report
+  result = api_instance.insert_report(report)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->insert_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **report** | [**Report**](Report.md)| Report to create | 
+
+### Return type
+
+[**ReportResponse**](ReportResponse.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)
+
+Update a report
+
+Update a 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::Report.new # Report | Report to update
+
+report_oid = 56 # Integer | The report oid to update.
+
+
+begin
+  #Update a report
+  result = api_instance.update_report(report, report_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling DatawarehouseApi->update_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **report** | [**Report**](Report.md)| Report to update | 
+ **report_oid** | **Integer**| The report oid to update. | 
+
+### Return type
+
+[**ReportResponse**](ReportResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+

data/docs/Report.md

@@ -0,0 +1,17 @@
+# UltracartClient::Report
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** |  | [optional] 
+**data_sources** | [**Array<ReportDataSource>**](ReportDataSource.md) |  | [optional] 
+**default_dataset_id** | **String** |  | [optional] 
+**default_project_id** | **String** |  | [optional] 
+**filters** | [**Array<ReportFilter>**](ReportFilter.md) |  | [optional] 
+**merchant_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**pages** | [**Array<ReportPage>**](ReportPage.md) |  | [optional] 
+**report_oid** | **Integer** | Object identifier for this report. | [optional] 
+**security_level** | **String** | Security level to execute report under | [optional] 
+
+

data/docs/ReportAuth.md

@@ -0,0 +1,11 @@
+# UltracartClient::ReportAuth
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_uuid** | **String** | Unique UUID assigned to this client | [optional] 
+**jwt** | **String** |  | [optional] 
+**merchant_id** | **String** |  | [optional] 
+**websocket_url** | **String** |  | [optional] 
+
+

data/docs/ReportAuthResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ReportAuthResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**report_auth** | [**ReportAuth**](ReportAuth.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ReportDataSet.md

@@ -0,0 +1,22 @@
+# UltracartClient::ReportDataSet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_set_query_uuid** | **String** | A unique identifier assigned to the data set query that is returned. | [optional] 
+**data_set_uuid** | **String** | A unique identifier assigned to the data set that is returned. | [optional] 
+**destination_table_id** | **String** | The BigQuery destination table id that contains the result. | [optional] 
+**error_message** | **String** | Error message if the query failed. | [optional] 
+**for_object_id** | **String** | An identifier that can be used to help match up the returned data set | [optional] 
+**for_object_type** | **String** | The type of object this data set is for | [optional] 
+**initial_pages** | [**Array<ReportDataSetPage>**](ReportDataSetPage.md) | Initial pages returned in the dataset | [optional] 
+**max_results** | **Integer** | The total number of results | [optional] 
+**merchant_id** | **String** | Merchant that owns this data set | [optional] 
+**page_count** | **Integer** | The size of the pages | [optional] 
+**page_size** | **Integer** | The size of the pages | [optional] 
+**schema** | [**Array<ReportDataSetSchema>**](ReportDataSetSchema.md) | The schema associated with the data set. | [optional] 
+**security_level** | **String** | Security level this dataset was read from. | [optional] 
+**timezone** | **String** |  | [optional] 
+**user_data** | **String** | Any other data that needs to be returned with the response to help the UI | [optional] 
+
+

data/docs/ReportDataSetColumn.md

@@ -0,0 +1,8 @@
+# UltracartClient::ReportDataSetColumn
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+
+

data/docs/ReportDataSetPage.md

@@ -0,0 +1,17 @@
+# UltracartClient::ReportDataSetPage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_set_uuid** | **String** | A unique identifier assigned to the data set that is returned. | [optional] 
+**merchant_id** | **String** | Merchant that owns this data set | [optional] 
+**next_page_token** | **String** |  | [optional] 
+**next_start_index** | **Integer** |  | [optional] 
+**page_number** | **Integer** |  | [optional] 
+**row_count** | **Integer** |  | [optional] 
+**rows** | [**Array<ReportDataSetRow>**](ReportDataSetRow.md) | Rows returned for the data set | [optional] 
+**rows_s3_url** | **String** | Signed S3 URL where the page rows can be downloaded from | [optional] 
+**start_index** | **Integer** | Zero based index of the starting row | [optional] 
+**table_id** | **String** | The BigQuery destination table id that contains the result. | [optional] 
+
+

data/docs/ReportDataSetPageResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ReportDataSetPageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**page** | [**ReportDataSetPage**](ReportDataSetPage.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ReportDataSetQuery.md

@@ -0,0 +1,19 @@
+# UltracartClient::ReportDataSetQuery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**comparison_results** | **BOOLEAN** | True if a date range filter is provided with comparison date ranges and two results should be returned for the query. | [optional] 
+**data_set_query_uuid** | **String** | A unique identifier assigned to the data set query that is returned. | [optional] 
+**data_source** | [**ReportDataSource**](ReportDataSource.md) |  | [optional] 
+**dimensions** | [**Array<ReportPageVisualizationDimension>**](ReportPageVisualizationDimension.md) |  | [optional] 
+**filter** | [**ReportFilter**](ReportFilter.md) |  | [optional] 
+**for_object_id** | **String** | An identifier that can be used to help match up the returned data set | [optional] 
+**for_object_type** | **String** | The type of object this data set is for | [optional] 
+**metrics** | [**Array<ReportPageVisualizationMetric>**](ReportPageVisualizationMetric.md) |  | [optional] 
+**page_size** | **Integer** | Result set page size.  The default value is 200 records.  Max is 10000. | [optional] 
+**selected_filters** | [**Array<ReportFilter>**](ReportFilter.md) |  | [optional] 
+**skip_cache** | **BOOLEAN** | True if the 15 minute cache should be skipped. | [optional] 
+**user_data** | **String** | Any other data that needs to be returned with the response to help the UI | [optional] 
+
+