@teemill/platform 0.29.0 → 0.30.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 +7 -2
- package/api.ts +340 -13
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +215 -13
- package/dist/api.js +188 -6
- 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 +215 -13
- package/dist/esm/api.js +187 -5
- 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/AmendOrderRequest.md +20 -0
- package/docs/AmendOrderRequestAmendmentsInner.md +26 -0
- package/docs/CustomersApi.md +4 -4
- package/docs/OrdersApi.md +132 -0
- package/docs/ReturnOrderRequest.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.30.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -26,6 +26,10 @@ import globalAxios from 'axios';
|
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import { BASE_PATH, BaseAPI, operationServerMap } from './base';
|
|
29
|
+
export const AmendOrderRequestAmendmentsInnerActionEnum = {
|
|
30
|
+
Refund: 'refund',
|
|
31
|
+
Exchange: 'exchange'
|
|
32
|
+
};
|
|
29
33
|
export const CustomsInformationPreRegistrationTypeEnum = {
|
|
30
34
|
Ioss: 'IOSS'
|
|
31
35
|
};
|
|
@@ -75,7 +79,7 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
75
79
|
* @param {Array<string>} [countries] Filter customers by country code
|
|
76
80
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
77
81
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
78
|
-
* @param {Array<
|
|
82
|
+
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
79
83
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
80
84
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
81
85
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -220,7 +224,7 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
220
224
|
* @param {Array<string>} [countries] Filter customers by country code
|
|
221
225
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
222
226
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
223
|
-
* @param {Array<
|
|
227
|
+
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
224
228
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
225
229
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
226
230
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -336,7 +340,7 @@ export const CustomersApiFp = function (configuration) {
|
|
|
336
340
|
* @param {Array<string>} [countries] Filter customers by country code
|
|
337
341
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
338
342
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
339
|
-
* @param {Array<
|
|
343
|
+
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
340
344
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
341
345
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
342
346
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -388,7 +392,7 @@ export const CustomersApiFp = function (configuration) {
|
|
|
388
392
|
* @param {Array<string>} [countries] Filter customers by country code
|
|
389
393
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
390
394
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
391
|
-
* @param {Array<
|
|
395
|
+
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
392
396
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
393
397
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
394
398
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -1021,6 +1025,55 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
1021
1025
|
*/
|
|
1022
1026
|
export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
1023
1027
|
return {
|
|
1028
|
+
/**
|
|
1029
|
+
*
|
|
1030
|
+
* @summary Amend the contents of an order
|
|
1031
|
+
* @param {string} project Project unique identifier
|
|
1032
|
+
* @param {string} platformId The platform identifier
|
|
1033
|
+
* @param {string} orderId The order identifier
|
|
1034
|
+
* @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
|
|
1035
|
+
* @param {*} [options] Override http request option.
|
|
1036
|
+
* @throws {RequiredError}
|
|
1037
|
+
*/
|
|
1038
|
+
amendOrder: (project_1, platformId_1, orderId_1, amendOrderRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, amendOrderRequest_1, ...args_1], void 0, function* (project, platformId, orderId, amendOrderRequest, options = {}) {
|
|
1039
|
+
// verify required parameter 'project' is not null or undefined
|
|
1040
|
+
assertParamExists('amendOrder', 'project', project);
|
|
1041
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1042
|
+
assertParamExists('amendOrder', 'platformId', platformId);
|
|
1043
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
1044
|
+
assertParamExists('amendOrder', 'orderId', orderId);
|
|
1045
|
+
// verify required parameter 'amendOrderRequest' is not null or undefined
|
|
1046
|
+
assertParamExists('amendOrder', 'amendOrderRequest', amendOrderRequest);
|
|
1047
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/amend`
|
|
1048
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1049
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
1050
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1051
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1052
|
+
let baseOptions;
|
|
1053
|
+
if (configuration) {
|
|
1054
|
+
baseOptions = configuration.baseOptions;
|
|
1055
|
+
}
|
|
1056
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1057
|
+
const localVarHeaderParameter = {};
|
|
1058
|
+
const localVarQueryParameter = {};
|
|
1059
|
+
// authentication session-oauth required
|
|
1060
|
+
// oauth required
|
|
1061
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1062
|
+
// authentication api-key required
|
|
1063
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1064
|
+
if (project !== undefined) {
|
|
1065
|
+
localVarQueryParameter['project'] = project;
|
|
1066
|
+
}
|
|
1067
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1068
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1069
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1070
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1071
|
+
localVarRequestOptions.data = serializeDataIfNeeded(amendOrderRequest, localVarRequestOptions, configuration);
|
|
1072
|
+
return {
|
|
1073
|
+
url: toPathString(localVarUrlObj),
|
|
1074
|
+
options: localVarRequestOptions,
|
|
1075
|
+
};
|
|
1076
|
+
}),
|
|
1024
1077
|
/**
|
|
1025
1078
|
*
|
|
1026
1079
|
* @summary Confirm order
|
|
@@ -1469,6 +1522,55 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1469
1522
|
options: localVarRequestOptions,
|
|
1470
1523
|
};
|
|
1471
1524
|
}),
|
|
1525
|
+
/**
|
|
1526
|
+
*
|
|
1527
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
1528
|
+
* @param {string} project Project unique identifier
|
|
1529
|
+
* @param {string} platformId The platform identifier
|
|
1530
|
+
* @param {string} orderId The order identifier
|
|
1531
|
+
* @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
|
|
1532
|
+
* @param {*} [options] Override http request option.
|
|
1533
|
+
* @throws {RequiredError}
|
|
1534
|
+
*/
|
|
1535
|
+
returnOrder: (project_1, platformId_1, orderId_1, returnOrderRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, returnOrderRequest_1, ...args_1], void 0, function* (project, platformId, orderId, returnOrderRequest, options = {}) {
|
|
1536
|
+
// verify required parameter 'project' is not null or undefined
|
|
1537
|
+
assertParamExists('returnOrder', 'project', project);
|
|
1538
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1539
|
+
assertParamExists('returnOrder', 'platformId', platformId);
|
|
1540
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
1541
|
+
assertParamExists('returnOrder', 'orderId', orderId);
|
|
1542
|
+
// verify required parameter 'returnOrderRequest' is not null or undefined
|
|
1543
|
+
assertParamExists('returnOrder', 'returnOrderRequest', returnOrderRequest);
|
|
1544
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/return`
|
|
1545
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1546
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
1547
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1548
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1549
|
+
let baseOptions;
|
|
1550
|
+
if (configuration) {
|
|
1551
|
+
baseOptions = configuration.baseOptions;
|
|
1552
|
+
}
|
|
1553
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1554
|
+
const localVarHeaderParameter = {};
|
|
1555
|
+
const localVarQueryParameter = {};
|
|
1556
|
+
// authentication session-oauth required
|
|
1557
|
+
// oauth required
|
|
1558
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1559
|
+
// authentication api-key required
|
|
1560
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1561
|
+
if (project !== undefined) {
|
|
1562
|
+
localVarQueryParameter['project'] = project;
|
|
1563
|
+
}
|
|
1564
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1565
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1566
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1567
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1568
|
+
localVarRequestOptions.data = serializeDataIfNeeded(returnOrderRequest, localVarRequestOptions, configuration);
|
|
1569
|
+
return {
|
|
1570
|
+
url: toPathString(localVarUrlObj),
|
|
1571
|
+
options: localVarRequestOptions,
|
|
1572
|
+
};
|
|
1573
|
+
}),
|
|
1472
1574
|
/**
|
|
1473
1575
|
* 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.
|
|
1474
1576
|
* @summary Send order receipt
|
|
@@ -1571,6 +1673,25 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1571
1673
|
export const OrdersApiFp = function (configuration) {
|
|
1572
1674
|
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration);
|
|
1573
1675
|
return {
|
|
1676
|
+
/**
|
|
1677
|
+
*
|
|
1678
|
+
* @summary Amend the contents of an order
|
|
1679
|
+
* @param {string} project Project unique identifier
|
|
1680
|
+
* @param {string} platformId The platform identifier
|
|
1681
|
+
* @param {string} orderId The order identifier
|
|
1682
|
+
* @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
|
|
1683
|
+
* @param {*} [options] Override http request option.
|
|
1684
|
+
* @throws {RequiredError}
|
|
1685
|
+
*/
|
|
1686
|
+
amendOrder(project, platformId, orderId, amendOrderRequest, options) {
|
|
1687
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1688
|
+
var _a, _b, _c;
|
|
1689
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.amendOrder(project, platformId, orderId, amendOrderRequest, options);
|
|
1690
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1691
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.amendOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1692
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1693
|
+
});
|
|
1694
|
+
},
|
|
1574
1695
|
/**
|
|
1575
1696
|
*
|
|
1576
1697
|
* @summary Confirm order
|
|
@@ -1743,6 +1864,25 @@ export const OrdersApiFp = function (configuration) {
|
|
|
1743
1864
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1744
1865
|
});
|
|
1745
1866
|
},
|
|
1867
|
+
/**
|
|
1868
|
+
*
|
|
1869
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
1870
|
+
* @param {string} project Project unique identifier
|
|
1871
|
+
* @param {string} platformId The platform identifier
|
|
1872
|
+
* @param {string} orderId The order identifier
|
|
1873
|
+
* @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
|
|
1874
|
+
* @param {*} [options] Override http request option.
|
|
1875
|
+
* @throws {RequiredError}
|
|
1876
|
+
*/
|
|
1877
|
+
returnOrder(project, platformId, orderId, returnOrderRequest, options) {
|
|
1878
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1879
|
+
var _a, _b, _c;
|
|
1880
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.returnOrder(project, platformId, orderId, returnOrderRequest, options);
|
|
1881
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1882
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.returnOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1883
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1884
|
+
});
|
|
1885
|
+
},
|
|
1746
1886
|
/**
|
|
1747
1887
|
* 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.
|
|
1748
1888
|
* @summary Send order receipt
|
|
@@ -1789,6 +1929,16 @@ export const OrdersApiFp = function (configuration) {
|
|
|
1789
1929
|
export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
1790
1930
|
const localVarFp = OrdersApiFp(configuration);
|
|
1791
1931
|
return {
|
|
1932
|
+
/**
|
|
1933
|
+
*
|
|
1934
|
+
* @summary Amend the contents of an order
|
|
1935
|
+
* @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
|
|
1936
|
+
* @param {*} [options] Override http request option.
|
|
1937
|
+
* @throws {RequiredError}
|
|
1938
|
+
*/
|
|
1939
|
+
amendOrder(requestParameters, options) {
|
|
1940
|
+
return localVarFp.amendOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.amendOrderRequest, options).then((request) => request(axios, basePath));
|
|
1941
|
+
},
|
|
1792
1942
|
/**
|
|
1793
1943
|
*
|
|
1794
1944
|
* @summary Confirm order
|
|
@@ -1879,6 +2029,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
1879
2029
|
retryPlatformPayment(requestParameters, options) {
|
|
1880
2030
|
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
1881
2031
|
},
|
|
2032
|
+
/**
|
|
2033
|
+
*
|
|
2034
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
2035
|
+
* @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
|
|
2036
|
+
* @param {*} [options] Override http request option.
|
|
2037
|
+
* @throws {RequiredError}
|
|
2038
|
+
*/
|
|
2039
|
+
returnOrder(requestParameters, options) {
|
|
2040
|
+
return localVarFp.returnOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.returnOrderRequest, options).then((request) => request(axios, basePath));
|
|
2041
|
+
},
|
|
1882
2042
|
/**
|
|
1883
2043
|
* 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.
|
|
1884
2044
|
* @summary Send order receipt
|
|
@@ -1908,6 +2068,17 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
1908
2068
|
* @extends {BaseAPI}
|
|
1909
2069
|
*/
|
|
1910
2070
|
export class OrdersApi extends BaseAPI {
|
|
2071
|
+
/**
|
|
2072
|
+
*
|
|
2073
|
+
* @summary Amend the contents of an order
|
|
2074
|
+
* @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
|
|
2075
|
+
* @param {*} [options] Override http request option.
|
|
2076
|
+
* @throws {RequiredError}
|
|
2077
|
+
* @memberof OrdersApi
|
|
2078
|
+
*/
|
|
2079
|
+
amendOrder(requestParameters, options) {
|
|
2080
|
+
return OrdersApiFp(this.configuration).amendOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.amendOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2081
|
+
}
|
|
1911
2082
|
/**
|
|
1912
2083
|
*
|
|
1913
2084
|
* @summary Confirm order
|
|
@@ -2007,6 +2178,17 @@ export class OrdersApi extends BaseAPI {
|
|
|
2007
2178
|
retryPlatformPayment(requestParameters, options) {
|
|
2008
2179
|
return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
2009
2180
|
}
|
|
2181
|
+
/**
|
|
2182
|
+
*
|
|
2183
|
+
* @summary Return the contents of an order for a refund or exchange
|
|
2184
|
+
* @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
|
|
2185
|
+
* @param {*} [options] Override http request option.
|
|
2186
|
+
* @throws {RequiredError}
|
|
2187
|
+
* @memberof OrdersApi
|
|
2188
|
+
*/
|
|
2189
|
+
returnOrder(requestParameters, options) {
|
|
2190
|
+
return OrdersApiFp(this.configuration).returnOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.returnOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2191
|
+
}
|
|
2010
2192
|
/**
|
|
2011
2193
|
* 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.
|
|
2012
2194
|
* @summary Send order receipt
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AmendOrderRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**amendments** | [**Array<AmendOrderRequestAmendmentsInner>**](AmendOrderRequestAmendmentsInner.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AmendOrderRequest } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: AmendOrderRequest = {
|
|
16
|
+
amendments,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# AmendOrderRequestAmendmentsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique order item identifier | [default to undefined]
|
|
9
|
+
**action** | **string** | | [default to undefined]
|
|
10
|
+
**quantity** | **number** | The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order. | [default to undefined]
|
|
11
|
+
**newVariantRef** | **string** | A reference to the variant being ordered | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AmendOrderRequestAmendmentsInner } from '@teemill/platform';
|
|
17
|
+
|
|
18
|
+
const instance: AmendOrderRequestAmendmentsInner = {
|
|
19
|
+
id,
|
|
20
|
+
action,
|
|
21
|
+
quantity,
|
|
22
|
+
newVariantRef,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/CustomersApi.md
CHANGED
|
@@ -30,7 +30,7 @@ let sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-t
|
|
|
30
30
|
let countries: Array<string>; //Filter customers by country code (optional) (default to undefined)
|
|
31
31
|
let projects: Array<string>; //Filter customers by project. In the absence of this field, all projects will be included in the export. (optional) (default to undefined)
|
|
32
32
|
let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
|
|
33
|
-
let productTypes: Array<
|
|
33
|
+
let productTypes: Array<number>; //Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
34
34
|
let usedDiscount: boolean; //Filter customers by whether they have used a discount (optional) (default to undefined)
|
|
35
35
|
let minimumTotalOrderCount: number; //Filter customers by total order count greater than or equal to the value provided (optional) (default to undefined)
|
|
36
36
|
let maximumTotalOrderCount: number; //Filter customers by total order count less than or equal to the value provided (optional) (default to undefined)
|
|
@@ -71,7 +71,7 @@ const { status, data } = await apiInstance.exportCustomers(
|
|
|
71
71
|
| **countries** | **Array<string>** | Filter customers by country code | (optional) defaults to undefined|
|
|
72
72
|
| **projects** | **Array<string>** | Filter customers by project. In the absence of this field, all projects will be included in the export. | (optional) defaults to undefined|
|
|
73
73
|
| **gender** | [**'male' | 'female'**]**Array<'male' | 'female'>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
|
|
74
|
-
| **productTypes** | **Array<
|
|
74
|
+
| **productTypes** | **Array<number>** | Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
75
75
|
| **usedDiscount** | [**boolean**] | Filter customers by whether they have used a discount | (optional) defaults to undefined|
|
|
76
76
|
| **minimumTotalOrderCount** | [**number**] | Filter customers by total order count greater than or equal to the value provided | (optional) defaults to undefined|
|
|
77
77
|
| **maximumTotalOrderCount** | [**number**] | Filter customers by total order count less than or equal to the value provided | (optional) defaults to undefined|
|
|
@@ -196,7 +196,7 @@ let sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-t
|
|
|
196
196
|
let countries: Array<string>; //Filter customers by country code (optional) (default to undefined)
|
|
197
197
|
let projects: Array<string>; //Filter customers by project. In the absence of this field, all projects will be included in the export. (optional) (default to undefined)
|
|
198
198
|
let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
|
|
199
|
-
let productTypes: Array<
|
|
199
|
+
let productTypes: Array<number>; //Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
200
200
|
let usedDiscount: boolean; //Filter customers by whether they have used a discount (optional) (default to undefined)
|
|
201
201
|
let minimumTotalOrderCount: number; //Filter customers by total order count greater than or equal to the value provided (optional) (default to undefined)
|
|
202
202
|
let maximumTotalOrderCount: number; //Filter customers by total order count less than or equal to the value provided (optional) (default to undefined)
|
|
@@ -243,7 +243,7 @@ const { status, data } = await apiInstance.listCustomers(
|
|
|
243
243
|
| **countries** | **Array<string>** | Filter customers by country code | (optional) defaults to undefined|
|
|
244
244
|
| **projects** | **Array<string>** | Filter customers by project. In the absence of this field, all projects will be included in the export. | (optional) defaults to undefined|
|
|
245
245
|
| **gender** | [**'male' | 'female'**]**Array<'male' | 'female'>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
|
|
246
|
-
| **productTypes** | **Array<
|
|
246
|
+
| **productTypes** | **Array<number>** | Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
247
247
|
| **usedDiscount** | [**boolean**] | Filter customers by whether they have used a discount | (optional) defaults to undefined|
|
|
248
248
|
| **minimumTotalOrderCount** | [**number**] | Filter customers by total order count greater than or equal to the value provided | (optional) defaults to undefined|
|
|
249
249
|
| **maximumTotalOrderCount** | [**number**] | Filter customers by total order count less than or equal to the value provided | (optional) defaults to undefined|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**amendOrder**](#amendorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/amend | Amend the contents of an order|
|
|
7
8
|
|[**confirmOrder**](#confirmorder) | **POST** /v1/platform/{platformId}/orders/{orderId}/confirm | Confirm order|
|
|
8
9
|
|[**createOrder**](#createorder) | **POST** /v1/platform/{platformId}/orders | Create order|
|
|
9
10
|
|[**exportOrders**](#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders|
|
|
@@ -13,9 +14,75 @@ All URIs are relative to *https://localhost:8080*
|
|
|
13
14
|
|[**listAvailableFulfillers**](#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers|
|
|
14
15
|
|[**listOrders**](#listorders) | **GET** /v1/platform/{platformId}/orders | List orders|
|
|
15
16
|
|[**retryPlatformPayment**](#retryplatformpayment) | **POST** /v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment | Retry|
|
|
17
|
+
|[**returnOrder**](#returnorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/return | Return the contents of an order for a refund or exchange|
|
|
16
18
|
|[**sendOrderReceipt**](#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt|
|
|
17
19
|
|[**updateFulfillment**](#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment|
|
|
18
20
|
|
|
21
|
+
# **amendOrder**
|
|
22
|
+
> Order amendOrder(amendOrderRequest)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import {
|
|
29
|
+
OrdersApi,
|
|
30
|
+
Configuration,
|
|
31
|
+
AmendOrderRequest
|
|
32
|
+
} from '@teemill/platform';
|
|
33
|
+
|
|
34
|
+
const configuration = new Configuration();
|
|
35
|
+
const apiInstance = new OrdersApi(configuration);
|
|
36
|
+
|
|
37
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
38
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
39
|
+
let orderId: string; //The order identifier (default to undefined)
|
|
40
|
+
let amendOrderRequest: AmendOrderRequest; //AmendOrder schema
|
|
41
|
+
|
|
42
|
+
const { status, data } = await apiInstance.amendOrder(
|
|
43
|
+
project,
|
|
44
|
+
platformId,
|
|
45
|
+
orderId,
|
|
46
|
+
amendOrderRequest
|
|
47
|
+
);
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Parameters
|
|
51
|
+
|
|
52
|
+
|Name | Type | Description | Notes|
|
|
53
|
+
|------------- | ------------- | ------------- | -------------|
|
|
54
|
+
| **amendOrderRequest** | **AmendOrderRequest**| AmendOrder schema | |
|
|
55
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
56
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
57
|
+
| **orderId** | [**string**] | The order identifier | defaults to undefined|
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
**Order**
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: application/json
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### HTTP response details
|
|
75
|
+
| Status code | Description | Response headers |
|
|
76
|
+
|-------------|-------------|------------------|
|
|
77
|
+
|**200** | Order schema | - |
|
|
78
|
+
|**400** | Failed validation | - |
|
|
79
|
+
|**401** | Not authorised to access this resource | - |
|
|
80
|
+
|**403** | Refuse to authorize | - |
|
|
81
|
+
|**404** | Resource not found | - |
|
|
82
|
+
|**500** | Unknown server error | - |
|
|
83
|
+
|
|
84
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
85
|
+
|
|
19
86
|
# **confirmOrder**
|
|
20
87
|
> Order confirmOrder(confirmOrderRequest)
|
|
21
88
|
|
|
@@ -591,6 +658,71 @@ const { status, data } = await apiInstance.retryPlatformPayment(
|
|
|
591
658
|
- **Accept**: application/json
|
|
592
659
|
|
|
593
660
|
|
|
661
|
+
### HTTP response details
|
|
662
|
+
| Status code | Description | Response headers |
|
|
663
|
+
|-------------|-------------|------------------|
|
|
664
|
+
|**200** | Order schema | - |
|
|
665
|
+
|**400** | Failed validation | - |
|
|
666
|
+
|**401** | Not authorised to access this resource | - |
|
|
667
|
+
|**403** | Refuse to authorize | - |
|
|
668
|
+
|**404** | Resource not found | - |
|
|
669
|
+
|**500** | Unknown server error | - |
|
|
670
|
+
|
|
671
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
672
|
+
|
|
673
|
+
# **returnOrder**
|
|
674
|
+
> Order returnOrder(returnOrderRequest)
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
### Example
|
|
678
|
+
|
|
679
|
+
```typescript
|
|
680
|
+
import {
|
|
681
|
+
OrdersApi,
|
|
682
|
+
Configuration,
|
|
683
|
+
ReturnOrderRequest
|
|
684
|
+
} from '@teemill/platform';
|
|
685
|
+
|
|
686
|
+
const configuration = new Configuration();
|
|
687
|
+
const apiInstance = new OrdersApi(configuration);
|
|
688
|
+
|
|
689
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
690
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
691
|
+
let orderId: string; //The order identifier (default to undefined)
|
|
692
|
+
let returnOrderRequest: ReturnOrderRequest; //ReturnOrder schema
|
|
693
|
+
|
|
694
|
+
const { status, data } = await apiInstance.returnOrder(
|
|
695
|
+
project,
|
|
696
|
+
platformId,
|
|
697
|
+
orderId,
|
|
698
|
+
returnOrderRequest
|
|
699
|
+
);
|
|
700
|
+
```
|
|
701
|
+
|
|
702
|
+
### Parameters
|
|
703
|
+
|
|
704
|
+
|Name | Type | Description | Notes|
|
|
705
|
+
|------------- | ------------- | ------------- | -------------|
|
|
706
|
+
| **returnOrderRequest** | **ReturnOrderRequest**| ReturnOrder schema | |
|
|
707
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
708
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
709
|
+
| **orderId** | [**string**] | The order identifier | defaults to undefined|
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
### Return type
|
|
713
|
+
|
|
714
|
+
**Order**
|
|
715
|
+
|
|
716
|
+
### Authorization
|
|
717
|
+
|
|
718
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
719
|
+
|
|
720
|
+
### HTTP request headers
|
|
721
|
+
|
|
722
|
+
- **Content-Type**: application/json
|
|
723
|
+
- **Accept**: application/json
|
|
724
|
+
|
|
725
|
+
|
|
594
726
|
### HTTP response details
|
|
595
727
|
| Status code | Description | Response headers |
|
|
596
728
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ReturnOrderRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**returns** | [**Array<AmendOrderRequestAmendmentsInner>**](AmendOrderRequestAmendmentsInner.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ReturnOrderRequest } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: ReturnOrderRequest = {
|
|
16
|
+
returns,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|