ultracart_rest_api_v2_typescript 4.1.57 → 4.1.58

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.
@@ -645,8 +645,6 @@ src/models/ItemInternal.ts
645
645
  src/models/ItemInventorySnapshot.ts
646
646
  src/models/ItemInventorySnapshotDistributionCenter.ts
647
647
  src/models/ItemInventorySnapshotResponse.ts
648
- src/models/ItemInventoryUpdate.ts
649
- src/models/ItemInventoryUpdateRequest.ts
650
648
  src/models/ItemKitComponent.ts
651
649
  src/models/ItemKitDefinition.ts
652
650
  src/models/ItemOption.ts
@@ -678,7 +676,6 @@ src/models/ItemShippingCase.ts
678
676
  src/models/ItemShippingDestinationMarkup.ts
679
677
  src/models/ItemShippingDestinationRestriction.ts
680
678
  src/models/ItemShippingDistributionCenter.ts
681
- src/models/ItemShippingDistributionCenterResponse.ts
682
679
  src/models/ItemShippingMethod.ts
683
680
  src/models/ItemShippingPackageRequirement.ts
684
681
  src/models/ItemTag.ts
@@ -785,6 +782,7 @@ src/models/OrderTokenResponse.ts
785
782
  src/models/OrderTrackingNumberDetail.ts
786
783
  src/models/OrderTrackingNumberDetails.ts
787
784
  src/models/OrderTransactionalMerchantNote.ts
785
+ src/models/OrderUpsellCartRequest.ts
788
786
  src/models/OrderUtm.ts
789
787
  src/models/OrderValidationRequest.ts
790
788
  src/models/OrderValidationResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.57
2
+ ## ultracart_rest_api_v2_typescript@4.1.58
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.57 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.58 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.58 | 02/10/2026 | conversations - new method to look up an item with sparse variations. |
88
89
  | 4.1.57 | 02/03/2026 | conversations - pbx class of service objects and endpoints |
89
90
  | 4.1.56 | 02/02/2026 | conversations - add default phone number to the agent auth |
90
91
  | 4.1.55 | 02/02/2026 | conversations - add enumerated values for say voice on queue and agent |
