ultracart_api 3.10.136 → 3.10.137

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4f62ee16df0cb8145b9ee22f25d355ccf010f13203af122e008636c66ce3fbf
-  data.tar.gz: 24c929112a6f1792825226b76d5a401f96d43afc0d43c601df8987bb04726af4
+  metadata.gz: 41772bca30e80b49caf5add3c7bb10863d3f6037d4dfb210e066a0993792ff38
+  data.tar.gz: d8dd859a52d4f23e0b726e7d8837c842b5701746913fafbca06a52e8725cca9c
 SHA512:
-  metadata.gz: de1a7f6b1555093965c2a02ed2408226e981af4268a15027d8cd91917ad33faeb34bc65f148c2e3e6a7711cf1f0f2efd66d7d681eb13117c48ee3c488eb1823b
-  data.tar.gz: 6e76bb911b53159c5b314353f9ecf299deaaa984c1a53702423bbd674b5c2ce69c7e85c41f02011f4518ef0629eefabcd783ab5e4da4baf0abfc52020b7e59c6
+  metadata.gz: 8fe8004e8a976bc5149e4ccc60a2780608f2eec60db7293b36a3c12ce5687e4ef20c584e97a2f1135979ad0f7745a2a3daa4826d27f7ab0e3fa8fee9a18d5885
+  data.tar.gz: 5ce510408e7892fbc25bd143bcac6fde26c68180378490e540ee8f1da3d31c22314bd81cddca102a1e32477d78b951ebae31b00e962b7d3ba0bc4b3a2acbe506

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.10.136
+- Package version: 3.10.137
 - 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.10.136.gem
+gem install ./ultracart_api-3.10.137.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.136.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.137.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.10.136'
+    gem 'ultracart_api', '~> 3.10.137'
 
 ### Install from Git
 
