@teemill/platform 0.23.0 → 0.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/api.ts +241 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +131 -1
- package/dist/api.js +167 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +131 -1
- package/dist/esm/api.js +167 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Order.md +2 -0
- package/docs/OrdersApi.md +126 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Platform API
|
|
6
6
|
* Manage Your podOS platform
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.24.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -974,6 +974,50 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
974
974
|
options: localVarRequestOptions,
|
|
975
975
|
};
|
|
976
976
|
}),
|
|
977
|
+
/**
|
|
978
|
+
* Get an order receipt for a platform by a given order ID.
|
|
979
|
+
* @summary Get order receipt
|
|
980
|
+
* @param {string} project Project unique identifier
|
|
981
|
+
* @param {string} platformId The platform identifier
|
|
982
|
+
* @param {string} orderId The order identifier
|
|
983
|
+
* @param {*} [options] Override http request option.
|
|
984
|
+
* @throws {RequiredError}
|
|
985
|
+
*/
|
|
986
|
+
getOrderReceipt: (project_1, platformId_1, orderId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, ...args_1], void 0, function* (project, platformId, orderId, options = {}) {
|
|
987
|
+
// verify required parameter 'project' is not null or undefined
|
|
988
|
+
(0, common_1.assertParamExists)('getOrderReceipt', 'project', project);
|
|
989
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
990
|
+
(0, common_1.assertParamExists)('getOrderReceipt', 'platformId', platformId);
|
|
991
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
992
|
+
(0, common_1.assertParamExists)('getOrderReceipt', 'orderId', orderId);
|
|
993
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt`
|
|
994
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
995
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
996
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
997
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
998
|
+
let baseOptions;
|
|
999
|
+
if (configuration) {
|
|
1000
|
+
baseOptions = configuration.baseOptions;
|
|
1001
|
+
}
|
|
1002
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1003
|
+
const localVarHeaderParameter = {};
|
|
1004
|
+
const localVarQueryParameter = {};
|
|
1005
|
+
// authentication session-oauth required
|
|
1006
|
+
// oauth required
|
|
1007
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1008
|
+
// authentication api-key required
|
|
1009
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1010
|
+
if (project !== undefined) {
|
|
1011
|
+
localVarQueryParameter['project'] = project;
|
|
1012
|
+
}
|
|
1013
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1014
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1015
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1016
|
+
return {
|
|
1017
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1018
|
+
options: localVarRequestOptions,
|
|
1019
|
+
};
|
|
1020
|
+
}),
|
|
977
1021
|
/**
|
|
978
1022
|
* List available fulfillers for a given fulfillment
|
|
979
1023
|
* @summary List available fulfillers
|
|
@@ -1130,6 +1174,50 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1130
1174
|
options: localVarRequestOptions,
|
|
1131
1175
|
};
|
|
1132
1176
|
}),
|
|
1177
|
+
/**
|
|
1178
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
1179
|
+
* @summary Send order receipt
|
|
1180
|
+
* @param {string} project Project unique identifier
|
|
1181
|
+
* @param {string} platformId The platform identifier
|
|
1182
|
+
* @param {string} orderId The order identifier
|
|
1183
|
+
* @param {*} [options] Override http request option.
|
|
1184
|
+
* @throws {RequiredError}
|
|
1185
|
+
*/
|
|
1186
|
+
sendOrderReceipt: (project_1, platformId_1, orderId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, ...args_1], void 0, function* (project, platformId, orderId, options = {}) {
|
|
1187
|
+
// verify required parameter 'project' is not null or undefined
|
|
1188
|
+
(0, common_1.assertParamExists)('sendOrderReceipt', 'project', project);
|
|
1189
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1190
|
+
(0, common_1.assertParamExists)('sendOrderReceipt', 'platformId', platformId);
|
|
1191
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
1192
|
+
(0, common_1.assertParamExists)('sendOrderReceipt', 'orderId', orderId);
|
|
1193
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt/send`
|
|
1194
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1195
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
1196
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1197
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1198
|
+
let baseOptions;
|
|
1199
|
+
if (configuration) {
|
|
1200
|
+
baseOptions = configuration.baseOptions;
|
|
1201
|
+
}
|
|
1202
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1203
|
+
const localVarHeaderParameter = {};
|
|
1204
|
+
const localVarQueryParameter = {};
|
|
1205
|
+
// authentication session-oauth required
|
|
1206
|
+
// oauth required
|
|
1207
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1208
|
+
// authentication api-key required
|
|
1209
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1210
|
+
if (project !== undefined) {
|
|
1211
|
+
localVarQueryParameter['project'] = project;
|
|
1212
|
+
}
|
|
1213
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1214
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1215
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1216
|
+
return {
|
|
1217
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1218
|
+
options: localVarRequestOptions,
|
|
1219
|
+
};
|
|
1220
|
+
}),
|
|
1133
1221
|
/**
|
|
1134
1222
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1135
1223
|
* @summary Update fulfillment
|
|
@@ -1245,6 +1333,24 @@ const OrdersApiFp = function (configuration) {
|
|
|
1245
1333
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1246
1334
|
});
|
|
1247
1335
|
},
|
|
1336
|
+
/**
|
|
1337
|
+
* Get an order receipt for a platform by a given order ID.
|
|
1338
|
+
* @summary Get order receipt
|
|
1339
|
+
* @param {string} project Project unique identifier
|
|
1340
|
+
* @param {string} platformId The platform identifier
|
|
1341
|
+
* @param {string} orderId The order identifier
|
|
1342
|
+
* @param {*} [options] Override http request option.
|
|
1343
|
+
* @throws {RequiredError}
|
|
1344
|
+
*/
|
|
1345
|
+
getOrderReceipt(project, platformId, orderId, options) {
|
|
1346
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1347
|
+
var _a, _b, _c;
|
|
1348
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrderReceipt(project, platformId, orderId, options);
|
|
1349
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1350
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.getOrderReceipt']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1351
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1352
|
+
});
|
|
1353
|
+
},
|
|
1248
1354
|
/**
|
|
1249
1355
|
* List available fulfillers for a given fulfillment
|
|
1250
1356
|
* @summary List available fulfillers
|
|
@@ -1304,6 +1410,24 @@ const OrdersApiFp = function (configuration) {
|
|
|
1304
1410
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1305
1411
|
});
|
|
1306
1412
|
},
|
|
1413
|
+
/**
|
|
1414
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
1415
|
+
* @summary Send order receipt
|
|
1416
|
+
* @param {string} project Project unique identifier
|
|
1417
|
+
* @param {string} platformId The platform identifier
|
|
1418
|
+
* @param {string} orderId The order identifier
|
|
1419
|
+
* @param {*} [options] Override http request option.
|
|
1420
|
+
* @throws {RequiredError}
|
|
1421
|
+
*/
|
|
1422
|
+
sendOrderReceipt(project, platformId, orderId, options) {
|
|
1423
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1424
|
+
var _a, _b, _c;
|
|
1425
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.sendOrderReceipt(project, platformId, orderId, options);
|
|
1426
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1427
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.sendOrderReceipt']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1428
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1429
|
+
});
|
|
1430
|
+
},
|
|
1307
1431
|
/**
|
|
1308
1432
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1309
1433
|
* @summary Update fulfillment
|
|
@@ -1363,6 +1487,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
1363
1487
|
getOrder(requestParameters, options) {
|
|
1364
1488
|
return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
1365
1489
|
},
|
|
1490
|
+
/**
|
|
1491
|
+
* Get an order receipt for a platform by a given order ID.
|
|
1492
|
+
* @summary Get order receipt
|
|
1493
|
+
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
1494
|
+
* @param {*} [options] Override http request option.
|
|
1495
|
+
* @throws {RequiredError}
|
|
1496
|
+
*/
|
|
1497
|
+
getOrderReceipt(requestParameters, options) {
|
|
1498
|
+
return localVarFp.getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
1499
|
+
},
|
|
1366
1500
|
/**
|
|
1367
1501
|
* List available fulfillers for a given fulfillment
|
|
1368
1502
|
* @summary List available fulfillers
|
|
@@ -1393,6 +1527,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
1393
1527
|
retryPlatformPayment(requestParameters, options) {
|
|
1394
1528
|
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
1395
1529
|
},
|
|
1530
|
+
/**
|
|
1531
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
1532
|
+
* @summary Send order receipt
|
|
1533
|
+
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
1534
|
+
* @param {*} [options] Override http request option.
|
|
1535
|
+
* @throws {RequiredError}
|
|
1536
|
+
*/
|
|
1537
|
+
sendOrderReceipt(requestParameters, options) {
|
|
1538
|
+
return localVarFp.sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
1539
|
+
},
|
|
1396
1540
|
/**
|
|
1397
1541
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1398
1542
|
* @summary Update fulfillment
|
|
@@ -1446,6 +1590,17 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
1446
1590
|
getOrder(requestParameters, options) {
|
|
1447
1591
|
return (0, exports.OrdersApiFp)(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
1448
1592
|
}
|
|
1593
|
+
/**
|
|
1594
|
+
* Get an order receipt for a platform by a given order ID.
|
|
1595
|
+
* @summary Get order receipt
|
|
1596
|
+
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
1597
|
+
* @param {*} [options] Override http request option.
|
|
1598
|
+
* @throws {RequiredError}
|
|
1599
|
+
* @memberof OrdersApi
|
|
1600
|
+
*/
|
|
1601
|
+
getOrderReceipt(requestParameters, options) {
|
|
1602
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
1603
|
+
}
|
|
1449
1604
|
/**
|
|
1450
1605
|
* List available fulfillers for a given fulfillment
|
|
1451
1606
|
* @summary List available fulfillers
|
|
@@ -1479,6 +1634,17 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
1479
1634
|
retryPlatformPayment(requestParameters, options) {
|
|
1480
1635
|
return (0, exports.OrdersApiFp)(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
1481
1636
|
}
|
|
1637
|
+
/**
|
|
1638
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
1639
|
+
* @summary Send order receipt
|
|
1640
|
+
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
1641
|
+
* @param {*} [options] Override http request option.
|
|
1642
|
+
* @throws {RequiredError}
|
|
1643
|
+
* @memberof OrdersApi
|
|
1644
|
+
*/
|
|
1645
|
+
sendOrderReceipt(requestParameters, options) {
|
|
1646
|
+
return (0, exports.OrdersApiFp)(this.configuration).sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
1647
|
+
}
|
|
1482
1648
|
/**
|
|
1483
1649
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
1484
1650
|
* @summary Update fulfillment
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.24.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -874,6 +874,12 @@ export interface Order {
|
|
|
874
874
|
* @memberof Order
|
|
875
875
|
*/
|
|
876
876
|
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
877
|
+
/**
|
|
878
|
+
* The integration type of the order, e.g. \"website\" or \"shopify\"
|
|
879
|
+
* @type {string}
|
|
880
|
+
* @memberof Order
|
|
881
|
+
*/
|
|
882
|
+
'integrationType'?: string;
|
|
877
883
|
}
|
|
878
884
|
/**
|
|
879
885
|
*
|
|
@@ -2371,6 +2377,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2371
2377
|
* @throws {RequiredError}
|
|
2372
2378
|
*/
|
|
2373
2379
|
getOrder: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2380
|
+
/**
|
|
2381
|
+
* Get an order receipt for a platform by a given order ID.
|
|
2382
|
+
* @summary Get order receipt
|
|
2383
|
+
* @param {string} project Project unique identifier
|
|
2384
|
+
* @param {string} platformId The platform identifier
|
|
2385
|
+
* @param {string} orderId The order identifier
|
|
2386
|
+
* @param {*} [options] Override http request option.
|
|
2387
|
+
* @throws {RequiredError}
|
|
2388
|
+
*/
|
|
2389
|
+
getOrderReceipt: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2374
2390
|
/**
|
|
2375
2391
|
* List available fulfillers for a given fulfillment
|
|
2376
2392
|
* @summary List available fulfillers
|
|
@@ -2406,6 +2422,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2406
2422
|
* @throws {RequiredError}
|
|
2407
2423
|
*/
|
|
2408
2424
|
retryPlatformPayment: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2425
|
+
/**
|
|
2426
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
2427
|
+
* @summary Send order receipt
|
|
2428
|
+
* @param {string} project Project unique identifier
|
|
2429
|
+
* @param {string} platformId The platform identifier
|
|
2430
|
+
* @param {string} orderId The order identifier
|
|
2431
|
+
* @param {*} [options] Override http request option.
|
|
2432
|
+
* @throws {RequiredError}
|
|
2433
|
+
*/
|
|
2434
|
+
sendOrderReceipt: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2409
2435
|
/**
|
|
2410
2436
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2411
2437
|
* @summary Update fulfillment
|
|
@@ -2455,6 +2481,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2455
2481
|
* @throws {RequiredError}
|
|
2456
2482
|
*/
|
|
2457
2483
|
getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2484
|
+
/**
|
|
2485
|
+
* Get an order receipt for a platform by a given order ID.
|
|
2486
|
+
* @summary Get order receipt
|
|
2487
|
+
* @param {string} project Project unique identifier
|
|
2488
|
+
* @param {string} platformId The platform identifier
|
|
2489
|
+
* @param {string} orderId The order identifier
|
|
2490
|
+
* @param {*} [options] Override http request option.
|
|
2491
|
+
* @throws {RequiredError}
|
|
2492
|
+
*/
|
|
2493
|
+
getOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
2458
2494
|
/**
|
|
2459
2495
|
* List available fulfillers for a given fulfillment
|
|
2460
2496
|
* @summary List available fulfillers
|
|
@@ -2490,6 +2526,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2490
2526
|
* @throws {RequiredError}
|
|
2491
2527
|
*/
|
|
2492
2528
|
retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2529
|
+
/**
|
|
2530
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
2531
|
+
* @summary Send order receipt
|
|
2532
|
+
* @param {string} project Project unique identifier
|
|
2533
|
+
* @param {string} platformId The platform identifier
|
|
2534
|
+
* @param {string} orderId The order identifier
|
|
2535
|
+
* @param {*} [options] Override http request option.
|
|
2536
|
+
* @throws {RequiredError}
|
|
2537
|
+
*/
|
|
2538
|
+
sendOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2493
2539
|
/**
|
|
2494
2540
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2495
2541
|
* @summary Update fulfillment
|
|
@@ -2531,6 +2577,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
2531
2577
|
* @throws {RequiredError}
|
|
2532
2578
|
*/
|
|
2533
2579
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
2580
|
+
/**
|
|
2581
|
+
* Get an order receipt for a platform by a given order ID.
|
|
2582
|
+
* @summary Get order receipt
|
|
2583
|
+
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
2584
|
+
* @param {*} [options] Override http request option.
|
|
2585
|
+
* @throws {RequiredError}
|
|
2586
|
+
*/
|
|
2587
|
+
getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
2534
2588
|
/**
|
|
2535
2589
|
* List available fulfillers for a given fulfillment
|
|
2536
2590
|
* @summary List available fulfillers
|
|
@@ -2555,6 +2609,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
2555
2609
|
* @throws {RequiredError}
|
|
2556
2610
|
*/
|
|
2557
2611
|
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
2612
|
+
/**
|
|
2613
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
2614
|
+
* @summary Send order receipt
|
|
2615
|
+
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
2616
|
+
* @param {*} [options] Override http request option.
|
|
2617
|
+
* @throws {RequiredError}
|
|
2618
|
+
*/
|
|
2619
|
+
sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2558
2620
|
/**
|
|
2559
2621
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2560
2622
|
* @summary Update fulfillment
|
|
@@ -2651,6 +2713,31 @@ export interface OrdersApiGetOrderRequest {
|
|
|
2651
2713
|
*/
|
|
2652
2714
|
readonly orderId: string;
|
|
2653
2715
|
}
|
|
2716
|
+
/**
|
|
2717
|
+
* Request parameters for getOrderReceipt operation in OrdersApi.
|
|
2718
|
+
* @export
|
|
2719
|
+
* @interface OrdersApiGetOrderReceiptRequest
|
|
2720
|
+
*/
|
|
2721
|
+
export interface OrdersApiGetOrderReceiptRequest {
|
|
2722
|
+
/**
|
|
2723
|
+
* Project unique identifier
|
|
2724
|
+
* @type {string}
|
|
2725
|
+
* @memberof OrdersApiGetOrderReceipt
|
|
2726
|
+
*/
|
|
2727
|
+
readonly project: string;
|
|
2728
|
+
/**
|
|
2729
|
+
* The platform identifier
|
|
2730
|
+
* @type {string}
|
|
2731
|
+
* @memberof OrdersApiGetOrderReceipt
|
|
2732
|
+
*/
|
|
2733
|
+
readonly platformId: string;
|
|
2734
|
+
/**
|
|
2735
|
+
* The order identifier
|
|
2736
|
+
* @type {string}
|
|
2737
|
+
* @memberof OrdersApiGetOrderReceipt
|
|
2738
|
+
*/
|
|
2739
|
+
readonly orderId: string;
|
|
2740
|
+
}
|
|
2654
2741
|
/**
|
|
2655
2742
|
* Request parameters for listAvailableFulfillers operation in OrdersApi.
|
|
2656
2743
|
* @export
|
|
@@ -2756,6 +2843,31 @@ export interface OrdersApiRetryPlatformPaymentRequest {
|
|
|
2756
2843
|
*/
|
|
2757
2844
|
readonly orderId: string;
|
|
2758
2845
|
}
|
|
2846
|
+
/**
|
|
2847
|
+
* Request parameters for sendOrderReceipt operation in OrdersApi.
|
|
2848
|
+
* @export
|
|
2849
|
+
* @interface OrdersApiSendOrderReceiptRequest
|
|
2850
|
+
*/
|
|
2851
|
+
export interface OrdersApiSendOrderReceiptRequest {
|
|
2852
|
+
/**
|
|
2853
|
+
* Project unique identifier
|
|
2854
|
+
* @type {string}
|
|
2855
|
+
* @memberof OrdersApiSendOrderReceipt
|
|
2856
|
+
*/
|
|
2857
|
+
readonly project: string;
|
|
2858
|
+
/**
|
|
2859
|
+
* The platform identifier
|
|
2860
|
+
* @type {string}
|
|
2861
|
+
* @memberof OrdersApiSendOrderReceipt
|
|
2862
|
+
*/
|
|
2863
|
+
readonly platformId: string;
|
|
2864
|
+
/**
|
|
2865
|
+
* The order identifier
|
|
2866
|
+
* @type {string}
|
|
2867
|
+
* @memberof OrdersApiSendOrderReceipt
|
|
2868
|
+
*/
|
|
2869
|
+
readonly orderId: string;
|
|
2870
|
+
}
|
|
2759
2871
|
/**
|
|
2760
2872
|
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
2761
2873
|
* @export
|
|
@@ -2821,6 +2933,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2821
2933
|
* @memberof OrdersApi
|
|
2822
2934
|
*/
|
|
2823
2935
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
2936
|
+
/**
|
|
2937
|
+
* Get an order receipt for a platform by a given order ID.
|
|
2938
|
+
* @summary Get order receipt
|
|
2939
|
+
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
2940
|
+
* @param {*} [options] Override http request option.
|
|
2941
|
+
* @throws {RequiredError}
|
|
2942
|
+
* @memberof OrdersApi
|
|
2943
|
+
*/
|
|
2944
|
+
getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
2824
2945
|
/**
|
|
2825
2946
|
* List available fulfillers for a given fulfillment
|
|
2826
2947
|
* @summary List available fulfillers
|
|
@@ -2848,6 +2969,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2848
2969
|
* @memberof OrdersApi
|
|
2849
2970
|
*/
|
|
2850
2971
|
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
2972
|
+
/**
|
|
2973
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
2974
|
+
* @summary Send order receipt
|
|
2975
|
+
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
2976
|
+
* @param {*} [options] Override http request option.
|
|
2977
|
+
* @throws {RequiredError}
|
|
2978
|
+
* @memberof OrdersApi
|
|
2979
|
+
*/
|
|
2980
|
+
sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2851
2981
|
/**
|
|
2852
2982
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2853
2983
|
* @summary Update fulfillment
|