ultracart_api 3.10.135 → 3.10.137
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +13 -4
- data/docs/ItemApi.md +269 -0
- data/docs/ItemPricingTierLimit.md +1 -0
- data/docs/ItemReview.md +17 -17
- data/docs/ItemReviewResponse.md +12 -0
- data/docs/ItemReviewsResponse.md +12 -0
- data/lib/ultracart_api/api/item_api.rb +304 -0
- data/lib/ultracart_api/models/item_pricing_tier_limit.rb +11 -1
- data/lib/ultracart_api/models/item_review.rb +291 -0
- data/lib/ultracart_api/models/item_review_response.rb +221 -0
- data/lib/ultracart_api/models/item_reviews_response.rb +224 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +2 -0
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 41772bca30e80b49caf5add3c7bb10863d3f6037d4dfb210e066a0993792ff38
|
4
|
+
data.tar.gz: d8dd859a52d4f23e0b726e7d8837c842b5701746913fafbca06a52e8725cca9c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8fe8004e8a976bc5149e4ccc60a2780608f2eec60db7293b36a3c12ce5687e4ef20c584e97a2f1135979ad0f7745a2a3daa4826d27f7ab0e3fa8fee9a18d5885
|
7
|
+
data.tar.gz: 5ce510408e7892fbc25bd143bcac6fde26c68180378490e540ee8f1da3d31c22314bd81cddca102a1e32477d78b951ebae31b00e962b7d3ba0bc4b3a2acbe506
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.137
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.137.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.137.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.137'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -235,6 +235,7 @@ Class | Method | HTTP request | Description
|
|
235
235
|
*UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
|
236
236
|
*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
|
237
237
|
*UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
|
238
|
+
*UltracartClient::ItemApi* | [**delete_review**](docs/ItemApi.md#delete_review) | **DELETE** /item/items/{merchant_item_oid}/reviews/{review_oid} | Delete a review
|
238
239
|
*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
|
239
240
|
*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
|
240
241
|
*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
|
|
242
243
|
*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
|
243
244
|
*UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
244
245
|
*UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
|
246
|
+
*UltracartClient::ItemApi* | [**get_review**](docs/ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | get a review
|
247
|
+
*UltracartClient::ItemApi* | [**get_reviews**](docs/ItemApi.md#get_reviews) | **GET** /item/items/{merchant_item_oid}/reviews | get reviews for an item
|
245
248
|
*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
|
246
249
|
*UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
|
247
250
|
*UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
|
251
|
+
*UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
|
248
252
|
*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
|
249
253
|
*UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
250
254
|
*UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
255
|
+
*UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
|
251
256
|
*UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
|
252
257
|
*UltracartClient::OauthApi* | [**oauth_access_token**](docs/OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token.
|
253
258
|
*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
|
|
1010
1015
|
- [UltracartClient::ItemRestrictionItem](docs/ItemRestrictionItem.md)
|
1011
1016
|
- [UltracartClient::ItemRevguard](docs/ItemRevguard.md)
|
1012
1017
|
- [UltracartClient::ItemReview](docs/ItemReview.md)
|
1018
|
+
- [UltracartClient::ItemReviewResponse](docs/ItemReviewResponse.md)
|
1013
1019
|
- [UltracartClient::ItemReviews](docs/ItemReviews.md)
|
1020
|
+
- [UltracartClient::ItemReviewsResponse](docs/ItemReviewsResponse.md)
|
1014
1021
|
- [UltracartClient::ItemSalesforce](docs/ItemSalesforce.md)
|
1015
1022
|
- [UltracartClient::ItemShipping](docs/ItemShipping.md)
|
1016
1023
|
- [UltracartClient::ItemShippingCase](docs/ItemShippingCase.md)
|
@@ -1347,6 +1354,8 @@ Not every change is committed to every SDK.
|
|
1347
1354
|
|
1348
1355
|
| Version | Date | Comments |
|
1349
1356
|
| --: | :-: | --- |
|
1357
|
+
| 3.10.137 | 05/04/2023 | item api added methods for items reviews |
|
1358
|
+
| 3.10.136 | 04/28/2023 | item - pricing tier level flag for exempt from min item count |
|
1350
1359
|
| 3.10.135 | 04/27/2023 | order - expose dual vaulted identifiers |
|
1351
1360
|
| 3.10.134 | 04/24/2023 | internal development - data warehouse |
|
1352
1361
|
| 3.10.133 | 04/21/2023 | internal development - data warehouse |
|
data/docs/ItemApi.md
CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**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
|
8
8
|
[**delete_item**](ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
|
9
|
+
[**delete_review**](ItemApi.md#delete_review) | **DELETE** /item/items/{merchant_item_oid}/reviews/{review_oid} | Delete a review
|
9
10
|
[**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
|
10
11
|
[**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
|
11
12
|
[**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
|
|
13
14
|
[**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
|
14
15
|
[**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
15
16
|
[**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
|
17
|
+
[**get_review**](ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | get a review
|
18
|
+
[**get_reviews**](ItemApi.md#get_reviews) | **GET** /item/items/{merchant_item_oid}/reviews | get reviews for an item
|
16
19
|
[**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
|
17
20
|
[**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
|
18
21
|
[**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item
|
22
|
+
[**insert_review**](ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
|
19
23
|
[**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
|
20
24
|
[**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
21
25
|
[**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
26
|
+
[**update_review**](ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
|
22
27
|
[**upload_temporary_multimedia**](ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
|
23
28
|
|
24
29
|
|
@@ -120,6 +125,58 @@ nil (empty response body)
|
|
120
125
|
|
121
126
|
|
122
127
|
|
128
|
+
# **delete_review**
|
129
|
+
> delete_review(review_oid, merchant_item_oid)
|
130
|
+
|
131
|
+
Delete a review
|
132
|
+
|
133
|
+
Delete an item review.
|
134
|
+
|
135
|
+
### Example
|
136
|
+
```ruby
|
137
|
+
# load the gem
|
138
|
+
require 'ultracart_api'
|
139
|
+
|
140
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
141
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
142
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
143
|
+
|
144
|
+
|
145
|
+
review_oid = 56 # Integer | The review oid to delete.
|
146
|
+
|
147
|
+
merchant_item_oid = 56 # Integer | The item oid the review is associated with.
|
148
|
+
|
149
|
+
|
150
|
+
begin
|
151
|
+
#Delete a review
|
152
|
+
api_instance.delete_review(review_oid, merchant_item_oid)
|
153
|
+
rescue UltracartClient::ApiError => e
|
154
|
+
puts "Exception when calling ItemApi->delete_review: #{e}"
|
155
|
+
end
|
156
|
+
```
|
157
|
+
|
158
|
+
### Parameters
|
159
|
+
|
160
|
+
Name | Type | Description | Notes
|
161
|
+
------------- | ------------- | ------------- | -------------
|
162
|
+
**review_oid** | **Integer**| The review oid to delete. |
|
163
|
+
**merchant_item_oid** | **Integer**| The item oid the review is associated with. |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
nil (empty response body)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
172
|
+
|
173
|
+
### HTTP request headers
|
174
|
+
|
175
|
+
- **Content-Type**: application/json; charset=UTF-8
|
176
|
+
- **Accept**: application/json
|
177
|
+
|
178
|
+
|
179
|
+
|
123
180
|
# **get_digital_item**
|
124
181
|
> ItemDigitalItemResponse get_digital_item(digital_item_oid)
|
125
182
|
|
@@ -509,6 +566,109 @@ Name | Type | Description | Notes
|
|
509
566
|
|
510
567
|
|
511
568
|
|
569
|
+
# **get_review**
|
570
|
+
> ItemReviewResponse get_review(review_oid, merchant_item_oid)
|
571
|
+
|
572
|
+
get a review
|
573
|
+
|
574
|
+
Retrieve an item review.
|
575
|
+
|
576
|
+
### Example
|
577
|
+
```ruby
|
578
|
+
# load the gem
|
579
|
+
require 'ultracart_api'
|
580
|
+
|
581
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
582
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
583
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
584
|
+
|
585
|
+
|
586
|
+
review_oid = 56 # Integer | The review oid to retrieve.
|
587
|
+
|
588
|
+
merchant_item_oid = 56 # Integer | The item oid the review is associated with.
|
589
|
+
|
590
|
+
|
591
|
+
begin
|
592
|
+
#get a review
|
593
|
+
result = api_instance.get_review(review_oid, merchant_item_oid)
|
594
|
+
p result
|
595
|
+
rescue UltracartClient::ApiError => e
|
596
|
+
puts "Exception when calling ItemApi->get_review: #{e}"
|
597
|
+
end
|
598
|
+
```
|
599
|
+
|
600
|
+
### Parameters
|
601
|
+
|
602
|
+
Name | Type | Description | Notes
|
603
|
+
------------- | ------------- | ------------- | -------------
|
604
|
+
**review_oid** | **Integer**| The review oid to retrieve. |
|
605
|
+
**merchant_item_oid** | **Integer**| The item oid the review is associated with. |
|
606
|
+
|
607
|
+
### Return type
|
608
|
+
|
609
|
+
[**ItemReviewResponse**](ItemReviewResponse.md)
|
610
|
+
|
611
|
+
### Authorization
|
612
|
+
|
613
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
614
|
+
|
615
|
+
### HTTP request headers
|
616
|
+
|
617
|
+
- **Content-Type**: application/json; charset=UTF-8
|
618
|
+
- **Accept**: application/json
|
619
|
+
|
620
|
+
|
621
|
+
|
622
|
+
# **get_reviews**
|
623
|
+
> ItemReviewsResponse get_reviews(merchant_item_oid)
|
624
|
+
|
625
|
+
get reviews for an item
|
626
|
+
|
627
|
+
Retrieve item reviews.
|
628
|
+
|
629
|
+
### Example
|
630
|
+
```ruby
|
631
|
+
# load the gem
|
632
|
+
require 'ultracart_api'
|
633
|
+
|
634
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
635
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
636
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
637
|
+
|
638
|
+
|
639
|
+
merchant_item_oid = 56 # Integer | The item oid the review is associated with.
|
640
|
+
|
641
|
+
|
642
|
+
begin
|
643
|
+
#get reviews for an item
|
644
|
+
result = api_instance.get_reviews(merchant_item_oid)
|
645
|
+
p result
|
646
|
+
rescue UltracartClient::ApiError => e
|
647
|
+
puts "Exception when calling ItemApi->get_reviews: #{e}"
|
648
|
+
end
|
649
|
+
```
|
650
|
+
|
651
|
+
### Parameters
|
652
|
+
|
653
|
+
Name | Type | Description | Notes
|
654
|
+
------------- | ------------- | ------------- | -------------
|
655
|
+
**merchant_item_oid** | **Integer**| The item oid the review is associated with. |
|
656
|
+
|
657
|
+
### Return type
|
658
|
+
|
659
|
+
[**ItemReviewsResponse**](ItemReviewsResponse.md)
|
660
|
+
|
661
|
+
### Authorization
|
662
|
+
|
663
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
664
|
+
|
665
|
+
### HTTP request headers
|
666
|
+
|
667
|
+
- **Content-Type**: application/json; charset=UTF-8
|
668
|
+
- **Accept**: application/json
|
669
|
+
|
670
|
+
|
671
|
+
|
512
672
|
# **get_unassociated_digital_items**
|
513
673
|
> ItemDigitalItemsResponse get_unassociated_digital_items(opts)
|
514
674
|
|
@@ -676,6 +836,59 @@ Name | Type | Description | Notes
|
|
676
836
|
|
677
837
|
|
678
838
|
|
839
|
+
# **insert_review**
|
840
|
+
> ItemReviewResponse insert_review(review, merchant_item_oid)
|
841
|
+
|
842
|
+
Insert a review
|
843
|
+
|
844
|
+
Insert a item review.
|
845
|
+
|
846
|
+
### Example
|
847
|
+
```ruby
|
848
|
+
# load the gem
|
849
|
+
require 'ultracart_api'
|
850
|
+
|
851
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
852
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
853
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
854
|
+
|
855
|
+
|
856
|
+
review = UltracartClient::ItemReview.new # ItemReview | Review to insert
|
857
|
+
|
858
|
+
merchant_item_oid = 56 # Integer | The item oid the review is associated with.
|
859
|
+
|
860
|
+
|
861
|
+
begin
|
862
|
+
#Insert a review
|
863
|
+
result = api_instance.insert_review(review, merchant_item_oid)
|
864
|
+
p result
|
865
|
+
rescue UltracartClient::ApiError => e
|
866
|
+
puts "Exception when calling ItemApi->insert_review: #{e}"
|
867
|
+
end
|
868
|
+
```
|
869
|
+
|
870
|
+
### Parameters
|
871
|
+
|
872
|
+
Name | Type | Description | Notes
|
873
|
+
------------- | ------------- | ------------- | -------------
|
874
|
+
**review** | [**ItemReview**](ItemReview.md)| Review to insert |
|
875
|
+
**merchant_item_oid** | **Integer**| The item oid the review is associated with. |
|
876
|
+
|
877
|
+
### Return type
|
878
|
+
|
879
|
+
[**ItemReviewResponse**](ItemReviewResponse.md)
|
880
|
+
|
881
|
+
### Authorization
|
882
|
+
|
883
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
884
|
+
|
885
|
+
### HTTP request headers
|
886
|
+
|
887
|
+
- **Content-Type**: application/json; charset=UTF-8
|
888
|
+
- **Accept**: application/json
|
889
|
+
|
890
|
+
|
891
|
+
|
679
892
|
# **update_digital_item**
|
680
893
|
> ItemDigitalItemResponse update_digital_item(digital_item_oid, digital_item)
|
681
894
|
|
@@ -846,6 +1059,62 @@ Name | Type | Description | Notes
|
|
846
1059
|
|
847
1060
|
|
848
1061
|
|
1062
|
+
# **update_review**
|
1063
|
+
> ItemReviewResponse update_review(review, review_oid, merchant_item_oid)
|
1064
|
+
|
1065
|
+
Update a review
|
1066
|
+
|
1067
|
+
Update an item review.
|
1068
|
+
|
1069
|
+
### Example
|
1070
|
+
```ruby
|
1071
|
+
# load the gem
|
1072
|
+
require 'ultracart_api'
|
1073
|
+
|
1074
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1075
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1076
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
1077
|
+
|
1078
|
+
|
1079
|
+
review = UltracartClient::ItemReview.new # ItemReview | Review to update
|
1080
|
+
|
1081
|
+
review_oid = 56 # Integer | The review oid to update.
|
1082
|
+
|
1083
|
+
merchant_item_oid = 56 # Integer | The item oid the review is associated with.
|
1084
|
+
|
1085
|
+
|
1086
|
+
begin
|
1087
|
+
#Update a review
|
1088
|
+
result = api_instance.update_review(review, review_oid, merchant_item_oid)
|
1089
|
+
p result
|
1090
|
+
rescue UltracartClient::ApiError => e
|
1091
|
+
puts "Exception when calling ItemApi->update_review: #{e}"
|
1092
|
+
end
|
1093
|
+
```
|
1094
|
+
|
1095
|
+
### Parameters
|
1096
|
+
|
1097
|
+
Name | Type | Description | Notes
|
1098
|
+
------------- | ------------- | ------------- | -------------
|
1099
|
+
**review** | [**ItemReview**](ItemReview.md)| Review to update |
|
1100
|
+
**review_oid** | **Integer**| The review oid to update. |
|
1101
|
+
**merchant_item_oid** | **Integer**| The item oid the review is associated with. |
|
1102
|
+
|
1103
|
+
### Return type
|
1104
|
+
|
1105
|
+
[**ItemReviewResponse**](ItemReviewResponse.md)
|
1106
|
+
|
1107
|
+
### Authorization
|
1108
|
+
|
1109
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1110
|
+
|
1111
|
+
### HTTP request headers
|
1112
|
+
|
1113
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1114
|
+
- **Accept**: application/json
|
1115
|
+
|
1116
|
+
|
1117
|
+
|
849
1118
|
# **upload_temporary_multimedia**
|
850
1119
|
> TempMultimediaResponse upload_temporary_multimedia(file)
|
851
1120
|
|
@@ -4,6 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**cumulative_order_limit** | **Integer** | Cumulative order limit | [optional]
|
7
|
+
**exempt_from_minimum_item_count** | **BOOLEAN** | Exempt from Minimum Item Count | [optional]
|
7
8
|
**individual_order_limit** | **Integer** | Individual order limit | [optional]
|
8
9
|
**multiple_quantity** | **Integer** | Multiple quantity | [optional]
|
9
10
|
|
data/docs/ItemReview.md
CHANGED
@@ -9,16 +9,16 @@ Name | Type | Description | Notes
|
|
9
9
|
**helpful_yes_votes** | **Integer** | | [optional]
|
10
10
|
**order_id** | **String** | | [optional]
|
11
11
|
**overall** | **Float** | | [optional]
|
12
|
-
**rating_name1** | **String** |
|
13
|
-
**rating_name10** | **String** |
|
14
|
-
**rating_name2** | **String** |
|
15
|
-
**rating_name3** | **String** |
|
16
|
-
**rating_name4** | **String** |
|
17
|
-
**rating_name5** | **String** |
|
18
|
-
**rating_name6** | **String** |
|
19
|
-
**rating_name7** | **String** |
|
20
|
-
**rating_name8** | **String** |
|
21
|
-
**rating_name9** | **String** |
|
12
|
+
**rating_name1** | **String** | Rating Name 1 | [optional]
|
13
|
+
**rating_name10** | **String** | Rating Name 10 | [optional]
|
14
|
+
**rating_name2** | **String** | Rating Name 2 | [optional]
|
15
|
+
**rating_name3** | **String** | Rating Name 3 | [optional]
|
16
|
+
**rating_name4** | **String** | Rating Name 4 | [optional]
|
17
|
+
**rating_name5** | **String** | Rating Name 5 | [optional]
|
18
|
+
**rating_name6** | **String** | Rating Name 6 | [optional]
|
19
|
+
**rating_name7** | **String** | Rating Name 7 | [optional]
|
20
|
+
**rating_name8** | **String** | Rating Name 8 | [optional]
|
21
|
+
**rating_name9** | **String** | Rating Name 9 | [optional]
|
22
22
|
**rating_score1** | **Float** | | [optional]
|
23
23
|
**rating_score10** | **Float** | | [optional]
|
24
24
|
**rating_score2** | **Float** | | [optional]
|
@@ -31,14 +31,14 @@ Name | Type | Description | Notes
|
|
31
31
|
**rating_score9** | **Float** | | [optional]
|
32
32
|
**recommend_store_to_friend** | **Integer** | | [optional]
|
33
33
|
**recommend_to_friend** | **BOOLEAN** | | [optional]
|
34
|
-
**review** | **String** |
|
34
|
+
**review** | **String** | Review | [optional]
|
35
35
|
**review_oid** | **Integer** | | [optional]
|
36
|
-
**reviewed_nickname** | **String** |
|
37
|
-
**reviewer_email** | **String** |
|
38
|
-
**reviewer_location** | **String** |
|
39
|
-
**status** | **String** |
|
40
|
-
**store_feedback** | **String** |
|
36
|
+
**reviewed_nickname** | **String** | Nickname | [optional]
|
37
|
+
**reviewer_email** | **String** | Reviewer Email | [optional]
|
38
|
+
**reviewer_location** | **String** | Location | [optional]
|
39
|
+
**status** | **String** | Status of the review | [optional]
|
40
|
+
**store_feedback** | **String** | Store Feedback | [optional]
|
41
41
|
**submitted_dts** | **String** | Date/time of review submission | [optional]
|
42
|
-
**title** | **String** |
|
42
|
+
**title** | **String** | Title | [optional]
|
43
43
|
|
44
44
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ItemReviewResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**review** | [**ItemReview**](ItemReview.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ItemReviewsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**reviews** | [**Array<ItemReview>**](ItemReview.md) | reviews | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|