ultracart_api 4.0.153 → 4.0.154

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 74f0b59f6e236d45f16c4b8b1b1d52bf3b0ed5400866606d8159f3a53baee5be
4
- data.tar.gz: 4715fa0c177324f966aa5d3fe3996e16d03b2828aa9a33ccb116844dc6611c99
3
+ metadata.gz: 26b3c13189274ce0cbd16a0775d373a8c88bf9e1f8cea27e162369412f4c206f
4
+ data.tar.gz: d641791b35121d7f3c445bf82a9374bddf5f2cf058ff07d33efc5e37ac4e3fd2
5
5
  SHA512:
6
- metadata.gz: bfc1f07907c13b8b8d62a53d05584d2ba2fedb919030f2dea72fc112958b15a31900779cdbc5d815d3367ffdfaa922dff8077ea37c53a10044d2eca76e627491
7
- data.tar.gz: 8e19f5664dcdb3744e3bf064af0448cda24a995c88b37c902d4d7351411b185cbca72d68c4af96e00b271f1b37147d08901e1f1eb37d6d39f44f55918c847dd2
6
+ metadata.gz: f80331ee8245e455606f5f9a66ebaeebe8ddf10a211b6a492a7ff9ca6ad1cda7a8c8b2a9aa8af39d896997b4cbe0a0ebaf8382fcbcf6069c5e716774e946141d
7
+ data.tar.gz: 6053780afe674adb0af48d542c018059bf237c7669d252fe3937dfd96f332d488cedfbfe0ce59a6036a9cbb0a45239e82f295c7f9d53c3b726e5b09995018267
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.0.153
10
+ - Package version: 4.0.154
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-4.0.153.gem
27
+ gem install ./ultracart_api-4.0.154.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.153.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.154.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'ultracart_api', '~> 4.0.153'
36
+ gem 'ultracart_api', '~> 4.0.154'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -241,6 +241,7 @@ Class | Method | HTTP request | Description
241
241
  *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
242
242
  *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
243
243
  *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
