ultracart_rest_api_v2_typescript 4.0.153 → 4.0.155
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/README.md +4 -2
- package/dist/apis/ItemApi.d.ts +146 -1
- package/dist/apis/ItemApi.js +312 -0
- package/dist/models/AutoOrderItem.d.ts +12 -0
- package/dist/models/AutoOrderItem.js +4 -0
- package/dist/models/ItemPricingTierLimit.d.ts +6 -0
- package/dist/models/ItemPricingTierLimit.js +2 -0
- package/dist/models/ItemReview.d.ts +28 -18
- package/dist/models/ItemReview.js +10 -1
- package/dist/models/ItemReviewResponse.d.ts +55 -0
- package/dist/models/ItemReviewResponse.js +54 -0
- package/dist/models/ItemReviewsResponse.d.ts +55 -0
- package/dist/models/ItemReviewsResponse.js +54 -0
- package/dist/models/ReportDataSet.d.ts +6 -0
- package/dist/models/ReportDataSet.js +2 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
- package/src/apis/ItemApi.ts +349 -0
- package/src/models/AutoOrderItem.ts +16 -0
- package/src/models/ItemPricingTierLimit.ts +8 -0
- package/src/models/ItemReview.ts +31 -18
- package/src/models/ItemReviewResponse.ts +113 -0
- package/src/models/ItemReviewsResponse.ts +113 -0
- package/src/models/ReportDataSet.ts +8 -0
- package/src/models/index.ts +2 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -528,7 +528,9 @@ src/models/ItemRestriction.ts
|
|
|
528
528
|
src/models/ItemRestrictionItem.ts
|
|
529
529
|
src/models/ItemRevguard.ts
|
|
530
530
|
src/models/ItemReview.ts
|
|
531
|
+
src/models/ItemReviewResponse.ts
|
|
531
532
|
src/models/ItemReviews.ts
|
|
533
|
+
src/models/ItemReviewsResponse.ts
|
|
532
534
|
src/models/ItemSalesforce.ts
|
|
533
535
|
src/models/ItemShipping.ts
|
|
534
536
|
src/models/ItemShippingCase.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@4.0.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@4.0.155
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install ultracart_rest_api_v2_typescript@4.0.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@4.0.155 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 4.0.155 | 05/18/2023 | dw bi - send back the executed SQL |
|
|
58
|
+
| 4.0.154 | 05/04/2023 | item api added methods for items reviews |
|
|
57
59
|
| 4.0.153 | 04/28/2023 | item - pricing tier level flag for exempt from min item count |
|
|
58
60
|
| 4.0.152 | 04/27/2023 | order - expose dual vaulted identifiers |
|
|
59
61
|
| 4.0.151 | 04/24/2023 | internal development - data warehouse |
|
package/dist/apis/ItemApi.d.ts
CHANGED
|
@@ -10,13 +10,17 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { Item, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
|
|
13
|
+
import { Item, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemResponse, ItemReview, ItemReviewResponse, ItemReviewsResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
|
|
14
14
|
export interface DeleteDigitalItemRequest {
|
|
15
15
|
digitalItemOid: number;
|
|
16
16
|
}
|
|
17
17
|
export interface DeleteItemRequest {
|
|
18
18
|
merchantItemOid: number;
|
|
19
19
|
}
|
|
20
|
+
export interface DeleteReviewRequest {
|
|
21
|
+
reviewOid: number;
|
|
22
|
+
merchantItemOid: number;
|
|
23
|
+
}
|
|
20
24
|
export interface GetDigitalItemRequest {
|
|
21
25
|
digitalItemOid: number;
|
|
22
26
|
}
|
|
@@ -54,6 +58,13 @@ export interface GetItemsRequest {
|
|
|
54
58
|
export interface GetPricingTiersRequest {
|
|
55
59
|
expand?: string;
|
|
56
60
|
}
|
|
61
|
+
export interface GetReviewRequest {
|
|
62
|
+
reviewOid: number;
|
|
63
|
+
merchantItemOid: number;
|
|
64
|
+
}
|
|
65
|
+
export interface GetReviewsRequest {
|
|
66
|
+
merchantItemOid: number;
|
|
67
|
+
}
|
|
57
68
|
export interface GetUnassociatedDigitalItemsRequest {
|
|
58
69
|
limit?: number;
|
|
59
70
|
offset?: number;
|
|
@@ -70,6 +81,10 @@ export interface InsertItemRequest {
|
|
|
70
81
|
expand?: string;
|
|
71
82
|
placeholders?: boolean;
|
|
72
83
|
}
|
|
84
|
+
export interface InsertReviewRequest {
|
|
85
|
+
merchantItemOid: number;
|
|
86
|
+
review: ItemReview;
|
|
87
|
+
}
|
|
73
88
|
export interface UpdateDigitalItemRequest {
|
|
74
89
|
digitalItemOid: number;
|
|
75
90
|
digitalItem: ItemDigitalItem;
|
|
@@ -86,6 +101,11 @@ export interface UpdateItemsRequest {
|
|
|
86
101
|
placeholders?: boolean;
|
|
87
102
|
async?: boolean;
|
|
88
103
|
}
|
|
104
|
+
export interface UpdateReviewRequest {
|
|
105
|
+
reviewOid: number;
|
|
106
|
+
merchantItemOid: number;
|
|
107
|
+
review: ItemReview;
|
|
108
|
+
}
|
|
89
109
|
export interface UploadTemporaryMultimediaRequest {
|
|
90
110
|
file: Blob;
|
|
91
111
|
}
|
|
@@ -124,6 +144,21 @@ export interface ItemApiInterface {
|
|
|
124
144
|
* Delete an item
|
|
125
145
|
*/
|
|
126
146
|
deleteItem(requestParameters: DeleteItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
147
|
+
/**
|
|
148
|
+
* Delete an item review.
|
|
149
|
+
* @summary Delete a review
|
|
150
|
+
* @param {number} reviewOid The review oid to delete.
|
|
151
|
+
* @param {number} merchantItemOid The item oid the review is associated with.
|
|
152
|
+
* @param {*} [options] Override http request option.
|
|
153
|
+
* @throws {RequiredError}
|
|
154
|
+
* @memberof ItemApiInterface
|
|
155
|
+
*/
|
|
156
|
+
deleteReviewRaw(requestParameters: DeleteReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
157
|
+
/**
|
|
158
|
+
* Delete an item review.
|
|
159
|
+
* Delete a review
|
|
160
|
+
*/
|
|
161
|
+
deleteReview(requestParameters: DeleteReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
127
162
|
/**
|
|
128
163
|
* Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
|
|
129
164
|
* @summary Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
|
@@ -238,6 +273,35 @@ export interface ItemApiInterface {
|
|
|
238
273
|
* Retrieve pricing tiers
|
|
239
274
|
*/
|
|
240
275
|
getPricingTiers(requestParameters: GetPricingTiersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PricingTiersResponse>;
|
|
276
|
+
/**
|
|
277
|
+
* Retrieve an item review.
|
|
278
|
+
* @summary Get a review
|
|
279
|
+
* @param {number} reviewOid The review oid to retrieve.
|
|
280
|
+
* @param {number} merchantItemOid The item oid the review is associated with.
|
|
281
|
+
* @param {*} [options] Override http request option.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
* @memberof ItemApiInterface
|
|
284
|
+
*/
|
|
285
|
+
getReviewRaw(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewResponse>>;
|
|
286
|
+
/**
|
|
287
|
+
* Retrieve an item review.
|
|
288
|
+
* Get a review
|
|
289
|
+
*/
|
|
290
|
+
getReview(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
|
|
291
|
+
/**
|
|
292
|
+
* Retrieve item reviews.
|
|
293
|
+
* @summary Get reviews for an item
|
|
294
|
+
* @param {number} merchantItemOid The item oid the review is associated with.
|
|
295
|
+
* @param {*} [options] Override http request option.
|
|
296
|
+
* @throws {RequiredError}
|
|
297
|
+
* @memberof ItemApiInterface
|
|
298
|
+
*/
|
|
299
|
+
getReviewsRaw(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewsResponse>>;
|
|
300
|
+
/**
|
|
301
|
+
* Retrieve item reviews.
|
|
302
|
+
* Get reviews for an item
|
|
303
|
+
*/
|
|
304
|
+
getReviews(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewsResponse>;
|
|
241
305
|
/**
|
|
242
306
|
* Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
243
307
|
* @summary Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
|
@@ -287,6 +351,21 @@ export interface ItemApiInterface {
|
|
|
287
351
|
* Create an item
|
|
288
352
|
*/
|
|
289
353
|
insertItem(requestParameters: InsertItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
354
|
+
/**
|
|
355
|
+
* Insert a item review.
|
|
356
|
+
* @summary Insert a review
|
|
357
|
+
* @param {number} merchantItemOid The item oid the review is associated with.
|
|
358
|
+
* @param {ItemReview} review Review to insert
|
|
359
|
+
* @param {*} [options] Override http request option.
|
|
360
|
+
* @throws {RequiredError}
|
|
361
|
+
* @memberof ItemApiInterface
|
|
362
|
+
*/
|
|
363
|
+
insertReviewRaw(requestParameters: InsertReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewResponse>>;
|
|
364
|
+
/**
|
|
365
|
+
* Insert a item review.
|
|
366
|
+
* Insert a review
|
|
367
|
+
*/
|
|
368
|
+
insertReview(requestParameters: InsertReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
|
|
290
369
|
/**
|
|
291
370
|
* Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
|
|
292
371
|
* @summary Updates a file within the digital library
|
|
@@ -336,6 +415,22 @@ export interface ItemApiInterface {
|
|
|
336
415
|
* Update multiple items
|
|
337
416
|
*/
|
|
338
417
|
updateItems(requestParameters: UpdateItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemsResponse>;
|
|
418
|
+
/**
|
|
419
|
+
* Update an item review.
|
|
420
|
+
* @summary Update a review
|
|
421
|
+
* @param {number} reviewOid The review oid to update.
|
|
422
|
+
* @param {number} merchantItemOid The item oid the review is associated with.
|
|
423
|
+
* @param {ItemReview} review Review to update
|
|
424
|
+
* @param {*} [options] Override http request option.
|
|
425
|
+
* @throws {RequiredError}
|
|
426
|
+
* @memberof ItemApiInterface
|
|
427
|
+
*/
|
|
428
|
+
updateReviewRaw(requestParameters: UpdateReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewResponse>>;
|
|
429
|
+
/**
|
|
430
|
+
* Update an item review.
|
|
431
|
+
* Update a review
|
|
432
|
+
*/
|
|
433
|
+
updateReview(requestParameters: UpdateReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
|
|
339
434
|
/**
|
|
340
435
|
* Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.
|
|
341
436
|
* @summary Upload an image to the temporary multimedia.
|
|
@@ -375,6 +470,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
375
470
|
* Delete an item
|
|
376
471
|
*/
|
|
377
472
|
deleteItem(requestParameters: DeleteItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
473
|
+
/**
|
|
474
|
+
* Delete an item review.
|
|
475
|
+
* Delete a review
|
|
476
|
+
*/
|
|
477
|
+
deleteReviewRaw(requestParameters: DeleteReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
478
|
+
/**
|
|
479
|
+
* Delete an item review.
|
|
480
|
+
* Delete a review
|
|
481
|
+
*/
|
|
482
|
+
deleteReview(requestParameters: DeleteReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
378
483
|
/**
|
|
379
484
|
* Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
|
|
380
485
|
* Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
|
@@ -445,6 +550,26 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
445
550
|
* Retrieve pricing tiers
|
|
446
551
|
*/
|
|
447
552
|
getPricingTiers(requestParameters?: GetPricingTiersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PricingTiersResponse>;
|
|
553
|
+
/**
|
|
554
|
+
* Retrieve an item review.
|
|
555
|
+
* Get a review
|
|
556
|
+
*/
|
|
557
|
+
getReviewRaw(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewResponse>>;
|
|
558
|
+
/**
|
|
559
|
+
* Retrieve an item review.
|
|
560
|
+
* Get a review
|
|
561
|
+
*/
|
|
562
|
+
getReview(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
|
|
563
|
+
/**
|
|
564
|
+
* Retrieve item reviews.
|
|
565
|
+
* Get reviews for an item
|
|
566
|
+
*/
|
|
567
|
+
getReviewsRaw(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewsResponse>>;
|
|
568
|
+
/**
|
|
569
|
+
* Retrieve item reviews.
|
|
570
|
+
* Get reviews for an item
|
|
571
|
+
*/
|
|
572
|
+
getReviews(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewsResponse>;
|
|
448
573
|
/**
|
|
449
574
|
* Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
450
575
|
* Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
|
@@ -475,6 +600,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
475
600
|
* Create an item
|
|
476
601
|
*/
|
|
477
602
|
insertItem(requestParameters: InsertItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
603
|
+
/**
|
|
604
|
+
* Insert a item review.
|
|
605
|
+
* Insert a review
|
|
606
|
+
*/
|
|
607
|
+
insertReviewRaw(requestParameters: InsertReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewResponse>>;
|
|
608
|
+
/**
|
|
609
|
+
* Insert a item review.
|
|
610
|
+
* Insert a review
|
|
611
|
+
*/
|
|
612
|
+
insertReview(requestParameters: InsertReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
|
|
478
613
|
/**
|
|
479
614
|
* Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
|
|
480
615
|
* Updates a file within the digital library
|
|
@@ -505,6 +640,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
505
640
|
* Update multiple items
|
|
506
641
|
*/
|
|
507
642
|
updateItems(requestParameters: UpdateItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemsResponse>;
|
|
643
|
+
/**
|
|
644
|
+
* Update an item review.
|
|
645
|
+
* Update a review
|
|
646
|
+
*/
|
|
647
|
+
updateReviewRaw(requestParameters: UpdateReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewResponse>>;
|
|
648
|
+
/**
|
|
649
|
+
* Update an item review.
|
|
650
|
+
* Update a review
|
|
651
|
+
*/
|
|
652
|
+
updateReview(requestParameters: UpdateReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
|
|
508
653
|
/**
|
|
509
654
|
* Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.
|
|
510
655
|
* Upload an image to the temporary multimedia.
|
package/dist/apis/ItemApi.js
CHANGED
|
@@ -189,6 +189,66 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
189
189
|
});
|
|
190
190
|
});
|
|
191
191
|
};
|
|
192
|
+
/**
|
|
193
|
+
* Delete an item review.
|
|
194
|
+
* Delete a review
|
|
195
|
+
*/
|
|
196
|
+
ItemApi.prototype.deleteReviewRaw = function (requestParameters, initOverrides) {
|
|
197
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
198
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
199
|
+
return __generator(this, function (_c) {
|
|
200
|
+
switch (_c.label) {
|
|
201
|
+
case 0:
|
|
202
|
+
if (requestParameters.reviewOid === null || requestParameters.reviewOid === undefined) {
|
|
203
|
+
throw new runtime.RequiredError('reviewOid', 'Required parameter requestParameters.reviewOid was null or undefined when calling deleteReview.');
|
|
204
|
+
}
|
|
205
|
+
if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
|
|
206
|
+
throw new runtime.RequiredError('merchantItemOid', 'Required parameter requestParameters.merchantItemOid was null or undefined when calling deleteReview.');
|
|
207
|
+
}
|
|
208
|
+
queryParameters = {};
|
|
209
|
+
headerParameters = {};
|
|
210
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
211
|
+
// oauth required
|
|
212
|
+
_a = headerParameters;
|
|
213
|
+
_b = "Authorization";
|
|
214
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_write"])];
|
|
215
|
+
case 1:
|
|
216
|
+
// oauth required
|
|
217
|
+
_a[_b] = _c.sent();
|
|
218
|
+
_c.label = 2;
|
|
219
|
+
case 2:
|
|
220
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
221
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
222
|
+
}
|
|
223
|
+
return [4 /*yield*/, this.request({
|
|
224
|
+
path: "/item/items/{merchant_item_oid}/reviews/{review_oid}".replace("{".concat("review_oid", "}"), encodeURIComponent(String(requestParameters.reviewOid))).replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(requestParameters.merchantItemOid))),
|
|
225
|
+
method: 'DELETE',
|
|
226
|
+
headers: headerParameters,
|
|
227
|
+
query: queryParameters,
|
|
228
|
+
}, initOverrides)];
|
|
229
|
+
case 3:
|
|
230
|
+
response = _c.sent();
|
|
231
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
232
|
+
}
|
|
233
|
+
});
|
|
234
|
+
});
|
|
235
|
+
};
|
|
236
|
+
/**
|
|
237
|
+
* Delete an item review.
|
|
238
|
+
* Delete a review
|
|
239
|
+
*/
|
|
240
|
+
ItemApi.prototype.deleteReview = function (requestParameters, initOverrides) {
|
|
241
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
242
|
+
return __generator(this, function (_a) {
|
|
243
|
+
switch (_a.label) {
|
|
244
|
+
case 0: return [4 /*yield*/, this.deleteReviewRaw(requestParameters, initOverrides)];
|
|
245
|
+
case 1:
|
|
246
|
+
_a.sent();
|
|
247
|
+
return [2 /*return*/];
|
|
248
|
+
}
|
|
249
|
+
});
|
|
250
|
+
});
|
|
251
|
+
};
|
|
192
252
|
/**
|
|
193
253
|
* Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
|
|
194
254
|
* Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
|
|
@@ -653,6 +713,127 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
653
713
|
});
|
|
654
714
|
});
|
|
655
715
|
};
|
|
716
|
+
/**
|
|
717
|
+
* Retrieve an item review.
|
|
718
|
+
* Get a review
|
|
719
|
+
*/
|
|
720
|
+
ItemApi.prototype.getReviewRaw = function (requestParameters, initOverrides) {
|
|
721
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
722
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
723
|
+
return __generator(this, function (_c) {
|
|
724
|
+
switch (_c.label) {
|
|
725
|
+
case 0:
|
|
726
|
+
if (requestParameters.reviewOid === null || requestParameters.reviewOid === undefined) {
|
|
727
|
+
throw new runtime.RequiredError('reviewOid', 'Required parameter requestParameters.reviewOid was null or undefined when calling getReview.');
|
|
728
|
+
}
|
|
729
|
+
if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
|
|
730
|
+
throw new runtime.RequiredError('merchantItemOid', 'Required parameter requestParameters.merchantItemOid was null or undefined when calling getReview.');
|
|
731
|
+
}
|
|
732
|
+
queryParameters = {};
|
|
733
|
+
headerParameters = {};
|
|
734
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
735
|
+
// oauth required
|
|
736
|
+
_a = headerParameters;
|
|
737
|
+
_b = "Authorization";
|
|
738
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_read"])];
|
|
739
|
+
case 1:
|
|
740
|
+
// oauth required
|
|
741
|
+
_a[_b] = _c.sent();
|
|
742
|
+
_c.label = 2;
|
|
743
|
+
case 2:
|
|
744
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
745
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
746
|
+
}
|
|
747
|
+
return [4 /*yield*/, this.request({
|
|
748
|
+
path: "/item/items/{merchant_item_oid}/reviews/{review_oid}".replace("{".concat("review_oid", "}"), encodeURIComponent(String(requestParameters.reviewOid))).replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(requestParameters.merchantItemOid))),
|
|
749
|
+
method: 'GET',
|
|
750
|
+
headers: headerParameters,
|
|
751
|
+
query: queryParameters,
|
|
752
|
+
}, initOverrides)];
|
|
753
|
+
case 3:
|
|
754
|
+
response = _c.sent();
|
|
755
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemReviewResponseFromJSON)(jsonValue); })];
|
|
756
|
+
}
|
|
757
|
+
});
|
|
758
|
+
});
|
|
759
|
+
};
|
|
760
|
+
/**
|
|
761
|
+
* Retrieve an item review.
|
|
762
|
+
* Get a review
|
|
763
|
+
*/
|
|
764
|
+
ItemApi.prototype.getReview = function (requestParameters, initOverrides) {
|
|
765
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
766
|
+
var response;
|
|
767
|
+
return __generator(this, function (_a) {
|
|
768
|
+
switch (_a.label) {
|
|
769
|
+
case 0: return [4 /*yield*/, this.getReviewRaw(requestParameters, initOverrides)];
|
|
770
|
+
case 1:
|
|
771
|
+
response = _a.sent();
|
|
772
|
+
return [4 /*yield*/, response.value()];
|
|
773
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
774
|
+
}
|
|
775
|
+
});
|
|
776
|
+
});
|
|
777
|
+
};
|
|
778
|
+
/**
|
|
779
|
+
* Retrieve item reviews.
|
|
780
|
+
* Get reviews for an item
|
|
781
|
+
*/
|
|
782
|
+
ItemApi.prototype.getReviewsRaw = function (requestParameters, initOverrides) {
|
|
783
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
784
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
785
|
+
return __generator(this, function (_c) {
|
|
786
|
+
switch (_c.label) {
|
|
787
|
+
case 0:
|
|
788
|
+
if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
|
|
789
|
+
throw new runtime.RequiredError('merchantItemOid', 'Required parameter requestParameters.merchantItemOid was null or undefined when calling getReviews.');
|
|
790
|
+
}
|
|
791
|
+
queryParameters = {};
|
|
792
|
+
headerParameters = {};
|
|
793
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
794
|
+
// oauth required
|
|
795
|
+
_a = headerParameters;
|
|
796
|
+
_b = "Authorization";
|
|
797
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_read"])];
|
|
798
|
+
case 1:
|
|
799
|
+
// oauth required
|
|
800
|
+
_a[_b] = _c.sent();
|
|
801
|
+
_c.label = 2;
|
|
802
|
+
case 2:
|
|
803
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
804
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
805
|
+
}
|
|
806
|
+
return [4 /*yield*/, this.request({
|
|
807
|
+
path: "/item/items/{merchant_item_oid}/reviews".replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(requestParameters.merchantItemOid))),
|
|
808
|
+
method: 'GET',
|
|
809
|
+
headers: headerParameters,
|
|
810
|
+
query: queryParameters,
|
|
811
|
+
}, initOverrides)];
|
|
812
|
+
case 3:
|
|
813
|
+
response = _c.sent();
|
|
814
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemReviewsResponseFromJSON)(jsonValue); })];
|
|
815
|
+
}
|
|
816
|
+
});
|
|
817
|
+
});
|
|
818
|
+
};
|
|
819
|
+
/**
|
|
820
|
+
* Retrieve item reviews.
|
|
821
|
+
* Get reviews for an item
|
|
822
|
+
*/
|
|
823
|
+
ItemApi.prototype.getReviews = function (requestParameters, initOverrides) {
|
|
824
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
825
|
+
var response;
|
|
826
|
+
return __generator(this, function (_a) {
|
|
827
|
+
switch (_a.label) {
|
|
828
|
+
case 0: return [4 /*yield*/, this.getReviewsRaw(requestParameters, initOverrides)];
|
|
829
|
+
case 1:
|
|
830
|
+
response = _a.sent();
|
|
831
|
+
return [4 /*yield*/, response.value()];
|
|
832
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
833
|
+
}
|
|
834
|
+
});
|
|
835
|
+
});
|
|
836
|
+
};
|
|
656
837
|
/**
|
|
657
838
|
* Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
658
839
|
* Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
|
|
@@ -856,6 +1037,70 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
856
1037
|
});
|
|
857
1038
|
});
|
|
858
1039
|
};
|
|
1040
|
+
/**
|
|
1041
|
+
* Insert a item review.
|
|
1042
|
+
* Insert a review
|
|
1043
|
+
*/
|
|
1044
|
+
ItemApi.prototype.insertReviewRaw = function (requestParameters, initOverrides) {
|
|
1045
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1046
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
1047
|
+
return __generator(this, function (_c) {
|
|
1048
|
+
switch (_c.label) {
|
|
1049
|
+
case 0:
|
|
1050
|
+
if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
|
|
1051
|
+
throw new runtime.RequiredError('merchantItemOid', 'Required parameter requestParameters.merchantItemOid was null or undefined when calling insertReview.');
|
|
1052
|
+
}
|
|
1053
|
+
if (requestParameters.review === null || requestParameters.review === undefined) {
|
|
1054
|
+
throw new runtime.RequiredError('review', 'Required parameter requestParameters.review was null or undefined when calling insertReview.');
|
|
1055
|
+
}
|
|
1056
|
+
queryParameters = {};
|
|
1057
|
+
headerParameters = {};
|
|
1058
|
+
headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
|
|
1059
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
1060
|
+
// oauth required
|
|
1061
|
+
_a = headerParameters;
|
|
1062
|
+
_b = "Authorization";
|
|
1063
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_write"])];
|
|
1064
|
+
case 1:
|
|
1065
|
+
// oauth required
|
|
1066
|
+
_a[_b] = _c.sent();
|
|
1067
|
+
_c.label = 2;
|
|
1068
|
+
case 2:
|
|
1069
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1070
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1071
|
+
}
|
|
1072
|
+
return [4 /*yield*/, this.request({
|
|
1073
|
+
path: "/item/items/{merchant_item_oid}/reviews".replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(requestParameters.merchantItemOid))),
|
|
1074
|
+
method: 'POST',
|
|
1075
|
+
headers: headerParameters,
|
|
1076
|
+
query: queryParameters,
|
|
1077
|
+
body: (0, models_1.ItemReviewToJSON)(requestParameters.review),
|
|
1078
|
+
}, initOverrides)];
|
|
1079
|
+
case 3:
|
|
1080
|
+
response = _c.sent();
|
|
1081
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemReviewResponseFromJSON)(jsonValue); })];
|
|
1082
|
+
}
|
|
1083
|
+
});
|
|
1084
|
+
});
|
|
1085
|
+
};
|
|
1086
|
+
/**
|
|
1087
|
+
* Insert a item review.
|
|
1088
|
+
* Insert a review
|
|
1089
|
+
*/
|
|
1090
|
+
ItemApi.prototype.insertReview = function (requestParameters, initOverrides) {
|
|
1091
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1092
|
+
var response;
|
|
1093
|
+
return __generator(this, function (_a) {
|
|
1094
|
+
switch (_a.label) {
|
|
1095
|
+
case 0: return [4 /*yield*/, this.insertReviewRaw(requestParameters, initOverrides)];
|
|
1096
|
+
case 1:
|
|
1097
|
+
response = _a.sent();
|
|
1098
|
+
return [4 /*yield*/, response.value()];
|
|
1099
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
1100
|
+
}
|
|
1101
|
+
});
|
|
1102
|
+
});
|
|
1103
|
+
};
|
|
859
1104
|
/**
|
|
860
1105
|
* Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
|
|
861
1106
|
* Updates a file within the digital library
|
|
@@ -1060,6 +1305,73 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
1060
1305
|
});
|
|
1061
1306
|
});
|
|
1062
1307
|
};
|
|
1308
|
+
/**
|
|
1309
|
+
* Update an item review.
|
|
1310
|
+
* Update a review
|
|
1311
|
+
*/
|
|
1312
|
+
ItemApi.prototype.updateReviewRaw = function (requestParameters, initOverrides) {
|
|
1313
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1314
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
1315
|
+
return __generator(this, function (_c) {
|
|
1316
|
+
switch (_c.label) {
|
|
1317
|
+
case 0:
|
|
1318
|
+
if (requestParameters.reviewOid === null || requestParameters.reviewOid === undefined) {
|
|
1319
|
+
throw new runtime.RequiredError('reviewOid', 'Required parameter requestParameters.reviewOid was null or undefined when calling updateReview.');
|
|
1320
|
+
}
|
|
1321
|
+
if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
|
|
1322
|
+
throw new runtime.RequiredError('merchantItemOid', 'Required parameter requestParameters.merchantItemOid was null or undefined when calling updateReview.');
|
|
1323
|
+
}
|
|
1324
|
+
if (requestParameters.review === null || requestParameters.review === undefined) {
|
|
1325
|
+
throw new runtime.RequiredError('review', 'Required parameter requestParameters.review was null or undefined when calling updateReview.');
|
|
1326
|
+
}
|
|
1327
|
+
queryParameters = {};
|
|
1328
|
+
headerParameters = {};
|
|
1329
|
+
headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
|
|
1330
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
1331
|
+
// oauth required
|
|
1332
|
+
_a = headerParameters;
|
|
1333
|
+
_b = "Authorization";
|
|
1334
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_write"])];
|
|
1335
|
+
case 1:
|
|
1336
|
+
// oauth required
|
|
1337
|
+
_a[_b] = _c.sent();
|
|
1338
|
+
_c.label = 2;
|
|
1339
|
+
case 2:
|
|
1340
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1341
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1342
|
+
}
|
|
1343
|
+
return [4 /*yield*/, this.request({
|
|
1344
|
+
path: "/item/items/{merchant_item_oid}/reviews/{review_oid}".replace("{".concat("review_oid", "}"), encodeURIComponent(String(requestParameters.reviewOid))).replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(requestParameters.merchantItemOid))),
|
|
1345
|
+
method: 'PUT',
|
|
1346
|
+
headers: headerParameters,
|
|
1347
|
+
query: queryParameters,
|
|
1348
|
+
body: (0, models_1.ItemReviewToJSON)(requestParameters.review),
|
|
1349
|
+
}, initOverrides)];
|
|
1350
|
+
case 3:
|
|
1351
|
+
response = _c.sent();
|
|
1352
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemReviewResponseFromJSON)(jsonValue); })];
|
|
1353
|
+
}
|
|
1354
|
+
});
|
|
1355
|
+
});
|
|
1356
|
+
};
|
|
1357
|
+
/**
|
|
1358
|
+
* Update an item review.
|
|
1359
|
+
* Update a review
|
|
1360
|
+
*/
|
|
1361
|
+
ItemApi.prototype.updateReview = function (requestParameters, initOverrides) {
|
|
1362
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1363
|
+
var response;
|
|
1364
|
+
return __generator(this, function (_a) {
|
|
1365
|
+
switch (_a.label) {
|
|
1366
|
+
case 0: return [4 /*yield*/, this.updateReviewRaw(requestParameters, initOverrides)];
|
|
1367
|
+
case 1:
|
|
1368
|
+
response = _a.sent();
|
|
1369
|
+
return [4 /*yield*/, response.value()];
|
|
1370
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
1371
|
+
}
|
|
1372
|
+
});
|
|
1373
|
+
});
|
|
1374
|
+
};
|
|
1063
1375
|
/**
|
|
1064
1376
|
* Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.
|
|
1065
1377
|
* Upload an image to the temporary multimedia.
|
|
@@ -60,6 +60,12 @@ export interface AutoOrderItem {
|
|
|
60
60
|
* @memberof AutoOrderItem
|
|
61
61
|
*/
|
|
62
62
|
auto_order_item_oid?: number;
|
|
63
|
+
/**
|
|
64
|
+
* Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet.
|
|
65
|
+
* @type {string}
|
|
66
|
+
* @memberof AutoOrderItem
|
|
67
|
+
*/
|
|
68
|
+
first_order_dts?: string;
|
|
63
69
|
/**
|
|
64
70
|
* Frequency of the rebill if not a fixed schedule
|
|
65
71
|
* @type {string}
|
|
@@ -126,6 +132,12 @@ export interface AutoOrderItem {
|
|
|
126
132
|
* @memberof AutoOrderItem
|
|
127
133
|
*/
|
|
128
134
|
original_quantity?: number;
|
|
135
|
+
/**
|
|
136
|
+
* True if paused. This field is an object instead of a primitive for backwards compatibility.
|
|
137
|
+
* @type {boolean}
|
|
138
|
+
* @memberof AutoOrderItem
|
|
139
|
+
*/
|
|
140
|
+
paused?: boolean;
|
|
129
141
|
/**
|
|
130
142
|
* The PayPal Payer ID tied to this item
|
|
131
143
|
* @type {string}
|
|
@@ -52,6 +52,7 @@ function AutoOrderItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
52
52
|
'arbitrary_unit_cost': !(0, runtime_1.exists)(json, 'arbitrary_unit_cost') ? undefined : json['arbitrary_unit_cost'],
|
|
53
53
|
'arbitrary_unit_cost_remaining_orders': !(0, runtime_1.exists)(json, 'arbitrary_unit_cost_remaining_orders') ? undefined : json['arbitrary_unit_cost_remaining_orders'],
|
|
54
54
|
'auto_order_item_oid': !(0, runtime_1.exists)(json, 'auto_order_item_oid') ? undefined : json['auto_order_item_oid'],
|
|
55
|
+
'first_order_dts': !(0, runtime_1.exists)(json, 'first_order_dts') ? undefined : json['first_order_dts'],
|
|
55
56
|
'frequency': !(0, runtime_1.exists)(json, 'frequency') ? undefined : json['frequency'],
|
|
56
57
|
'future_schedules': !(0, runtime_1.exists)(json, 'future_schedules') ? undefined : (json['future_schedules'].map(AutoOrderItemFutureSchedule_1.AutoOrderItemFutureScheduleFromJSON)),
|
|
57
58
|
'last_order_dts': !(0, runtime_1.exists)(json, 'last_order_dts') ? undefined : json['last_order_dts'],
|
|
@@ -63,6 +64,7 @@ function AutoOrderItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
63
64
|
'options': !(0, runtime_1.exists)(json, 'options') ? undefined : (json['options'].map(AutoOrderItemOption_1.AutoOrderItemOptionFromJSON)),
|
|
64
65
|
'original_item_id': !(0, runtime_1.exists)(json, 'original_item_id') ? undefined : json['original_item_id'],
|
|
65
66
|
'original_quantity': !(0, runtime_1.exists)(json, 'original_quantity') ? undefined : json['original_quantity'],
|
|
67
|
+
'paused': !(0, runtime_1.exists)(json, 'paused') ? undefined : json['paused'],
|
|
66
68
|
'paypal_payer_id': !(0, runtime_1.exists)(json, 'paypal_payer_id') ? undefined : json['paypal_payer_id'],
|
|
67
69
|
'paypal_recurring_payment_profile_id': !(0, runtime_1.exists)(json, 'paypal_recurring_payment_profile_id') ? undefined : json['paypal_recurring_payment_profile_id'],
|
|
68
70
|
'preshipment_notice_sent': !(0, runtime_1.exists)(json, 'preshipment_notice_sent') ? undefined : json['preshipment_notice_sent'],
|
|
@@ -87,6 +89,7 @@ function AutoOrderItemToJSON(value) {
|
|
|
87
89
|
'arbitrary_unit_cost': value.arbitrary_unit_cost,
|
|
88
90
|
'arbitrary_unit_cost_remaining_orders': value.arbitrary_unit_cost_remaining_orders,
|
|
89
91
|
'auto_order_item_oid': value.auto_order_item_oid,
|
|
92
|
+
'first_order_dts': value.first_order_dts,
|
|
90
93
|
'frequency': value.frequency,
|
|
91
94
|
'future_schedules': value.future_schedules === undefined ? undefined : (value.future_schedules.map(AutoOrderItemFutureSchedule_1.AutoOrderItemFutureScheduleToJSON)),
|
|
92
95
|
'last_order_dts': value.last_order_dts,
|
|
@@ -98,6 +101,7 @@ function AutoOrderItemToJSON(value) {
|
|
|
98
101
|
'options': value.options === undefined ? undefined : (value.options.map(AutoOrderItemOption_1.AutoOrderItemOptionToJSON)),
|
|
99
102
|
'original_item_id': value.original_item_id,
|
|
100
103
|
'original_quantity': value.original_quantity,
|
|
104
|
+
'paused': value.paused,
|
|
101
105
|
'paypal_payer_id': value.paypal_payer_id,
|
|
102
106
|
'paypal_recurring_payment_profile_id': value.paypal_recurring_payment_profile_id,
|
|
103
107
|
'preshipment_notice_sent': value.preshipment_notice_sent,
|