ultracart_api 4.1.16 → 4.1.18

data/docs/DatawarehouseApi.md

@@ -4,11 +4,15 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**delete_custom_dashboard**](DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard |
 | [**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_custom_reports**](DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports |
 | [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries |
+| [**get_custom_dashboard**](DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard |
+| [**get_custom_dashboards**](DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards |
 | [**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 |
@@ -17,13 +21,68 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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_dashboard**](DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard |
 | [**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_dashboard**](DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard |
 | [**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_dashboard
+
+> delete_custom_dashboard(custom_dashboard_oid)
+
+Delete a custom dashboard
+
+Delete a custom dashboard on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the delete_custom_dashboard_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_dashboard_with_http_info(custom_dashboard_oid)
+
+```ruby
+begin
+  # Delete a custom dashboard
+  data, status_code, headers = api_instance.delete_custom_dashboard_with_http_info(custom_dashboard_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->delete_custom_dashboard_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_dashboard_oid** | **Integer** | The dashboard 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_custom_report
 
 > delete_custom_report(custom_report_oid)
@@ -187,7 +246,7 @@ end
 
 ## execute_custom_report
 
-> <CustomReportResponse> execute_custom_report(custom_report_oid, execution_request)
+> <CustomReportExecutionResponse> execute_custom_report(custom_report_oid, execution_request)
 
 Execute a custom report
 
@@ -204,7 +263,7 @@ Execute a custom report on the UltraCart account.
 
 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)
+> <Array(<CustomReportExecutionResponse>, Integer, Hash)> execute_custom_report_with_http_info(custom_report_oid, execution_request)
 
 ```ruby
 begin
@@ -212,7 +271,7 @@ begin
   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>
+  p data # => <CustomReportExecutionResponse>
 rescue UltracartClient::ApiError => e
   puts "Error when calling DatawarehouseApi->execute_custom_report_with_http_info: #{e}"
 end
@@ -227,7 +286,60 @@ end
 
 ### Return type
 
-[**CustomReportResponse**](CustomReportResponse.md)
+[**CustomReportExecutionResponse**](CustomReportExecutionResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
+## execute_custom_reports
+
+> <CustomReportsExecutionResponse> execute_custom_reports(execution_request)
+
+Execute a custom reports
+
+Execute a custom reports on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the execute_custom_reports_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportsExecutionResponse>, Integer, Hash)> execute_custom_reports_with_http_info(execution_request)
+
+```ruby
+begin
+  # Execute a custom reports
+  data, status_code, headers = api_instance.execute_custom_reports_with_http_info(execution_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportsExecutionResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->execute_custom_reports_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **execution_request** | [**CustomReportsExecutionRequest**](CustomReportsExecutionRequest.md) | Request to execute custom reports |  |
+
+### Return type
+
+[**CustomReportsExecutionResponse**](CustomReportsExecutionResponse.md)
 
 ### Authorization
 
@@ -293,6 +405,110 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## get_custom_dashboard
+
+> <CustomDashboardResponse> get_custom_dashboard(custom_dashboard_oid)
+
+Get a custom dashboard
+
+Retrieve a custom dashboard 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_custom_dashboard_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomDashboardResponse>, Integer, Hash)> get_custom_dashboard_with_http_info(custom_dashboard_oid)
+
+```ruby
+begin
+  # Get a custom dashboard
+  data, status_code, headers = api_instance.get_custom_dashboard_with_http_info(custom_dashboard_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomDashboardResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->get_custom_dashboard_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_dashboard_oid** | **Integer** |  |  |
+
+### Return type
+
+[**CustomDashboardResponse**](CustomDashboardResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_custom_dashboards
+
+> <CustomDashboardsResponse> get_custom_dashboards
+
+Get custom dashboards
+
+Retrieve a custom dashboards 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_custom_dashboards_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomDashboardsResponse>, Integer, Hash)> get_custom_dashboards_with_http_info
+
+```ruby
+begin
+  # Get custom dashboards
+  data, status_code, headers = api_instance.get_custom_dashboards_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomDashboardsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->get_custom_dashboards_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CustomDashboardsResponse**](CustomDashboardsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_custom_report
 
 > <CustomReportResponse> get_custom_report(custom_report_oid)
@@ -715,6 +931,59 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## insert_custom_dashboard
+
+> <CustomDashboardResponse> insert_custom_dashboard(dashboard)
+
+Create a custom dashboard
+
+Create a new custom dashboard on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the insert_custom_dashboard_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomDashboardResponse>, Integer, Hash)> insert_custom_dashboard_with_http_info(dashboard)
+
+```ruby
+begin
+  # Create a custom dashboard
+  data, status_code, headers = api_instance.insert_custom_dashboard_with_http_info(dashboard)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomDashboardResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->insert_custom_dashboard_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dashboard** | [**CustomDashboard**](CustomDashboard.md) | Dashboard to create |  |
+
+### Return type
+
+[**CustomDashboardResponse**](CustomDashboardResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
 ## insert_custom_report
 
 > <CustomReportResponse> insert_custom_report(report)
@@ -822,6 +1091,60 @@ end
 - **Accept**: application/json
 
 
+## update_custom_dashboard
+
+> <CustomDashboardResponse> update_custom_dashboard(custom_dashboard_oid, dashboard)
+
+Update a custom dashboard
+
+Update a custom dashboard on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_custom_dashboard_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomDashboardResponse>, Integer, Hash)> update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)
+
+```ruby
+begin
+  # Update a custom dashboard
+  data, status_code, headers = api_instance.update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomDashboardResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->update_custom_dashboard_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_dashboard_oid** | **Integer** | The dashboard oid to custom update. |  |
+| **dashboard** | [**CustomDashboard**](CustomDashboard.md) | Dashboard to custom update |  |
+
+### Return type
+
+[**CustomDashboardResponse**](CustomDashboardResponse.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
 
 > <CustomReportResponse> update_custom_report(custom_report_oid, report)

data/docs/EmailEditorValuesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::EmailEditorValuesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **loyalty_tiers** | **Array<String>** |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailEditorValuesResponse.new(
+  error: null,
+  loyalty_tiers: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/StorefrontApi.md

@@ -44,6 +44,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_email_campaigns**](StorefrontApi.md#get_email_campaigns) | **GET** /storefront/{storefront_oid}/email/campaigns | Get email campaigns |
 | [**get_email_campaigns_with_stats**](StorefrontApi.md#get_email_campaigns_with_stats) | **GET** /storefront/{storefront_oid}/email/campaignsWithStats/{stat_days} | Get email campaigns with stats |
 | [**get_email_commseq**](StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq |
+| [**get_email_commseq_editor_values**](StorefrontApi.md#get_email_commseq_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/editorValues | Get email merchant specific editor values |
 | [**get_email_commseq_email_stats**](StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats |
 | [**get_email_commseq_postcard_stats**](StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats |
 | [**get_email_commseq_postcard_tracking**](StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking |
@@ -2303,6 +2304,57 @@ end
 - **Accept**: application/json
 
 
+## get_email_commseq_editor_values
+
+> <EmailEditorValuesResponse> get_email_commseq_editor_values(storefront_oid)
+
+Get email merchant specific editor values
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_email_commseq_editor_values_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailEditorValuesResponse>, Integer, Hash)> get_email_commseq_editor_values_with_http_info(storefront_oid)
+
+```ruby
+begin
+  # Get email merchant specific editor values
+  data, status_code, headers = api_instance.get_email_commseq_editor_values_with_http_info(storefront_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailEditorValuesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->get_email_commseq_editor_values_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+
+### Return type
+
+[**EmailEditorValuesResponse**](EmailEditorValuesResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_email_commseq_email_stats
 
 > <EmailStatSummaryResponse> get_email_commseq_email_stats(storefront_oid, commseq_uuid, stats_request)