@teemill/platform 0.42.0 → 0.44.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 +194 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +25 -2
- package/dist/api.d.ts +117 -3
- package/dist/api.js +122 -8
- 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 +25 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +117 -3
- package/dist/esm/api.js +120 -7
- 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 +25 -1
- package/dist/esm/configuration.js +2 -2
- 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/Application.md +32 -0
- package/docs/AttachedFile.md +22 -0
- package/docs/OrdersApi.md +76 -3
- package/docs/PrintArea.md +23 -0
- package/docs/UpdatePlatformFulfillmentStyleApplicationRequest.md +20 -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.44.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
25
|
+
exports.TermsApiFp = exports.TermsApiAxiosParamCreator = exports.ReviewsApi = exports.ReviewsApiFactory = exports.ReviewsApiFp = exports.ReviewsApiAxiosParamCreator = exports.PlatformApi = exports.PlatformApiFactory = exports.PlatformApiFp = exports.PlatformApiAxiosParamCreator = exports.PixelsApi = exports.PixelsApiFactory = exports.PixelsApiFp = exports.PixelsApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.ListOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.EnquiriesApi = exports.EnquiriesApiFactory = exports.EnquiriesApiFp = exports.EnquiriesApiAxiosParamCreator = exports.DashboardApi = exports.DashboardApiFactory = exports.DashboardApiFp = exports.DashboardApiAxiosParamCreator = exports.ListCustomersGenderEnum = exports.ListCustomersSortByEnum = exports.ExportCustomersGenderEnum = exports.ExportCustomersSortByEnum = exports.CustomersApi = exports.CustomersApiFactory = exports.CustomersApiFp = exports.CustomersApiAxiosParamCreator = exports.ReturnOrderRequestReturnsInnerActionEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.PaymentAccountMethodEnum = exports.OrderStatus = exports.EnquiryStatusEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.ApplicationPlacementEnum = exports.AmendmentLogAmendmentTypeEnum = exports.AmendOrderRequestAmendmentsInnerActionEnum = void 0;
|
|
26
|
+
exports.TermsApi = exports.TermsApiFactory = void 0;
|
|
26
27
|
const axios_1 = require("axios");
|
|
27
28
|
// Some imports not used depending on template conditions
|
|
28
29
|
// @ts-ignore
|
|
@@ -37,6 +38,10 @@ exports.AmendmentLogAmendmentTypeEnum = {
|
|
|
37
38
|
Refund: 'refund',
|
|
38
39
|
Exchange: 'exchange'
|
|
39
40
|
};
|
|
41
|
+
exports.ApplicationPlacementEnum = {
|
|
42
|
+
Front: 'front',
|
|
43
|
+
Back: 'back'
|
|
44
|
+
};
|
|
40
45
|
exports.CustomsInformationPreRegistrationTypeEnum = {
|
|
41
46
|
Ioss: 'IOSS'
|
|
42
47
|
};
|
|
@@ -1505,10 +1510,11 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1505
1510
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1506
1511
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
1507
1512
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1513
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1508
1514
|
* @param {*} [options] Override http request option.
|
|
1509
1515
|
* @throws {RequiredError}
|
|
1510
1516
|
*/
|
|
1511
|
-
exportOrders: (project_1, platformId_1, start_1, end_1, search_1, ...args_1) => __awaiter(this, [project_1, platformId_1, start_1, end_1, search_1, ...args_1], void 0, function* (project, platformId, start, end, search, options = {}) {
|
|
1517
|
+
exportOrders: (project_1, platformId_1, start_1, end_1, search_1, dateFilterType_1, ...args_1) => __awaiter(this, [project_1, platformId_1, start_1, end_1, search_1, dateFilterType_1, ...args_1], void 0, function* (project, platformId, start, end, search, dateFilterType, options = {}) {
|
|
1512
1518
|
// verify required parameter 'project' is not null or undefined
|
|
1513
1519
|
(0, common_1.assertParamExists)('exportOrders', 'project', project);
|
|
1514
1520
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1547,6 +1553,9 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1547
1553
|
if (search !== undefined) {
|
|
1548
1554
|
localVarQueryParameter['search'] = search;
|
|
1549
1555
|
}
|
|
1556
|
+
if (dateFilterType !== undefined) {
|
|
1557
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1558
|
+
}
|
|
1550
1559
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1551
1560
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1552
1561
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -1993,6 +2002,59 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1993
2002
|
options: localVarRequestOptions,
|
|
1994
2003
|
};
|
|
1995
2004
|
}),
|
|
2005
|
+
/**
|
|
2006
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2007
|
+
* @summary Update platform fulfillment style application
|
|
2008
|
+
* @param {string} project Project unique identifier
|
|
2009
|
+
* @param {string} platformId The platform identifier
|
|
2010
|
+
* @param {string} styleId Unique identifier of a fulfillment style
|
|
2011
|
+
* @param {string} applicationId Unique identifier of a fulfillment style application
|
|
2012
|
+
* @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
|
|
2013
|
+
* @param {*} [options] Override http request option.
|
|
2014
|
+
* @throws {RequiredError}
|
|
2015
|
+
*/
|
|
2016
|
+
updatePlatformFulfillmentStyleApplication: (project_1, platformId_1, styleId_1, applicationId_1, updatePlatformFulfillmentStyleApplicationRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, styleId_1, applicationId_1, updatePlatformFulfillmentStyleApplicationRequest_1, ...args_1], void 0, function* (project, platformId, styleId, applicationId, updatePlatformFulfillmentStyleApplicationRequest, options = {}) {
|
|
2017
|
+
// verify required parameter 'project' is not null or undefined
|
|
2018
|
+
(0, common_1.assertParamExists)('updatePlatformFulfillmentStyleApplication', 'project', project);
|
|
2019
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2020
|
+
(0, common_1.assertParamExists)('updatePlatformFulfillmentStyleApplication', 'platformId', platformId);
|
|
2021
|
+
// verify required parameter 'styleId' is not null or undefined
|
|
2022
|
+
(0, common_1.assertParamExists)('updatePlatformFulfillmentStyleApplication', 'styleId', styleId);
|
|
2023
|
+
// verify required parameter 'applicationId' is not null or undefined
|
|
2024
|
+
(0, common_1.assertParamExists)('updatePlatformFulfillmentStyleApplication', 'applicationId', applicationId);
|
|
2025
|
+
// verify required parameter 'updatePlatformFulfillmentStyleApplicationRequest' is not null or undefined
|
|
2026
|
+
(0, common_1.assertParamExists)('updatePlatformFulfillmentStyleApplication', 'updatePlatformFulfillmentStyleApplicationRequest', updatePlatformFulfillmentStyleApplicationRequest);
|
|
2027
|
+
const localVarPath = `/v1/platform/{platformId}/styles/{styleId}/applications/{applicationId}`
|
|
2028
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2029
|
+
.replace(`{${"styleId"}}`, encodeURIComponent(String(styleId)))
|
|
2030
|
+
.replace(`{${"applicationId"}}`, encodeURIComponent(String(applicationId)));
|
|
2031
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2032
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2033
|
+
let baseOptions;
|
|
2034
|
+
if (configuration) {
|
|
2035
|
+
baseOptions = configuration.baseOptions;
|
|
2036
|
+
}
|
|
2037
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
2038
|
+
const localVarHeaderParameter = {};
|
|
2039
|
+
const localVarQueryParameter = {};
|
|
2040
|
+
// authentication session-oauth required
|
|
2041
|
+
// oauth required
|
|
2042
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
2043
|
+
// authentication api-key required
|
|
2044
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
2045
|
+
if (project !== undefined) {
|
|
2046
|
+
localVarQueryParameter['project'] = project;
|
|
2047
|
+
}
|
|
2048
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2049
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2050
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2051
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2052
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updatePlatformFulfillmentStyleApplicationRequest, localVarRequestOptions, configuration);
|
|
2053
|
+
return {
|
|
2054
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2055
|
+
options: localVarRequestOptions,
|
|
2056
|
+
};
|
|
2057
|
+
}),
|
|
1996
2058
|
};
|
|
1997
2059
|
};
|
|
1998
2060
|
exports.OrdersApiAxiosParamCreator = OrdersApiAxiosParamCreator;
|
|
@@ -2084,13 +2146,14 @@ const OrdersApiFp = function (configuration) {
|
|
|
2084
2146
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2085
2147
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
2086
2148
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2149
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2087
2150
|
* @param {*} [options] Override http request option.
|
|
2088
2151
|
* @throws {RequiredError}
|
|
2089
2152
|
*/
|
|
2090
|
-
exportOrders(project, platformId, start, end, search, options) {
|
|
2153
|
+
exportOrders(project, platformId, start, end, search, dateFilterType, options) {
|
|
2091
2154
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2092
2155
|
var _a, _b, _c;
|
|
2093
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, options);
|
|
2156
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, dateFilterType, options);
|
|
2094
2157
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2095
2158
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.exportOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2096
2159
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2267,6 +2330,26 @@ const OrdersApiFp = function (configuration) {
|
|
|
2267
2330
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2268
2331
|
});
|
|
2269
2332
|
},
|
|
2333
|
+
/**
|
|
2334
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2335
|
+
* @summary Update platform fulfillment style application
|
|
2336
|
+
* @param {string} project Project unique identifier
|
|
2337
|
+
* @param {string} platformId The platform identifier
|
|
2338
|
+
* @param {string} styleId Unique identifier of a fulfillment style
|
|
2339
|
+
* @param {string} applicationId Unique identifier of a fulfillment style application
|
|
2340
|
+
* @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
|
|
2341
|
+
* @param {*} [options] Override http request option.
|
|
2342
|
+
* @throws {RequiredError}
|
|
2343
|
+
*/
|
|
2344
|
+
updatePlatformFulfillmentStyleApplication(project, platformId, styleId, applicationId, updatePlatformFulfillmentStyleApplicationRequest, options) {
|
|
2345
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2346
|
+
var _a, _b, _c;
|
|
2347
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePlatformFulfillmentStyleApplication(project, platformId, styleId, applicationId, updatePlatformFulfillmentStyleApplicationRequest, options);
|
|
2348
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2349
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.updatePlatformFulfillmentStyleApplication']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2350
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2351
|
+
});
|
|
2352
|
+
},
|
|
2270
2353
|
};
|
|
2271
2354
|
};
|
|
2272
2355
|
exports.OrdersApiFp = OrdersApiFp;
|
|
@@ -2324,7 +2407,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
2324
2407
|
* @throws {RequiredError}
|
|
2325
2408
|
*/
|
|
2326
2409
|
exportOrders(requestParameters, options) {
|
|
2327
|
-
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
2410
|
+
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
2328
2411
|
},
|
|
2329
2412
|
/**
|
|
2330
2413
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
@@ -2416,6 +2499,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
2416
2499
|
updateFulfillment(requestParameters, options) {
|
|
2417
2500
|
return localVarFp.updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(axios, basePath));
|
|
2418
2501
|
},
|
|
2502
|
+
/**
|
|
2503
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2504
|
+
* @summary Update platform fulfillment style application
|
|
2505
|
+
* @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
|
|
2506
|
+
* @param {*} [options] Override http request option.
|
|
2507
|
+
* @throws {RequiredError}
|
|
2508
|
+
*/
|
|
2509
|
+
updatePlatformFulfillmentStyleApplication(requestParameters, options) {
|
|
2510
|
+
return localVarFp.updatePlatformFulfillmentStyleApplication(requestParameters.project, requestParameters.platformId, requestParameters.styleId, requestParameters.applicationId, requestParameters.updatePlatformFulfillmentStyleApplicationRequest, options).then((request) => request(axios, basePath));
|
|
2511
|
+
},
|
|
2419
2512
|
};
|
|
2420
2513
|
};
|
|
2421
2514
|
exports.OrdersApiFactory = OrdersApiFactory;
|
|
@@ -2471,7 +2564,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
2471
2564
|
* @throws {RequiredError}
|
|
2472
2565
|
*/
|
|
2473
2566
|
exportOrders(requestParameters, options) {
|
|
2474
|
-
return (0, exports.OrdersApiFp)(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
2567
|
+
return (0, exports.OrdersApiFp)(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
2475
2568
|
}
|
|
2476
2569
|
/**
|
|
2477
2570
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
@@ -2563,12 +2656,33 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
2563
2656
|
updateFulfillment(requestParameters, options) {
|
|
2564
2657
|
return (0, exports.OrdersApiFp)(this.configuration).updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2565
2658
|
}
|
|
2659
|
+
/**
|
|
2660
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2661
|
+
* @summary Update platform fulfillment style application
|
|
2662
|
+
* @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
|
|
2663
|
+
* @param {*} [options] Override http request option.
|
|
2664
|
+
* @throws {RequiredError}
|
|
2665
|
+
*/
|
|
2666
|
+
updatePlatformFulfillmentStyleApplication(requestParameters, options) {
|
|
2667
|
+
return (0, exports.OrdersApiFp)(this.configuration).updatePlatformFulfillmentStyleApplication(requestParameters.project, requestParameters.platformId, requestParameters.styleId, requestParameters.applicationId, requestParameters.updatePlatformFulfillmentStyleApplicationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2668
|
+
}
|
|
2566
2669
|
}
|
|
2567
2670
|
exports.OrdersApi = OrdersApi;
|
|
2671
|
+
exports.ExportOrdersDateFilterTypeEnum = {
|
|
2672
|
+
CreatedAt: 'createdAt',
|
|
2673
|
+
PaidAt: 'paidAt',
|
|
2674
|
+
UpdatedAt: 'updatedAt',
|
|
2675
|
+
StatusChangedAt: 'statusChangedAt',
|
|
2676
|
+
CompletedAt: 'completedAt',
|
|
2677
|
+
RefundedAt: 'refundedAt'
|
|
2678
|
+
};
|
|
2568
2679
|
exports.ListOrdersDateFilterTypeEnum = {
|
|
2569
2680
|
CreatedAt: 'createdAt',
|
|
2681
|
+
PaidAt: 'paidAt',
|
|
2570
2682
|
UpdatedAt: 'updatedAt',
|
|
2571
|
-
StatusChangedAt: 'statusChangedAt'
|
|
2683
|
+
StatusChangedAt: 'statusChangedAt',
|
|
2684
|
+
CompletedAt: 'completedAt',
|
|
2685
|
+
RefundedAt: 'refundedAt'
|
|
2572
2686
|
};
|
|
2573
2687
|
/**
|
|
2574
2688
|
* PaymentApi - axios parameter creator
|
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
|
@@ -2,18 +2,30 @@
|
|
|
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.44.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
interface AWSv4Configuration {
|
|
13
|
+
options?: {
|
|
14
|
+
region?: string;
|
|
15
|
+
service?: string;
|
|
16
|
+
};
|
|
17
|
+
credentials?: {
|
|
18
|
+
accessKeyId?: string;
|
|
19
|
+
secretAccessKey?: string;
|
|
20
|
+
sessionToken?: string;
|
|
21
|
+
};
|
|
22
|
+
}
|
|
12
23
|
export interface ConfigurationParameters {
|
|
13
24
|
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
14
25
|
username?: string;
|
|
15
26
|
password?: string;
|
|
16
27
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
28
|
+
awsv4?: AWSv4Configuration;
|
|
17
29
|
basePath?: string;
|
|
18
30
|
serverIndex?: number;
|
|
19
31
|
baseOptions?: any;
|
|
@@ -39,6 +51,17 @@ export declare class Configuration {
|
|
|
39
51
|
* @param scopes oauth2 scope
|
|
40
52
|
*/
|
|
41
53
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
54
|
+
/**
|
|
55
|
+
* parameter for aws4 signature security
|
|
56
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
57
|
+
* @param {string} options.region - aws region
|
|
58
|
+
* @param {string} options.service - name of the service.
|
|
59
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
60
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
61
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
62
|
+
* @memberof Configuration
|
|
63
|
+
*/
|
|
64
|
+
awsv4?: AWSv4Configuration;
|
|
42
65
|
/**
|
|
43
66
|
* override base path
|
|
44
67
|
*/
|
|
@@ -72,3 +95,4 @@ export declare class Configuration {
|
|
|
72
95
|
*/
|
|
73
96
|
isJsonMime(mime: string): boolean;
|
|
74
97
|
}
|
|
98
|
+
export {};
|
package/dist/configuration.js
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
3
|
/**
|
|
5
4
|
* Platform API
|
|
6
5
|
* Manage Your podOS platform
|
|
7
6
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.44.0
|
|
9
8
|
*
|
|
10
9
|
*
|
|
11
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -21,6 +20,7 @@ class Configuration {
|
|
|
21
20
|
this.username = param.username;
|
|
22
21
|
this.password = param.password;
|
|
23
22
|
this.accessToken = param.accessToken;
|
|
23
|
+
this.awsv4 = param.awsv4;
|
|
24
24
|
this.basePath = param.basePath;
|
|
25
25
|
this.serverIndex = param.serverIndex;
|
|
26
26
|
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
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.44.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -107,6 +107,30 @@ export interface ApiError {
|
|
|
107
107
|
'code'?: string;
|
|
108
108
|
'message': string;
|
|
109
109
|
}
|
|
110
|
+
export interface Application {
|
|
111
|
+
/**
|
|
112
|
+
* Unique object identifier
|
|
113
|
+
*/
|
|
114
|
+
'id'?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Unique object identifier
|
|
117
|
+
*/
|
|
118
|
+
'styleId'?: string;
|
|
119
|
+
'placement'?: ApplicationPlacementEnum;
|
|
120
|
+
'mockup'?: string;
|
|
121
|
+
'design'?: string;
|
|
122
|
+
'printArea'?: PrintArea;
|
|
123
|
+
'files'?: Array<AttachedFile>;
|
|
124
|
+
}
|
|
125
|
+
export declare const ApplicationPlacementEnum: {
|
|
126
|
+
readonly Front: "front";
|
|
127
|
+
readonly Back: "back";
|
|
128
|
+
};
|
|
129
|
+
export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
|
|
130
|
+
export interface AttachedFile {
|
|
131
|
+
'url'?: string;
|
|
132
|
+
'name'?: string;
|
|
133
|
+
}
|
|
110
134
|
export interface AuthorizeStripe200Response {
|
|
111
135
|
/**
|
|
112
136
|
* The URL to redirect to
|
|
@@ -736,6 +760,13 @@ export interface Price {
|
|
|
736
760
|
*/
|
|
737
761
|
'currencyCode'?: string;
|
|
738
762
|
}
|
|
763
|
+
/**
|
|
764
|
+
* Print area dimensions in mm
|
|
765
|
+
*/
|
|
766
|
+
export interface PrintArea {
|
|
767
|
+
'width'?: number;
|
|
768
|
+
'height'?: number;
|
|
769
|
+
}
|
|
739
770
|
export interface Project {
|
|
740
771
|
'id': string;
|
|
741
772
|
/**
|
|
@@ -920,6 +951,9 @@ export interface UpdateFulfillmentRequest {
|
|
|
920
951
|
*/
|
|
921
952
|
'fulfillerId'?: string;
|
|
922
953
|
}
|
|
954
|
+
export interface UpdatePlatformFulfillmentStyleApplicationRequest {
|
|
955
|
+
'design'?: string;
|
|
956
|
+
}
|
|
923
957
|
export interface UpdatePlatformRequest {
|
|
924
958
|
'logos'?: Array<PlatformLogo>;
|
|
925
959
|
'favicon'?: string;
|
|
@@ -1919,10 +1953,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1919
1953
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1920
1954
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
1921
1955
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1956
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1922
1957
|
* @param {*} [options] Override http request option.
|
|
1923
1958
|
* @throws {RequiredError}
|
|
1924
1959
|
*/
|
|
1925
|
-
exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1960
|
+
exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1926
1961
|
/**
|
|
1927
1962
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1928
1963
|
* @summary Get fulfillment
|
|
@@ -2022,6 +2057,18 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2022
2057
|
* @throws {RequiredError}
|
|
2023
2058
|
*/
|
|
2024
2059
|
updateFulfillment: (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2060
|
+
/**
|
|
2061
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2062
|
+
* @summary Update platform fulfillment style application
|
|
2063
|
+
* @param {string} project Project unique identifier
|
|
2064
|
+
* @param {string} platformId The platform identifier
|
|
2065
|
+
* @param {string} styleId Unique identifier of a fulfillment style
|
|
2066
|
+
* @param {string} applicationId Unique identifier of a fulfillment style application
|
|
2067
|
+
* @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
|
|
2068
|
+
* @param {*} [options] Override http request option.
|
|
2069
|
+
* @throws {RequiredError}
|
|
2070
|
+
*/
|
|
2071
|
+
updatePlatformFulfillmentStyleApplication: (project: string, platformId: string, styleId: string, applicationId: string, updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2025
2072
|
};
|
|
2026
2073
|
/**
|
|
2027
2074
|
* OrdersApi - functional programming interface
|
|
@@ -2077,10 +2124,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2077
2124
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2078
2125
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
2079
2126
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2127
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2080
2128
|
* @param {*} [options] Override http request option.
|
|
2081
2129
|
* @throws {RequiredError}
|
|
2082
2130
|
*/
|
|
2083
|
-
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2131
|
+
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2084
2132
|
/**
|
|
2085
2133
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
2086
2134
|
* @summary Get fulfillment
|
|
@@ -2180,6 +2228,18 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2180
2228
|
* @throws {RequiredError}
|
|
2181
2229
|
*/
|
|
2182
2230
|
updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
|
|
2231
|
+
/**
|
|
2232
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2233
|
+
* @summary Update platform fulfillment style application
|
|
2234
|
+
* @param {string} project Project unique identifier
|
|
2235
|
+
* @param {string} platformId The platform identifier
|
|
2236
|
+
* @param {string} styleId Unique identifier of a fulfillment style
|
|
2237
|
+
* @param {string} applicationId Unique identifier of a fulfillment style application
|
|
2238
|
+
* @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
|
|
2239
|
+
* @param {*} [options] Override http request option.
|
|
2240
|
+
* @throws {RequiredError}
|
|
2241
|
+
*/
|
|
2242
|
+
updatePlatformFulfillmentStyleApplication(project: string, platformId: string, styleId: string, applicationId: string, updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Application>>;
|
|
2183
2243
|
};
|
|
2184
2244
|
/**
|
|
2185
2245
|
* OrdersApi - factory interface
|
|
@@ -2297,6 +2357,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
2297
2357
|
* @throws {RequiredError}
|
|
2298
2358
|
*/
|
|
2299
2359
|
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
|
|
2360
|
+
/**
|
|
2361
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2362
|
+
* @summary Update platform fulfillment style application
|
|
2363
|
+
* @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
|
|
2364
|
+
* @param {*} [options] Override http request option.
|
|
2365
|
+
* @throws {RequiredError}
|
|
2366
|
+
*/
|
|
2367
|
+
updatePlatformFulfillmentStyleApplication(requestParameters: OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Application>;
|
|
2300
2368
|
};
|
|
2301
2369
|
/**
|
|
2302
2370
|
* Request parameters for amendOrder operation in OrdersApi.
|
|
@@ -2398,6 +2466,10 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
2398
2466
|
* Search term to filter based on order reference, customer name and email
|
|
2399
2467
|
*/
|
|
2400
2468
|
readonly search?: string;
|
|
2469
|
+
/**
|
|
2470
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2471
|
+
*/
|
|
2472
|
+
readonly dateFilterType?: ExportOrdersDateFilterTypeEnum;
|
|
2401
2473
|
}
|
|
2402
2474
|
/**
|
|
2403
2475
|
* Request parameters for getFulfillment operation in OrdersApi.
|
|
@@ -2585,6 +2657,28 @@ export interface OrdersApiUpdateFulfillmentRequest {
|
|
|
2585
2657
|
readonly fulfillmentId: string;
|
|
2586
2658
|
readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
|
|
2587
2659
|
}
|
|
2660
|
+
/**
|
|
2661
|
+
* Request parameters for updatePlatformFulfillmentStyleApplication operation in OrdersApi.
|
|
2662
|
+
*/
|
|
2663
|
+
export interface OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest {
|
|
2664
|
+
/**
|
|
2665
|
+
* Project unique identifier
|
|
2666
|
+
*/
|
|
2667
|
+
readonly project: string;
|
|
2668
|
+
/**
|
|
2669
|
+
* The platform identifier
|
|
2670
|
+
*/
|
|
2671
|
+
readonly platformId: string;
|
|
2672
|
+
/**
|
|
2673
|
+
* Unique identifier of a fulfillment style
|
|
2674
|
+
*/
|
|
2675
|
+
readonly styleId: string;
|
|
2676
|
+
/**
|
|
2677
|
+
* Unique identifier of a fulfillment style application
|
|
2678
|
+
*/
|
|
2679
|
+
readonly applicationId: string;
|
|
2680
|
+
readonly updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest;
|
|
2681
|
+
}
|
|
2588
2682
|
/**
|
|
2589
2683
|
* OrdersApi - object-oriented interface
|
|
2590
2684
|
*/
|
|
@@ -2701,11 +2795,31 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2701
2795
|
* @throws {RequiredError}
|
|
2702
2796
|
*/
|
|
2703
2797
|
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any, {}>>;
|
|
2798
|
+
/**
|
|
2799
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2800
|
+
* @summary Update platform fulfillment style application
|
|
2801
|
+
* @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
|
|
2802
|
+
* @param {*} [options] Override http request option.
|
|
2803
|
+
* @throws {RequiredError}
|
|
2804
|
+
*/
|
|
2805
|
+
updatePlatformFulfillmentStyleApplication(requestParameters: OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Application, any, {}>>;
|
|
2704
2806
|
}
|
|
2807
|
+
export declare const ExportOrdersDateFilterTypeEnum: {
|
|
2808
|
+
readonly CreatedAt: "createdAt";
|
|
2809
|
+
readonly PaidAt: "paidAt";
|
|
2810
|
+
readonly UpdatedAt: "updatedAt";
|
|
2811
|
+
readonly StatusChangedAt: "statusChangedAt";
|
|
2812
|
+
readonly CompletedAt: "completedAt";
|
|
2813
|
+
readonly RefundedAt: "refundedAt";
|
|
2814
|
+
};
|
|
2815
|
+
export type ExportOrdersDateFilterTypeEnum = typeof ExportOrdersDateFilterTypeEnum[keyof typeof ExportOrdersDateFilterTypeEnum];
|
|
2705
2816
|
export declare const ListOrdersDateFilterTypeEnum: {
|
|
2706
2817
|
readonly CreatedAt: "createdAt";
|
|
2818
|
+
readonly PaidAt: "paidAt";
|
|
2707
2819
|
readonly UpdatedAt: "updatedAt";
|
|
2708
2820
|
readonly StatusChangedAt: "statusChangedAt";
|
|
2821
|
+
readonly CompletedAt: "completedAt";
|
|
2822
|
+
readonly RefundedAt: "refundedAt";
|
|
2709
2823
|
};
|
|
2710
2824
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
2711
2825
|
/**
|