@@ -235,6 +235,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
 *UltracartClient::ItemApi* | [**delete_digital_item**](docs/ItemApi.md#delete_digital_item) | **DELETE** /item/digital_library/{digital_item_oid} | Delete a digital item, which is a file within the digital library, not an actual merchant item
 *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
+*UltracartClient::ItemApi* | [**delete_review**](docs/ItemApi.md#delete_review) | **DELETE** /item/items/{merchant_item_oid}/reviews/{review_oid} | Delete a review
 *UltracartClient::ItemApi* | [**get_digital_item**](docs/ItemApi.md#get_digital_item) | **GET** /item/digital_library/{digital_item_oid} | Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
 *UltracartClient::ItemApi* | [**get_digital_items**](docs/ItemApi.md#get_digital_items) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items
 *UltracartClient::ItemApi* | [**get_digital_items_by_external_id**](docs/ItemApi.md#get_digital_items_by_external_id) | **GET** /item/digital_library/by_external/{external_id} | Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
@@ -242,12 +243,16 @@ Class | Method | HTTP request | Description
 *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
 *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
 *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
+*UltracartClient::ItemApi* | [**get_review**](docs/ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | get a review
+*UltracartClient::ItemApi* | [**get_reviews**](docs/ItemApi.md#get_reviews) | **GET** /item/items/{merchant_item_oid}/reviews | get reviews for an item
 *UltracartClient::ItemApi* | [**get_unassociated_digital_items**](docs/ItemApi.md#get_unassociated_digital_items) | **GET** /item/digital_library/unassociated | Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
 *UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
 *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
+*UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
 *UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
 *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
 *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
+*UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
 *UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
 *UltracartClient::OauthApi* | [**oauth_access_token**](docs/OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token.
 *UltracartClient::OauthApi* | [**oauth_revoke**](docs/OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application.
@@ -1010,7 +1015,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ItemRestrictionItem](docs/ItemRestrictionItem.md)
  - [UltracartClient::ItemRevguard](docs/ItemRevguard.md)
  - [UltracartClient::ItemReview](docs/ItemReview.md)
+ - [UltracartClient::ItemReviewResponse](docs/ItemReviewResponse.md)
  - [UltracartClient::ItemReviews](docs/ItemReviews.md)
+ - [UltracartClient::ItemReviewsResponse](docs/ItemReviewsResponse.md)
  - [UltracartClient::ItemSalesforce](docs/ItemSalesforce.md)
  - [UltracartClient::ItemShipping](docs/ItemShipping.md)
  - [UltracartClient::ItemShippingCase](docs/ItemShippingCase.md)
@@ -1347,6 +1354,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.137 | 05/04/2023 | item api added methods for items reviews |
 | 3.10.136 | 04/28/2023 | item - pricing tier level flag for exempt from min item count |
 | 3.10.135 | 04/27/2023 | order - expose dual vaulted identifiers |
 | 3.10.134 | 04/24/2023 | internal development - data warehouse |

data/docs/ItemApi.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**delete_digital_item**](ItemApi.md#delete_digital_item) | **DELETE** /item/digital_library/{digital_item_oid} | Delete a digital item, which is a file within the digital library, not an actual merchant item
 [**delete_item**](ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
+[**delete_review**](ItemApi.md#delete_review) | **DELETE** /item/items/{merchant_item_oid}/reviews/{review_oid} | Delete a review
 [**get_digital_item**](ItemApi.md#get_digital_item) | **GET** /item/digital_library/{digital_item_oid} | Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
 [**get_digital_items**](ItemApi.md#get_digital_items) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items
 [**get_digital_items_by_external_id**](ItemApi.md#get_digital_items_by_external_id) | **GET** /item/digital_library/by_external/{external_id} | Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
@@ -13,12 +14,16 @@ Method | HTTP request | Description
 [**get_item_by_merchant_item_id**](ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
 [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items
 [**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
+[**get_review**](ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | get a review
+[**get_reviews**](ItemApi.md#get_reviews) | **GET** /item/items/{merchant_item_oid}/reviews | get reviews for an item
 [**get_unassociated_digital_items**](ItemApi.md#get_unassociated_digital_items) | **GET** /item/digital_library/unassociated | Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
 [**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
 [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item
+[**insert_review**](ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
 [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
 [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
 [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
+[**update_review**](ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
 [**upload_temporary_multimedia**](ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
 
 
@@ -120,6 +125,58 @@ nil (empty response body)
 
 
 
+# **delete_review**
+> delete_review(review_oid, merchant_item_oid)
+
+Delete a review
+
+Delete an item review. 
+
+### 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::ItemApi.new_using_api_key(simple_key, false, false)
+
+
+review_oid = 56 # Integer | The review oid to delete.
+
+merchant_item_oid = 56 # Integer | The item oid the review is associated with.
+
+
+begin
+  #Delete a review
+  api_instance.delete_review(review_oid, merchant_item_oid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ItemApi->delete_review: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **review_oid** | **Integer**| The review oid to delete. | 
+ **merchant_item_oid** | **Integer**| The item oid the review is associated with. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **get_digital_item**
 > ItemDigitalItemResponse get_digital_item(digital_item_oid)
 
@@ -509,6 +566,109 @@ Name | Type | Description  | Notes
 
 
 
+# **get_review**
+> ItemReviewResponse get_review(review_oid, merchant_item_oid)
+
+get a review
+
+Retrieve an item review. 
+
+### 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::ItemApi.new_using_api_key(simple_key, false, false)
+
+
+review_oid = 56 # Integer | The review oid to retrieve.
+
+merchant_item_oid = 56 # Integer | The item oid the review is associated with.
+
+
+begin
+  #get a review
+  result = api_instance.get_review(review_oid, merchant_item_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ItemApi->get_review: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **review_oid** | **Integer**| The review oid to retrieve. | 
+ **merchant_item_oid** | **Integer**| The item oid the review is associated with. | 
+
+### Return type
+
+[**ItemReviewResponse**](ItemReviewResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **get_reviews**
+> ItemReviewsResponse get_reviews(merchant_item_oid)
+
+get reviews for an item
+
+Retrieve item reviews. 
+
+### 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::ItemApi.new_using_api_key(simple_key, false, false)
+
+
+merchant_item_oid = 56 # Integer | The item oid the review is associated with.
+
+
+begin
+  #get reviews for an item
+  result = api_instance.get_reviews(merchant_item_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ItemApi->get_reviews: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **merchant_item_oid** | **Integer**| The item oid the review is associated with. | 
+
+### Return type
+
+[**ItemReviewsResponse**](ItemReviewsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **get_unassociated_digital_items**
 > ItemDigitalItemsResponse get_unassociated_digital_items(opts)
 
@@ -676,6 +836,59 @@ Name | Type | Description  | Notes
 
 
 
+# **insert_review**
+> ItemReviewResponse insert_review(review, merchant_item_oid)
+
+Insert a review
+
+Insert a item review. 
+
+### 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::ItemApi.new_using_api_key(simple_key, false, false)
+
+
+review = UltracartClient::ItemReview.new # ItemReview | Review to insert
+
+merchant_item_oid = 56 # Integer | The item oid the review is associated with.
+
+
+begin
+  #Insert a review
+  result = api_instance.insert_review(review, merchant_item_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ItemApi->insert_review: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **review** | [**ItemReview**](ItemReview.md)| Review to insert | 
+ **merchant_item_oid** | **Integer**| The item oid the review is associated with. | 
+
+### Return type
+
+[**ItemReviewResponse**](ItemReviewResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **update_digital_item**
 > ItemDigitalItemResponse update_digital_item(digital_item_oid, digital_item)
 
@@ -846,6 +1059,62 @@ Name | Type | Description  | Notes
 
 
 
+# **update_review**
+> ItemReviewResponse update_review(review, review_oid, merchant_item_oid)
+
+Update a review
+
+Update an item review. 
+
+### 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::ItemApi.new_using_api_key(simple_key, false, false)
+
+
+review = UltracartClient::ItemReview.new # ItemReview | Review to update
+
+review_oid = 56 # Integer | The review oid to update.
+
+merchant_item_oid = 56 # Integer | The item oid the review is associated with.
+
+
+begin
+  #Update a review
+  result = api_instance.update_review(review, review_oid, merchant_item_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ItemApi->update_review: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **review** | [**ItemReview**](ItemReview.md)| Review to update | 
+ **review_oid** | **Integer**| The review oid to update. | 
+ **merchant_item_oid** | **Integer**| The item oid the review is associated with. | 
+
+### Return type
+
+[**ItemReviewResponse**](ItemReviewResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **upload_temporary_multimedia**
 > TempMultimediaResponse upload_temporary_multimedia(file)
 

data/docs/ItemReview.md

@@ -9,16 +9,16 @@ Name | Type | Description | Notes
 **helpful_yes_votes** | **Integer** |  | [optional] 
 **order_id** | **String** |  | [optional] 
 **overall** | **Float** |  | [optional] 
-**rating_name1** | **String** |  | [optional] 
-**rating_name10** | **String** |  | [optional] 
-**rating_name2** | **String** |  | [optional] 
-**rating_name3** | **String** |  | [optional] 
-**rating_name4** | **String** |  | [optional] 
-**rating_name5** | **String** |  | [optional] 
-**rating_name6** | **String** |  | [optional] 
-**rating_name7** | **String** |  | [optional] 
-**rating_name8** | **String** |  | [optional] 
-**rating_name9** | **String** |  | [optional] 
+**rating_name1** | **String** | Rating Name 1 | [optional] 
+**rating_name10** | **String** | Rating Name 10 | [optional] 
+**rating_name2** | **String** | Rating Name 2 | [optional] 
+**rating_name3** | **String** | Rating Name 3 | [optional] 
+**rating_name4** | **String** | Rating Name 4 | [optional] 
+**rating_name5** | **String** | Rating Name 5 | [optional] 
+**rating_name6** | **String** | Rating Name 6 | [optional] 
+**rating_name7** | **String** | Rating Name 7 | [optional] 
+**rating_name8** | **String** | Rating Name 8 | [optional] 
+**rating_name9** | **String** | Rating Name 9 | [optional] 
 **rating_score1** | **Float** |  | [optional] 
 **rating_score10** | **Float** |  | [optional] 
 **rating_score2** | **Float** |  | [optional] 
@@ -31,14 +31,14 @@ Name | Type | Description | Notes
 **rating_score9** | **Float** |  | [optional] 
 **recommend_store_to_friend** | **Integer** |  | [optional] 
 **recommend_to_friend** | **BOOLEAN** |  | [optional] 
-**review** | **String** |  | [optional] 
+**review** | **String** | Review | [optional] 
 **review_oid** | **Integer** |  | [optional] 
-**reviewed_nickname** | **String** |  | [optional] 
-**reviewer_email** | **String** |  | [optional] 
-**reviewer_location** | **String** |  | [optional] 
-**status** | **String** |  | [optional] 
-**store_feedback** | **String** |  | [optional] 
+**reviewed_nickname** | **String** | Nickname | [optional] 
+**reviewer_email** | **String** | Reviewer Email | [optional] 
+**reviewer_location** | **String** | Location | [optional] 
+**status** | **String** | Status of the review | [optional] 
+**store_feedback** | **String** | Store Feedback | [optional] 
 **submitted_dts** | **String** | Date/time of review submission | [optional] 
-**title** | **String** |  | [optional] 
+**title** | **String** | Title | [optional] 
 
 

data/docs/ItemReviewResponse.md

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

data/docs/ItemReviewsResponse.md

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