ultracart_rest_api_v2_typescript 4.1.86 → 4.1.87
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 +4 -0
- package/README.md +3 -2
- package/dist/apis/AutoOrderApi.d.ts +28 -1
- package/dist/apis/AutoOrderApi.js +59 -0
- package/dist/apis/OrderApi.d.ts +28 -1
- package/dist/apis/OrderApi.js +59 -0
- package/dist/models/AutoOrder.d.ts +7 -0
- package/dist/models/AutoOrder.js +3 -0
- package/dist/models/AutoOrderEmail.d.ts +139 -0
- package/dist/models/AutoOrderEmail.js +86 -0
- package/dist/models/AutoOrderEmailsResponse.d.ts +59 -0
- package/dist/models/AutoOrderEmailsResponse.js +62 -0
- package/dist/models/Order.d.ts +7 -0
- package/dist/models/Order.js +3 -0
- package/dist/models/OrderEmail.d.ts +139 -0
- package/dist/models/OrderEmail.js +86 -0
- package/dist/models/OrderEmailsResponse.d.ts +59 -0
- package/dist/models/OrderEmailsResponse.js +62 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/package.json +1 -1
- package/src/apis/AutoOrderApi.ts +64 -0
- package/src/apis/OrderApi.ts +64 -0
- package/src/models/AutoOrder.ts +14 -0
- package/src/models/AutoOrderEmail.ts +211 -0
- package/src/models/AutoOrderEmailsResponse.ts +124 -0
- package/src/models/Order.ts +14 -0
- package/src/models/OrderEmail.ts +211 -0
- package/src/models/OrderEmailsResponse.ts +124 -0
- package/src/models/index.ts +4 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -53,6 +53,8 @@ src/models/AutoOrderAddonItem.ts
|
|
|
53
53
|
src/models/AutoOrderAddonItemOption.ts
|
|
54
54
|
src/models/AutoOrderAddonItemsUpdateRequest.ts
|
|
55
55
|
src/models/AutoOrderConsolidate.ts
|
|
56
|
+
src/models/AutoOrderEmail.ts
|
|
57
|
+
src/models/AutoOrderEmailsResponse.ts
|
|
56
58
|
src/models/AutoOrderItem.ts
|
|
57
59
|
src/models/AutoOrderItemCancelRequest.ts
|
|
58
60
|
src/models/AutoOrderItemFutureSchedule.ts
|
|
@@ -765,6 +767,8 @@ src/models/OrderDigitalOrder.ts
|
|
|
765
767
|
src/models/OrderEdi.ts
|
|
766
768
|
src/models/OrderEdiDocument.ts
|
|
767
769
|
src/models/OrderEdiDocumentsResponse.ts
|
|
770
|
+
src/models/OrderEmail.ts
|
|
771
|
+
src/models/OrderEmailsResponse.ts
|
|
768
772
|
src/models/OrderFormat.ts
|
|
769
773
|
src/models/OrderFormatResponse.ts
|
|
770
774
|
src/models/OrderFraudScore.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.87
|
|
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.87 --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.87 | 05/08/2026 | order and auto order emails |
|
|
88
89
|
| 4.1.86 | 05/07/2026 | rest auto order api - additional item cancel request parameter for no orders after dts |
|
|
89
90
|
| 4.1.85 | 05/05/2026 | improved warning object for customer insertCustomer and updateCustomer |
|
|
90
91
|
| 4.1.84 | 05/04/2026 | Order API - add hold stage to allowed values on order query request |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderConsolidate, AutoOrderItemCancelRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
|
|
13
|
+
import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderConsolidate, AutoOrderEmailsResponse, AutoOrderItemCancelRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
|
|
14
14
|
export interface CancelAutoOrderItemByReferenceOrderIdRequest {
|
|
15
15
|
referenceOrderId: string;
|
|
16
16
|
originalItemId: string;
|
|
@@ -38,6 +38,9 @@ export interface GetAutoOrderByReferenceOrderIdRequest {
|
|
|
38
38
|
referenceOrderId: string;
|
|
39
39
|
expand?: string;
|
|
40
40
|
}
|
|
41
|
+
export interface GetAutoOrderEmailsRequest {
|
|
42
|
+
autoOrderOid: number;
|
|
43
|
+
}
|
|
41
44
|
export interface GetAutoOrdersRequest {
|
|
42
45
|
autoOrderCode?: string;
|
|
43
46
|
originalOrderId?: string;
|
|
@@ -208,6 +211,20 @@ export interface AutoOrderApiInterface {
|
|
|
208
211
|
* Retrieve an auto order by order id
|
|
209
212
|
*/
|
|
210
213
|
getAutoOrderByReferenceOrderId(requestParameters: GetAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
214
|
+
/**
|
|
215
|
+
* Retrieves email delivery records associated with the specified auto order.
|
|
216
|
+
* @summary Retrieve email delivery information for this auto order.
|
|
217
|
+
* @param {number} autoOrderOid The auto order oid to retrieve email delivery information for.
|
|
218
|
+
* @param {*} [options] Override http request option.
|
|
219
|
+
* @throws {RequiredError}
|
|
220
|
+
* @memberof AutoOrderApiInterface
|
|
221
|
+
*/
|
|
222
|
+
getAutoOrderEmailsRaw(requestParameters: GetAutoOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderEmailsResponse>>;
|
|
223
|
+
/**
|
|
224
|
+
* Retrieves email delivery records associated with the specified auto order.
|
|
225
|
+
* Retrieve email delivery information for this auto order.
|
|
226
|
+
*/
|
|
227
|
+
getAutoOrderEmails(requestParameters: GetAutoOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderEmailsResponse>;
|
|
211
228
|
/**
|
|
212
229
|
* Retrieves auto orders from the account. If no parameters are specified, all auto orders 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.
|
|
213
230
|
* @summary Retrieve auto orders
|
|
@@ -442,6 +459,16 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
|
|
|
442
459
|
* Retrieve an auto order by order id
|
|
443
460
|
*/
|
|
444
461
|
getAutoOrderByReferenceOrderId(requestParameters: GetAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
462
|
+
/**
|
|
463
|
+
* Retrieves email delivery records associated with the specified auto order.
|
|
464
|
+
* Retrieve email delivery information for this auto order.
|
|
465
|
+
*/
|
|
466
|
+
getAutoOrderEmailsRaw(requestParameters: GetAutoOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderEmailsResponse>>;
|
|
467
|
+
/**
|
|
468
|
+
* Retrieves email delivery records associated with the specified auto order.
|
|
469
|
+
* Retrieve email delivery information for this auto order.
|
|
470
|
+
*/
|
|
471
|
+
getAutoOrderEmails(requestParameters: GetAutoOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderEmailsResponse>;
|
|
445
472
|
/**
|
|
446
473
|
* Retrieves auto orders from the account. If no parameters are specified, all auto orders 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.
|
|
447
474
|
* Retrieve auto orders
|
|
@@ -457,6 +457,65 @@ var AutoOrderApi = /** @class */ (function (_super) {
|
|
|
457
457
|
});
|
|
458
458
|
});
|
|
459
459
|
};
|
|
460
|
+
/**
|
|
461
|
+
* Retrieves email delivery records associated with the specified auto order.
|
|
462
|
+
* Retrieve email delivery information for this auto order.
|
|
463
|
+
*/
|
|
464
|
+
AutoOrderApi.prototype.getAutoOrderEmailsRaw = function (requestParameters, initOverrides) {
|
|
465
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
466
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
467
|
+
return __generator(this, function (_c) {
|
|
468
|
+
switch (_c.label) {
|
|
469
|
+
case 0:
|
|
470
|
+
if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
|
|
471
|
+
throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling getAutoOrderEmails.');
|
|
472
|
+
}
|
|
473
|
+
queryParameters = {};
|
|
474
|
+
headerParameters = {};
|
|
475
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
476
|
+
// oauth required
|
|
477
|
+
_a = headerParameters;
|
|
478
|
+
_b = "Authorization";
|
|
479
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_read"])];
|
|
480
|
+
case 1:
|
|
481
|
+
// oauth required
|
|
482
|
+
_a[_b] = _c.sent();
|
|
483
|
+
_c.label = 2;
|
|
484
|
+
case 2:
|
|
485
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
486
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
487
|
+
}
|
|
488
|
+
return [4 /*yield*/, this.request({
|
|
489
|
+
path: "/auto_order/auto_orders/{auto_order_oid}/emails".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))),
|
|
490
|
+
method: 'GET',
|
|
491
|
+
headers: headerParameters,
|
|
492
|
+
query: queryParameters,
|
|
493
|
+
}, initOverrides)];
|
|
494
|
+
case 3:
|
|
495
|
+
response = _c.sent();
|
|
496
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderEmailsResponseFromJSON)(jsonValue); })];
|
|
497
|
+
}
|
|
498
|
+
});
|
|
499
|
+
});
|
|
500
|
+
};
|
|
501
|
+
/**
|
|
502
|
+
* Retrieves email delivery records associated with the specified auto order.
|
|
503
|
+
* Retrieve email delivery information for this auto order.
|
|
504
|
+
*/
|
|
505
|
+
AutoOrderApi.prototype.getAutoOrderEmails = function (requestParameters, initOverrides) {
|
|
506
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
507
|
+
var response;
|
|
508
|
+
return __generator(this, function (_a) {
|
|
509
|
+
switch (_a.label) {
|
|
510
|
+
case 0: return [4 /*yield*/, this.getAutoOrderEmailsRaw(requestParameters, initOverrides)];
|
|
511
|
+
case 1:
|
|
512
|
+
response = _a.sent();
|
|
513
|
+
return [4 /*yield*/, response.value()];
|
|
514
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
515
|
+
}
|
|
516
|
+
});
|
|
517
|
+
});
|
|
518
|
+
};
|
|
460
519
|
/**
|
|
461
520
|
* Retrieves auto orders from the account. If no parameters are specified, all auto orders 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.
|
|
462
521
|
* Retrieve auto orders
|
package/dist/apis/OrderApi.d.ts
CHANGED
|
@@ -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, OrderAddItemsAndReleaseRequest, OrderAssignToAffiliateRequest, OrderByTokenQuery, OrderEdiDocumentsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderUpsellCartRequest, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
|
|
13
|
+
import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAddItemsAndReleaseRequest, OrderAssignToAffiliateRequest, OrderByTokenQuery, OrderEdiDocumentsResponse, OrderEmailsResponse, 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;
|
|
@@ -72,6 +72,9 @@ export interface GetOrderByTokenRequest {
|
|
|
72
72
|
export interface GetOrderEdiDocumentsRequest {
|
|
73
73
|
orderId: string;
|
|
74
74
|
}
|
|
75
|
+
export interface GetOrderEmailsRequest {
|
|
76
|
+
orderId: string;
|
|
77
|
+
}
|
|
75
78
|
export interface GetOrderUpsellCartRequest {
|
|
76
79
|
orderId: string;
|
|
77
80
|
upsellCartRequest: OrderUpsellCartRequest;
|
|
@@ -452,6 +455,20 @@ export interface OrderApiInterface {
|
|
|
452
455
|
* Retrieve EDI documents associated with this order.
|
|
453
456
|
*/
|
|
454
457
|
getOrderEdiDocuments(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEdiDocumentsResponse>;
|
|
458
|
+
/**
|
|
459
|
+
* Retrieves email delivery records associated with the specified order id.
|
|
460
|
+
* @summary Retrieve email delivery information for this order.
|
|
461
|
+
* @param {string} orderId The order id to retrieve email delivery information for.
|
|
462
|
+
* @param {*} [options] Override http request option.
|
|
463
|
+
* @throws {RequiredError}
|
|
464
|
+
* @memberof OrderApiInterface
|
|
465
|
+
*/
|
|
466
|
+
getOrderEmailsRaw(requestParameters: GetOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderEmailsResponse>>;
|
|
467
|
+
/**
|
|
468
|
+
* Retrieves email delivery records associated with the specified order id.
|
|
469
|
+
* Retrieve email delivery information for this order.
|
|
470
|
+
*/
|
|
471
|
+
getOrderEmails(requestParameters: GetOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEmailsResponse>;
|
|
455
472
|
/**
|
|
456
473
|
* 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
|
|
457
474
|
* @summary Get Order Upsell Cart
|
|
@@ -945,6 +962,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
|
|
|
945
962
|
* Retrieve EDI documents associated with this order.
|
|
946
963
|
*/
|
|
947
964
|
getOrderEdiDocuments(requestParameters: GetOrderEdiDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEdiDocumentsResponse>;
|
|
965
|
+
/**
|
|
966
|
+
* Retrieves email delivery records associated with the specified order id.
|
|
967
|
+
* Retrieve email delivery information for this order.
|
|
968
|
+
*/
|
|
969
|
+
getOrderEmailsRaw(requestParameters: GetOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderEmailsResponse>>;
|
|
970
|
+
/**
|
|
971
|
+
* Retrieves email delivery records associated with the specified order id.
|
|
972
|
+
* Retrieve email delivery information for this order.
|
|
973
|
+
*/
|
|
974
|
+
getOrderEmails(requestParameters: GetOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEmailsResponse>;
|
|
948
975
|
/**
|
|
949
976
|
* 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
|
|
950
977
|
* Get Order Upsell Cart
|
package/dist/apis/OrderApi.js
CHANGED
|
@@ -1172,6 +1172,65 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
1172
1172
|
});
|
|
1173
1173
|
});
|
|
1174
1174
|
};
|
|
1175
|
+
/**
|
|
1176
|
+
* Retrieves email delivery records associated with the specified order id.
|
|
1177
|
+
* Retrieve email delivery information for this order.
|
|
1178
|
+
*/
|
|
1179
|
+
OrderApi.prototype.getOrderEmailsRaw = function (requestParameters, initOverrides) {
|
|
1180
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1181
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
1182
|
+
return __generator(this, function (_c) {
|
|
1183
|
+
switch (_c.label) {
|
|
1184
|
+
case 0:
|
|
1185
|
+
if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
|
|
1186
|
+
throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling getOrderEmails.');
|
|
1187
|
+
}
|
|
1188
|
+
queryParameters = {};
|
|
1189
|
+
headerParameters = {};
|
|
1190
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
1191
|
+
// oauth required
|
|
1192
|
+
_a = headerParameters;
|
|
1193
|
+
_b = "Authorization";
|
|
1194
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_read"])];
|
|
1195
|
+
case 1:
|
|
1196
|
+
// oauth required
|
|
1197
|
+
_a[_b] = _c.sent();
|
|
1198
|
+
_c.label = 2;
|
|
1199
|
+
case 2:
|
|
1200
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1201
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1202
|
+
}
|
|
1203
|
+
return [4 /*yield*/, this.request({
|
|
1204
|
+
path: "/order/orders/{order_id}/emails".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
|
|
1205
|
+
method: 'GET',
|
|
1206
|
+
headers: headerParameters,
|
|
1207
|
+
query: queryParameters,
|
|
1208
|
+
}, initOverrides)];
|
|
1209
|
+
case 3:
|
|
1210
|
+
response = _c.sent();
|
|
1211
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderEmailsResponseFromJSON)(jsonValue); })];
|
|
1212
|
+
}
|
|
1213
|
+
});
|
|
1214
|
+
});
|
|
1215
|
+
};
|
|
1216
|
+
/**
|
|
1217
|
+
* Retrieves email delivery records associated with the specified order id.
|
|
1218
|
+
* Retrieve email delivery information for this order.
|
|
1219
|
+
*/
|
|
1220
|
+
OrderApi.prototype.getOrderEmails = function (requestParameters, initOverrides) {
|
|
1221
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1222
|
+
var response;
|
|
1223
|
+
return __generator(this, function (_a) {
|
|
1224
|
+
switch (_a.label) {
|
|
1225
|
+
case 0: return [4 /*yield*/, this.getOrderEmailsRaw(requestParameters, initOverrides)];
|
|
1226
|
+
case 1:
|
|
1227
|
+
response = _a.sent();
|
|
1228
|
+
return [4 /*yield*/, response.value()];
|
|
1229
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
1230
|
+
}
|
|
1231
|
+
});
|
|
1232
|
+
});
|
|
1233
|
+
};
|
|
1175
1234
|
/**
|
|
1176
1235
|
* 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
|
|
1177
1236
|
* Get Order Upsell Cart
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import { AutoOrderAddonItem } from './AutoOrderAddonItem';
|
|
13
|
+
import { AutoOrderEmail } from './AutoOrderEmail';
|
|
13
14
|
import { AutoOrderItem } from './AutoOrderItem';
|
|
14
15
|
import { AutoOrderLog } from './AutoOrderLog';
|
|
15
16
|
import { AutoOrderManagement } from './AutoOrderManagement';
|
|
@@ -93,6 +94,12 @@ export interface AutoOrder {
|
|
|
93
94
|
* @memberof AutoOrder
|
|
94
95
|
*/
|
|
95
96
|
disabled_dts?: string;
|
|
97
|
+
/**
|
|
98
|
+
* Email delivery records associated with this auto order.
|
|
99
|
+
* @type {Array<AutoOrderEmail>}
|
|
100
|
+
* @memberof AutoOrder
|
|
101
|
+
*/
|
|
102
|
+
emails?: Array<AutoOrderEmail>;
|
|
96
103
|
/**
|
|
97
104
|
* True if this auto order is enabled
|
|
98
105
|
* @type {boolean}
|
package/dist/models/AutoOrder.js
CHANGED
|
@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
16
16
|
exports.AutoOrderToJSON = exports.AutoOrderFromJSONTyped = exports.AutoOrderFromJSON = exports.instanceOfAutoOrder = exports.AutoOrderStatusEnum = void 0;
|
|
17
17
|
var runtime_1 = require("../runtime");
|
|
18
18
|
var AutoOrderAddonItem_1 = require("./AutoOrderAddonItem");
|
|
19
|
+
var AutoOrderEmail_1 = require("./AutoOrderEmail");
|
|
19
20
|
var AutoOrderItem_1 = require("./AutoOrderItem");
|
|
20
21
|
var AutoOrderLog_1 = require("./AutoOrderLog");
|
|
21
22
|
var AutoOrderManagement_1 = require("./AutoOrderManagement");
|
|
@@ -59,6 +60,7 @@ function AutoOrderFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
59
60
|
'completed': !(0, runtime_1.exists)(json, 'completed') ? undefined : json['completed'],
|
|
60
61
|
'credit_card_attempt': !(0, runtime_1.exists)(json, 'credit_card_attempt') ? undefined : json['credit_card_attempt'],
|
|
61
62
|
'disabled_dts': !(0, runtime_1.exists)(json, 'disabled_dts') ? undefined : json['disabled_dts'],
|
|
63
|
+
'emails': !(0, runtime_1.exists)(json, 'emails') ? undefined : (json['emails'].map(AutoOrderEmail_1.AutoOrderEmailFromJSON)),
|
|
62
64
|
'enabled': !(0, runtime_1.exists)(json, 'enabled') ? undefined : json['enabled'],
|
|
63
65
|
'failure_reason': !(0, runtime_1.exists)(json, 'failure_reason') ? undefined : json['failure_reason'],
|
|
64
66
|
'items': !(0, runtime_1.exists)(json, 'items') ? undefined : (json['items'].map(AutoOrderItem_1.AutoOrderItemFromJSON)),
|
|
@@ -98,6 +100,7 @@ function AutoOrderToJSON(value) {
|
|
|
98
100
|
'completed': value.completed,
|
|
99
101
|
'credit_card_attempt': value.credit_card_attempt,
|
|
100
102
|
'disabled_dts': value.disabled_dts,
|
|
103
|
+
'emails': value.emails === undefined ? undefined : (value.emails.map(AutoOrderEmail_1.AutoOrderEmailToJSON)),
|
|
101
104
|
'enabled': value.enabled,
|
|
102
105
|
'failure_reason': value.failure_reason,
|
|
103
106
|
'items': value.items === undefined ? undefined : (value.items.map(AutoOrderItem_1.AutoOrderItemToJSON)),
|
|
@@ -0,0 +1,139 @@
|
|
|
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
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AutoOrderEmail
|
|
16
|
+
*/
|
|
17
|
+
export interface AutoOrderEmail {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof AutoOrderEmail
|
|
22
|
+
*/
|
|
23
|
+
bounce_diagnostic_code?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Date/time that the email was bounced
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof AutoOrderEmail
|
|
28
|
+
*/
|
|
29
|
+
bounce_dts?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof AutoOrderEmail
|
|
34
|
+
*/
|
|
35
|
+
bounce_sub_type?: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof AutoOrderEmail
|
|
40
|
+
*/
|
|
41
|
+
bounce_type?: string;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {boolean}
|
|
45
|
+
* @memberof AutoOrderEmail
|
|
46
|
+
*/
|
|
47
|
+
clicked?: boolean;
|
|
48
|
+
/**
|
|
49
|
+
* Date/time that the email was clicked
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof AutoOrderEmail
|
|
52
|
+
*/
|
|
53
|
+
clicked_dts?: string;
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @type {boolean}
|
|
57
|
+
* @memberof AutoOrderEmail
|
|
58
|
+
*/
|
|
59
|
+
delivered?: boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Date/time that the email was delivered
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof AutoOrderEmail
|
|
64
|
+
*/
|
|
65
|
+
delivery_dts?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Email
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof AutoOrderEmail
|
|
70
|
+
*/
|
|
71
|
+
email?: string;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @type {boolean}
|
|
75
|
+
* @memberof AutoOrderEmail
|
|
76
|
+
*/
|
|
77
|
+
internal?: boolean;
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof AutoOrderEmail
|
|
82
|
+
*/
|
|
83
|
+
message_id?: string;
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {boolean}
|
|
87
|
+
* @memberof AutoOrderEmail
|
|
88
|
+
*/
|
|
89
|
+
opened?: boolean;
|
|
90
|
+
/**
|
|
91
|
+
* Date/time that the email was opened
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof AutoOrderEmail
|
|
94
|
+
*/
|
|
95
|
+
opened_dts?: string;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {string}
|
|
99
|
+
* @memberof AutoOrderEmail
|
|
100
|
+
*/
|
|
101
|
+
reporting_mta?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Date/time that the email was sent
|
|
104
|
+
* @type {string}
|
|
105
|
+
* @memberof AutoOrderEmail
|
|
106
|
+
*/
|
|
107
|
+
send_dts?: string;
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @type {string}
|
|
111
|
+
* @memberof AutoOrderEmail
|
|
112
|
+
*/
|
|
113
|
+
skip_reason?: string;
|
|
114
|
+
/**
|
|
115
|
+
*
|
|
116
|
+
* @type {boolean}
|
|
117
|
+
* @memberof AutoOrderEmail
|
|
118
|
+
*/
|
|
119
|
+
skipped?: boolean;
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @type {string}
|
|
123
|
+
* @memberof AutoOrderEmail
|
|
124
|
+
*/
|
|
125
|
+
smtp_response?: string;
|
|
126
|
+
/**
|
|
127
|
+
*
|
|
128
|
+
* @type {string}
|
|
129
|
+
* @memberof AutoOrderEmail
|
|
130
|
+
*/
|
|
131
|
+
subject?: string;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Check if a given object implements the AutoOrderEmail interface.
|
|
135
|
+
*/
|
|
136
|
+
export declare function instanceOfAutoOrderEmail(value: object): boolean;
|
|
137
|
+
export declare function AutoOrderEmailFromJSON(json: any): AutoOrderEmail;
|
|
138
|
+
export declare function AutoOrderEmailFromJSONTyped(json: any, ignoreDiscriminator: boolean): AutoOrderEmail;
|
|
139
|
+
export declare function AutoOrderEmailToJSON(value?: AutoOrderEmail | null): any;
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.AutoOrderEmailToJSON = exports.AutoOrderEmailFromJSONTyped = exports.AutoOrderEmailFromJSON = exports.instanceOfAutoOrderEmail = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the AutoOrderEmail interface.
|
|
20
|
+
*/
|
|
21
|
+
function instanceOfAutoOrderEmail(value) {
|
|
22
|
+
var isInstance = true;
|
|
23
|
+
return isInstance;
|
|
24
|
+
}
|
|
25
|
+
exports.instanceOfAutoOrderEmail = instanceOfAutoOrderEmail;
|
|
26
|
+
function AutoOrderEmailFromJSON(json) {
|
|
27
|
+
return AutoOrderEmailFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
exports.AutoOrderEmailFromJSON = AutoOrderEmailFromJSON;
|
|
30
|
+
function AutoOrderEmailFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if ((json === undefined) || (json === null)) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'bounce_diagnostic_code': !(0, runtime_1.exists)(json, 'bounce_diagnostic_code') ? undefined : json['bounce_diagnostic_code'],
|
|
36
|
+
'bounce_dts': !(0, runtime_1.exists)(json, 'bounce_dts') ? undefined : json['bounce_dts'],
|
|
37
|
+
'bounce_sub_type': !(0, runtime_1.exists)(json, 'bounce_sub_type') ? undefined : json['bounce_sub_type'],
|
|
38
|
+
'bounce_type': !(0, runtime_1.exists)(json, 'bounce_type') ? undefined : json['bounce_type'],
|
|
39
|
+
'clicked': !(0, runtime_1.exists)(json, 'clicked') ? undefined : json['clicked'],
|
|
40
|
+
'clicked_dts': !(0, runtime_1.exists)(json, 'clicked_dts') ? undefined : json['clicked_dts'],
|
|
41
|
+
'delivered': !(0, runtime_1.exists)(json, 'delivered') ? undefined : json['delivered'],
|
|
42
|
+
'delivery_dts': !(0, runtime_1.exists)(json, 'delivery_dts') ? undefined : json['delivery_dts'],
|
|
43
|
+
'email': !(0, runtime_1.exists)(json, 'email') ? undefined : json['email'],
|
|
44
|
+
'internal': !(0, runtime_1.exists)(json, 'internal') ? undefined : json['internal'],
|
|
45
|
+
'message_id': !(0, runtime_1.exists)(json, 'message_id') ? undefined : json['message_id'],
|
|
46
|
+
'opened': !(0, runtime_1.exists)(json, 'opened') ? undefined : json['opened'],
|
|
47
|
+
'opened_dts': !(0, runtime_1.exists)(json, 'opened_dts') ? undefined : json['opened_dts'],
|
|
48
|
+
'reporting_mta': !(0, runtime_1.exists)(json, 'reporting_mta') ? undefined : json['reporting_mta'],
|
|
49
|
+
'send_dts': !(0, runtime_1.exists)(json, 'send_dts') ? undefined : json['send_dts'],
|
|
50
|
+
'skip_reason': !(0, runtime_1.exists)(json, 'skip_reason') ? undefined : json['skip_reason'],
|
|
51
|
+
'skipped': !(0, runtime_1.exists)(json, 'skipped') ? undefined : json['skipped'],
|
|
52
|
+
'smtp_response': !(0, runtime_1.exists)(json, 'smtp_response') ? undefined : json['smtp_response'],
|
|
53
|
+
'subject': !(0, runtime_1.exists)(json, 'subject') ? undefined : json['subject'],
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
exports.AutoOrderEmailFromJSONTyped = AutoOrderEmailFromJSONTyped;
|
|
57
|
+
function AutoOrderEmailToJSON(value) {
|
|
58
|
+
if (value === undefined) {
|
|
59
|
+
return undefined;
|
|
60
|
+
}
|
|
61
|
+
if (value === null) {
|
|
62
|
+
return null;
|
|
63
|
+
}
|
|
64
|
+
return {
|
|
65
|
+
'bounce_diagnostic_code': value.bounce_diagnostic_code,
|
|
66
|
+
'bounce_dts': value.bounce_dts,
|
|
67
|
+
'bounce_sub_type': value.bounce_sub_type,
|
|
68
|
+
'bounce_type': value.bounce_type,
|
|
69
|
+
'clicked': value.clicked,
|
|
70
|
+
'clicked_dts': value.clicked_dts,
|
|
71
|
+
'delivered': value.delivered,
|
|
72
|
+
'delivery_dts': value.delivery_dts,
|
|
73
|
+
'email': value.email,
|
|
74
|
+
'internal': value.internal,
|
|
75
|
+
'message_id': value.message_id,
|
|
76
|
+
'opened': value.opened,
|
|
77
|
+
'opened_dts': value.opened_dts,
|
|
78
|
+
'reporting_mta': value.reporting_mta,
|
|
79
|
+
'send_dts': value.send_dts,
|
|
80
|
+
'skip_reason': value.skip_reason,
|
|
81
|
+
'skipped': value.skipped,
|
|
82
|
+
'smtp_response': value.smtp_response,
|
|
83
|
+
'subject': value.subject,
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
exports.AutoOrderEmailToJSON = AutoOrderEmailToJSON;
|
|
@@ -0,0 +1,59 @@
|
|
|
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 { AutoOrderEmail } from './AutoOrderEmail';
|
|
13
|
+
import { ModelError } from './ModelError';
|
|
14
|
+
import { ResponseMetadata } from './ResponseMetadata';
|
|
15
|
+
import { Warning } from './Warning';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AutoOrderEmailsResponse
|
|
20
|
+
*/
|
|
21
|
+
export interface AutoOrderEmailsResponse {
|
|
22
|
+
/**
|
|
23
|
+
* emails
|
|
24
|
+
* @type {Array<AutoOrderEmail>}
|
|
25
|
+
* @memberof AutoOrderEmailsResponse
|
|
26
|
+
*/
|
|
27
|
+
emails?: Array<AutoOrderEmail>;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {ModelError}
|
|
31
|
+
* @memberof AutoOrderEmailsResponse
|
|
32
|
+
*/
|
|
33
|
+
error?: ModelError;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {ResponseMetadata}
|
|
37
|
+
* @memberof AutoOrderEmailsResponse
|
|
38
|
+
*/
|
|
39
|
+
metadata?: ResponseMetadata;
|
|
40
|
+
/**
|
|
41
|
+
* Indicates if API call was successful
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof AutoOrderEmailsResponse
|
|
44
|
+
*/
|
|
45
|
+
success?: boolean;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {Warning}
|
|
49
|
+
* @memberof AutoOrderEmailsResponse
|
|
50
|
+
*/
|
|
51
|
+
warning?: Warning;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Check if a given object implements the AutoOrderEmailsResponse interface.
|
|
55
|
+
*/
|
|
56
|
+
export declare function instanceOfAutoOrderEmailsResponse(value: object): boolean;
|
|
57
|
+
export declare function AutoOrderEmailsResponseFromJSON(json: any): AutoOrderEmailsResponse;
|
|
58
|
+
export declare function AutoOrderEmailsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AutoOrderEmailsResponse;
|
|
59
|
+
export declare function AutoOrderEmailsResponseToJSON(value?: AutoOrderEmailsResponse | null): any;
|