244
+ *UltracartClient::ItemApi* | [**delete_review**](docs/ItemApi.md#delete_review) | **DELETE** /item/items/{merchant_item_oid}/reviews/{review_oid} | Delete a review
244
245
  *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
245
246
  *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
246
247
  *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
@@ -248,12 +249,16 @@ Class | Method | HTTP request | Description
248
249
  *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
249
250
  *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
250
251
  *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
252
+ *UltracartClient::ItemApi* | [**get_review**](docs/ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | get a review
253
+ *UltracartClient::ItemApi* | [**get_reviews**](docs/ItemApi.md#get_reviews) | **GET** /item/items/{merchant_item_oid}/reviews | get reviews for an item
251
254
  *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
252
255
  *UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
253
256
  *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
257
+ *UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
254
258
  *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
255
259
  *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
256
260
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
261
+ *UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
257
262
  *UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
258
263
  *UltracartClient::OauthApi* | [**oauth_access_token**](docs/OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token.
259
264
  *UltracartClient::OauthApi* | [**oauth_revoke**](docs/OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application.
@@ -1015,7 +1020,9 @@ Class | Method | HTTP request | Description
1015
1020
  - [UltracartClient::ItemRestrictionItem](docs/ItemRestrictionItem.md)
1016
1021
  - [UltracartClient::ItemRevguard](docs/ItemRevguard.md)
1017
1022
  - [UltracartClient::ItemReview](docs/ItemReview.md)
1023
+ - [UltracartClient::ItemReviewResponse](docs/ItemReviewResponse.md)
1018
1024
  - [UltracartClient::ItemReviews](docs/ItemReviews.md)
1025
+ - [UltracartClient::ItemReviewsResponse](docs/ItemReviewsResponse.md)
1019
1026
  - [UltracartClient::ItemSalesforce](docs/ItemSalesforce.md)
1020
1027
  - [UltracartClient::ItemShipping](docs/ItemShipping.md)
1021
1028
  - [UltracartClient::ItemShippingCase](docs/ItemShippingCase.md)
@@ -1355,6 +1362,7 @@ Not every change is committed to every SDK.
1355
1362
 
1356
1363
  | Version | Date | Comments |
1357
1364
  | --: | :-: | --- |
1365
+ | 4.0.154 | 05/04/2023 | item api added methods for items reviews |
1358
1366
  | 4.0.153 | 04/28/2023 | item - pricing tier level flag for exempt from min item count |
1359
1367
  | 4.0.152 | 04/27/2023 | order - expose dual vaulted identifiers |
1360
1368
  | 4.0.151 | 04/24/2023 | internal development - data warehouse |
data/docs/ItemApi.md CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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
 
@@ -162,6 +167,78 @@ nil (empty response body)
162
167
  - **Accept**: application/json
163
168
 
164
169
 
170
+ ## delete_review
171
+
172
+ > delete_review(review_oid, merchant_item_oid)
173
+
174
+ Delete a review
175
+
176
+ Delete an item review.
177
+
178
+ ### Examples
179
+
180
+ ```ruby
181
+ require 'time'
182
+ require 'ultracart_api'
183
+ require 'json'
184
+ require 'yaml'
185
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
186
+
187
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
188
+ # As such, this might not be the best way to use this object.
189
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
190
+
191
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
192
+ review_oid = 56 # Integer | The review oid to delete.
193
+ merchant_item_oid = 56 # Integer | The item oid the review is associated with.
194
+
195
+ begin
196
+ # Delete a review
197
+ api_instance.delete_review(review_oid, merchant_item_oid)
198
+ rescue UltracartClient::ApiError => e
199
+ puts "Error when calling ItemApi->delete_review: #{e}"
200
+ end
201
+ ```
202
+
203
+ #### Using the delete_review_with_http_info variant
204
+
205
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
206
+
207
+ > <Array(nil, Integer, Hash)> delete_review_with_http_info(review_oid, merchant_item_oid)
208
+
209
+ ```ruby
210
+ begin
211
+ # Delete a review
212
+ data, status_code, headers = api_instance.delete_review_with_http_info(review_oid, merchant_item_oid)
213
+ p status_code # => 2xx
214
+ p headers # => { ... }
215
+ p data # => nil
216
+ rescue UltracartClient::ApiError => e
217
+ puts "Error when calling ItemApi->delete_review_with_http_info: #{e}"
218
+ end
219
+ ```
220
+
221
+ ### Parameters
222
+
223
+ | Name | Type | Description | Notes |
224
+ | ---- | ---- | ----------- | ----- |
225
+ | **review_oid** | **Integer** | The review oid to delete. | |
226
+ | **merchant_item_oid** | **Integer** | The item oid the review is associated with. | |
227
+
228
+ ### Return type
229
+
230
+ nil (empty response body)
231
+
232
+ ### Authorization
233
+
234
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
235
+
236
+ ### HTTP request headers
237
+
238
+ - **Content-Type**: Not defined
239
+ - **Accept**: application/json
240
+
241
+
165
242
  ## get_digital_item
166
243
 
167
244
  > <ItemDigitalItemResponse> get_digital_item(digital_item_oid)
@@ -701,6 +778,150 @@ end
701
778
  - **Accept**: application/json
702
779
 
703
780
 
781
+ ## get_review
782
+
783
+ > <ItemReviewResponse> get_review(review_oid, merchant_item_oid)
784
+
785
+ get a review
786
+
787
+ Retrieve an item review.
788
+
789
+ ### Examples
790
+
791
+ ```ruby
792
+ require 'time'
793
+ require 'ultracart_api'
794
+ require 'json'
795
+ require 'yaml'
796
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
797
+
798
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
799
+ # As such, this might not be the best way to use this object.
800
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
801
+
802
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
803
+ review_oid = 56 # Integer | The review oid to retrieve.
804
+ merchant_item_oid = 56 # Integer | The item oid the review is associated with.
805
+
806
+ begin
807
+ # get a review
808
+ result = api_instance.get_review(review_oid, merchant_item_oid)
809
+ p result
810
+ rescue UltracartClient::ApiError => e
811
+ puts "Error when calling ItemApi->get_review: #{e}"
812
+ end
813
+ ```
814
+
815
+ #### Using the get_review_with_http_info variant
816
+
817
+ This returns an Array which contains the response data, status code and headers.
818
+
819
+ > <Array(<ItemReviewResponse>, Integer, Hash)> get_review_with_http_info(review_oid, merchant_item_oid)
820
+
821
+ ```ruby
822
+ begin
823
+ # get a review
824
+ data, status_code, headers = api_instance.get_review_with_http_info(review_oid, merchant_item_oid)
825
+ p status_code # => 2xx
826
+ p headers # => { ... }
827
+ p data # => <ItemReviewResponse>
828
+ rescue UltracartClient::ApiError => e
829
+ puts "Error when calling ItemApi->get_review_with_http_info: #{e}"
830
+ end
831
+ ```
832
+
833
+ ### Parameters
834
+
835
+ | Name | Type | Description | Notes |
836
+ | ---- | ---- | ----------- | ----- |
837
+ | **review_oid** | **Integer** | The review oid to retrieve. | |
838
+ | **merchant_item_oid** | **Integer** | The item oid the review is associated with. | |
839
+
840
+ ### Return type
841
+
842
+ [**ItemReviewResponse**](ItemReviewResponse.md)
843
+
844
+ ### Authorization
845
+
846
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
847
+
848
+ ### HTTP request headers
849
+
850
+ - **Content-Type**: Not defined
851
+ - **Accept**: application/json
852
+
853
+
854
+ ## get_reviews
855
+
856
+ > <ItemReviewsResponse> get_reviews(merchant_item_oid)
857
+
858
+ get reviews for an item
859
+
860
+ Retrieve item reviews.
861
+
862
+ ### Examples
863
+
864
+ ```ruby
865
+ require 'time'
866
+ require 'ultracart_api'
867
+ require 'json'
868
+ require 'yaml'
869
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
870
+
871
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
872
+ # As such, this might not be the best way to use this object.
873
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
874
+
875
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
876
+ merchant_item_oid = 56 # Integer | The item oid the review is associated with.
877
+
878
+ begin
879
+ # get reviews for an item
880
+ result = api_instance.get_reviews(merchant_item_oid)
881
+ p result
882
+ rescue UltracartClient::ApiError => e
883
+ puts "Error when calling ItemApi->get_reviews: #{e}"
884
+ end
885
+ ```
886
+
887
+ #### Using the get_reviews_with_http_info variant
888
+
889
+ This returns an Array which contains the response data, status code and headers.
890
+
891
+ > <Array(<ItemReviewsResponse>, Integer, Hash)> get_reviews_with_http_info(merchant_item_oid)
892
+
893
+ ```ruby
894
+ begin
895
+ # get reviews for an item
896
+ data, status_code, headers = api_instance.get_reviews_with_http_info(merchant_item_oid)
897
+ p status_code # => 2xx
898
+ p headers # => { ... }
899
+ p data # => <ItemReviewsResponse>
900
+ rescue UltracartClient::ApiError => e
901
+ puts "Error when calling ItemApi->get_reviews_with_http_info: #{e}"
902
+ end
903
+ ```
904
+
905
+ ### Parameters
906
+
907
+ | Name | Type | Description | Notes |
908
+ | ---- | ---- | ----------- | ----- |
909
+ | **merchant_item_oid** | **Integer** | The item oid the review is associated with. | |
910
+
911
+ ### Return type
912
+
913
+ [**ItemReviewsResponse**](ItemReviewsResponse.md)
914
+
915
+ ### Authorization
916
+
917
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
918
+
919
+ ### HTTP request headers
920
+
921
+ - **Content-Type**: Not defined
922
+ - **Accept**: application/json
923
+
924
+
704
925
  ## get_unassociated_digital_items
705
926
 
706
927
  > <ItemDigitalItemsResponse> get_unassociated_digital_items(opts)
@@ -932,6 +1153,79 @@ end
932
1153
  - **Accept**: application/json
933
1154
 
934
1155
 
1156
+ ## insert_review
1157
+
1158
+ > <ItemReviewResponse> insert_review(merchant_item_oid, review)
1159
+
1160
+ Insert a review
1161
+
1162
+ Insert a item review.
1163
+
1164
+ ### Examples
1165
+
1166
+ ```ruby
1167
+ require 'time'
1168
+ require 'ultracart_api'
1169
+ require 'json'
1170
+ require 'yaml'
1171
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1172
+
1173
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1174
+ # As such, this might not be the best way to use this object.
1175
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1176
+
1177
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1178
+ merchant_item_oid = 56 # Integer | The item oid the review is associated with.
1179
+ review = UltracartClient::ItemReview.new # ItemReview | Review to insert
1180
+
1181
+ begin
1182
+ # Insert a review
1183
+ result = api_instance.insert_review(merchant_item_oid, review)
1184
+ p result
1185
+ rescue UltracartClient::ApiError => e
1186
+ puts "Error when calling ItemApi->insert_review: #{e}"
1187
+ end
1188
+ ```
1189
+
1190
+ #### Using the insert_review_with_http_info variant
1191
+
1192
+ This returns an Array which contains the response data, status code and headers.
1193
+
1194
+ > <Array(<ItemReviewResponse>, Integer, Hash)> insert_review_with_http_info(merchant_item_oid, review)
1195
+
1196
+ ```ruby
1197
+ begin
1198
+ # Insert a review
1199
+ data, status_code, headers = api_instance.insert_review_with_http_info(merchant_item_oid, review)
1200
+ p status_code # => 2xx
1201
+ p headers # => { ... }
1202
+ p data # => <ItemReviewResponse>
1203
+ rescue UltracartClient::ApiError => e
1204
+ puts "Error when calling ItemApi->insert_review_with_http_info: #{e}"
1205
+ end
1206
+ ```
1207
+
1208
+ ### Parameters
1209
+
1210
+ | Name | Type | Description | Notes |
1211
+ | ---- | ---- | ----------- | ----- |
1212
+ | **merchant_item_oid** | **Integer** | The item oid the review is associated with. | |
1213
+ | **review** | [**ItemReview**](ItemReview.md) | Review to insert | |
1214
+
1215
+ ### Return type
1216
+
1217
+ [**ItemReviewResponse**](ItemReviewResponse.md)
1218
+
1219
+ ### Authorization
1220
+
1221
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1222
+
1223
+ ### HTTP request headers
1224
+
1225
+ - **Content-Type**: application/json; charset=UTF-8
1226
+ - **Accept**: application/json
1227
+
1228
+
935
1229
  ## update_digital_item
936
1230
 
937
1231
  > <ItemDigitalItemResponse> update_digital_item(digital_item_oid, digital_item)
@@ -1163,6 +1457,81 @@ end
1163
1457
  - **Accept**: application/json
1164
1458
 
1165
1459
 
1460
+ ## update_review
1461
+
1462
+ > <ItemReviewResponse> update_review(review_oid, merchant_item_oid, review)
1463
+
1464
+ Update a review
1465
+
1466
+ Update an item review.
1467
+
1468
+ ### Examples
1469
+
1470
+ ```ruby
1471
+ require 'time'
1472
+ require 'ultracart_api'
1473
+ require 'json'
1474
+ require 'yaml'
1475
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1476
+
1477
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1478
+ # As such, this might not be the best way to use this object.
1479
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1480
+
1481
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1482
+ review_oid = 56 # Integer | The review oid to update.
1483
+ merchant_item_oid = 56 # Integer | The item oid the review is associated with.
1484
+ review = UltracartClient::ItemReview.new # ItemReview | Review to update
1485
+
1486
+ begin
1487
+ # Update a review
1488
+ result = api_instance.update_review(review_oid, merchant_item_oid, review)
1489
+ p result
1490
+ rescue UltracartClient::ApiError => e
1491
+ puts "Error when calling ItemApi->update_review: #{e}"
1492
+ end
1493
+ ```
1494
+
1495
+ #### Using the update_review_with_http_info variant
1496
+
1497
+ This returns an Array which contains the response data, status code and headers.
1498
+
1499
+ > <Array(<ItemReviewResponse>, Integer, Hash)> update_review_with_http_info(review_oid, merchant_item_oid, review)
1500
+
1501
+ ```ruby
1502
+ begin
1503
+ # Update a review
1504
+ data, status_code, headers = api_instance.update_review_with_http_info(review_oid, merchant_item_oid, review)
1505
+ p status_code # => 2xx
1506
+ p headers # => { ... }
1507
+ p data # => <ItemReviewResponse>
1508
+ rescue UltracartClient::ApiError => e
1509
+ puts "Error when calling ItemApi->update_review_with_http_info: #{e}"
1510
+ end
1511
+ ```
1512
+
1513
+ ### Parameters
1514
+
1515
+ | Name | Type | Description | Notes |
1516
+ | ---- | ---- | ----------- | ----- |
1517
+ | **review_oid** | **Integer** | The review oid to update. | |
1518
+ | **merchant_item_oid** | **Integer** | The item oid the review is associated with. | |
1519
+ | **review** | [**ItemReview**](ItemReview.md) | Review to update | |
1520
+
1521
+ ### Return type
1522
+
1523
+ [**ItemReviewResponse**](ItemReviewResponse.md)
1524
+
1525
+ ### Authorization
1526
+
1527
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1528
+
1529
+ ### HTTP request headers
1530
+
1531
+ - **Content-Type**: application/json; charset=UTF-8
1532
+ - **Accept**: application/json
1533
+
1534
+
1166
1535
  ## upload_temporary_multimedia
1167
1536
 
1168
1537
  > <TempMultimediaResponse> upload_temporary_multimedia(file)
data/docs/ItemReview.md CHANGED
@@ -10,16 +10,16 @@
10
10
  | **helpful_yes_votes** | **Integer** | | [optional] |
11
11
  | **order_id** | **String** | | [optional] |
12
12
  | **overall** | **Float** | | [optional] |
13
- | **rating_name1** | **String** | | [optional] |
14
- | **rating_name10** | **String** | | [optional] |
15
- | **rating_name2** | **String** | | [optional] |
16
- | **rating_name3** | **String** | | [optional] |
17
- | **rating_name4** | **String** | | [optional] |
18
- | **rating_name5** | **String** | | [optional] |
19
- | **rating_name6** | **String** | | [optional] |
20
- | **rating_name7** | **String** | | [optional] |
21
- | **rating_name8** | **String** | | [optional] |
22
- | **rating_name9** | **String** | | [optional] |
13
+ | **rating_name1** | **String** | Rating Name 1 | [optional] |
14
+ | **rating_name10** | **String** | Rating Name 10 | [optional] |
15
+ | **rating_name2** | **String** | Rating Name 2 | [optional] |
16
+ | **rating_name3** | **String** | Rating Name 3 | [optional] |
17
+ | **rating_name4** | **String** | Rating Name 4 | [optional] |
18
+ | **rating_name5** | **String** | Rating Name 5 | [optional] |
19
+ | **rating_name6** | **String** | Rating Name 6 | [optional] |
20
+ | **rating_name7** | **String** | Rating Name 7 | [optional] |
21
+ | **rating_name8** | **String** | Rating Name 8 | [optional] |
22
+ | **rating_name9** | **String** | Rating Name 9 | [optional] |
23
23
  | **rating_score1** | **Float** | | [optional] |
24
24
  | **rating_score10** | **Float** | | [optional] |
25
25
  | **rating_score2** | **Float** | | [optional] |
@@ -32,15 +32,15 @@
32
32
  | **rating_score9** | **Float** | | [optional] |
33
33
  | **recommend_store_to_friend** | **Integer** | | [optional] |
34
34
  | **recommend_to_friend** | **Boolean** | | [optional] |
35
- | **review** | **String** | | [optional] |
35
+ | **review** | **String** | Review | [optional] |
36
36
  | **review_oid** | **Integer** | | [optional] |
37
- | **reviewed_nickname** | **String** | | [optional] |
38
- | **reviewer_email** | **String** | | [optional] |
39
- | **reviewer_location** | **String** | | [optional] |
40
- | **status** | **String** | | [optional] |
41
- | **store_feedback** | **String** | | [optional] |
37
+ | **reviewed_nickname** | **String** | Nickname | [optional] |
38
+ | **reviewer_email** | **String** | Reviewer Email | [optional] |
39
+ | **reviewer_location** | **String** | Location | [optional] |
40
+ | **status** | **String** | Status of the review | [optional] |
41
+ | **store_feedback** | **String** | Store Feedback | [optional] |
42
42
  | **submitted_dts** | **String** | Date/time of review submission | [optional] |
43
- | **title** | **String** | | [optional] |
43
+ | **title** | **String** | Title | [optional] |
44
44
 
45
45
  ## Example
46
46
 
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ItemReviewResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **review** | [**ItemReview**](ItemReview.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ItemReviewResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ review: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ItemReviewsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **reviews** | [**Array&lt;ItemReview&gt;**](ItemReview.md) | reviews | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ItemReviewsResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ reviews: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+