ultracart_rest_api_v2_typescript 4.1.62 → 4.1.63
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 +7 -0
- package/README.md +3 -2
- package/dist/apis/AutoOrderApi.d.ts +98 -1
- package/dist/apis/AutoOrderApi.js +207 -0
- package/dist/apis/ConversationApi.d.ts +28 -1
- package/dist/apis/ConversationApi.js +59 -0
- package/dist/apis/ItemApi.d.ts +92 -1
- package/dist/apis/ItemApi.js +192 -0
- package/dist/apis/OrderApi.d.ts +61 -1
- package/dist/apis/OrderApi.js +129 -0
- package/dist/models/AutoOrder.d.ts +7 -0
- package/dist/models/AutoOrder.js +3 -0
- package/dist/models/AutoOrderAddonItemsUpdateRequest.d.ts +32 -0
- package/dist/models/AutoOrderAddonItemsUpdateRequest.js +51 -0
- package/dist/models/AutoOrderItem.d.ts +14 -0
- package/dist/models/AutoOrderItem.js +6 -0
- package/dist/models/AutoOrderPropertiesUpdateRequest.d.ts +32 -0
- package/dist/models/AutoOrderPropertiesUpdateRequest.js +51 -0
- package/dist/models/AutoOrderProperty.d.ts +37 -0
- package/dist/models/AutoOrderProperty.js +52 -0
- package/dist/models/EmailCommseqPostcard.d.ts +1 -1
- package/dist/models/ItemInventoryUpdate.d.ts +43 -0
- package/dist/models/ItemInventoryUpdateRequest.d.ts +32 -0
- package/dist/models/ItemShipping.d.ts +6 -0
- package/dist/models/ItemShipping.js +2 -0
- package/dist/models/ItemShippingDistributionCenterResponse.d.ts +59 -0
- package/dist/models/OrderAddItemsAndReleaseRequest.d.ts +32 -0
- package/dist/models/OrderAddItemsAndReleaseRequest.js +51 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/package.json +1 -1
- package/src/apis/AutoOrderApi.ts +246 -0
- package/src/apis/ConversationApi.ts +64 -0
- package/src/apis/ItemApi.ts +226 -0
- package/src/apis/OrderApi.ts +146 -0
- package/src/models/AutoOrder.ts +14 -0
- package/src/models/AutoOrderAddonItemsUpdateRequest.ts +74 -0
- package/src/models/AutoOrderItem.ts +28 -0
- package/src/models/AutoOrderPropertiesUpdateRequest.ts +74 -0
- package/src/models/AutoOrderProperty.ts +75 -0
- package/src/models/EmailCommseqPostcard.ts +1 -1
- package/src/models/ItemInventoryUpdate.ts +83 -0
- package/src/models/ItemInventoryUpdateRequest.ts +74 -0
- package/src/models/ItemShipping.ts +8 -0
- package/src/models/ItemShippingDistributionCenterResponse.ts +124 -0
- package/src/models/OrderAddItemsAndReleaseRequest.ts +74 -0
- package/src/models/index.ts +7 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -49,6 +49,7 @@ src/models/ApplyLibraryItemResponse.ts
|
|
|
49
49
|
src/models/AutoOrder.ts
|
|
50
50
|
src/models/AutoOrderAddonItem.ts
|
|
51
51
|
src/models/AutoOrderAddonItemOption.ts
|
|
52
|
+
src/models/AutoOrderAddonItemsUpdateRequest.ts
|
|
52
53
|
src/models/AutoOrderConsolidate.ts
|
|
53
54
|
src/models/AutoOrderItem.ts
|
|
54
55
|
src/models/AutoOrderItemFutureSchedule.ts
|
|
@@ -56,6 +57,8 @@ src/models/AutoOrderItemOption.ts
|
|
|
56
57
|
src/models/AutoOrderItemSimpleSchedule.ts
|
|
57
58
|
src/models/AutoOrderLog.ts
|
|
58
59
|
src/models/AutoOrderManagement.ts
|
|
60
|
+
src/models/AutoOrderPropertiesUpdateRequest.ts
|
|
61
|
+
src/models/AutoOrderProperty.ts
|
|
59
62
|
src/models/AutoOrderQuery.ts
|
|
60
63
|
src/models/AutoOrderQueryBatch.ts
|
|
61
64
|
src/models/AutoOrderResponse.ts
|
|
@@ -645,6 +648,8 @@ src/models/ItemInternal.ts
|
|
|
645
648
|
src/models/ItemInventorySnapshot.ts
|
|
646
649
|
src/models/ItemInventorySnapshotDistributionCenter.ts
|
|
647
650
|
src/models/ItemInventorySnapshotResponse.ts
|
|
651
|
+
src/models/ItemInventoryUpdate.ts
|
|
652
|
+
src/models/ItemInventoryUpdateRequest.ts
|
|
648
653
|
src/models/ItemKitComponent.ts
|
|
649
654
|
src/models/ItemKitDefinition.ts
|
|
650
655
|
src/models/ItemOption.ts
|
|
@@ -676,6 +681,7 @@ src/models/ItemShippingCase.ts
|
|
|
676
681
|
src/models/ItemShippingDestinationMarkup.ts
|
|
677
682
|
src/models/ItemShippingDestinationRestriction.ts
|
|
678
683
|
src/models/ItemShippingDistributionCenter.ts
|
|
684
|
+
src/models/ItemShippingDistributionCenterResponse.ts
|
|
679
685
|
src/models/ItemShippingMethod.ts
|
|
680
686
|
src/models/ItemShippingPackageRequirement.ts
|
|
681
687
|
src/models/ItemTag.ts
|
|
@@ -714,6 +720,7 @@ src/models/Notification.ts
|
|
|
714
720
|
src/models/OauthRevokeSuccessResponse.ts
|
|
715
721
|
src/models/OauthTokenResponse.ts
|
|
716
722
|
src/models/Order.ts
|
|
723
|
+
src/models/OrderAddItemsAndReleaseRequest.ts
|
|
717
724
|
src/models/OrderAffiliate.ts
|
|
718
725
|
src/models/OrderAffiliateLedger.ts
|
|
719
726
|
src/models/OrderAssignToAffiliateRequest.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.63
|
|
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.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.63 --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.63 | 02/12/2026 | build automation issue |
|
|
88
89
|
| 4.1.62 | 02/12/2026 | build automation run, no code changes |
|
|
89
90
|
| 4.1.61 | 02/12/2026 | order - methods to release held orders |
|
|
90
91
|
| 4.1.60 | 02/12/2026 | auto order - properties, item add-ons, and item properties |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { AutoOrder, AutoOrderConsolidate, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
|
|
13
|
+
import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderConsolidate, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
|
|
14
14
|
export interface ConsolidateAutoOrdersRequest {
|
|
15
15
|
autoOrderOid: number;
|
|
16
16
|
autoOrderConsolidate: AutoOrderConsolidate;
|
|
@@ -79,6 +79,23 @@ export interface UpdateAutoOrderRequest {
|
|
|
79
79
|
validateOriginalOrder?: string;
|
|
80
80
|
expand?: string;
|
|
81
81
|
}
|
|
82
|
+
export interface UpdateAutoOrderItemAddOnsRequest {
|
|
83
|
+
autoOrderOid: number;
|
|
84
|
+
autoOrderItemOid: number;
|
|
85
|
+
autoOrderAddOnsUpdateRequest: AutoOrderAddonItemsUpdateRequest;
|
|
86
|
+
expand?: string;
|
|
87
|
+
}
|
|
88
|
+
export interface UpdateAutoOrderItemPropertiesRequest {
|
|
89
|
+
autoOrderOid: number;
|
|
90
|
+
autoOrderItemOid: number;
|
|
91
|
+
autoOrderPropertiesUpdateRequest: AutoOrderPropertiesUpdateRequest;
|
|
92
|
+
expand?: string;
|
|
93
|
+
}
|
|
94
|
+
export interface UpdateAutoOrderPropertiesRequest {
|
|
95
|
+
autoOrderOid: number;
|
|
96
|
+
autoOrderPropertiesUpdateRequest: AutoOrderPropertiesUpdateRequest;
|
|
97
|
+
expand?: string;
|
|
98
|
+
}
|
|
82
99
|
export interface UpdateAutoOrdersBatchRequest {
|
|
83
100
|
autoOrdersRequest: AutoOrdersRequest;
|
|
84
101
|
expand?: string;
|
|
@@ -270,6 +287,56 @@ export interface AutoOrderApiInterface {
|
|
|
270
287
|
* Update an auto order
|
|
271
288
|
*/
|
|
272
289
|
updateAutoOrder(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
290
|
+
/**
|
|
291
|
+
* Update an auto order item add ons. Returns the auto order based upon expansion
|
|
292
|
+
* @summary Update an auto order item add ons
|
|
293
|
+
* @param {number} autoOrderOid The auto order oid to update.
|
|
294
|
+
* @param {number} autoOrderItemOid The auto order item oid to update.
|
|
295
|
+
* @param {AutoOrderAddonItemsUpdateRequest} autoOrderAddOnsUpdateRequest Auto order add ons update request
|
|
296
|
+
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
297
|
+
* @param {*} [options] Override http request option.
|
|
298
|
+
* @throws {RequiredError}
|
|
299
|
+
* @memberof AutoOrderApiInterface
|
|
300
|
+
*/
|
|
301
|
+
updateAutoOrderItemAddOnsRaw(requestParameters: UpdateAutoOrderItemAddOnsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
|
|
302
|
+
/**
|
|
303
|
+
* Update an auto order item add ons. Returns the auto order based upon expansion
|
|
304
|
+
* Update an auto order item add ons
|
|
305
|
+
*/
|
|
306
|
+
updateAutoOrderItemAddOns(requestParameters: UpdateAutoOrderItemAddOnsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
307
|
+
/**
|
|
308
|
+
* Update an auto order item properties. Returns the auto order based upon expansion
|
|
309
|
+
* @summary Update an auto order item properties
|
|
310
|
+
* @param {number} autoOrderOid The auto order oid to update.
|
|
311
|
+
* @param {number} autoOrderItemOid The auto order item oid to update.
|
|
312
|
+
* @param {AutoOrderPropertiesUpdateRequest} autoOrderPropertiesUpdateRequest Auto order property update request
|
|
313
|
+
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
314
|
+
* @param {*} [options] Override http request option.
|
|
315
|
+
* @throws {RequiredError}
|
|
316
|
+
* @memberof AutoOrderApiInterface
|
|
317
|
+
*/
|
|
318
|
+
updateAutoOrderItemPropertiesRaw(requestParameters: UpdateAutoOrderItemPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
|
|
319
|
+
/**
|
|
320
|
+
* Update an auto order item properties. Returns the auto order based upon expansion
|
|
321
|
+
* Update an auto order item properties
|
|
322
|
+
*/
|
|
323
|
+
updateAutoOrderItemProperties(requestParameters: UpdateAutoOrderItemPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
324
|
+
/**
|
|
325
|
+
* Update an auto order properties. Returns the auto order based upon expansion
|
|
326
|
+
* @summary Update an auto order properties
|
|
327
|
+
* @param {number} autoOrderOid The auto order oid to update.
|
|
328
|
+
* @param {AutoOrderPropertiesUpdateRequest} autoOrderPropertiesUpdateRequest Auto order property update request
|
|
329
|
+
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
330
|
+
* @param {*} [options] Override http request option.
|
|
331
|
+
* @throws {RequiredError}
|
|
332
|
+
* @memberof AutoOrderApiInterface
|
|
333
|
+
*/
|
|
334
|
+
updateAutoOrderPropertiesRaw(requestParameters: UpdateAutoOrderPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
|
|
335
|
+
/**
|
|
336
|
+
* Update an auto order properties. Returns the auto order based upon expansion
|
|
337
|
+
* Update an auto order properties
|
|
338
|
+
*/
|
|
339
|
+
updateAutoOrderProperties(requestParameters: UpdateAutoOrderPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
273
340
|
/**
|
|
274
341
|
* Update multiple auto orders on the UltraCart account.
|
|
275
342
|
* @summary Update multiple auto orders
|
|
@@ -392,6 +459,36 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
|
|
|
392
459
|
* Update an auto order
|
|
393
460
|
*/
|
|
394
461
|
updateAutoOrder(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
462
|
+
/**
|
|
463
|
+
* Update an auto order item add ons. Returns the auto order based upon expansion
|
|
464
|
+
* Update an auto order item add ons
|
|
465
|
+
*/
|
|
466
|
+
updateAutoOrderItemAddOnsRaw(requestParameters: UpdateAutoOrderItemAddOnsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
|
|
467
|
+
/**
|
|
468
|
+
* Update an auto order item add ons. Returns the auto order based upon expansion
|
|
469
|
+
* Update an auto order item add ons
|
|
470
|
+
*/
|
|
471
|
+
updateAutoOrderItemAddOns(requestParameters: UpdateAutoOrderItemAddOnsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
472
|
+
/**
|
|
473
|
+
* Update an auto order item properties. Returns the auto order based upon expansion
|
|
474
|
+
* Update an auto order item properties
|
|
475
|
+
*/
|
|
476
|
+
updateAutoOrderItemPropertiesRaw(requestParameters: UpdateAutoOrderItemPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
|
|
477
|
+
/**
|
|
478
|
+
* Update an auto order item properties. Returns the auto order based upon expansion
|
|
479
|
+
* Update an auto order item properties
|
|
480
|
+
*/
|
|
481
|
+
updateAutoOrderItemProperties(requestParameters: UpdateAutoOrderItemPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
482
|
+
/**
|
|
483
|
+
* Update an auto order properties. Returns the auto order based upon expansion
|
|
484
|
+
* Update an auto order properties
|
|
485
|
+
*/
|
|
486
|
+
updateAutoOrderPropertiesRaw(requestParameters: UpdateAutoOrderPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
|
|
487
|
+
/**
|
|
488
|
+
* Update an auto order properties. Returns the auto order based upon expansion
|
|
489
|
+
* Update an auto order properties
|
|
490
|
+
*/
|
|
491
|
+
updateAutoOrderProperties(requestParameters: UpdateAutoOrderPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
395
492
|
/**
|
|
396
493
|
* Update multiple auto orders on the UltraCart account.
|
|
397
494
|
* Update multiple auto orders
|
|
@@ -790,6 +790,213 @@ var AutoOrderApi = /** @class */ (function (_super) {
|
|
|
790
790
|
});
|
|
791
791
|
});
|
|
792
792
|
};
|
|
793
|
+
/**
|
|
794
|
+
* Update an auto order item add ons. Returns the auto order based upon expansion
|
|
795
|
+
* Update an auto order item add ons
|
|
796
|
+
*/
|
|
797
|
+
AutoOrderApi.prototype.updateAutoOrderItemAddOnsRaw = function (requestParameters, initOverrides) {
|
|
798
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
799
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
800
|
+
return __generator(this, function (_c) {
|
|
801
|
+
switch (_c.label) {
|
|
802
|
+
case 0:
|
|
803
|
+
if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
|
|
804
|
+
throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling updateAutoOrderItemAddOns.');
|
|
805
|
+
}
|
|
806
|
+
if (requestParameters.autoOrderItemOid === null || requestParameters.autoOrderItemOid === undefined) {
|
|
807
|
+
throw new runtime.RequiredError('autoOrderItemOid', 'Required parameter requestParameters.autoOrderItemOid was null or undefined when calling updateAutoOrderItemAddOns.');
|
|
808
|
+
}
|
|
809
|
+
if (requestParameters.autoOrderAddOnsUpdateRequest === null || requestParameters.autoOrderAddOnsUpdateRequest === undefined) {
|
|
810
|
+
throw new runtime.RequiredError('autoOrderAddOnsUpdateRequest', 'Required parameter requestParameters.autoOrderAddOnsUpdateRequest was null or undefined when calling updateAutoOrderItemAddOns.');
|
|
811
|
+
}
|
|
812
|
+
queryParameters = {};
|
|
813
|
+
if (requestParameters.expand !== undefined) {
|
|
814
|
+
queryParameters['_expand'] = requestParameters.expand;
|
|
815
|
+
}
|
|
816
|
+
headerParameters = {};
|
|
817
|
+
headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
|
|
818
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
819
|
+
// oauth required
|
|
820
|
+
_a = headerParameters;
|
|
821
|
+
_b = "Authorization";
|
|
822
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
|
|
823
|
+
case 1:
|
|
824
|
+
// oauth required
|
|
825
|
+
_a[_b] = _c.sent();
|
|
826
|
+
_c.label = 2;
|
|
827
|
+
case 2:
|
|
828
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
829
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
830
|
+
}
|
|
831
|
+
return [4 /*yield*/, this.request({
|
|
832
|
+
path: "/auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))).replace("{".concat("auto_order_item_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderItemOid))),
|
|
833
|
+
method: 'PUT',
|
|
834
|
+
headers: headerParameters,
|
|
835
|
+
query: queryParameters,
|
|
836
|
+
body: (0, models_1.AutoOrderAddonItemsUpdateRequestToJSON)(requestParameters.autoOrderAddOnsUpdateRequest),
|
|
837
|
+
}, initOverrides)];
|
|
838
|
+
case 3:
|
|
839
|
+
response = _c.sent();
|
|
840
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderResponseFromJSON)(jsonValue); })];
|
|
841
|
+
}
|
|
842
|
+
});
|
|
843
|
+
});
|
|
844
|
+
};
|
|
845
|
+
/**
|
|
846
|
+
* Update an auto order item add ons. Returns the auto order based upon expansion
|
|
847
|
+
* Update an auto order item add ons
|
|
848
|
+
*/
|
|
849
|
+
AutoOrderApi.prototype.updateAutoOrderItemAddOns = function (requestParameters, initOverrides) {
|
|
850
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
851
|
+
var response;
|
|
852
|
+
return __generator(this, function (_a) {
|
|
853
|
+
switch (_a.label) {
|
|
854
|
+
case 0: return [4 /*yield*/, this.updateAutoOrderItemAddOnsRaw(requestParameters, initOverrides)];
|
|
855
|
+
case 1:
|
|
856
|
+
response = _a.sent();
|
|
857
|
+
return [4 /*yield*/, response.value()];
|
|
858
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
859
|
+
}
|
|
860
|
+
});
|
|
861
|
+
});
|
|
862
|
+
};
|
|
863
|
+
/**
|
|
864
|
+
* Update an auto order item properties. Returns the auto order based upon expansion
|
|
865
|
+
* Update an auto order item properties
|
|
866
|
+
*/
|
|
867
|
+
AutoOrderApi.prototype.updateAutoOrderItemPropertiesRaw = function (requestParameters, initOverrides) {
|
|
868
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
869
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
870
|
+
return __generator(this, function (_c) {
|
|
871
|
+
switch (_c.label) {
|
|
872
|
+
case 0:
|
|
873
|
+
if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
|
|
874
|
+
throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling updateAutoOrderItemProperties.');
|
|
875
|
+
}
|
|
876
|
+
if (requestParameters.autoOrderItemOid === null || requestParameters.autoOrderItemOid === undefined) {
|
|
877
|
+
throw new runtime.RequiredError('autoOrderItemOid', 'Required parameter requestParameters.autoOrderItemOid was null or undefined when calling updateAutoOrderItemProperties.');
|
|
878
|
+
}
|
|
879
|
+
if (requestParameters.autoOrderPropertiesUpdateRequest === null || requestParameters.autoOrderPropertiesUpdateRequest === undefined) {
|
|
880
|
+
throw new runtime.RequiredError('autoOrderPropertiesUpdateRequest', 'Required parameter requestParameters.autoOrderPropertiesUpdateRequest was null or undefined when calling updateAutoOrderItemProperties.');
|
|
881
|
+
}
|
|
882
|
+
queryParameters = {};
|
|
883
|
+
if (requestParameters.expand !== undefined) {
|
|
884
|
+
queryParameters['_expand'] = requestParameters.expand;
|
|
885
|
+
}
|
|
886
|
+
headerParameters = {};
|
|
887
|
+
headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
|
|
888
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
889
|
+
// oauth required
|
|
890
|
+
_a = headerParameters;
|
|
891
|
+
_b = "Authorization";
|
|
892
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
|
|
893
|
+
case 1:
|
|
894
|
+
// oauth required
|
|
895
|
+
_a[_b] = _c.sent();
|
|
896
|
+
_c.label = 2;
|
|
897
|
+
case 2:
|
|
898
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
899
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
900
|
+
}
|
|
901
|
+
return [4 /*yield*/, this.request({
|
|
902
|
+
path: "/auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))).replace("{".concat("auto_order_item_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderItemOid))),
|
|
903
|
+
method: 'PUT',
|
|
904
|
+
headers: headerParameters,
|
|
905
|
+
query: queryParameters,
|
|
906
|
+
body: (0, models_1.AutoOrderPropertiesUpdateRequestToJSON)(requestParameters.autoOrderPropertiesUpdateRequest),
|
|
907
|
+
}, initOverrides)];
|
|
908
|
+
case 3:
|
|
909
|
+
response = _c.sent();
|
|
910
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderResponseFromJSON)(jsonValue); })];
|
|
911
|
+
}
|
|
912
|
+
});
|
|
913
|
+
});
|
|
914
|
+
};
|
|
915
|
+
/**
|
|
916
|
+
* Update an auto order item properties. Returns the auto order based upon expansion
|
|
917
|
+
* Update an auto order item properties
|
|
918
|
+
*/
|
|
919
|
+
AutoOrderApi.prototype.updateAutoOrderItemProperties = function (requestParameters, initOverrides) {
|
|
920
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
921
|
+
var response;
|
|
922
|
+
return __generator(this, function (_a) {
|
|
923
|
+
switch (_a.label) {
|
|
924
|
+
case 0: return [4 /*yield*/, this.updateAutoOrderItemPropertiesRaw(requestParameters, initOverrides)];
|
|
925
|
+
case 1:
|
|
926
|
+
response = _a.sent();
|
|
927
|
+
return [4 /*yield*/, response.value()];
|
|
928
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
929
|
+
}
|
|
930
|
+
});
|
|
931
|
+
});
|
|
932
|
+
};
|
|
933
|
+
/**
|
|
934
|
+
* Update an auto order properties. Returns the auto order based upon expansion
|
|
935
|
+
* Update an auto order properties
|
|
936
|
+
*/
|
|
937
|
+
AutoOrderApi.prototype.updateAutoOrderPropertiesRaw = function (requestParameters, initOverrides) {
|
|
938
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
939
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
940
|
+
return __generator(this, function (_c) {
|
|
941
|
+
switch (_c.label) {
|
|
942
|
+
case 0:
|
|
943
|
+
if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
|
|
944
|
+
throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling updateAutoOrderProperties.');
|
|
945
|
+
}
|
|
946
|
+
if (requestParameters.autoOrderPropertiesUpdateRequest === null || requestParameters.autoOrderPropertiesUpdateRequest === undefined) {
|
|
947
|
+
throw new runtime.RequiredError('autoOrderPropertiesUpdateRequest', 'Required parameter requestParameters.autoOrderPropertiesUpdateRequest was null or undefined when calling updateAutoOrderProperties.');
|
|
948
|
+
}
|
|
949
|
+
queryParameters = {};
|
|
950
|
+
if (requestParameters.expand !== undefined) {
|
|
951
|
+
queryParameters['_expand'] = requestParameters.expand;
|
|
952
|
+
}
|
|
953
|
+
headerParameters = {};
|
|
954
|
+
headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
|
|
955
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
956
|
+
// oauth required
|
|
957
|
+
_a = headerParameters;
|
|
958
|
+
_b = "Authorization";
|
|
959
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
|
|
960
|
+
case 1:
|
|
961
|
+
// oauth required
|
|
962
|
+
_a[_b] = _c.sent();
|
|
963
|
+
_c.label = 2;
|
|
964
|
+
case 2:
|
|
965
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
966
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
967
|
+
}
|
|
968
|
+
return [4 /*yield*/, this.request({
|
|
969
|
+
path: "/auto_order/auto_orders/{auto_order_oid}/properties".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))),
|
|
970
|
+
method: 'PUT',
|
|
971
|
+
headers: headerParameters,
|
|
972
|
+
query: queryParameters,
|
|
973
|
+
body: (0, models_1.AutoOrderPropertiesUpdateRequestToJSON)(requestParameters.autoOrderPropertiesUpdateRequest),
|
|
974
|
+
}, initOverrides)];
|
|
975
|
+
case 3:
|
|
976
|
+
response = _c.sent();
|
|
977
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderResponseFromJSON)(jsonValue); })];
|
|
978
|
+
}
|
|
979
|
+
});
|
|
980
|
+
});
|
|
981
|
+
};
|
|
982
|
+
/**
|
|
983
|
+
* Update an auto order properties. Returns the auto order based upon expansion
|
|
984
|
+
* Update an auto order properties
|
|
985
|
+
*/
|
|
986
|
+
AutoOrderApi.prototype.updateAutoOrderProperties = function (requestParameters, initOverrides) {
|
|
987
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
988
|
+
var response;
|
|
989
|
+
return __generator(this, function (_a) {
|
|
990
|
+
switch (_a.label) {
|
|
991
|
+
case 0: return [4 /*yield*/, this.updateAutoOrderPropertiesRaw(requestParameters, initOverrides)];
|
|
992
|
+
case 1:
|
|
993
|
+
response = _a.sent();
|
|
994
|
+
return [4 /*yield*/, response.value()];
|
|
995
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
996
|
+
}
|
|
997
|
+
});
|
|
998
|
+
});
|
|
999
|
+
};
|
|
793
1000
|
/**
|
|
794
1001
|
* Update multiple auto orders on the UltraCart account.
|
|
795
1002
|
* Update multiple auto orders
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { BaseResponse, ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCallResponse, ConversationPbxCallSearchRequest, ConversationPbxCallSearchResponse, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
|
|
13
|
+
import { BaseResponse, ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCallResponse, ConversationPbxCallSearchRequest, ConversationPbxCallSearchResponse, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse, ItemResponse } from '../models';
|
|
14
14
|
export interface DeleteAgentProfileKnowledgeBaseDocumentRequest {
|
|
15
15
|
userId: number;
|
|
16
16
|
documentUuid: string;
|
|
@@ -89,6 +89,9 @@ export interface GetConversationContextRequest {
|
|
|
89
89
|
export interface GetConversationEngagementRequest {
|
|
90
90
|
conversationEngagementOid: number;
|
|
91
91
|
}
|
|
92
|
+
export interface GetConversationItemVariationsRequest {
|
|
93
|
+
merchantItemId: string;
|
|
94
|
+
}
|
|
92
95
|
export interface GetConversationKnowledgeBaseDocumentUploadUrlRequest {
|
|
93
96
|
userId: number;
|
|
94
97
|
extension: string;
|
|
@@ -799,6 +802,20 @@ export interface ConversationApiInterface {
|
|
|
799
802
|
* Retrieve a list of engagements ordered by name
|
|
800
803
|
*/
|
|
801
804
|
getConversationEngagements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementsResponse>;
|
|
805
|
+
/**
|
|
806
|
+
* Retrieve an item with sparse variations populated
|
|
807
|
+
* @summary Retrieve an item with sparse variations populated
|
|
808
|
+
* @param {string} merchantItemId
|
|
809
|
+
* @param {*} [options] Override http request option.
|
|
810
|
+
* @throws {RequiredError}
|
|
811
|
+
* @memberof ConversationApiInterface
|
|
812
|
+
*/
|
|
813
|
+
getConversationItemVariationsRaw(requestParameters: GetConversationItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemResponse>>;
|
|
814
|
+
/**
|
|
815
|
+
* Retrieve an item with sparse variations populated
|
|
816
|
+
* Retrieve an item with sparse variations populated
|
|
817
|
+
*/
|
|
818
|
+
getConversationItemVariations(requestParameters: GetConversationItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
802
819
|
/**
|
|
803
820
|
* Get a pre-signed conversation knowledge base document upload URL
|
|
804
821
|
* @summary Get a pre-signed conversation knowledge base document upload URL
|
|
@@ -2407,6 +2424,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
2407
2424
|
* Retrieve a list of engagements ordered by name
|
|
2408
2425
|
*/
|
|
2409
2426
|
getConversationEngagements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementsResponse>;
|
|
2427
|
+
/**
|
|
2428
|
+
* Retrieve an item with sparse variations populated
|
|
2429
|
+
* Retrieve an item with sparse variations populated
|
|
2430
|
+
*/
|
|
2431
|
+
getConversationItemVariationsRaw(requestParameters: GetConversationItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemResponse>>;
|
|
2432
|
+
/**
|
|
2433
|
+
* Retrieve an item with sparse variations populated
|
|
2434
|
+
* Retrieve an item with sparse variations populated
|
|
2435
|
+
*/
|
|
2436
|
+
getConversationItemVariations(requestParameters: GetConversationItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemResponse>;
|
|
2410
2437
|
/**
|
|
2411
2438
|
* Get a pre-signed conversation knowledge base document upload URL
|
|
2412
2439
|
* Get a pre-signed conversation knowledge base document upload URL
|
|
@@ -1941,6 +1941,65 @@ var ConversationApi = /** @class */ (function (_super) {
|
|
|
1941
1941
|
});
|
|
1942
1942
|
});
|
|
1943
1943
|
};
|
|
1944
|
+
/**
|
|
1945
|
+
* Retrieve an item with sparse variations populated
|
|
1946
|
+
* Retrieve an item with sparse variations populated
|
|
1947
|
+
*/
|
|
1948
|
+
ConversationApi.prototype.getConversationItemVariationsRaw = function (requestParameters, initOverrides) {
|
|
1949
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1950
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
1951
|
+
return __generator(this, function (_c) {
|
|
1952
|
+
switch (_c.label) {
|
|
1953
|
+
case 0:
|
|
1954
|
+
if (requestParameters.merchantItemId === null || requestParameters.merchantItemId === undefined) {
|
|
1955
|
+
throw new runtime.RequiredError('merchantItemId', 'Required parameter requestParameters.merchantItemId was null or undefined when calling getConversationItemVariations.');
|
|
1956
|
+
}
|
|
1957
|
+
queryParameters = {};
|
|
1958
|
+
headerParameters = {};
|
|
1959
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
1960
|
+
// oauth required
|
|
1961
|
+
_a = headerParameters;
|
|
1962
|
+
_b = "Authorization";
|
|
1963
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_read"])];
|
|
1964
|
+
case 1:
|
|
1965
|
+
// oauth required
|
|
1966
|
+
_a[_b] = _c.sent();
|
|
1967
|
+
_c.label = 2;
|
|
1968
|
+
case 2:
|
|
1969
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1970
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1971
|
+
}
|
|
1972
|
+
return [4 /*yield*/, this.request({
|
|
1973
|
+
path: "/conversation/items/{merchant_item_id}/variations".replace("{".concat("merchant_item_id", "}"), encodeURIComponent(String(requestParameters.merchantItemId))),
|
|
1974
|
+
method: 'GET',
|
|
1975
|
+
headers: headerParameters,
|
|
1976
|
+
query: queryParameters,
|
|
1977
|
+
}, initOverrides)];
|
|
1978
|
+
case 3:
|
|
1979
|
+
response = _c.sent();
|
|
1980
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemResponseFromJSON)(jsonValue); })];
|
|
1981
|
+
}
|
|
1982
|
+
});
|
|
1983
|
+
});
|
|
1984
|
+
};
|
|
1985
|
+
/**
|
|
1986
|
+
* Retrieve an item with sparse variations populated
|
|
1987
|
+
* Retrieve an item with sparse variations populated
|
|
1988
|
+
*/
|
|
1989
|
+
ConversationApi.prototype.getConversationItemVariations = function (requestParameters, initOverrides) {
|
|
1990
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1991
|
+
var response;
|
|
1992
|
+
return __generator(this, function (_a) {
|
|
1993
|
+
switch (_a.label) {
|
|
1994
|
+
case 0: return [4 /*yield*/, this.getConversationItemVariationsRaw(requestParameters, initOverrides)];
|
|
1995
|
+
case 1:
|
|
1996
|
+
response = _a.sent();
|
|
1997
|
+
return [4 /*yield*/, response.value()];
|
|
1998
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
1999
|
+
}
|
|
2000
|
+
});
|
|
2001
|
+
});
|
|
2002
|
+
};
|
|
1944
2003
|
/**
|
|
1945
2004
|
* Get a pre-signed conversation knowledge base document upload URL
|
|
1946
2005
|
* Get a pre-signed conversation knowledge base document upload URL
|