ultracart_api 3.1.48 → 3.2.8

data/docs/AutoOrderQuery.md

@@ -11,10 +11,12 @@ Name | Type | Description | Notes
 **customer_profile_oid** | **Integer** | Customer profile object identifier | [optional] 
 **email** | **String** | Email | [optional] 
 **first_name** | **String** | First name | [optional] 
-**item_id** | **String** | Item ID | [optional] 
+**item_id** | **String** | Item ID.  Deprecated query field.  This incorrectly meant the original order contained this item id. | [optional] 
 **last_name** | **String** | Last name | [optional] 
+**next_item_id** | **String** | Next Item ID that is supposed to ship.  This is calculated based upon the schedule associated with the original item id. | [optional] 
 **next_shipment_date_begin** | **String** | Next shipment date begin | [optional] 
 **next_shipment_date_end** | **String** | Next shipment date end | [optional] 
+**original_item_id** | **String** | Original Item ID purchased on auto order. | [optional] 
 **original_order_date_begin** | **String** | Original order date begin | [optional] 
 **original_order_date_end** | **String** | Original order date end | [optional] 
 **original_order_id** | **String** | Original order ID | [optional] 

data/docs/CustomerApi.md

@@ -7,11 +7,11 @@ Method | HTTP request | Description
 [**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
 [**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
 [**get_customer_by_email**](CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
+[**get_customer_editor_values**](CustomerApi.md#get_customer_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
+[**get_customer_email_lists**](CustomerApi.md#get_customer_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
 [**get_customers**](CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
 [**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
 [**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
-[**get_editor_values**](CustomerApi.md#get_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
-[**get_email_lists**](CustomerApi.md#get_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
 [**get_email_verification_token**](CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
 [**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
 [**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
@@ -177,6 +177,96 @@ Name | Type | Description  | Notes
 
 
 
+# **get_customer_editor_values**
+> CustomerEditorValues get_customer_editor_values
+
+Retrieve values needed for a customer profile editor
+
+Retrieve values needed for a customer profile editor. 
+
+### 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::CustomerApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Retrieve values needed for a customer profile editor
+  result = api_instance.get_customer_editor_values
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling CustomerApi->get_customer_editor_values: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CustomerEditorValues**](CustomerEditorValues.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_customer_email_lists**
+> EmailListsResponse get_customer_email_lists
+
+Retrieve all email lists across all storefronts
+
+Retrieve all email lists across all storefronts 
+
+### 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::CustomerApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Retrieve all email lists across all storefronts
+  result = api_instance.get_customer_email_lists
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling CustomerApi->get_customer_email_lists: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**EmailListsResponse**](EmailListsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_customers**
 > CustomersResponse get_customers(opts)
 
@@ -403,96 +493,6 @@ Name | Type | Description  | Notes
 
 
 
-# **get_editor_values**
-> CustomerEditorValues get_editor_values
-
-Retrieve values needed for a customer profile editor
-
-Retrieve values needed for a customer profile editor. 
-
-### 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::CustomerApi.new_using_api_key(simple_key, false, false)
-
-
-
-begin
-  #Retrieve values needed for a customer profile editor
-  result = api_instance.get_editor_values
-  p result
-rescue UltracartClient::ApiError => e
-  puts "Exception when calling CustomerApi->get_editor_values: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**CustomerEditorValues**](CustomerEditorValues.md)
-
-### Authorization
-
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_email_lists**
-> EmailListsResponse get_email_lists
-
-Retrieve all email lists across all storefronts
-
-Retrieve all email lists across all storefronts 
-
-### 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::CustomerApi.new_using_api_key(simple_key, false, false)
-
-
-
-begin
-  #Retrieve all email lists across all storefronts
-  result = api_instance.get_email_lists
-  p result
-rescue UltracartClient::ApiError => e
-  puts "Exception when calling CustomerApi->get_email_lists: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**EmailListsResponse**](EmailListsResponse.md)
-
-### Authorization
-
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
 # **get_email_verification_token**
 > EmailVerifyTokenResponse get_email_verification_token(token_request)
 

data/docs/IntegrationLog.md

@@ -10,13 +10,16 @@ Name | Type | Description | Notes
 **integration_log_oid** | **Integer** |  | [optional] 
 **item_id** | **String** |  | [optional] 
 **item_ipn_oid** | **Integer** |  | [optional] 
-**log_dts** | **String** |  | [optional] 
+**log_dts** | **String** | Date/time the integration log was created | [optional] 
 **log_type** | **String** |  | [optional] 
 **logger_id** | **String** |  | [optional] 
+**logger_name** | **String** |  | [optional] 
 **logs** | [**Array<IntegrationLogLog>**](IntegrationLogLog.md) |  | [optional] 
+**omit_log_map** | **BOOLEAN** |  | [optional] 
 **order_ids** | **Array<String>** |  | [optional] 
 **pk** | **String** |  | [optional] 
 **sk** | **String** |  | [optional] 
 **status** | **String** |  | [optional] 
+**status_code** | **Integer** |  | [optional] 
 
 

data/docs/IntegrationLogApi.md

@@ -5,11 +5,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_integration_log**](IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
+[**get_integration_log_file**](IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file
 [**get_integration_logs_query**](IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
 
 
 # **get_integration_log**
-> IntegrationLog get_integration_log(pk, sk)
+> IntegrationLogResponse get_integration_log(pk, sk)
 
 Retrieve an integration log
 
@@ -48,7 +49,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**IntegrationLog**](IntegrationLog.md)
+[**IntegrationLogResponse**](IntegrationLogResponse.md)
 
 ### Authorization
 
@@ -61,6 +62,62 @@ Name | Type | Description  | Notes
 
 
 
+# **get_integration_log_file**
+> File get_integration_log_file(pk, sk, uuid)
+
+Retrieve an integration log file
+
+Retrieve an integration log file from the account based identifiers 
+
+### 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::IntegrationLogApi.new_using_api_key(simple_key, false, false)
+
+
+pk = 'pk_example' # String | 
+
+sk = 'sk_example' # String | 
+
+uuid = 'uuid_example' # String | 
+
+
+begin
+  #Retrieve an integration log file
+  result = api_instance.get_integration_log_file(pk, sk, uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling IntegrationLogApi->get_integration_log_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+ **sk** | **String**|  | 
+ **uuid** | **String**|  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/octet-stream
+
+
+
 # **get_integration_logs_query**
 > IntegrationLogQueryResponse get_integration_logs_query(integration_log_query, opts)
 

data/docs/IntegrationLogFile.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**mime_type** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
 **size** | **Integer** |  | [optional] 
 **uuid** | **String** |  | [optional] 

data/docs/IntegrationLogQueryFilterValues.md

@@ -9,7 +9,10 @@ Name | Type | Description | Notes
 **file_names** | **Array<String>** |  | [optional] 
 **item_ids** | **Array<String>** |  | [optional] 
 **item_ipn_oids** | **Array<Integer>** |  | [optional] 
+**log_dts_max** | **String** | Maximum date/time log date/time | [optional] 
+**log_dts_min** | **String** | Minimum date/time log date/time | [optional] 
 **log_types** | **Array<String>** |  | [optional] 
+**logger_names** | **Array<String>** |  | [optional] 
 **order_ids** | **Array<String>** |  | [optional] 
 **statuses** | **Array<String>** |  | [optional] 
 

data/docs/IntegrationLogQueryRequest.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **log_dts_end** | **String** | Log date/time end | [optional] 
 **log_type** | **String** |  | [optional] 
 **logger_id** | **String** |  | [optional] 
+**logger_name** | **String** |  | [optional] 
 **order_ids** | **Array<String>** |  | [optional] 
 **status** | **String** |  | [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/LibraryItemAttribute.md

@@ -3,7 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**library_item_oid** | **Integer** |  | [optional] 
 **name** | **String** |  | [optional] 
 **value** | **String** |  | [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/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/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
@@ -4430,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)
 
@@ -4909,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)