@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/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.44.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -34,6 +34,10 @@ export const AmendmentLogAmendmentTypeEnum = {
|
|
|
34
34
|
Refund: 'refund',
|
|
35
35
|
Exchange: 'exchange'
|
|
36
36
|
};
|
|
37
|
+
export const ApplicationPlacementEnum = {
|
|
38
|
+
Front: 'front',
|
|
39
|
+
Back: 'back'
|
|
40
|
+
};
|
|
37
41
|
export const CustomsInformationPreRegistrationTypeEnum = {
|
|
38
42
|
Ioss: 'IOSS'
|
|
39
43
|
};
|
|
@@ -1490,10 +1494,11 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1490
1494
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1491
1495
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
1492
1496
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1497
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1493
1498
|
* @param {*} [options] Override http request option.
|
|
1494
1499
|
* @throws {RequiredError}
|
|
1495
1500
|
*/
|
|
1496
|
-
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 = {}) {
|
|
1501
|
+
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 = {}) {
|
|
1497
1502
|
// verify required parameter 'project' is not null or undefined
|
|
1498
1503
|
assertParamExists('exportOrders', 'project', project);
|
|
1499
1504
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1532,6 +1537,9 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1532
1537
|
if (search !== undefined) {
|
|
1533
1538
|
localVarQueryParameter['search'] = search;
|
|
1534
1539
|
}
|
|
1540
|
+
if (dateFilterType !== undefined) {
|
|
1541
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1542
|
+
}
|
|
1535
1543
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1536
1544
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1537
1545
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -1978,6 +1986,59 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1978
1986
|
options: localVarRequestOptions,
|
|
1979
1987
|
};
|
|
1980
1988
|
}),
|
|
1989
|
+
/**
|
|
1990
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
1991
|
+
* @summary Update platform fulfillment style application
|
|
1992
|
+
* @param {string} project Project unique identifier
|
|
1993
|
+
* @param {string} platformId The platform identifier
|
|
1994
|
+
* @param {string} styleId Unique identifier of a fulfillment style
|
|
1995
|
+
* @param {string} applicationId Unique identifier of a fulfillment style application
|
|
1996
|
+
* @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
|
|
1997
|
+
* @param {*} [options] Override http request option.
|
|
1998
|
+
* @throws {RequiredError}
|
|
1999
|
+
*/
|
|
2000
|
+
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 = {}) {
|
|
2001
|
+
// verify required parameter 'project' is not null or undefined
|
|
2002
|
+
assertParamExists('updatePlatformFulfillmentStyleApplication', 'project', project);
|
|
2003
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2004
|
+
assertParamExists('updatePlatformFulfillmentStyleApplication', 'platformId', platformId);
|
|
2005
|
+
// verify required parameter 'styleId' is not null or undefined
|
|
2006
|
+
assertParamExists('updatePlatformFulfillmentStyleApplication', 'styleId', styleId);
|
|
2007
|
+
// verify required parameter 'applicationId' is not null or undefined
|
|
2008
|
+
assertParamExists('updatePlatformFulfillmentStyleApplication', 'applicationId', applicationId);
|
|
2009
|
+
// verify required parameter 'updatePlatformFulfillmentStyleApplicationRequest' is not null or undefined
|
|
2010
|
+
assertParamExists('updatePlatformFulfillmentStyleApplication', 'updatePlatformFulfillmentStyleApplicationRequest', updatePlatformFulfillmentStyleApplicationRequest);
|
|
2011
|
+
const localVarPath = `/v1/platform/{platformId}/styles/{styleId}/applications/{applicationId}`
|
|
2012
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2013
|
+
.replace(`{${"styleId"}}`, encodeURIComponent(String(styleId)))
|
|
2014
|
+
.replace(`{${"applicationId"}}`, encodeURIComponent(String(applicationId)));
|
|
2015
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2016
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2017
|
+
let baseOptions;
|
|
2018
|
+
if (configuration) {
|
|
2019
|
+
baseOptions = configuration.baseOptions;
|
|
2020
|
+
}
|
|
2021
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
2022
|
+
const localVarHeaderParameter = {};
|
|
2023
|
+
const localVarQueryParameter = {};
|
|
2024
|
+
// authentication session-oauth required
|
|
2025
|
+
// oauth required
|
|
2026
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
2027
|
+
// authentication api-key required
|
|
2028
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2029
|
+
if (project !== undefined) {
|
|
2030
|
+
localVarQueryParameter['project'] = project;
|
|
2031
|
+
}
|
|
2032
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2033
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2034
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2035
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2036
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updatePlatformFulfillmentStyleApplicationRequest, localVarRequestOptions, configuration);
|
|
2037
|
+
return {
|
|
2038
|
+
url: toPathString(localVarUrlObj),
|
|
2039
|
+
options: localVarRequestOptions,
|
|
2040
|
+
};
|
|
2041
|
+
}),
|
|
1981
2042
|
};
|
|
1982
2043
|
};
|
|
1983
2044
|
/**
|
|
@@ -2068,13 +2129,14 @@ export const OrdersApiFp = function (configuration) {
|
|
|
2068
2129
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2069
2130
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
2070
2131
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2132
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2071
2133
|
* @param {*} [options] Override http request option.
|
|
2072
2134
|
* @throws {RequiredError}
|
|
2073
2135
|
*/
|
|
2074
|
-
exportOrders(project, platformId, start, end, search, options) {
|
|
2136
|
+
exportOrders(project, platformId, start, end, search, dateFilterType, options) {
|
|
2075
2137
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2076
2138
|
var _a, _b, _c;
|
|
2077
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, options);
|
|
2139
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, dateFilterType, options);
|
|
2078
2140
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2079
2141
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.exportOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2080
2142
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2251,6 +2313,26 @@ export const OrdersApiFp = function (configuration) {
|
|
|
2251
2313
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2252
2314
|
});
|
|
2253
2315
|
},
|
|
2316
|
+
/**
|
|
2317
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2318
|
+
* @summary Update platform fulfillment style application
|
|
2319
|
+
* @param {string} project Project unique identifier
|
|
2320
|
+
* @param {string} platformId The platform identifier
|
|
2321
|
+
* @param {string} styleId Unique identifier of a fulfillment style
|
|
2322
|
+
* @param {string} applicationId Unique identifier of a fulfillment style application
|
|
2323
|
+
* @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
|
|
2324
|
+
* @param {*} [options] Override http request option.
|
|
2325
|
+
* @throws {RequiredError}
|
|
2326
|
+
*/
|
|
2327
|
+
updatePlatformFulfillmentStyleApplication(project, platformId, styleId, applicationId, updatePlatformFulfillmentStyleApplicationRequest, options) {
|
|
2328
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2329
|
+
var _a, _b, _c;
|
|
2330
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePlatformFulfillmentStyleApplication(project, platformId, styleId, applicationId, updatePlatformFulfillmentStyleApplicationRequest, options);
|
|
2331
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2332
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.updatePlatformFulfillmentStyleApplication']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2333
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2334
|
+
});
|
|
2335
|
+
},
|
|
2254
2336
|
};
|
|
2255
2337
|
};
|
|
2256
2338
|
/**
|
|
@@ -2307,7 +2389,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
2307
2389
|
* @throws {RequiredError}
|
|
2308
2390
|
*/
|
|
2309
2391
|
exportOrders(requestParameters, options) {
|
|
2310
|
-
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
2392
|
+
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
2311
2393
|
},
|
|
2312
2394
|
/**
|
|
2313
2395
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
@@ -2399,6 +2481,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
2399
2481
|
updateFulfillment(requestParameters, options) {
|
|
2400
2482
|
return localVarFp.updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(axios, basePath));
|
|
2401
2483
|
},
|
|
2484
|
+
/**
|
|
2485
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2486
|
+
* @summary Update platform fulfillment style application
|
|
2487
|
+
* @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
|
|
2488
|
+
* @param {*} [options] Override http request option.
|
|
2489
|
+
* @throws {RequiredError}
|
|
2490
|
+
*/
|
|
2491
|
+
updatePlatformFulfillmentStyleApplication(requestParameters, options) {
|
|
2492
|
+
return localVarFp.updatePlatformFulfillmentStyleApplication(requestParameters.project, requestParameters.platformId, requestParameters.styleId, requestParameters.applicationId, requestParameters.updatePlatformFulfillmentStyleApplicationRequest, options).then((request) => request(axios, basePath));
|
|
2493
|
+
},
|
|
2402
2494
|
};
|
|
2403
2495
|
};
|
|
2404
2496
|
/**
|
|
@@ -2453,7 +2545,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
2453
2545
|
* @throws {RequiredError}
|
|
2454
2546
|
*/
|
|
2455
2547
|
exportOrders(requestParameters, options) {
|
|
2456
|
-
return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
2548
|
+
return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
2457
2549
|
}
|
|
2458
2550
|
/**
|
|
2459
2551
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
@@ -2545,11 +2637,32 @@ export class OrdersApi extends BaseAPI {
|
|
|
2545
2637
|
updateFulfillment(requestParameters, options) {
|
|
2546
2638
|
return OrdersApiFp(this.configuration).updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2547
2639
|
}
|
|
2640
|
+
/**
|
|
2641
|
+
* Update a fulfillment style application for a fulfillment for a platform order
|
|
2642
|
+
* @summary Update platform fulfillment style application
|
|
2643
|
+
* @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
|
|
2644
|
+
* @param {*} [options] Override http request option.
|
|
2645
|
+
* @throws {RequiredError}
|
|
2646
|
+
*/
|
|
2647
|
+
updatePlatformFulfillmentStyleApplication(requestParameters, options) {
|
|
2648
|
+
return OrdersApiFp(this.configuration).updatePlatformFulfillmentStyleApplication(requestParameters.project, requestParameters.platformId, requestParameters.styleId, requestParameters.applicationId, requestParameters.updatePlatformFulfillmentStyleApplicationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2649
|
+
}
|
|
2548
2650
|
}
|
|
2651
|
+
export const ExportOrdersDateFilterTypeEnum = {
|
|
2652
|
+
CreatedAt: 'createdAt',
|
|
2653
|
+
PaidAt: 'paidAt',
|
|
2654
|
+
UpdatedAt: 'updatedAt',
|
|
2655
|
+
StatusChangedAt: 'statusChangedAt',
|
|
2656
|
+
CompletedAt: 'completedAt',
|
|
2657
|
+
RefundedAt: 'refundedAt'
|
|
2658
|
+
};
|
|
2549
2659
|
export const ListOrdersDateFilterTypeEnum = {
|
|
2550
2660
|
CreatedAt: 'createdAt',
|
|
2661
|
+
PaidAt: 'paidAt',
|
|
2551
2662
|
UpdatedAt: 'updatedAt',
|
|
2552
|
-
StatusChangedAt: 'statusChangedAt'
|
|
2663
|
+
StatusChangedAt: 'statusChangedAt',
|
|
2664
|
+
CompletedAt: 'completedAt',
|
|
2665
|
+
RefundedAt: 'refundedAt'
|
|
2553
2666
|
};
|
|
2554
2667
|
/**
|
|
2555
2668
|
* PaymentApi - axios parameter creator
|
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
|
@@ -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 {};
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
2
|
/**
|
|
4
3
|
* Platform API
|
|
5
4
|
* Manage Your podOS platform
|
|
6
5
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
6
|
+
* The version of the OpenAPI document: 0.44.0
|
|
8
7
|
*
|
|
9
8
|
*
|
|
10
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -18,6 +17,7 @@ export class Configuration {
|
|
|
18
17
|
this.username = param.username;
|
|
19
18
|
this.password = param.password;
|
|
20
19
|
this.accessToken = param.accessToken;
|
|
20
|
+
this.awsv4 = param.awsv4;
|
|
21
21
|
this.basePath = param.basePath;
|
|
22
22
|
this.serverIndex = param.serverIndex;
|
|
23
23
|
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/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Application
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
9
|
+
**styleId** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
10
|
+
**placement** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**mockup** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**design** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**printArea** | [**PrintArea**](PrintArea.md) | | [optional] [default to undefined]
|
|
14
|
+
**files** | [**Array<AttachedFile>**](AttachedFile.md) | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { Application } from '@teemill/platform';
|
|
20
|
+
|
|
21
|
+
const instance: Application = {
|
|
22
|
+
id,
|
|
23
|
+
styleId,
|
|
24
|
+
placement,
|
|
25
|
+
mockup,
|
|
26
|
+
design,
|
|
27
|
+
printArea,
|
|
28
|
+
files,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,22 @@
|
|
|
1
|
+
# AttachedFile
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AttachedFile } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: AttachedFile = {
|
|
17
|
+
url,
|
|
18
|
+
name,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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/OrdersApi.md
CHANGED
|
@@ -18,6 +18,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
18
18
|
|[**returnOrder**](#returnorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/return | Return the contents of an order for a refund or exchange|
|
|
19
19
|
|[**sendOrderReceipt**](#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt|
|
|
20
20
|
|[**updateFulfillment**](#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment|
|
|
21
|
+
|[**updatePlatformFulfillmentStyleApplication**](#updateplatformfulfillmentstyleapplication) | **PATCH** /v1/platform/{platformId}/styles/{styleId}/applications/{applicationId} | Update platform fulfillment style application|
|
|
21
22
|
|
|
22
23
|
# **amendOrder**
|
|
23
24
|
> Order amendOrder(amendOrderRequest)
|
|
@@ -293,13 +294,15 @@ let platformId: string; //The platform identifier (default to undefined)
|
|
|
293
294
|
let start: string; //Start of date range to filter by when orders were placed (default to undefined)
|
|
294
295
|
let end: string; //End of date range to filter when orders were placed (optional) (default to undefined)
|
|
295
296
|
let search: string; //Search term to filter based on order reference, customer name and email (optional) (default to undefined)
|
|
297
|
+
let dateFilterType: 'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
296
298
|
|
|
297
299
|
const { status, data } = await apiInstance.exportOrders(
|
|
298
300
|
project,
|
|
299
301
|
platformId,
|
|
300
302
|
start,
|
|
301
303
|
end,
|
|
302
|
-
search
|
|
304
|
+
search,
|
|
305
|
+
dateFilterType
|
|
303
306
|
);
|
|
304
307
|
```
|
|
305
308
|
|
|
@@ -312,6 +315,7 @@ const { status, data } = await apiInstance.exportOrders(
|
|
|
312
315
|
| **start** | [**string**] | Start of date range to filter by when orders were placed | defaults to undefined|
|
|
313
316
|
| **end** | [**string**] | End of date range to filter when orders were placed | (optional) defaults to undefined|
|
|
314
317
|
| **search** | [**string**] | Search term to filter based on order reference, customer name and email | (optional) defaults to undefined|
|
|
318
|
+
| **dateFilterType** | [**'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'**]**Array<'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
315
319
|
|
|
316
320
|
|
|
317
321
|
### Return type
|
|
@@ -611,7 +615,7 @@ let pageSize: number; //Max page size. This is the maximum page size that will b
|
|
|
611
615
|
let search: string; //Search term to filter based on order reference, customer name and email (optional) (default to undefined)
|
|
612
616
|
let start: string; //Start of date range to filter when orders were placed (optional) (default to undefined)
|
|
613
617
|
let end: string; //End of date range to filter when orders were placed (optional) (default to undefined)
|
|
614
|
-
let dateFilterType: 'createdAt' | 'updatedAt' | 'statusChangedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
618
|
+
let dateFilterType: 'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
615
619
|
let maxOrderTotal: number; //The maximum value of the order (optional) (default to undefined)
|
|
616
620
|
let minOrderTotal: number; //The minimum value of the order (optional) (default to undefined)
|
|
617
621
|
|
|
@@ -640,7 +644,7 @@ const { status, data } = await apiInstance.listOrders(
|
|
|
640
644
|
| **search** | [**string**] | Search term to filter based on order reference, customer name and email | (optional) defaults to undefined|
|
|
641
645
|
| **start** | [**string**] | Start of date range to filter when orders were placed | (optional) defaults to undefined|
|
|
642
646
|
| **end** | [**string**] | End of date range to filter when orders were placed | (optional) defaults to undefined|
|
|
643
|
-
| **dateFilterType** | [**'createdAt' | 'updatedAt' | 'statusChangedAt'**]**Array<'createdAt' | 'updatedAt' | 'statusChangedAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
647
|
+
| **dateFilterType** | [**'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'**]**Array<'createdAt' | 'paidAt' | 'updatedAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
644
648
|
| **maxOrderTotal** | [**number**] | The maximum value of the order | (optional) defaults to undefined|
|
|
645
649
|
| **minOrderTotal** | [**number**] | The minimum value of the order | (optional) defaults to undefined|
|
|
646
650
|
|
|
@@ -926,3 +930,72 @@ const { status, data } = await apiInstance.updateFulfillment(
|
|
|
926
930
|
|
|
927
931
|
[[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)
|
|
928
932
|
|
|
933
|
+
# **updatePlatformFulfillmentStyleApplication**
|
|
934
|
+
> Application updatePlatformFulfillmentStyleApplication(updatePlatformFulfillmentStyleApplicationRequest)
|
|
935
|
+
|
|
936
|
+
Update a fulfillment style application for a fulfillment for a platform order
|
|
937
|
+
|
|
938
|
+
### Example
|
|
939
|
+
|
|
940
|
+
```typescript
|
|
941
|
+
import {
|
|
942
|
+
OrdersApi,
|
|
943
|
+
Configuration,
|
|
944
|
+
UpdatePlatformFulfillmentStyleApplicationRequest
|
|
945
|
+
} from '@teemill/platform';
|
|
946
|
+
|
|
947
|
+
const configuration = new Configuration();
|
|
948
|
+
const apiInstance = new OrdersApi(configuration);
|
|
949
|
+
|
|
950
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
951
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
952
|
+
let styleId: string; //Unique identifier of a fulfillment style (default to undefined)
|
|
953
|
+
let applicationId: string; //Unique identifier of a fulfillment style application (default to undefined)
|
|
954
|
+
let updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest; //
|
|
955
|
+
|
|
956
|
+
const { status, data } = await apiInstance.updatePlatformFulfillmentStyleApplication(
|
|
957
|
+
project,
|
|
958
|
+
platformId,
|
|
959
|
+
styleId,
|
|
960
|
+
applicationId,
|
|
961
|
+
updatePlatformFulfillmentStyleApplicationRequest
|
|
962
|
+
);
|
|
963
|
+
```
|
|
964
|
+
|
|
965
|
+
### Parameters
|
|
966
|
+
|
|
967
|
+
|Name | Type | Description | Notes|
|
|
968
|
+
|------------- | ------------- | ------------- | -------------|
|
|
969
|
+
| **updatePlatformFulfillmentStyleApplicationRequest** | **UpdatePlatformFulfillmentStyleApplicationRequest**| | |
|
|
970
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
971
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
972
|
+
| **styleId** | [**string**] | Unique identifier of a fulfillment style | defaults to undefined|
|
|
973
|
+
| **applicationId** | [**string**] | Unique identifier of a fulfillment style application | defaults to undefined|
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
### Return type
|
|
977
|
+
|
|
978
|
+
**Application**
|
|
979
|
+
|
|
980
|
+
### Authorization
|
|
981
|
+
|
|
982
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
983
|
+
|
|
984
|
+
### HTTP request headers
|
|
985
|
+
|
|
986
|
+
- **Content-Type**: application/json
|
|
987
|
+
- **Accept**: application/json
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
### HTTP response details
|
|
991
|
+
| Status code | Description | Response headers |
|
|
992
|
+
|-------------|-------------|------------------|
|
|
993
|
+
|**200** | Fulfillment style application updated | - |
|
|
994
|
+
|**400** | Failed validation | - |
|
|
995
|
+
|**401** | Not authorised to access this resource | - |
|
|
996
|
+
|**403** | Refuse to authorize | - |
|
|
997
|
+
|**404** | Resource not found | - |
|
|
998
|
+
|**500** | Unknown server error | - |
|
|
999
|
+
|
|
1000
|
+
[[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)
|
|
1001
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PrintArea
|
|
2
|
+
|
|
3
|
+
Print area dimensions in mm
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**width** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**height** | **number** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PrintArea } from '@teemill/platform';
|
|
16
|
+
|
|
17
|
+
const instance: PrintArea = {
|
|
18
|
+
width,
|
|
19
|
+
height,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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,20 @@
|
|
|
1
|
+
# UpdatePlatformFulfillmentStyleApplicationRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**design** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdatePlatformFulfillmentStyleApplicationRequest } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: UpdatePlatformFulfillmentStyleApplicationRequest = {
|
|
16
|
+
design,
|
|
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)
|
package/index.ts
CHANGED