ultracart_api 4.1.19 → 4.1.21

data/docs/DatawarehouseApi.md

@@ -4,7 +4,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**analyze_custom_report**](DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report |
 | [**delete_custom_dashboard**](DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard |
+| [**delete_custom_dashboard_schedule**](DatawarehouseApi.md#delete_custom_dashboard_schedule) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Delete a custom dashboard schedule |
 | [**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 |
@@ -12,9 +14,11 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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_dashboard_schedules**](DatawarehouseApi.md#get_custom_dashboard_schedules) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Get custom dashboards |
 | [**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_report_chart_png_upload_url**](DatawarehouseApi.md#get_custom_report_chart_png_upload_url) | **GET** /datawarehouse/custom_reports/{custom_report_oid}/chart_png | Upload a PNG of a custom report chart |
 | [**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 |
@@ -22,14 +26,70 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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_dashboard_schedule**](DatawarehouseApi.md#insert_custom_dashboard_schedule) | **POST** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Create a custom dashboard schedule |
 | [**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_dashboard_schedule**](DatawarehouseApi.md#update_custom_dashboard_schedule) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Update a custom dashboard schedule |
 | [**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 |
 
 
+## analyze_custom_report
+
+> <CustomReportAnalysisResponse> analyze_custom_report(custom_report_oid, analyze_request)
+
+Analyze a custom report
+
+Analyze a custom report on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the analyze_custom_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportAnalysisResponse>, Integer, Hash)> analyze_custom_report_with_http_info(custom_report_oid, analyze_request)
+
+```ruby
+begin
+  # Analyze a custom report
+  data, status_code, headers = api_instance.analyze_custom_report_with_http_info(custom_report_oid, analyze_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportAnalysisResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->analyze_custom_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_report_oid** | **Integer** | The report oid to analyze. |  |
+| **analyze_request** | [**CustomReportAnalysisRequest**](CustomReportAnalysisRequest.md) | Request to analyze custom report |  |
+
+### Return type
+
+[**CustomReportAnalysisResponse**](CustomReportAnalysisResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
 ## delete_custom_dashboard
 
 > delete_custom_dashboard(custom_dashboard_oid)
@@ -83,6 +143,60 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## delete_custom_dashboard_schedule
+
+> delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid)
+
+Delete a custom dashboard schedule
+
+delete a custom dashboard schedule on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the delete_custom_dashboard_schedule_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_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)
+
+```ruby
+begin
+  # Delete a custom dashboard schedule
+  data, status_code, headers = api_instance.delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->delete_custom_dashboard_schedule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_dashboard_schedule_oid** | **Integer** | The dashboard schedule oid to delete. |  |
+| **custom_dashboard_oid** | **Integer** | The dashboard oid that owns the schedule. |  |
+
+### 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)
@@ -458,6 +572,59 @@ end
 - **Accept**: application/json
 
 
+## get_custom_dashboard_schedules
+
+> <CustomDashboardSchedulesResponse> get_custom_dashboard_schedules(custom_dashboard_oid)
+
+Get custom dashboards
+
+Retrieve a custom dashboards 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_custom_dashboard_schedules_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomDashboardSchedulesResponse>, Integer, Hash)> get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)
+
+```ruby
+begin
+  # Get custom dashboards
+  data, status_code, headers = api_instance.get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomDashboardSchedulesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->get_custom_dashboard_schedules_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_dashboard_oid** | **Integer** |  |  |
+
+### Return type
+
+[**CustomDashboardSchedulesResponse**](CustomDashboardSchedulesResponse.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
@@ -613,6 +780,59 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_custom_report_chart_png_upload_url
+
+> <CustomReportChartPngUploadResponse> get_custom_report_chart_png_upload_url(custom_report_oid)
+
+Upload a PNG of a custom report chart
+
+Upload a PNG of a custom report chart 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_custom_report_chart_png_upload_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomReportChartPngUploadResponse>, Integer, Hash)> get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)
+
+```ruby
+begin
+  # Upload a PNG of a custom report chart
+  data, status_code, headers = api_instance.get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomReportChartPngUploadResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->get_custom_report_chart_png_upload_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_report_oid** | **Integer** | The report oid to upload a chart PNG for. |  |
+
+### Return type
+
+[**CustomReportChartPngUploadResponse**](CustomReportChartPngUploadResponse.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
@@ -984,6 +1204,60 @@ end
 - **Accept**: application/json
 
 
+## insert_custom_dashboard_schedule
+
+> <CustomDashboardScheduleResponse> insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule)
+
+Create a custom dashboard schedule
+
+Create a new custom dashboard schedule on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the insert_custom_dashboard_schedule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomDashboardScheduleResponse>, Integer, Hash)> insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)
+
+```ruby
+begin
+  # Create a custom dashboard schedule
+  data, status_code, headers = api_instance.insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomDashboardScheduleResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->insert_custom_dashboard_schedule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_dashboard_oid** | **Integer** |  |  |
+| **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | Dashboard schedule to create |  |
+
+### Return type
+
+[**CustomDashboardScheduleResponse**](CustomDashboardScheduleResponse.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)
@@ -1145,6 +1419,61 @@ end
 - **Accept**: application/json
 
 
+## update_custom_dashboard_schedule
+
+> <CustomDashboardResponse> update_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
+
+Update a custom dashboard schedule
+
+Update a custom dashboard schedule on the UltraCart account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_custom_dashboard_schedule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomDashboardResponse>, Integer, Hash)> update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
+
+```ruby
+begin
+  # Update a custom dashboard schedule
+  data, status_code, headers = api_instance.update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomDashboardResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling DatawarehouseApi->update_custom_dashboard_schedule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_dashboard_schedule_oid** | **Integer** | The dashboard schedule oid to update. |  |
+| **custom_dashboard_oid** | **Integer** | The dashboard oid to update. |  |
+| **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | Dashboard schedule to 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/EmailCampaign.md

@@ -21,6 +21,8 @@
 | **name** | **String** | Name of email campaign | [optional] |
 | **open_rate_formatted** | **String** | Open rate of emails | [optional] |
 | **prevent_sending_due_to_spam** | **Boolean** | True if this campaign is prevented from sending at this time due to spam complaints. | [optional] |
+| **repeat_monthly** | **Boolean** | True if the campaign should repeat on a monthly basis | [optional] |
+| **repeat_weekly** | **Boolean** | True if the campaign should repeat on a weekly basis | [optional] |
 | **revenue_formatted** | **String** | Revenue associated with campaign | [optional] |
 | **revenue_per_customer_formatted** | **String** | Revenue per customer associated with campaign | [optional] |
 | **scheduled_dts** | **String** | Scheduled date | [optional] |
@@ -54,6 +56,8 @@ instance = UltracartClient::EmailCampaign.new(
   name: null,
   open_rate_formatted: null,
   prevent_sending_due_to_spam: null,
+  repeat_monthly: null,
+  repeat_weekly: null,
   revenue_formatted: null,
   revenue_per_customer_formatted: null,
   scheduled_dts: null,

data/docs/ItemTag.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **tag_type** | **String** | tag_tpe | [optional] |
+| **tag_type** | **String** | tag_type | [optional] |
 | **tag_value** | **String** | tag_value | [optional] |
 
 ## Example

data/docs/OrderApi.md

@@ -26,6 +26,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**is_refundable_order**](OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded |
 | [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment |
 | [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order |
+| [**replace_order_item_merchant_item_id**](OrderApi.md#replace_order_item_merchant_item_id) | **PUT** /order/orders/{order_id}/replace_item_id | Replaces an order item id |
 | [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order |
 | [**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt |
 | [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation |
@@ -2280,6 +2281,61 @@ end
 - **Accept**: application/json
 
 
+## replace_order_item_merchant_item_id
+
+> <OrderResponse> replace_order_item_merchant_item_id(order_id, replace_order_item_id_request, opts)
+
+Replaces an order item id
+
+Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged.  A custom method requested by a merchant to allow for item id updates due to shipping errors.  It is doubtful you will ever need this method.  The expansion variable affects the returned order object. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the replace_order_item_merchant_item_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrderResponse>, Integer, Hash)> replace_order_item_merchant_item_id_with_http_info(order_id, replace_order_item_id_request, opts)
+
+```ruby
+begin
+  # Replaces an order item id
+  data, status_code, headers = api_instance.replace_order_item_merchant_item_id_with_http_info(order_id, replace_order_item_id_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrderResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->replace_order_item_merchant_item_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | The order id to update. |  |
+| **replace_order_item_id_request** | [**ReplaceOrderItemIdRequest**](ReplaceOrderItemIdRequest.md) | Replacement Request |  |
+| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
+
+### Return type
+
+[**OrderResponse**](OrderResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
 ## replacement
 
 > <OrderReplacementResponse> replacement(order_id, replacement)

data/docs/ReplaceOrderItemIdRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::ReplaceOrderItemIdRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_index** | **Integer** | Index of the item on the order (one based index) | [optional] |
+| **merchant_item_id** | **String** | Item ID | [optional] |
+| **order_id** | **String** | Order ID | [optional] |
+| **replacement_merchant_item_id** | **String** | Replacement Item ID | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReplaceOrderItemIdRequest.new(
+  item_index: null,
+  merchant_item_id: null,
+  order_id: null,
+  replacement_merchant_item_id: null
+)
+```
+