ultracart_api 3.1.46 → 3.2.6

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

@@ -0,0 +1,23 @@
+# UltracartClient::IntegrationLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** |  | [optional] 
+**direction** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**files** | [**Array<IntegrationLogFile>**](IntegrationLogFile.md) |  | [optional] 
+**integration_log_oid** | **Integer** |  | [optional] 
+**item_id** | **String** |  | [optional] 
+**item_ipn_oid** | **Integer** |  | [optional] 
+**log_dts** | **String** |  | [optional] 
+**log_type** | **String** |  | [optional] 
+**logger_id** | **String** |  | [optional] 
+**logger_name** | **String** |  | [optional] 
+**logs** | [**Array<IntegrationLogLog>**](IntegrationLogLog.md) |  | [optional] 
+**order_ids** | **Array<String>** |  | [optional] 
+**pk** | **String** |  | [optional] 
+**sk** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/IntegrationLogApi.md

@@ -0,0 +1,178 @@
+# UltracartClient::IntegrationLogApi
+
+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**
+> IntegrationLogResponse get_integration_log(pk, sk)
+
+Retrieve an integration log
+
+Retrieve an integration logs 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 | 
+
+
+begin
+  #Retrieve an integration log
+  result = api_instance.get_integration_log(pk, sk)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling IntegrationLogApi->get_integration_log: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+ **sk** | **String**|  | 
+
+### Return type
+
+[**IntegrationLogResponse**](IntegrationLogResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **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)
+
+Retrieve integration logs
+
+Retrieves a set of integration logs from the account based on a query object. 
+
+### 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)
+
+
+integration_log_query = UltracartClient::IntegrationLogQueryRequest.new # IntegrationLogQueryRequest | Integration log 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
+  #Retrieve integration logs
+  result = api_instance.get_integration_logs_query(integration_log_query, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling IntegrationLogApi->get_integration_logs_query: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_log_query** | [**IntegrationLogQueryRequest**](IntegrationLogQueryRequest.md)| Integration log 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
+
+[**IntegrationLogQueryResponse**](IntegrationLogQueryResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/IntegrationLogFile.md

@@ -0,0 +1,11 @@
+# UltracartClient::IntegrationLogFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mime_type** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**uuid** | **String** |  | [optional] 
+
+

data/docs/IntegrationLogLog.md

@@ -0,0 +1,9 @@
+# UltracartClient::IntegrationLogLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contents** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/IntegrationLogQueryFilterValues.md

@@ -0,0 +1,17 @@
+# UltracartClient::IntegrationLogQueryFilterValues
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**actions** | **Array<String>** |  | [optional] 
+**directions** | **Array<String>** |  | [optional] 
+**emails** | **Array<String>** |  | [optional] 
+**file_names** | **Array<String>** |  | [optional] 
+**item_ids** | **Array<String>** |  | [optional] 
+**item_ipn_oids** | **Array<Integer>** |  | [optional] 
+**log_types** | **Array<String>** |  | [optional] 
+**logger_names** | **Array<String>** |  | [optional] 
+**order_ids** | **Array<String>** |  | [optional] 
+**statuses** | **Array<String>** |  | [optional] 
+
+