ultracart_api 3.1.45 → 3.2.4

data/docs/IntegrationLogQueryRequest.md

@@ -0,0 +1,19 @@
+# UltracartClient::IntegrationLogQueryRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** |  | [optional] 
+**direction** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**file_names** | **Array<String>** |  | [optional] 
+**item_id** | **String** |  | [optional] 
+**item_ipn_oid** | **Integer** |  | [optional] 
+**log_dts_begin** | **String** | Log date/time begin | [optional] 
+**log_dts_end** | **String** | Log date/time end | [optional] 
+**log_type** | **String** |  | [optional] 
+**logger_id** | **String** |  | [optional] 
+**order_ids** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/IntegrationLogQueryResponse.md

@@ -0,0 +1,13 @@
+# UltracartClient::IntegrationLogQueryResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**filter_values** | [**IntegrationLogQueryFilterValues**](IntegrationLogQueryFilterValues.md) |  | [optional] 
+**integration_logs** | [**Array<IntegrationLog>**](IntegrationLog.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/IntegrationLogResponse.md

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

data/docs/ItemChannelPartnerMapping.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **buyer_item_number** | **String** | Buyer item number (EDI only) | [optional] 
 **channel_partner_code** | **String** | Channel partner code | [optional] 
 **channel_partner_oid** | **Integer** | Channel partner object identifier | [optional] 
+**cost** | **Float** | Cost given to this channel partner | [optional] 
 **from_item_id** | **String** | From Item ID | [optional] 
 **from_sku** | **String** | From SKU | [optional] 
 **mutually_defined_number** | **String** | Mutually defined number (EDI only) | [optional] 

data/docs/ScreenRecordingHeatmap.md

@@ -3,17 +3,29 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**large_click_thumbnail_url** | **String** |  | [optional] 
 **large_click_url** | **String** |  | [optional] 
+**large_movement_thumbnail_url** | **String** |  | [optional] 
 **large_movement_url** | **String** |  | [optional] 
+**large_regular_thumbnail_url** | **String** |  | [optional] 
 **large_regular_url** | **String** |  | [optional] 
+**large_scroll_thumbnail_url** | **String** |  | [optional] 
 **large_scroll_url** | **String** |  | [optional] 
+**medium_click_thumbnail_url** | **String** |  | [optional] 
 **medium_click_url** | **String** |  | [optional] 
+**medium_movement_thumbnail_url** | **String** |  | [optional] 
 **medium_movement_url** | **String** |  | [optional] 
+**medium_regular_thumbnail_url** | **String** |  | [optional] 
 **medium_regular_url** | **String** |  | [optional] 
+**medium_scroll_thumbnail_url** | **String** |  | [optional] 
 **medium_scroll_url** | **String** |  | [optional] 
+**small_click_thumbnail_url** | **String** |  | [optional] 
 **small_click_url** | **String** |  | [optional] 
+**small_movement_thumbnail_url** | **String** |  | [optional] 
 **small_movement_url** | **String** |  | [optional] 
+**small_regular_thumbnail_url** | **String** |  | [optional] 
 **small_regular_url** | **String** |  | [optional] 
+**small_scroll_thumbnail_url** | **String** |  | [optional] 
 **small_scroll_url** | **String** |  | [optional] 
 
 

data/docs/ScreenRecordingHeatmapIndexRequest.md

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

data/docs/ScreenRecordingHeatmapRequest.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **range** | [**ScreenRecordingFilterRangeDate**](ScreenRecordingFilterRangeDate.md) |  | [optional] 
+**screen_sizes** | **Array<String>** |  | [optional] 
 **url** | **String** |  | [optional] 
 
 

data/docs/ScreenRecordingHeatmapUrl.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **histogram_data** | **Array<Integer>** |  | [optional] 
 **histogram_interval** | **String** |  | [optional] 
 **histogram_start_dts** | **String** |  | [optional] 
+**page_rank** | **Integer** |  | [optional] 
 **session_count** | **Integer** |  | [optional] 
 **url** | **String** |  | [optional] 
 

data/docs/StorefrontApi.md

@@ -88,7 +88,6 @@ Method | HTTP request | Description
 [**get_library_filter_values**](StorefrontApi.md#get_library_filter_values) | **GET** /storefront/code_library/filter_values | Get library values used to populate drop down boxes for filtering.
 [**get_library_item**](StorefrontApi.md#get_library_item) | **GET** /storefront/code_library/{library_item_oid} | Get library item.
 [**get_library_item_published_versions**](StorefrontApi.md#get_library_item_published_versions) | **GET** /storefront/code_library/{library_item_oid}/published_versions | Get all published versions for a library item.
-[**get_pricing_tiers**](StorefrontApi.md#get_pricing_tiers) | **GET** /storefront/pricing_tiers | Retrieve pricing tiers
 [**get_screen_recording**](StorefrontApi.md#get_screen_recording) | **GET** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid} | Get screen recording
 [**get_screen_recording_page_view_data**](StorefrontApi.md#get_screen_recording_page_view_data) | **GET** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/page_view_data/{screen_recording_page_view_uuid} | Get screen recording page view data
 [**get_screen_recording_segment**](StorefrontApi.md#get_screen_recording_segment) | **GET** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Get screen recording segment
@@ -97,6 +96,7 @@ Method | HTTP request | Description
 [**get_screen_recording_tags**](StorefrontApi.md#get_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/tags | Get tags used by screen recording
 [**get_screen_recordings_by_query**](StorefrontApi.md#get_screen_recordings_by_query) | **POST** /storefront/{storefront_oid}/screen_recordings/query | Query screen recordings
 [**get_screen_recordings_by_segment**](StorefrontApi.md#get_screen_recordings_by_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query | Get screen recordings by segment
+[**get_store_front_pricing_tiers**](StorefrontApi.md#get_store_front_pricing_tiers) | **GET** /storefront/pricing_tiers | Retrieve pricing tiers
 [**get_thumbnail_parameters**](StorefrontApi.md#get_thumbnail_parameters) | **POST** /storefront/thumbnailParameters | Get thumbnail parameters
 [**get_transaction_email**](StorefrontApi.md#get_transaction_email) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Gets a transaction email object
 [**get_transaction_email_list**](StorefrontApi.md#get_transaction_email_list) | **GET** /storefront/{storefront_oid}/transaction_email/list | Gets a list of transaction email names
@@ -4119,7 +4119,7 @@ Name | Type | Description  | Notes
 
 
 # **get_heatmap_index**
-> ScreenRecordingHeatmapIndexResponse get_heatmap_index(storefront_oid)
+> ScreenRecordingHeatmapIndexResponse get_heatmap_index(storefront_oid, query, opts)
 
 Get screen recording heatmap index
 
@@ -4137,10 +4137,17 @@ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, fals
 
 storefront_oid = 56 # Integer | 
 
+query = UltracartClient::ScreenRecordingHeatmapIndexRequest.new # ScreenRecordingHeatmapIndexRequest | Query
+
+opts = { 
+  _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
+  _offset: 0, # Integer | Pagination of the record set.  Offset is a zero based index.
+  _sort: '_sort_example' # String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+}
 
 begin
   #Get screen recording heatmap index
-  result = api_instance.get_heatmap_index(storefront_oid)
+  result = api_instance.get_heatmap_index(storefront_oid, query, opts)
   p result
 rescue UltracartClient::ApiError => e
   puts "Exception when calling StorefrontApi->get_heatmap_index: #{e}"
@@ -4152,6 +4159,10 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **storefront_oid** | **Integer**|  | 
+ **query** | [**ScreenRecordingHeatmapIndexRequest**](ScreenRecordingHeatmapIndexRequest.md)| Query | 
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional] [default to 100]
+ **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
+ **_sort** | **String**| The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] 
 
 ### Return type
 
@@ -4419,57 +4430,6 @@ Name | Type | Description  | Notes
 
 
 
-# **get_pricing_tiers**
-> PricingTiersResponse get_pricing_tiers(opts)
-
-Retrieve pricing tiers
-
-Retrieves the pricing tiers 
-
-### 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)
-
-
-opts = { 
-  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
-}
-
-begin
-  #Retrieve pricing tiers
-  result = api_instance.get_pricing_tiers(opts)
-  p result
-rescue UltracartClient::ApiError => e
-  puts "Exception when calling StorefrontApi->get_pricing_tiers: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional] 
-
-### Return type
-
-[**PricingTiersResponse**](PricingTiersResponse.md)
-
-### Authorization
-
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
 # **get_screen_recording**
 > ScreenRecordingResponse get_screen_recording(storefront_oid, screen_recording_uuid)
 
@@ -4898,6 +4858,57 @@ Name | Type | Description  | Notes
 
 
 
+# **get_store_front_pricing_tiers**
+> PricingTiersResponse get_store_front_pricing_tiers(opts)
+
+Retrieve pricing tiers
+
+Retrieves the pricing tiers 
+
+### 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)
+
+
+opts = { 
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
+}
+
+begin
+  #Retrieve pricing tiers
+  result = api_instance.get_store_front_pricing_tiers(opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_store_front_pricing_tiers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional] 
+
+### Return type
+
+[**PricingTiersResponse**](PricingTiersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_thumbnail_parameters**
 > ThumbnailParametersResponse get_thumbnail_parameters(thumbnail_parameters)
 

data/lib/ultracart_api.rb

@@ -325,6 +325,13 @@ require 'ultracart_api/models/group_response'
 require 'ultracart_api/models/group_user_membership'
 require 'ultracart_api/models/groups_response'
 require 'ultracart_api/models/http_header'
+require 'ultracart_api/models/integration_log'
+require 'ultracart_api/models/integration_log_file'
+require 'ultracart_api/models/integration_log_log'
+require 'ultracart_api/models/integration_log_query_filter_values'
+require 'ultracart_api/models/integration_log_query_request'
+require 'ultracart_api/models/integration_log_query_response'
+require 'ultracart_api/models/integration_log_response'
 require 'ultracart_api/models/item'
 require 'ultracart_api/models/item_accounting'
 require 'ultracart_api/models/item_amember'
@@ -505,6 +512,7 @@ require 'ultracart_api/models/screen_recording_filter_values_event_params'
 require 'ultracart_api/models/screen_recording_filter_values_page_param'
 require 'ultracart_api/models/screen_recording_filter_values_page_view'
 require 'ultracart_api/models/screen_recording_heatmap'
+require 'ultracart_api/models/screen_recording_heatmap_index_request'
 require 'ultracart_api/models/screen_recording_heatmap_index_response'
 require 'ultracart_api/models/screen_recording_heatmap_request'
 require 'ultracart_api/models/screen_recording_heatmap_reset'
@@ -599,6 +607,7 @@ require 'ultracart_api/api/checkout_api'
 require 'ultracart_api/api/coupon_api'
 require 'ultracart_api/api/customer_api'
 require 'ultracart_api/api/fulfillment_api'
+require 'ultracart_api/api/integration_log_api'
 require 'ultracart_api/api/item_api'
 require 'ultracart_api/api/oauth_api'
 require 'ultracart_api/api/order_api'

data/lib/ultracart_api/api/customer_api.rb

@@ -203,6 +203,104 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve values needed for a customer profile editor
+    # Retrieve values needed for a customer profile editor. 
+    # @param [Hash] opts the optional parameters
+    # @return [CustomerEditorValues]
+    def get_customer_editor_values(opts = {})
+      data, _status_code, _headers = get_customer_editor_values_with_http_info(opts)
+      data
+    end
+
+    # Retrieve values needed for a customer profile editor
+    # Retrieve values needed for a customer profile editor. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomerEditorValues, Fixnum, Hash)>] CustomerEditorValues data, response status code and response headers
+    def get_customer_editor_values_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_editor_values ...'
+      end
+      # resource path
+      local_var_path = '/customer/editor_values'
+
+      # 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 => 'CustomerEditorValues')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomerApi#get_customer_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve all email lists across all storefronts
+    # Retrieve all email lists across all storefronts 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailListsResponse]
+    def get_customer_email_lists(opts = {})
+      data, _status_code, _headers = get_customer_email_lists_with_http_info(opts)
+      data
+    end
+
+    # Retrieve all email lists across all storefronts
+    # Retrieve all email lists across all storefronts 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailListsResponse, Fixnum, Hash)>] EmailListsResponse data, response status code and response headers
+    def get_customer_email_lists_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_email_lists ...'
+      end
+      # resource path
+      local_var_path = '/customer/email_lists'
+
+      # 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 => 'EmailListsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomerApi#get_customer_email_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve customers
     # Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param [Hash] opts the optional parameters
@@ -470,104 +568,6 @@ module UltracartClient
       end
       return data, status_code, headers
     end
-    # Retrieve values needed for a customer profile editor
-    # Retrieve values needed for a customer profile editor. 
-    # @param [Hash] opts the optional parameters
-    # @return [CustomerEditorValues]
-    def get_editor_values(opts = {})
-      data, _status_code, _headers = get_editor_values_with_http_info(opts)
-      data
-    end
-
-    # Retrieve values needed for a customer profile editor
-    # Retrieve values needed for a customer profile editor. 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(CustomerEditorValues, Fixnum, Hash)>] CustomerEditorValues data, response status code and response headers
-    def get_editor_values_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CustomerApi.get_editor_values ...'
-      end
-      # resource path
-      local_var_path = '/customer/editor_values'
-
-      # 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 => 'CustomerEditorValues')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CustomerApi#get_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Retrieve all email lists across all storefronts
-    # Retrieve all email lists across all storefronts 
-    # @param [Hash] opts the optional parameters
-    # @return [EmailListsResponse]
-    def get_email_lists(opts = {})
-      data, _status_code, _headers = get_email_lists_with_http_info(opts)
-      data
-    end
-
-    # Retrieve all email lists across all storefronts
-    # Retrieve all email lists across all storefronts 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(EmailListsResponse, Fixnum, Hash)>] EmailListsResponse data, response status code and response headers
-    def get_email_lists_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CustomerApi.get_email_lists ...'
-      end
-      # resource path
-      local_var_path = '/customer/email_lists'
-
-      # 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 => 'EmailListsResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CustomerApi#get_email_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
     # Create a token that can be used to verify a customer email address
     # Create a token that can be used to verify a customer email address.  The implementation of how a customer interacts with this token is left to the merchant. 
     # @param token_request Token request