ultracart_api 3.1.44 → 3.1.49

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4327218145d44faf910ead52e4ac5f7d1741ea8b7fee8fe7d1af98787915333b
-  data.tar.gz: bb3956368f8c557b12d57e56e00eb5e31ce530ac5fd7c8a9402b1a49990d0ec5
+  metadata.gz: 78dde4732a6cd85317d65aefcff10374fab0fb37c263f8528d2997e62247a645
+  data.tar.gz: 4603210aeae5cce21e86cb97c4f823b87775bfcb120c4c913b1daa620a6087dd
 SHA512:
-  metadata.gz: 3c69e17d8dc4a791cb7df0324e91966cd7c1c5ad4050c644a2577eb09d622bb7ad6b562ae7b1bfe2bd9bb638a5f4880caa67c38aa26395b90a8ef2bd35f297f6
-  data.tar.gz: 7857fc4cff529cf8258213d3ff114cfdd83286d9beea414a8bdc3a48db3c6b40f909ae033e5b6614a6144b9809756c580b199c8ae885df105a21fcd5094d2ac7
+  metadata.gz: d7e8c2b2a0365ad99ca0c891ddc0b15d985e331e304a34d18d3eadbe04527988e84352bfdc63751bb30517bb8a08200fbeeb055b3c51bd432fbaa6f9d1b5f188
+  data.tar.gz: 0ff962b04bc327341237a33abcccdc1dd28db73b80de1788b5654fee74ca77e573a90ba53840182ffe9f98bf194f48b30bdc4101924f9164c8e248726a0d09c9

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.1.44
+- Package version: 3.1.49
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.1.44.gem
+gem install ./ultracart_api-3.1.49.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.1.44.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.1.49.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.1.44'
+    gem 'ultracart_api', '~> 3.1.49'
 
 ### Install from Git
 
@@ -157,6 +157,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::FulfillmentApi* | [**get_distribution_centers**](docs/FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
 *UltracartClient::FulfillmentApi* | [**ship_orders**](docs/FulfillmentApi.md#ship_orders) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/shipments | Mark orders as shipped
 *UltracartClient::FulfillmentApi* | [**update_inventory**](docs/FulfillmentApi.md#update_inventory) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/inventory | Update inventory
+*UltracartClient::IntegrationLogApi* | [**get_integration_log**](docs/IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
+*UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
 *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
 *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
 *UltracartClient::ItemApi* | [**get_item_by_merchant_item_id**](docs/ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
@@ -694,6 +696,13 @@ Class | Method | HTTP request | Description
  - [UltracartClient::GroupUserMembership](docs/GroupUserMembership.md)
  - [UltracartClient::GroupsResponse](docs/GroupsResponse.md)
  - [UltracartClient::HTTPHeader](docs/HTTPHeader.md)
+ - [UltracartClient::IntegrationLog](docs/IntegrationLog.md)
+ - [UltracartClient::IntegrationLogFile](docs/IntegrationLogFile.md)
+ - [UltracartClient::IntegrationLogLog](docs/IntegrationLogLog.md)
+ - [UltracartClient::IntegrationLogQueryFilterValues](docs/IntegrationLogQueryFilterValues.md)
+ - [UltracartClient::IntegrationLogQueryRequest](docs/IntegrationLogQueryRequest.md)
+ - [UltracartClient::IntegrationLogQueryResponse](docs/IntegrationLogQueryResponse.md)
+ - [UltracartClient::IntegrationLogResponse](docs/IntegrationLogResponse.md)
  - [UltracartClient::Item](docs/Item.md)
  - [UltracartClient::ItemAccounting](docs/ItemAccounting.md)
  - [UltracartClient::ItemAmember](docs/ItemAmember.md)
@@ -874,6 +883,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ScreenRecordingFilterValuesPageParam](docs/ScreenRecordingFilterValuesPageParam.md)
  - [UltracartClient::ScreenRecordingFilterValuesPageView](docs/ScreenRecordingFilterValuesPageView.md)
  - [UltracartClient::ScreenRecordingHeatmap](docs/ScreenRecordingHeatmap.md)
+ - [UltracartClient::ScreenRecordingHeatmapIndexRequest](docs/ScreenRecordingHeatmapIndexRequest.md)
  - [UltracartClient::ScreenRecordingHeatmapIndexResponse](docs/ScreenRecordingHeatmapIndexResponse.md)
  - [UltracartClient::ScreenRecordingHeatmapRequest](docs/ScreenRecordingHeatmapRequest.md)
  - [UltracartClient::ScreenRecordingHeatmapReset](docs/ScreenRecordingHeatmapReset.md)
@@ -1019,8 +1029,11 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.1.49 | 06/17/2021 | Integrated Logging: standardize the response object from getIntegrationLog method  | 
+| 3.1.47 | 06/16/2021 | Integrated Logging Rest API  | 
+| 3.1.46 | 06/14/2021 | Screen recording: server side paginated heat map index with url contains filters, Item: channel partner item mapping unit cost override  | 
 | 3.1.44 | 06/02/2021 | new boolean flag on items object to allow sharing of reviews between items   | 
-| 3.1.43 | 06/01/2021 | one of us cannot spell, not saying who  | 
+| 3.1.43 | 06/01/2021 | fix item serialized name of item serialized name for channel partner item mappings  | 
 | 3.1.42 | 06/01/2021 | added quickbooks accounting codes at the tiered level for tiered coupons  | 
 | 3.1.41 | 05/21/2021 | screen recording heatmap methods | 
 | 3.1.40 | 05/20/2021 | Order.summary.actual_payment_processing field added | 

data/docs/Error.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **developer_message** | **String** | A technical message meant to be read by a developer | [optional] 
 **error_code** | **String** | HTTP status code | [optional] 
 **more_info** | **String** | Additional information often a link to additional documentation | [optional] 
+**object_id** | **String** | Object id that the error is associated with | [optional] 
 **user_message** | **String** | An end-user friendly message suitable for display to the customer | [optional] 
 
 

data/docs/IntegrationLog.md

@@ -0,0 +1,22 @@
+# 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] 
+**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,121 @@
+# 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_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_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,10 @@
+# UltracartClient::IntegrationLogFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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,16 @@
+# 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] 
+**order_ids** | **Array<String>** |  | [optional] 
+**statuses** | **Array<String>** |  | [optional] 
+
+

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/LibraryItemAttribute.md

@@ -3,6 +3,7 @@
 ## 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/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

@@ -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