ultracart_rest_api_v2_typescript 4.0.245 → 4.1.1
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/README.md +4 -2
- package/dist/apis/AutoOrderApi.d.ts +31 -0
- package/dist/apis/AutoOrderApi.js +67 -0
- package/dist/apis/ItemApi.d.ts +23 -23
- package/dist/apis/ItemApi.js +56 -56
- package/dist/models/ItemPaymentProcessing.d.ts +1 -1
- package/dist/models/OrderCoupon.d.ts +1 -1
- package/package.json +1 -1
- package/src/apis/AutoOrderApi.ts +76 -0
- package/src/apis/ItemApi.ts +52 -52
- package/src/models/ItemPaymentProcessing.ts +1 -1
- package/src/models/OrderCoupon.ts +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@4.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@4.1.1
|
|
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.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@4.1.1 --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.1.1 | 02/28/2025 | auto order pause method |
|
|
58
|
+
| 4.1.0 | 02/21/2025 | ItemApi.getInventorySnapshot had bad nickname causing bad sdk method name |
|
|
57
59
|
| 4.0.245 | 02/20/2025 | automation fix |
|
|
58
60
|
| 4.0.244 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
|
|
59
61
|
| 4.0.243 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
|
|
@@ -68,6 +68,11 @@ export interface GetAutoOrdersByQueryRequest {
|
|
|
68
68
|
sort?: string;
|
|
69
69
|
expand?: string;
|
|
70
70
|
}
|
|
71
|
+
export interface PauseAutoOrderRequest {
|
|
72
|
+
autoOrderOid: number;
|
|
73
|
+
autoOrder: AutoOrder;
|
|
74
|
+
expand?: string;
|
|
75
|
+
}
|
|
71
76
|
export interface UpdateAutoOrderRequest {
|
|
72
77
|
autoOrderOid: number;
|
|
73
78
|
autoOrder: AutoOrder;
|
|
@@ -232,6 +237,22 @@ export interface AutoOrderApiInterface {
|
|
|
232
237
|
* Retrieve auto orders by query
|
|
233
238
|
*/
|
|
234
239
|
getAutoOrdersByQuery(requestParameters: GetAutoOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse>;
|
|
240
|
+
/**
|
|
241
|
+
* Completely pause an auto order
|
|
242
|
+
* @summary Pause auto order
|
|
243
|
+
* @param {number} autoOrderOid The auto order oid to pause.
|
|
244
|
+
* @param {AutoOrder} autoOrder Auto orders to pause
|
|
245
|
+
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
246
|
+
* @param {*} [options] Override http request option.
|
|
247
|
+
* @throws {RequiredError}
|
|
248
|
+
* @memberof AutoOrderApiInterface
|
|
249
|
+
*/
|
|
250
|
+
pauseAutoOrderRaw(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
|
|
251
|
+
/**
|
|
252
|
+
* Completely pause an auto order
|
|
253
|
+
* Pause auto order
|
|
254
|
+
*/
|
|
255
|
+
pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
235
256
|
/**
|
|
236
257
|
* Update an auto order on the UltraCart account.
|
|
237
258
|
* @summary Update an auto order
|
|
@@ -351,6 +372,16 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
|
|
|
351
372
|
* Retrieve auto orders by query
|
|
352
373
|
*/
|
|
353
374
|
getAutoOrdersByQuery(requestParameters: GetAutoOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse>;
|
|
375
|
+
/**
|
|
376
|
+
* Completely pause an auto order
|
|
377
|
+
* Pause auto order
|
|
378
|
+
*/
|
|
379
|
+
pauseAutoOrderRaw(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
|
|
380
|
+
/**
|
|
381
|
+
* Completely pause an auto order
|
|
382
|
+
* Pause auto order
|
|
383
|
+
*/
|
|
384
|
+
pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
354
385
|
/**
|
|
355
386
|
* Update an auto order on the UltraCart account.
|
|
356
387
|
* Update an auto order
|
|
@@ -653,6 +653,73 @@ var AutoOrderApi = /** @class */ (function (_super) {
|
|
|
653
653
|
});
|
|
654
654
|
});
|
|
655
655
|
};
|
|
656
|
+
/**
|
|
657
|
+
* Completely pause an auto order
|
|
658
|
+
* Pause auto order
|
|
659
|
+
*/
|
|
660
|
+
AutoOrderApi.prototype.pauseAutoOrderRaw = function (requestParameters, initOverrides) {
|
|
661
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
662
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
663
|
+
return __generator(this, function (_c) {
|
|
664
|
+
switch (_c.label) {
|
|
665
|
+
case 0:
|
|
666
|
+
if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
|
|
667
|
+
throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling pauseAutoOrder.');
|
|
668
|
+
}
|
|
669
|
+
if (requestParameters.autoOrder === null || requestParameters.autoOrder === undefined) {
|
|
670
|
+
throw new runtime.RequiredError('autoOrder', 'Required parameter requestParameters.autoOrder was null or undefined when calling pauseAutoOrder.');
|
|
671
|
+
}
|
|
672
|
+
queryParameters = {};
|
|
673
|
+
if (requestParameters.expand !== undefined) {
|
|
674
|
+
queryParameters['_expand'] = requestParameters.expand;
|
|
675
|
+
}
|
|
676
|
+
headerParameters = {};
|
|
677
|
+
headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
|
|
678
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
679
|
+
// oauth required
|
|
680
|
+
_a = headerParameters;
|
|
681
|
+
_b = "Authorization";
|
|
682
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
|
|
683
|
+
case 1:
|
|
684
|
+
// oauth required
|
|
685
|
+
_a[_b] = _c.sent();
|
|
686
|
+
_c.label = 2;
|
|
687
|
+
case 2:
|
|
688
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
689
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
690
|
+
}
|
|
691
|
+
return [4 /*yield*/, this.request({
|
|
692
|
+
path: "/auto_order/auto_orders/{auto_order_oid}/pause".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))),
|
|
693
|
+
method: 'PUT',
|
|
694
|
+
headers: headerParameters,
|
|
695
|
+
query: queryParameters,
|
|
696
|
+
body: (0, models_1.AutoOrderToJSON)(requestParameters.autoOrder),
|
|
697
|
+
}, initOverrides)];
|
|
698
|
+
case 3:
|
|
699
|
+
response = _c.sent();
|
|
700
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderResponseFromJSON)(jsonValue); })];
|
|
701
|
+
}
|
|
702
|
+
});
|
|
703
|
+
});
|
|
704
|
+
};
|
|
705
|
+
/**
|
|
706
|
+
* Completely pause an auto order
|
|
707
|
+
* Pause auto order
|
|
708
|
+
*/
|
|
709
|
+
AutoOrderApi.prototype.pauseAutoOrder = function (requestParameters, initOverrides) {
|
|
710
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
711
|
+
var response;
|
|
712
|
+
return __generator(this, function (_a) {
|
|
713
|
+
switch (_a.label) {
|
|
714
|
+
case 0: return [4 /*yield*/, this.pauseAutoOrderRaw(requestParameters, initOverrides)];
|
|
715
|
+
case 1:
|
|
716
|
+
response = _a.sent();
|
|
717
|
+
return [4 /*yield*/, response.value()];
|
|
718
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
719
|
+
}
|
|
720
|
+
});
|
|
721
|
+
});
|
|
722
|
+
};
|
|
656
723
|
/**
|
|
657
724
|
* Update an auto order on the UltraCart account.
|
|
658
725
|
* Update an auto order
|
package/dist/apis/ItemApi.d.ts
CHANGED
|
@@ -210,6 +210,19 @@ export interface ItemApiInterface {
|
|
|
210
210
|
* Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
|
|
211
211
|
*/
|
|
212
212
|
getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
|
|
213
|
+
/**
|
|
214
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
215
|
+
* @summary Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
216
|
+
* @param {*} [options] Override http request option.
|
|
217
|
+
* @throws {RequiredError}
|
|
218
|
+
* @memberof ItemApiInterface
|
|
219
|
+
*/
|
|
220
|
+
getInventorySnapshotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
|
|
221
|
+
/**
|
|
222
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
223
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
224
|
+
*/
|
|
225
|
+
getInventorySnapshot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
|
|
213
226
|
/**
|
|
214
227
|
* Retrieves a single item using the specified item oid.
|
|
215
228
|
* @summary Retrieve an item
|
|
@@ -385,19 +398,6 @@ export interface ItemApiInterface {
|
|
|
385
398
|
* Upsert an item content attribute
|
|
386
399
|
*/
|
|
387
400
|
insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
388
|
-
/**
|
|
389
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
390
|
-
* @summary Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
391
|
-
* @param {*} [options] Override http request option.
|
|
392
|
-
* @throws {RequiredError}
|
|
393
|
-
* @memberof ItemApiInterface
|
|
394
|
-
*/
|
|
395
|
-
restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
|
|
396
|
-
/**
|
|
397
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
398
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
399
|
-
*/
|
|
400
|
-
restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
|
|
401
401
|
/**
|
|
402
402
|
* 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.
|
|
403
403
|
* @summary Updates a file within the digital library
|
|
@@ -542,6 +542,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
542
542
|
* Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
|
|
543
543
|
*/
|
|
544
544
|
getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
|
|
545
|
+
/**
|
|
546
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
547
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
548
|
+
*/
|
|
549
|
+
getInventorySnapshotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
|
|
550
|
+
/**
|
|
551
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
552
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
553
|
+
*/
|
|
554
|
+
getInventorySnapshot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
|
|
545
555
|
/**
|
|
546
556
|
* Retrieves a single item using the specified item oid.
|
|
547
557
|
* Retrieve an item
|
|
@@ -652,16 +662,6 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
|
|
|
652
662
|
* Upsert an item content attribute
|
|
653
663
|
*/
|
|
654
664
|
insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
655
|
-
/**
|
|
656
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
657
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
658
|
-
*/
|
|
659
|
-
restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
|
|
660
|
-
/**
|
|
661
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
662
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
663
|
-
*/
|
|
664
|
-
restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
|
|
665
665
|
/**
|
|
666
666
|
* 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.
|
|
667
667
|
* Updates a file within the digital library
|
package/dist/apis/ItemApi.js
CHANGED
|
@@ -442,6 +442,62 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
442
442
|
});
|
|
443
443
|
});
|
|
444
444
|
};
|
|
445
|
+
/**
|
|
446
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
447
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
448
|
+
*/
|
|
449
|
+
ItemApi.prototype.getInventorySnapshotRaw = function (initOverrides) {
|
|
450
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
451
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
452
|
+
return __generator(this, function (_c) {
|
|
453
|
+
switch (_c.label) {
|
|
454
|
+
case 0:
|
|
455
|
+
queryParameters = {};
|
|
456
|
+
headerParameters = {};
|
|
457
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
458
|
+
// oauth required
|
|
459
|
+
_a = headerParameters;
|
|
460
|
+
_b = "Authorization";
|
|
461
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_read"])];
|
|
462
|
+
case 1:
|
|
463
|
+
// oauth required
|
|
464
|
+
_a[_b] = _c.sent();
|
|
465
|
+
_c.label = 2;
|
|
466
|
+
case 2:
|
|
467
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
468
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
469
|
+
}
|
|
470
|
+
return [4 /*yield*/, this.request({
|
|
471
|
+
path: "/item/items/inventory_snapshot",
|
|
472
|
+
method: 'GET',
|
|
473
|
+
headers: headerParameters,
|
|
474
|
+
query: queryParameters,
|
|
475
|
+
}, initOverrides)];
|
|
476
|
+
case 3:
|
|
477
|
+
response = _c.sent();
|
|
478
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemInventorySnapshotResponseFromJSON)(jsonValue); })];
|
|
479
|
+
}
|
|
480
|
+
});
|
|
481
|
+
});
|
|
482
|
+
};
|
|
483
|
+
/**
|
|
484
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
485
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
486
|
+
*/
|
|
487
|
+
ItemApi.prototype.getInventorySnapshot = function (initOverrides) {
|
|
488
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
489
|
+
var response;
|
|
490
|
+
return __generator(this, function (_a) {
|
|
491
|
+
switch (_a.label) {
|
|
492
|
+
case 0: return [4 /*yield*/, this.getInventorySnapshotRaw(initOverrides)];
|
|
493
|
+
case 1:
|
|
494
|
+
response = _a.sent();
|
|
495
|
+
return [4 /*yield*/, response.value()];
|
|
496
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
497
|
+
}
|
|
498
|
+
});
|
|
499
|
+
});
|
|
500
|
+
};
|
|
445
501
|
/**
|
|
446
502
|
* Retrieves a single item using the specified item oid.
|
|
447
503
|
* Retrieve an item
|
|
@@ -1163,62 +1219,6 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
1163
1219
|
});
|
|
1164
1220
|
});
|
|
1165
1221
|
};
|
|
1166
|
-
/**
|
|
1167
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
1168
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
1169
|
-
*/
|
|
1170
|
-
ItemApi.prototype.restItemInventorySnapshotResponseRaw = function (initOverrides) {
|
|
1171
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
1172
|
-
var queryParameters, headerParameters, _a, _b, response;
|
|
1173
|
-
return __generator(this, function (_c) {
|
|
1174
|
-
switch (_c.label) {
|
|
1175
|
-
case 0:
|
|
1176
|
-
queryParameters = {};
|
|
1177
|
-
headerParameters = {};
|
|
1178
|
-
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
1179
|
-
// oauth required
|
|
1180
|
-
_a = headerParameters;
|
|
1181
|
-
_b = "Authorization";
|
|
1182
|
-
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_read"])];
|
|
1183
|
-
case 1:
|
|
1184
|
-
// oauth required
|
|
1185
|
-
_a[_b] = _c.sent();
|
|
1186
|
-
_c.label = 2;
|
|
1187
|
-
case 2:
|
|
1188
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
1189
|
-
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1190
|
-
}
|
|
1191
|
-
return [4 /*yield*/, this.request({
|
|
1192
|
-
path: "/item/items/inventory_snapshot",
|
|
1193
|
-
method: 'GET',
|
|
1194
|
-
headers: headerParameters,
|
|
1195
|
-
query: queryParameters,
|
|
1196
|
-
}, initOverrides)];
|
|
1197
|
-
case 3:
|
|
1198
|
-
response = _c.sent();
|
|
1199
|
-
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemInventorySnapshotResponseFromJSON)(jsonValue); })];
|
|
1200
|
-
}
|
|
1201
|
-
});
|
|
1202
|
-
});
|
|
1203
|
-
};
|
|
1204
|
-
/**
|
|
1205
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
1206
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
1207
|
-
*/
|
|
1208
|
-
ItemApi.prototype.restItemInventorySnapshotResponse = function (initOverrides) {
|
|
1209
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
1210
|
-
var response;
|
|
1211
|
-
return __generator(this, function (_a) {
|
|
1212
|
-
switch (_a.label) {
|
|
1213
|
-
case 0: return [4 /*yield*/, this.restItemInventorySnapshotResponseRaw(initOverrides)];
|
|
1214
|
-
case 1:
|
|
1215
|
-
response = _a.sent();
|
|
1216
|
-
return [4 /*yield*/, response.value()];
|
|
1217
|
-
case 2: return [2 /*return*/, _a.sent()];
|
|
1218
|
-
}
|
|
1219
|
-
});
|
|
1220
|
-
});
|
|
1221
|
-
};
|
|
1222
1222
|
/**
|
|
1223
1223
|
* 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.
|
|
1224
1224
|
* Updates a file within the digital library
|
|
@@ -22,7 +22,7 @@ export interface ItemPaymentProcessing {
|
|
|
22
22
|
*/
|
|
23
23
|
block_prepaid?: boolean;
|
|
24
24
|
/**
|
|
25
|
-
* True if this item should block any refund attempts
|
|
25
|
+
* True if this item should block any refund attempts, set to false otherwise, null value will not update the field
|
|
26
26
|
* @type {boolean}
|
|
27
27
|
* @memberof ItemPaymentProcessing
|
|
28
28
|
*/
|
package/package.json
CHANGED
package/src/apis/AutoOrderApi.ts
CHANGED
|
@@ -106,6 +106,12 @@ export interface GetAutoOrdersByQueryRequest {
|
|
|
106
106
|
expand?: string;
|
|
107
107
|
}
|
|
108
108
|
|
|
109
|
+
export interface PauseAutoOrderRequest {
|
|
110
|
+
autoOrderOid: number;
|
|
111
|
+
autoOrder: AutoOrder;
|
|
112
|
+
expand?: string;
|
|
113
|
+
}
|
|
114
|
+
|
|
109
115
|
export interface UpdateAutoOrderRequest {
|
|
110
116
|
autoOrderOid: number;
|
|
111
117
|
autoOrder: AutoOrder;
|
|
@@ -288,6 +294,24 @@ export interface AutoOrderApiInterface {
|
|
|
288
294
|
*/
|
|
289
295
|
getAutoOrdersByQuery(requestParameters: GetAutoOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse>;
|
|
290
296
|
|
|
297
|
+
/**
|
|
298
|
+
* Completely pause an auto order
|
|
299
|
+
* @summary Pause auto order
|
|
300
|
+
* @param {number} autoOrderOid The auto order oid to pause.
|
|
301
|
+
* @param {AutoOrder} autoOrder Auto orders to pause
|
|
302
|
+
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
303
|
+
* @param {*} [options] Override http request option.
|
|
304
|
+
* @throws {RequiredError}
|
|
305
|
+
* @memberof AutoOrderApiInterface
|
|
306
|
+
*/
|
|
307
|
+
pauseAutoOrderRaw(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* Completely pause an auto order
|
|
311
|
+
* Pause auto order
|
|
312
|
+
*/
|
|
313
|
+
pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
314
|
+
|
|
291
315
|
/**
|
|
292
316
|
* Update an auto order on the UltraCart account.
|
|
293
317
|
* @summary Update an auto order
|
|
@@ -802,6 +826,58 @@ export class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterfa
|
|
|
802
826
|
return await response.value();
|
|
803
827
|
}
|
|
804
828
|
|
|
829
|
+
/**
|
|
830
|
+
* Completely pause an auto order
|
|
831
|
+
* Pause auto order
|
|
832
|
+
*/
|
|
833
|
+
async pauseAutoOrderRaw(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>> {
|
|
834
|
+
if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
|
|
835
|
+
throw new runtime.RequiredError('autoOrderOid','Required parameter requestParameters.autoOrderOid was null or undefined when calling pauseAutoOrder.');
|
|
836
|
+
}
|
|
837
|
+
|
|
838
|
+
if (requestParameters.autoOrder === null || requestParameters.autoOrder === undefined) {
|
|
839
|
+
throw new runtime.RequiredError('autoOrder','Required parameter requestParameters.autoOrder was null or undefined when calling pauseAutoOrder.');
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
const queryParameters: any = {};
|
|
843
|
+
|
|
844
|
+
if (requestParameters.expand !== undefined) {
|
|
845
|
+
queryParameters['_expand'] = requestParameters.expand;
|
|
846
|
+
}
|
|
847
|
+
|
|
848
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
849
|
+
|
|
850
|
+
headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
|
|
851
|
+
|
|
852
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
853
|
+
// oauth required
|
|
854
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["auto_order_write"]);
|
|
855
|
+
}
|
|
856
|
+
|
|
857
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
858
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
859
|
+
}
|
|
860
|
+
|
|
861
|
+
const response = await this.request({
|
|
862
|
+
path: `/auto_order/auto_orders/{auto_order_oid}/pause`.replace(`{${"auto_order_oid"}}`, encodeURIComponent(String(requestParameters.autoOrderOid))),
|
|
863
|
+
method: 'PUT',
|
|
864
|
+
headers: headerParameters,
|
|
865
|
+
query: queryParameters,
|
|
866
|
+
body: AutoOrderToJSON(requestParameters.autoOrder),
|
|
867
|
+
}, initOverrides);
|
|
868
|
+
|
|
869
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AutoOrderResponseFromJSON(jsonValue));
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
/**
|
|
873
|
+
* Completely pause an auto order
|
|
874
|
+
* Pause auto order
|
|
875
|
+
*/
|
|
876
|
+
async pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse> {
|
|
877
|
+
const response = await this.pauseAutoOrderRaw(requestParameters, initOverrides);
|
|
878
|
+
return await response.value();
|
|
879
|
+
}
|
|
880
|
+
|
|
805
881
|
/**
|
|
806
882
|
* Update an auto order on the UltraCart account.
|
|
807
883
|
* Update an auto order
|
package/src/apis/ItemApi.ts
CHANGED
|
@@ -295,6 +295,21 @@ export interface ItemApiInterface {
|
|
|
295
295
|
*/
|
|
296
296
|
getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
|
|
297
297
|
|
|
298
|
+
/**
|
|
299
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
300
|
+
* @summary Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
301
|
+
* @param {*} [options] Override http request option.
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
* @memberof ItemApiInterface
|
|
304
|
+
*/
|
|
305
|
+
getInventorySnapshotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
309
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
310
|
+
*/
|
|
311
|
+
getInventorySnapshot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
|
|
312
|
+
|
|
298
313
|
/**
|
|
299
314
|
* Retrieves a single item using the specified item oid.
|
|
300
315
|
* @summary Retrieve an item
|
|
@@ -492,21 +507,6 @@ export interface ItemApiInterface {
|
|
|
492
507
|
*/
|
|
493
508
|
insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
494
509
|
|
|
495
|
-
/**
|
|
496
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
497
|
-
* @summary Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
498
|
-
* @param {*} [options] Override http request option.
|
|
499
|
-
* @throws {RequiredError}
|
|
500
|
-
* @memberof ItemApiInterface
|
|
501
|
-
*/
|
|
502
|
-
restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
|
|
503
|
-
|
|
504
|
-
/**
|
|
505
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
506
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
507
|
-
*/
|
|
508
|
-
restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
|
|
509
|
-
|
|
510
510
|
/**
|
|
511
511
|
* 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.
|
|
512
512
|
* @summary Updates a file within the digital library
|
|
@@ -870,6 +870,43 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
|
|
|
870
870
|
return await response.value();
|
|
871
871
|
}
|
|
872
872
|
|
|
873
|
+
/**
|
|
874
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
875
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
876
|
+
*/
|
|
877
|
+
async getInventorySnapshotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>> {
|
|
878
|
+
const queryParameters: any = {};
|
|
879
|
+
|
|
880
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
881
|
+
|
|
882
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
883
|
+
// oauth required
|
|
884
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["item_read"]);
|
|
885
|
+
}
|
|
886
|
+
|
|
887
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
888
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
const response = await this.request({
|
|
892
|
+
path: `/item/items/inventory_snapshot`,
|
|
893
|
+
method: 'GET',
|
|
894
|
+
headers: headerParameters,
|
|
895
|
+
query: queryParameters,
|
|
896
|
+
}, initOverrides);
|
|
897
|
+
|
|
898
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ItemInventorySnapshotResponseFromJSON(jsonValue));
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
/**
|
|
902
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
903
|
+
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
904
|
+
*/
|
|
905
|
+
async getInventorySnapshot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse> {
|
|
906
|
+
const response = await this.getInventorySnapshotRaw(initOverrides);
|
|
907
|
+
return await response.value();
|
|
908
|
+
}
|
|
909
|
+
|
|
873
910
|
/**
|
|
874
911
|
* Retrieves a single item using the specified item oid.
|
|
875
912
|
* Retrieve an item
|
|
@@ -1416,43 +1453,6 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
|
|
|
1416
1453
|
await this.insertUpdateItemContentAttributeRaw(requestParameters, initOverrides);
|
|
1417
1454
|
}
|
|
1418
1455
|
|
|
1419
|
-
/**
|
|
1420
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
1421
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
1422
|
-
*/
|
|
1423
|
-
async restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>> {
|
|
1424
|
-
const queryParameters: any = {};
|
|
1425
|
-
|
|
1426
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
1427
|
-
|
|
1428
|
-
if (this.configuration && this.configuration.accessToken) {
|
|
1429
|
-
// oauth required
|
|
1430
|
-
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["item_read"]);
|
|
1431
|
-
}
|
|
1432
|
-
|
|
1433
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
1434
|
-
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1435
|
-
}
|
|
1436
|
-
|
|
1437
|
-
const response = await this.request({
|
|
1438
|
-
path: `/item/items/inventory_snapshot`,
|
|
1439
|
-
method: 'GET',
|
|
1440
|
-
headers: headerParameters,
|
|
1441
|
-
query: queryParameters,
|
|
1442
|
-
}, initOverrides);
|
|
1443
|
-
|
|
1444
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => ItemInventorySnapshotResponseFromJSON(jsonValue));
|
|
1445
|
-
}
|
|
1446
|
-
|
|
1447
|
-
/**
|
|
1448
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
1449
|
-
* Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
1450
|
-
*/
|
|
1451
|
-
async restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse> {
|
|
1452
|
-
const response = await this.restItemInventorySnapshotResponseRaw(initOverrides);
|
|
1453
|
-
return await response.value();
|
|
1454
|
-
}
|
|
1455
|
-
|
|
1456
1456
|
/**
|
|
1457
1457
|
* 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.
|
|
1458
1458
|
* Updates a file within the digital library
|
|
@@ -26,7 +26,7 @@ export interface ItemPaymentProcessing {
|
|
|
26
26
|
*/
|
|
27
27
|
block_prepaid?: boolean;
|
|
28
28
|
/**
|
|
29
|
-
* True if this item should block any refund attempts
|
|
29
|
+
* True if this item should block any refund attempts, set to false otherwise, null value will not update the field
|
|
30
30
|
* @type {boolean}
|
|
31
31
|
* @memberof ItemPaymentProcessing
|
|
32
32
|
*/
|