ultracart_api 3.11.16 → 3.11.18

data/docs/StorefrontApi.md

@@ -44,6 +44,7 @@ Method | HTTP request | Description
 [**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
@@ -2203,6 +2204,54 @@ Name | Type | Description  | Notes
 
 
 
+# **get_email_commseq_editor_values**
+> EmailEditorValuesResponse get_email_commseq_editor_values(storefront_oid)
+
+Get email merchant specific editor values
+
+### 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::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+storefront_oid = 56 # Integer | 
+
+
+begin
+  #Get email merchant specific editor values
+  result = api_instance.get_email_commseq_editor_values(storefront_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_email_commseq_editor_values: #{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**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_email_commseq_email_stats**
 > EmailStatSummaryResponse get_email_commseq_email_stats(storefront_oid, commseq_uuid, stats_request)
 

data/lib/ultracart_api/api/datawarehouse_api.rb

@@ -32,6 +32,60 @@ module UltracartClient
       UltracartClient::DatawarehouseApi.new(api_client)
     end
 
+    # Delete a custom dashboard
+    # Delete a custom dashboard on the UltraCart account. 
+    # @param custom_dashboard_oid The dashboard oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_custom_dashboard(custom_dashboard_oid, opts = {})
+      delete_custom_dashboard_with_http_info(custom_dashboard_oid, opts)
+      nil
+    end
+
+    # Delete a custom dashboard
+    # Delete a custom dashboard on the UltraCart account. 
+    # @param custom_dashboard_oid The dashboard oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_custom_dashboard_with_http_info(custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_custom_dashboard ...'
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.delete_custom_dashboard"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}'.sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#delete_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Delete a custom report
     # Delete a custom report on the UltraCart account. 
     # @param custom_report_oid The report oid to delete.
@@ -200,7 +254,7 @@ module UltracartClient
     # @param execution_request Request to execute custom report
     # @param custom_report_oid The report oid to execute.
     # @param [Hash] opts the optional parameters
-    # @return [CustomReportResponse]
+    # @return [CustomReportExecutionResponse]
     def execute_custom_report(execution_request, custom_report_oid, opts = {})
       data, _status_code, _headers = execute_custom_report_with_http_info(execution_request, custom_report_oid, opts)
       data
@@ -211,7 +265,7 @@ module UltracartClient
     # @param execution_request Request to execute custom report
     # @param custom_report_oid The report oid to execute.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CustomReportResponse, Fixnum, Hash)>] CustomReportResponse data, response status code and response headers
+    # @return [Array<(CustomReportExecutionResponse, Fixnum, Hash)>] CustomReportExecutionResponse data, response status code and response headers
     def execute_custom_report_with_http_info(execution_request, custom_report_oid, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_custom_report ...'
@@ -250,12 +304,67 @@ module UltracartClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'CustomReportResponse')
+        :return_type => 'CustomReportExecutionResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: DatawarehouseApi#execute_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+    # Execute a custom reports
+    # Execute a custom reports on the UltraCart account. 
+    # @param execution_request Request to execute custom reports
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportsExecutionResponse]
+    def execute_custom_reports(execution_request, opts = {})
+      data, _status_code, _headers = execute_custom_reports_with_http_info(execution_request, opts)
+      data
+    end
+
+    # Execute a custom reports
+    # Execute a custom reports on the UltraCart account. 
+    # @param execution_request Request to execute custom reports
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportsExecutionResponse, Fixnum, Hash)>] CustomReportsExecutionResponse data, response status code and response headers
+    def execute_custom_reports_with_http_info(execution_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_custom_reports ...'
+      end
+      # verify the required parameter 'execution_request' is set
+      if @api_client.config.client_side_validation && execution_request.nil?
+        fail ArgumentError, "Missing the required parameter 'execution_request' when calling DatawarehouseApi.execute_custom_reports"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/execute'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(execution_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomReportsExecutionResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#execute_custom_reports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Execute the report queries
     # Execute the report queries 
     # @param query_request Query request
@@ -310,6 +419,110 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get a custom dashboard
+    # Retrieve a custom dashboard 
+    # @param custom_dashboard_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardResponse]
+    def get_custom_dashboard(custom_dashboard_oid, opts = {})
+      data, _status_code, _headers = get_custom_dashboard_with_http_info(custom_dashboard_oid, opts)
+      data
+    end
+
+    # Get a custom dashboard
+    # Retrieve a custom dashboard 
+    # @param custom_dashboard_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardResponse, Fixnum, Hash)>] CustomDashboardResponse data, response status code and response headers
+    def get_custom_dashboard_with_http_info(custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_dashboard ...'
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.get_custom_dashboard"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}'.sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomDashboardResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get custom dashboards
+    # Retrieve a custom dashboards 
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardsResponse]
+    def get_custom_dashboards(opts = {})
+      data, _status_code, _headers = get_custom_dashboards_with_http_info(opts)
+      data
+    end
+
+    # Get custom dashboards
+    # Retrieve a custom dashboards 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardsResponse, Fixnum, Hash)>] CustomDashboardsResponse data, response status code and response headers
+    def get_custom_dashboards_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_dashboards ...'
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomDashboardsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_dashboards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get a custom report
     # Retrieve a custom report 
     # @param custom_report_oid 
@@ -732,6 +945,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Create a custom dashboard
+    # Create a new custom dashboard on the UltraCart account. 
+    # @param dashboard Dashboard to create
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardResponse]
+    def insert_custom_dashboard(dashboard, opts = {})
+      data, _status_code, _headers = insert_custom_dashboard_with_http_info(dashboard, opts)
+      data
+    end
+
+    # Create a custom dashboard
+    # Create a new custom dashboard on the UltraCart account. 
+    # @param dashboard Dashboard to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardResponse, Fixnum, Hash)>] CustomDashboardResponse data, response status code and response headers
+    def insert_custom_dashboard_with_http_info(dashboard, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_custom_dashboard ...'
+      end
+      # verify the required parameter 'dashboard' is set
+      if @api_client.config.client_side_validation && dashboard.nil?
+        fail ArgumentError, "Missing the required parameter 'dashboard' when calling DatawarehouseApi.insert_custom_dashboard"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(dashboard)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomDashboardResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#insert_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Create a custom report
     # Create a new custom report on the UltraCart account. 
     # @param report Report to create
@@ -842,6 +1110,67 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update a custom dashboard
+    # Update a custom dashboard on the UltraCart account. 
+    # @param dashboard Dashboard to custom update
+    # @param custom_dashboard_oid The dashboard oid to custom update.
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardResponse]
+    def update_custom_dashboard(dashboard, custom_dashboard_oid, opts = {})
+      data, _status_code, _headers = update_custom_dashboard_with_http_info(dashboard, custom_dashboard_oid, opts)
+      data
+    end
+
+    # Update a custom dashboard
+    # Update a custom dashboard on the UltraCart account. 
+    # @param dashboard Dashboard to custom update
+    # @param custom_dashboard_oid The dashboard oid to custom update.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardResponse, Fixnum, Hash)>] CustomDashboardResponse data, response status code and response headers
+    def update_custom_dashboard_with_http_info(dashboard, custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_dashboard ...'
+      end
+      # verify the required parameter 'dashboard' is set
+      if @api_client.config.client_side_validation && dashboard.nil?
+        fail ArgumentError, "Missing the required parameter 'dashboard' when calling DatawarehouseApi.update_custom_dashboard"
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.update_custom_dashboard"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}'.sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(dashboard)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomDashboardResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a custom report
     # Update a custom report on the UltraCart account. 
     # @param report Report to custom update

data/lib/ultracart_api/api/storefront_api.rb

@@ -2327,6 +2327,59 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get email merchant specific editor values
+    # @param storefront_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailEditorValuesResponse]
+    def get_email_commseq_editor_values(storefront_oid, opts = {})
+      data, _status_code, _headers = get_email_commseq_editor_values_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # Get email merchant specific editor values
+    # @param storefront_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailEditorValuesResponse, Fixnum, Hash)>] EmailEditorValuesResponse data, response status code and response headers
+    def get_email_commseq_editor_values_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_editor_values ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_editor_values"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/commseqs/editorValues'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailEditorValuesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get email communication sequence emails stats
     # @param storefront_oid 
     # @param commseq_uuid