@@ -143,6 +143,7 @@ export interface GetPbxClassOfServiceRequest {
143
143
  export interface GetPbxCosAuditLogsRequest {
144
144
  since?: string;
145
145
  agentLogin?: string;
146
+ action?: string;
146
147
  limit?: number;
147
148
  }
148
149
  export interface GetPbxHardwarePhoneRequest {
@@ -1123,6 +1124,7 @@ export interface ConversationApiInterface {
1123
1124
  * @summary Get pbx class of service audit logs
1124
1125
  * @param {string} [since] ISO timestamp to filter entries since
1125
1126
  * @param {string} [agentLogin] Filter by agent login
1127
+ * @param {string} [action] Action
1126
1128
  * @param {number} [limit] Maximum number of entries to return (default 100)
1127
1129
  * @param {*} [options] Override http request option.
1128
1130
  * @throws {RequiredError}
@@ -3316,6 +3316,9 @@ var ConversationApi = /** @class */ (function (_super) {
3316
3316
  if (requestParameters.agentLogin !== undefined) {
3317
3317
  queryParameters['agent_login'] = requestParameters.agentLogin;
3318
3318
  }
3319
+ if (requestParameters.action !== undefined) {
3320
+ queryParameters['action'] = requestParameters.action;
3321
+ }
3319
3322
  if (requestParameters.limit !== undefined) {
3320
3323
  queryParameters['limit'] = requestParameters.limit;
3321
3324
  }
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { Item, ItemContentAttribute, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemInventorySnapshotResponse, ItemInventoryUpdateRequest, ItemResponse, ItemReview, ItemReviewResponse, ItemReviewsResponse, ItemShippingDistributionCenter, ItemShippingDistributionCenterResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
13
+ import { Item, ItemContentAttribute, ItemDigitalItem, ItemDigitalItemResponse, ItemDigitalItemsResponse, ItemInventorySnapshotResponse, ItemResponse, ItemReview, ItemReviewResponse, ItemReviewsResponse, ItemsRequest, ItemsResponse, PricingTiersResponse, TempMultimediaResponse } from '../models';
14
14
  export interface DeleteDigitalItemRequest {
15
15
  digitalItemOid: number;
16
16
  }
@@ -45,12 +45,6 @@ export interface GetItemByMerchantItemIdRequest {
45
45
  expand?: string;
46
46
  placeholders?: boolean;
47
47
  }
48
- export interface GetItemShippingDistributionCenterByCodeRequest {
49
- merchantItemOid: number;
50
- distributionCenterCode: string;
51
- expand?: string;
52
- placeholders?: boolean;
53
- }
54
48
  export interface GetItemsRequest {
55
49
  parentCategoryId?: number;
56
50
  parentCategoryPath?: string;
@@ -105,14 +99,6 @@ export interface UpdateItemRequest {
105
99
  expand?: string;
106
100
  placeholders?: boolean;
107
101
  }
108
- export interface UpdateItemInventoriesRequest {
109
- itemInventoryUpdateRequest: ItemInventoryUpdateRequest;
110
- }
111
- export interface UpdateItemShippingDistributionCenterByCodeRequest {
112
- merchantItemOid: number;
113
- distributionCenterCode: string;
114
- itemShippingDistributionCenter: ItemShippingDistributionCenter;
115
- }
116
102
  export interface UpdateItemsRequest {
117
103
  itemsRequest: ItemsRequest;
118
104
  expand?: string;
@@ -269,23 +255,6 @@ export interface ItemApiInterface {
269
255
  * Retrieve an item by item id
270
256
  */
271
257
  getItemByMerchantItemId(requestParameters: GetItemByMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
272
- /**
273
- * Retrieve an item shipping distribution center.
274
- * @summary Retrieve an item shipping distribution center
275
- * @param {number} merchantItemOid The item oid to retrieve.
276
- * @param {string} distributionCenterCode
277
- * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
278
- * @param {boolean} [placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
279
- * @param {*} [options] Override http request option.
280
- * @throws {RequiredError}
281
- * @memberof ItemApiInterface
282
- */
283
- getItemShippingDistributionCenterByCodeRaw(requestParameters: GetItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemShippingDistributionCenterResponse>>;
284
- /**
285
- * Retrieve an item shipping distribution center.
286
- * Retrieve an item shipping distribution center
287
- */
288
- getItemShippingDistributionCenterByCode(requestParameters: GetItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemShippingDistributionCenterResponse>;
289
258
  /**
290
259
  * Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
291
260
  * @summary Retrieve items
@@ -461,36 +430,6 @@ export interface ItemApiInterface {
461
430
  * Update an item
462
431
  */
463
432
  updateItem(requestParameters: UpdateItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
464
- /**
465
- * Update item inventories for a distribution center
466
- * @summary Update item inventories for a distribution center
467
- * @param {ItemInventoryUpdateRequest} itemInventoryUpdateRequest Item inventory updates
468
- * @param {*} [options] Override http request option.
469
- * @throws {RequiredError}
470
- * @memberof ItemApiInterface
471
- */
472
- updateItemInventoriesRaw(requestParameters: UpdateItemInventoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
473
- /**
474
- * Update item inventories for a distribution center
475
- * Update item inventories for a distribution center
476
- */
477
- updateItemInventories(requestParameters: UpdateItemInventoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
478
- /**
479
- * Update an item shipping distribution center
480
- * @summary Update an item shipping distribution center
481
- * @param {number} merchantItemOid The item oid to update.
482
- * @param {string} distributionCenterCode
483
- * @param {ItemShippingDistributionCenter} itemShippingDistributionCenter Item shipping distribution center
484
- * @param {*} [options] Override http request option.
485
- * @throws {RequiredError}
486
- * @memberof ItemApiInterface
487
- */
488
- updateItemShippingDistributionCenterByCodeRaw(requestParameters: UpdateItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
489
- /**
490
- * Update an item shipping distribution center
491
- * Update an item shipping distribution center
492
- */
493
- updateItemShippingDistributionCenterByCode(requestParameters: UpdateItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
494
433
  /**
495
434
  * Update multiple item on the UltraCart account.
496
435
  * @summary Update multiple items
@@ -633,16 +572,6 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
633
572
  * Retrieve an item by item id
634
573
  */
635
574
  getItemByMerchantItemId(requestParameters: GetItemByMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
636
- /**
637
- * Retrieve an item shipping distribution center.
638
- * Retrieve an item shipping distribution center
639
- */
640
- getItemShippingDistributionCenterByCodeRaw(requestParameters: GetItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemShippingDistributionCenterResponse>>;
641
- /**
642
- * Retrieve an item shipping distribution center.
643
- * Retrieve an item shipping distribution center
644
- */
645
- getItemShippingDistributionCenterByCode(requestParameters: GetItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemShippingDistributionCenterResponse>;
646
575
  /**
647
576
  * Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
648
577
  * Retrieve items
@@ -753,26 +682,6 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
753
682
  * Update an item
754
683
  */
755
684
  updateItem(requestParameters: UpdateItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
756
- /**
757
- * Update item inventories for a distribution center
758
- * Update item inventories for a distribution center
759
- */
760
- updateItemInventoriesRaw(requestParameters: UpdateItemInventoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
761
- /**
762
- * Update item inventories for a distribution center
763
- * Update item inventories for a distribution center
764
- */
765
- updateItemInventories(requestParameters: UpdateItemInventoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
766
- /**
767
- * Update an item shipping distribution center
768
- * Update an item shipping distribution center
769
- */
770
- updateItemShippingDistributionCenterByCodeRaw(requestParameters: UpdateItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
771
- /**
772
- * Update an item shipping distribution center
773
- * Update an item shipping distribution center
774
- */
775
- updateItemShippingDistributionCenterByCode(requestParameters: UpdateItemShippingDistributionCenterByCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
776
685
  /**
777
686
  * Update multiple item on the UltraCart account.
778
687
  * Update multiple items
@@ -628,74 +628,6 @@ var ItemApi = /** @class */ (function (_super) {
628
628
  });
629
629
  });
630
630
  };
631
- /**
632
- * Retrieve an item shipping distribution center.
633
- * Retrieve an item shipping distribution center
634
- */
635
- ItemApi.prototype.getItemShippingDistributionCenterByCodeRaw = function (requestParameters, initOverrides) {
636
- return __awaiter(this, void 0, void 0, function () {
637
- var queryParameters, headerParameters, _a, _b, response;
638
- return __generator(this, function (_c) {
639
- switch (_c.label) {
640
- case 0:
641
- if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
642
- throw new runtime.RequiredError('merchantItemOid', 'Required parameter requestParameters.merchantItemOid was null or undefined when calling getItemShippingDistributionCenterByCode.');
643
- }
644
- if (requestParameters.distributionCenterCode === null || requestParameters.distributionCenterCode === undefined) {
645
- throw new runtime.RequiredError('distributionCenterCode', 'Required parameter requestParameters.distributionCenterCode was null or undefined when calling getItemShippingDistributionCenterByCode.');
646
- }
647
- queryParameters = {};
648
- if (requestParameters.expand !== undefined) {
649
- queryParameters['_expand'] = requestParameters.expand;
650
- }
651
- if (requestParameters.placeholders !== undefined) {
652
- queryParameters['_placeholders'] = requestParameters.placeholders;
653
- }
654
- headerParameters = {};
655
- if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
656
- // oauth required
657
- _a = headerParameters;
658
- _b = "Authorization";
659
- return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_read"])];
660
- case 1:
661
- // oauth required
662
- _a[_b] = _c.sent();
663
- _c.label = 2;
664
- case 2:
665
- if (this.configuration && this.configuration.apiKey) {
666
- headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
667
- }
668
- return [4 /*yield*/, this.request({
669
- path: "/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}".replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(requestParameters.merchantItemOid))).replace("{".concat("distribution_center_code", "}"), encodeURIComponent(String(requestParameters.distributionCenterCode))),
670
- method: 'GET',
671
- headers: headerParameters,
672
- query: queryParameters,
673
- }, initOverrides)];
674
- case 3:
675
- response = _c.sent();
676
- return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemShippingDistributionCenterResponseFromJSON)(jsonValue); })];
677
- }
678
- });
679
- });
680
- };
681
- /**
682
- * Retrieve an item shipping distribution center.
683
- * Retrieve an item shipping distribution center
684
- */
685
- ItemApi.prototype.getItemShippingDistributionCenterByCode = function (requestParameters, initOverrides) {
686
- return __awaiter(this, void 0, void 0, function () {
687
- var response;
688
- return __generator(this, function (_a) {
689
- switch (_a.label) {
690
- case 0: return [4 /*yield*/, this.getItemShippingDistributionCenterByCodeRaw(requestParameters, initOverrides)];
691
- case 1:
692
- response = _a.sent();
693
- return [4 /*yield*/, response.value()];
694
- case 2: return [2 /*return*/, _a.sent()];
695
- }
696
- });
697
- });
698
- };
699
631
  /**
700
632
  * Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
701
633
  * Retrieve items
@@ -1421,130 +1353,6 @@ var ItemApi = /** @class */ (function (_super) {
1421
1353
  });
1422
1354
  });
1423
1355
  };
1424
- /**
1425
- * Update item inventories for a distribution center
1426
- * Update item inventories for a distribution center
1427
- */
1428
- ItemApi.prototype.updateItemInventoriesRaw = function (requestParameters, initOverrides) {
1429
- return __awaiter(this, void 0, void 0, function () {
1430
- var queryParameters, headerParameters, _a, _b, response;
1431
- return __generator(this, function (_c) {
1432
- switch (_c.label) {
1433
- case 0:
1434
- if (requestParameters.itemInventoryUpdateRequest === null || requestParameters.itemInventoryUpdateRequest === undefined) {
1435
- throw new runtime.RequiredError('itemInventoryUpdateRequest', 'Required parameter requestParameters.itemInventoryUpdateRequest was null or undefined when calling updateItemInventories.');
1436
- }
1437
- queryParameters = {};
1438
- headerParameters = {};
1439
- headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
1440
- if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1441
- // oauth required
1442
- _a = headerParameters;
1443
- _b = "Authorization";
1444
- return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_write"])];
1445
- case 1:
1446
- // oauth required
1447
- _a[_b] = _c.sent();
1448
- _c.label = 2;
1449
- case 2:
1450
- if (this.configuration && this.configuration.apiKey) {
1451
- headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1452
- }
1453
- return [4 /*yield*/, this.request({
1454
- path: "/item/items/update_item_inventories",
1455
- method: 'PUT',
1456
- headers: headerParameters,
1457
- query: queryParameters,
1458
- body: (0, models_1.ItemInventoryUpdateRequestToJSON)(requestParameters.itemInventoryUpdateRequest),
1459
- }, initOverrides)];
1460
- case 3:
1461
- response = _c.sent();
1462
- return [2 /*return*/, new runtime.VoidApiResponse(response)];
1463
- }
1464
- });
1465
- });
1466
- };
1467
- /**
1468
- * Update item inventories for a distribution center
1469
- * Update item inventories for a distribution center
1470
- */
1471
- ItemApi.prototype.updateItemInventories = function (requestParameters, initOverrides) {
1472
- return __awaiter(this, void 0, void 0, function () {
1473
- return __generator(this, function (_a) {
1474
- switch (_a.label) {
1475
- case 0: return [4 /*yield*/, this.updateItemInventoriesRaw(requestParameters, initOverrides)];
1476
- case 1:
1477
- _a.sent();
1478
- return [2 /*return*/];
1479
- }
1480
- });
1481
- });
1482
- };
1483
- /**
1484
- * Update an item shipping distribution center
1485
- * Update an item shipping distribution center
1486
- */
1487
- ItemApi.prototype.updateItemShippingDistributionCenterByCodeRaw = function (requestParameters, initOverrides) {
1488
- return __awaiter(this, void 0, void 0, function () {
1489
- var queryParameters, headerParameters, _a, _b, response;
1490
- return __generator(this, function (_c) {
1491
- switch (_c.label) {
1492
- case 0:
1493
- if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
1494
- throw new runtime.RequiredError('merchantItemOid', 'Required parameter requestParameters.merchantItemOid was null or undefined when calling updateItemShippingDistributionCenterByCode.');
1495
- }
1496
- if (requestParameters.distributionCenterCode === null || requestParameters.distributionCenterCode === undefined) {
1497
- throw new runtime.RequiredError('distributionCenterCode', 'Required parameter requestParameters.distributionCenterCode was null or undefined when calling updateItemShippingDistributionCenterByCode.');
1498
- }
1499
- if (requestParameters.itemShippingDistributionCenter === null || requestParameters.itemShippingDistributionCenter === undefined) {
1500
- throw new runtime.RequiredError('itemShippingDistributionCenter', 'Required parameter requestParameters.itemShippingDistributionCenter was null or undefined when calling updateItemShippingDistributionCenterByCode.');
1501
- }
1502
- queryParameters = {};
1503
- headerParameters = {};
1504
- headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
1505
- if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1506
- // oauth required
1507
- _a = headerParameters;
1508
- _b = "Authorization";
1509
- return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_write"])];
1510
- case 1:
1511
- // oauth required
1512
- _a[_b] = _c.sent();
1513
- _c.label = 2;
1514
- case 2:
1515
- if (this.configuration && this.configuration.apiKey) {
1516
- headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1517
- }
1518
- return [4 /*yield*/, this.request({
1519
- path: "/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}".replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(requestParameters.merchantItemOid))).replace("{".concat("distribution_center_code", "}"), encodeURIComponent(String(requestParameters.distributionCenterCode))),
1520
- method: 'PUT',
1521
- headers: headerParameters,
1522
- query: queryParameters,
1523
- body: (0, models_1.ItemShippingDistributionCenterToJSON)(requestParameters.itemShippingDistributionCenter),
1524
- }, initOverrides)];
1525
- case 3:
1526
- response = _c.sent();
1527
- return [2 /*return*/, new runtime.VoidApiResponse(response)];
1528
- }
1529
- });
1530
- });
1531
- };
1532
- /**
1533
- * Update an item shipping distribution center
1534
- * Update an item shipping distribution center
1535
- */
1536
- ItemApi.prototype.updateItemShippingDistributionCenterByCode = function (requestParameters, initOverrides) {
1537
- return __awaiter(this, void 0, void 0, function () {
1538
- return __generator(this, function (_a) {
1539
- switch (_a.label) {
1540
- case 0: return [4 /*yield*/, this.updateItemShippingDistributionCenterByCodeRaw(requestParameters, initOverrides)];
1541
- case 1:
1542
- _a.sent();
1543
- return [2 /*return*/];
1544
- }
1545
- });
1546
- });
1547
- };
1548
1356
  /**
1549
1357
  * Update multiple item on the UltraCart account.
1550
1358
  * Update multiple items
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAssignToAffiliateRequest, OrderByTokenQuery, OrderEdiDocumentsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
13
+ import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAssignToAffiliateRequest, OrderByTokenQuery, OrderEdiDocumentsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderUpsellCartRequest, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
14
14
  export interface AdjustOrderTotalRequest {
15
15
  orderId: string;
16
16
  desiredTotal: string;
@@ -68,6 +68,11 @@ export interface GetOrderByTokenRequest {
68
68
  export interface GetOrderEdiDocumentsRequest {
69
69
  orderId: string;
70
70
  }
71
+ export interface GetOrderUpsellCartRequest {
72
+ orderId: string;
73
+ upsellCartRequest: OrderUpsellCartRequest;
74
+ expand?: string;
75
+ }
71
76
  export interface GetOrdersRequest {
72
77
  orderId?: string;
73
78
  paymentMethod?: string;
@@ -406,6 +411,22 @@ export interface OrderApiInterface {
406
411
  * Retrieve EDI documents associated with this order.
407
412
  */
408
413
  getOrderEdiDocuments(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEdiDocumentsResponse>;
414
+ /**
415
+ * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
416
+ * @summary Get Order Upsell Cart
417
+ * @param {string} orderId The order id to base things on.
418
+ * @param {OrderUpsellCartRequest} upsellCartRequest Request for the upsell cart
419
+ * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
420
+ * @param {*} [options] Override http request option.
421
+ * @throws {RequiredError}
422
+ * @memberof OrderApiInterface
423
+ */
424
+ getOrderUpsellCartRaw(requestParameters: GetOrderUpsellCartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
425
+ /**
426
+ * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
427
+ * Get Order Upsell Cart
428
+ */
429
+ getOrderUpsellCart(requestParameters: GetOrderUpsellCartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
409
430
  /**
410
431
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
411
432
  * @summary Retrieve orders
@@ -832,6 +853,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
832
853
  * Retrieve EDI documents associated with this order.
833
854
  */
834
855
  getOrderEdiDocuments(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEdiDocumentsResponse>;
856
+ /**
857
+ * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
858
+ * Get Order Upsell Cart
859
+ */
860
+ getOrderUpsellCartRaw(requestParameters: GetOrderUpsellCartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
861
+ /**
862
+ * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
863
+ * Get Order Upsell Cart
864
+ */
865
+ getOrderUpsellCart(requestParameters: GetOrderUpsellCartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
835
866
  /**
836
867
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
837
868
  * Retrieve orders
@@ -1055,6 +1055,73 @@ var OrderApi = /** @class */ (function (_super) {
1055
1055
  });
1056
1056
  });
1057
1057
  };
1058
+ /**
1059
+ * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
1060
+ * Get Order Upsell Cart
1061
+ */
1062
+ OrderApi.prototype.getOrderUpsellCartRaw = function (requestParameters, initOverrides) {
1063
+ return __awaiter(this, void 0, void 0, function () {
1064
+ var queryParameters, headerParameters, _a, _b, response;
1065
+ return __generator(this, function (_c) {
1066
+ switch (_c.label) {
1067
+ case 0:
1068
+ if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
1069
+ throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling getOrderUpsellCart.');
1070
+ }
1071
+ if (requestParameters.upsellCartRequest === null || requestParameters.upsellCartRequest === undefined) {
1072
+ throw new runtime.RequiredError('upsellCartRequest', 'Required parameter requestParameters.upsellCartRequest was null or undefined when calling getOrderUpsellCart.');
1073
+ }
1074
+ queryParameters = {};
1075
+ if (requestParameters.expand !== undefined) {
1076
+ queryParameters['_expand'] = requestParameters.expand;
1077
+ }
1078
+ headerParameters = {};
1079
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
1080
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1081
+ // oauth required
1082
+ _a = headerParameters;
1083
+ _b = "Authorization";
1084
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_read"])];
1085
+ case 1:
1086
+ // oauth required
1087
+ _a[_b] = _c.sent();
1088
+ _c.label = 2;
1089
+ case 2:
1090
+ if (this.configuration && this.configuration.apiKey) {
1091
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1092
+ }
1093
+ return [4 /*yield*/, this.request({
1094
+ path: "/order/orders/{order_id}/upsell_with_cart".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
1095
+ method: 'PUT',
1096
+ headers: headerParameters,
1097
+ query: queryParameters,
1098
+ body: (0, models_1.OrderUpsellCartRequestToJSON)(requestParameters.upsellCartRequest),
1099
+ }, initOverrides)];
1100
+ case 3:
1101
+ response = _c.sent();
1102
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderResponseFromJSON)(jsonValue); })];
1103
+ }
1104
+ });
1105
+ });
1106
+ };
1107
+ /**
1108
+ * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
1109
+ * Get Order Upsell Cart
1110
+ */
1111
+ OrderApi.prototype.getOrderUpsellCart = function (requestParameters, initOverrides) {
1112
+ return __awaiter(this, void 0, void 0, function () {
1113
+ var response;
1114
+ return __generator(this, function (_a) {
1115
+ switch (_a.label) {
1116
+ case 0: return [4 /*yield*/, this.getOrderUpsellCartRaw(requestParameters, initOverrides)];
1117
+ case 1:
1118
+ response = _a.sent();
1119
+ return [4 /*yield*/, response.value()];
1120
+ case 2: return [2 /*return*/, _a.sent()];
1121
+ }
1122
+ });
1123
+ });
1124
+ };
1058
1125
  /**
1059
1126
  * Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
1060
1127
  * Retrieve orders
@@ -76,7 +76,7 @@ export interface EmailCommseqPostcard {
76
76
  */
77
77
  postcard_front_container_uuid?: string;
78
78
  /**
79
- * URL to screenshot of the back of the postcard
79
+ * URL to screenshot of the front of the postcard
80
80
  * @type {string}
81
81
  * @memberof EmailCommseqPostcard
82
82
  */
@@ -0,0 +1,44 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { CartItem } from './CartItem';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface OrderUpsellCartRequest
17
+ */
18
+ export interface OrderUpsellCartRequest {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof OrderUpsellCartRequest
23
+ */
24
+ checkout_url?: string;
25
+ /**
26
+ *
27
+ * @type {Array<string>}
28
+ * @memberof OrderUpsellCartRequest
29
+ */
30
+ coupon_codes?: Array<string>;
31
+ /**
32
+ *
33
+ * @type {Array<CartItem>}
34
+ * @memberof OrderUpsellCartRequest
35
+ */
36
+ items?: Array<CartItem>;
37
+ }
38
+ /**
39
+ * Check if a given object implements the OrderUpsellCartRequest interface.
40
+ */
41
+ export declare function instanceOfOrderUpsellCartRequest(value: object): boolean;
42
+ export declare function OrderUpsellCartRequestFromJSON(json: any): OrderUpsellCartRequest;
43
+ export declare function OrderUpsellCartRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderUpsellCartRequest;
44
+ export declare function OrderUpsellCartRequestToJSON(value?: OrderUpsellCartRequest | null): any;