@teemill/orders 1.15.1 → 1.16.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 +73 -2
- package/api.ts +176 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +118 -1
- package/dist/api.js +84 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +118 -1
- package/dist/esm/api.js +84 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Address.md +35 -0
- package/docs/ApiError.md +22 -0
- package/docs/ConfirmOrderFulfillment.md +24 -0
- package/docs/ConfirmOrderFulfillmentShipment.md +21 -0
- package/docs/ConfirmOrderRequest.md +20 -0
- package/docs/ConfirmOrderValidationError.md +22 -0
- package/docs/ContactInformation.md +23 -0
- package/docs/CreateOrder.md +29 -0
- package/docs/CreateOrderContactInformation.md +23 -0
- package/docs/CustomsInformation.md +27 -0
- package/docs/CustomsInformation1.md +26 -0
- package/docs/DeliveryEstimates.md +24 -0
- package/docs/ExportOrders202Response.md +20 -0
- package/docs/Fulfillment.md +34 -0
- package/docs/FulfillmentFulfiller.md +23 -0
- package/docs/FulfillmentFulfillerLocation.md +22 -0
- package/docs/FulfillmentItem.md +24 -0
- package/docs/Image.md +27 -0
- package/docs/Option.md +22 -0
- package/docs/Order.md +58 -0
- package/docs/OrderItem.md +40 -0
- package/docs/OrderItem1.md +24 -0
- package/docs/OrderItem1RecipientCost.md +22 -0
- package/docs/OrderTracking.md +24 -0
- package/docs/OrdersApi.md +475 -0
- package/docs/OrdersResponse.md +22 -0
- package/docs/Origin.md +22 -0
- package/docs/PaymentAttempt.md +32 -0
- package/docs/Price.md +23 -0
- package/docs/ShippingMethod.md +34 -0
- package/docs/Status.md +18 -0
- package/docs/StatusHistoryItem.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders API
|
|
6
6
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.16.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders API
|
|
6
6
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.16.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -631,6 +631,12 @@ export interface Order {
|
|
|
631
631
|
* @memberof Order
|
|
632
632
|
*/
|
|
633
633
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
634
|
+
/**
|
|
635
|
+
*
|
|
636
|
+
* @type {Array<PaymentAttempt>}
|
|
637
|
+
* @memberof Order
|
|
638
|
+
*/
|
|
639
|
+
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
634
640
|
}
|
|
635
641
|
/**
|
|
636
642
|
*
|
|
@@ -812,6 +818,55 @@ export interface Origin {
|
|
|
812
818
|
*/
|
|
813
819
|
'isPaid'?: boolean;
|
|
814
820
|
}
|
|
821
|
+
/**
|
|
822
|
+
*
|
|
823
|
+
* @export
|
|
824
|
+
* @interface PaymentAttempt
|
|
825
|
+
*/
|
|
826
|
+
export interface PaymentAttempt {
|
|
827
|
+
/**
|
|
828
|
+
* Unique object identifier
|
|
829
|
+
* @type {string}
|
|
830
|
+
* @memberof PaymentAttempt
|
|
831
|
+
*/
|
|
832
|
+
'id'?: string;
|
|
833
|
+
/**
|
|
834
|
+
* Unique object identifier
|
|
835
|
+
* @type {string}
|
|
836
|
+
* @memberof PaymentAttempt
|
|
837
|
+
*/
|
|
838
|
+
'invoiceId'?: string;
|
|
839
|
+
/**
|
|
840
|
+
*
|
|
841
|
+
* @type {string}
|
|
842
|
+
* @memberof PaymentAttempt
|
|
843
|
+
*/
|
|
844
|
+
'paymentMethodType'?: string;
|
|
845
|
+
/**
|
|
846
|
+
*
|
|
847
|
+
* @type {Status}
|
|
848
|
+
* @memberof PaymentAttempt
|
|
849
|
+
*/
|
|
850
|
+
'status'?: Status;
|
|
851
|
+
/**
|
|
852
|
+
*
|
|
853
|
+
* @type {string}
|
|
854
|
+
* @memberof PaymentAttempt
|
|
855
|
+
*/
|
|
856
|
+
'transactionId'?: string | null;
|
|
857
|
+
/**
|
|
858
|
+
*
|
|
859
|
+
* @type {string}
|
|
860
|
+
* @memberof PaymentAttempt
|
|
861
|
+
*/
|
|
862
|
+
'message'?: string;
|
|
863
|
+
/**
|
|
864
|
+
* ISO 8601 Timestamp
|
|
865
|
+
* @type {string}
|
|
866
|
+
* @memberof PaymentAttempt
|
|
867
|
+
*/
|
|
868
|
+
'createdAt'?: string;
|
|
869
|
+
}
|
|
815
870
|
/**
|
|
816
871
|
* Standard price definition that defines the amount and currency.
|
|
817
872
|
* @export
|
|
@@ -993,6 +1048,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
993
1048
|
* @throws {RequiredError}
|
|
994
1049
|
*/
|
|
995
1050
|
getOrders: (project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, dateFilterType?: GetOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1051
|
+
/**
|
|
1052
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1053
|
+
* @summary Retry
|
|
1054
|
+
* @param {string} project What project it is
|
|
1055
|
+
* @param {string} orderId Unique identifier of an order
|
|
1056
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1057
|
+
* @param {*} [options] Override http request option.
|
|
1058
|
+
* @throws {RequiredError}
|
|
1059
|
+
*/
|
|
1060
|
+
retryPlatformPayment: (project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
996
1061
|
};
|
|
997
1062
|
/**
|
|
998
1063
|
* OrdersApi - functional programming interface
|
|
@@ -1068,6 +1133,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1068
1133
|
* @throws {RequiredError}
|
|
1069
1134
|
*/
|
|
1070
1135
|
getOrders(project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, dateFilterType?: GetOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1138
|
+
* @summary Retry
|
|
1139
|
+
* @param {string} project What project it is
|
|
1140
|
+
* @param {string} orderId Unique identifier of an order
|
|
1141
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1142
|
+
* @param {*} [options] Override http request option.
|
|
1143
|
+
* @throws {RequiredError}
|
|
1144
|
+
*/
|
|
1145
|
+
retryPlatformPayment(project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
1071
1146
|
};
|
|
1072
1147
|
/**
|
|
1073
1148
|
* OrdersApi - factory interface
|
|
@@ -1122,6 +1197,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
1122
1197
|
* @throws {RequiredError}
|
|
1123
1198
|
*/
|
|
1124
1199
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
|
|
1200
|
+
/**
|
|
1201
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1202
|
+
* @summary Retry
|
|
1203
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1204
|
+
* @param {*} [options] Override http request option.
|
|
1205
|
+
* @throws {RequiredError}
|
|
1206
|
+
*/
|
|
1207
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
1125
1208
|
};
|
|
1126
1209
|
/**
|
|
1127
1210
|
* Request parameters for cancelOrder operation in OrdersApi.
|
|
@@ -1327,6 +1410,31 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
1327
1410
|
*/
|
|
1328
1411
|
readonly dateFilterType?: GetOrdersDateFilterTypeEnum;
|
|
1329
1412
|
}
|
|
1413
|
+
/**
|
|
1414
|
+
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
1415
|
+
* @export
|
|
1416
|
+
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
1417
|
+
*/
|
|
1418
|
+
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
1419
|
+
/**
|
|
1420
|
+
* What project it is
|
|
1421
|
+
* @type {string}
|
|
1422
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
1423
|
+
*/
|
|
1424
|
+
readonly project: string;
|
|
1425
|
+
/**
|
|
1426
|
+
* Unique identifier of an order
|
|
1427
|
+
* @type {string}
|
|
1428
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
1429
|
+
*/
|
|
1430
|
+
readonly orderId: string;
|
|
1431
|
+
/**
|
|
1432
|
+
* Specifies which fields to return, separated by commas
|
|
1433
|
+
* @type {string}
|
|
1434
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
1435
|
+
*/
|
|
1436
|
+
readonly fields?: string;
|
|
1437
|
+
}
|
|
1330
1438
|
/**
|
|
1331
1439
|
* OrdersApi - object-oriented interface
|
|
1332
1440
|
* @export
|
|
@@ -1388,6 +1496,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
1388
1496
|
* @memberof OrdersApi
|
|
1389
1497
|
*/
|
|
1390
1498
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
1499
|
+
/**
|
|
1500
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
1501
|
+
* @summary Retry
|
|
1502
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1503
|
+
* @param {*} [options] Override http request option.
|
|
1504
|
+
* @throws {RequiredError}
|
|
1505
|
+
* @memberof OrdersApi
|
|
1506
|
+
*/
|
|
1507
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
1391
1508
|
}
|
|
1392
1509
|
/**
|
|
1393
1510
|
* @export
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -366,6 +366,50 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
366
366
|
options: localVarRequestOptions,
|
|
367
367
|
};
|
|
368
368
|
}),
|
|
369
|
+
/**
|
|
370
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
371
|
+
* @summary Retry
|
|
372
|
+
* @param {string} project What project it is
|
|
373
|
+
* @param {string} orderId Unique identifier of an order
|
|
374
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
375
|
+
* @param {*} [options] Override http request option.
|
|
376
|
+
* @throws {RequiredError}
|
|
377
|
+
*/
|
|
378
|
+
retryPlatformPayment: (project_1, orderId_1, fields_1, ...args_1) => __awaiter(this, [project_1, orderId_1, fields_1, ...args_1], void 0, function* (project, orderId, fields, options = {}) {
|
|
379
|
+
// verify required parameter 'project' is not null or undefined
|
|
380
|
+
assertParamExists('retryPlatformPayment', 'project', project);
|
|
381
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
382
|
+
assertParamExists('retryPlatformPayment', 'orderId', orderId);
|
|
383
|
+
const localVarPath = `/v1/orders/{orderId}/retryPlatformPayment`
|
|
384
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
385
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
386
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
387
|
+
let baseOptions;
|
|
388
|
+
if (configuration) {
|
|
389
|
+
baseOptions = configuration.baseOptions;
|
|
390
|
+
}
|
|
391
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
392
|
+
const localVarHeaderParameter = {};
|
|
393
|
+
const localVarQueryParameter = {};
|
|
394
|
+
// authentication session-oauth required
|
|
395
|
+
// oauth required
|
|
396
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
397
|
+
// authentication api-key required
|
|
398
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
399
|
+
if (project !== undefined) {
|
|
400
|
+
localVarQueryParameter['project'] = project;
|
|
401
|
+
}
|
|
402
|
+
if (fields !== undefined) {
|
|
403
|
+
localVarQueryParameter['fields'] = fields;
|
|
404
|
+
}
|
|
405
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
406
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
407
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
408
|
+
return {
|
|
409
|
+
url: toPathString(localVarUrlObj),
|
|
410
|
+
options: localVarRequestOptions,
|
|
411
|
+
};
|
|
412
|
+
}),
|
|
369
413
|
};
|
|
370
414
|
};
|
|
371
415
|
/**
|
|
@@ -492,6 +536,24 @@ export const OrdersApiFp = function (configuration) {
|
|
|
492
536
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
493
537
|
});
|
|
494
538
|
},
|
|
539
|
+
/**
|
|
540
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
541
|
+
* @summary Retry
|
|
542
|
+
* @param {string} project What project it is
|
|
543
|
+
* @param {string} orderId Unique identifier of an order
|
|
544
|
+
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
545
|
+
* @param {*} [options] Override http request option.
|
|
546
|
+
* @throws {RequiredError}
|
|
547
|
+
*/
|
|
548
|
+
retryPlatformPayment(project, orderId, fields, options) {
|
|
549
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
550
|
+
var _a, _b, _c;
|
|
551
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.retryPlatformPayment(project, orderId, fields, options);
|
|
552
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
553
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.retryPlatformPayment']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
554
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
555
|
+
});
|
|
556
|
+
},
|
|
495
557
|
};
|
|
496
558
|
};
|
|
497
559
|
/**
|
|
@@ -561,6 +623,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
561
623
|
getOrders(requestParameters, options) {
|
|
562
624
|
return localVarFp.getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
563
625
|
},
|
|
626
|
+
/**
|
|
627
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
628
|
+
* @summary Retry
|
|
629
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
630
|
+
* @param {*} [options] Override http request option.
|
|
631
|
+
* @throws {RequiredError}
|
|
632
|
+
*/
|
|
633
|
+
retryPlatformPayment(requestParameters, options) {
|
|
634
|
+
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
635
|
+
},
|
|
564
636
|
};
|
|
565
637
|
};
|
|
566
638
|
/**
|
|
@@ -636,6 +708,17 @@ export class OrdersApi extends BaseAPI {
|
|
|
636
708
|
getOrders(requestParameters, options) {
|
|
637
709
|
return OrdersApiFp(this.configuration).getOrders(requestParameters.project, requestParameters.fields, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.ids, requestParameters.statuses, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
638
710
|
}
|
|
711
|
+
/**
|
|
712
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
713
|
+
* @summary Retry
|
|
714
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
715
|
+
* @param {*} [options] Override http request option.
|
|
716
|
+
* @throws {RequiredError}
|
|
717
|
+
* @memberof OrdersApi
|
|
718
|
+
*/
|
|
719
|
+
retryPlatformPayment(requestParameters, options) {
|
|
720
|
+
return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
721
|
+
}
|
|
639
722
|
}
|
|
640
723
|
/**
|
|
641
724
|
* @export
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders API
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.16.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders API
|
|
6
6
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.16.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/Address.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Address
|
|
2
|
+
|
|
3
|
+
A person\'s address.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**contactName** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**company** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**line1** | **string** | First line of the address. | [optional] [default to undefined]
|
|
12
|
+
**line2** | **string** | Second line of the address. | [optional] [default to undefined]
|
|
13
|
+
**city** | **string** | City of the address. | [optional] [default to undefined]
|
|
14
|
+
**postalCode** | **string** | Postal code of the address. | [optional] [default to undefined]
|
|
15
|
+
**country** | **string** | Country of the address (ISO 3166-1 alpha-2). | [default to undefined]
|
|
16
|
+
**state** | **string** | State of the address. If the country is Canada, Australia, or the United States, this field is required. | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { Address } from '@teemill/orders';
|
|
22
|
+
|
|
23
|
+
const instance: Address = {
|
|
24
|
+
contactName,
|
|
25
|
+
company,
|
|
26
|
+
line1,
|
|
27
|
+
line2,
|
|
28
|
+
city,
|
|
29
|
+
postalCode,
|
|
30
|
+
country,
|
|
31
|
+
state,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[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/ApiError.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApiError } from '@teemill/orders';
|
|
15
|
+
|
|
16
|
+
const instance: ApiError = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
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)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ConfirmOrderFulfillment
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fulfillmentId** | **string** | Unique object identifier | [default to undefined]
|
|
9
|
+
**shippingMethodId** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
10
|
+
**shipment** | [**ConfirmOrderFulfillmentShipment**](ConfirmOrderFulfillmentShipment.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ConfirmOrderFulfillment } from '@teemill/orders';
|
|
16
|
+
|
|
17
|
+
const instance: ConfirmOrderFulfillment = {
|
|
18
|
+
fulfillmentId,
|
|
19
|
+
shippingMethodId,
|
|
20
|
+
shipment,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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,21 @@
|
|
|
1
|
+
# ConfirmOrderFulfillmentShipment
|
|
2
|
+
|
|
3
|
+
This field is only required if you are using your own shipping label.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**image** | **string** | Only required if you are generating shipping labels outside of PodOS | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ConfirmOrderFulfillmentShipment } from '@teemill/orders';
|
|
15
|
+
|
|
16
|
+
const instance: ConfirmOrderFulfillmentShipment = {
|
|
17
|
+
image,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[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
|
+
# ConfirmOrderRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fulfillments** | [**Array<ConfirmOrderFulfillment>**](ConfirmOrderFulfillment.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ConfirmOrderRequest } from '@teemill/orders';
|
|
14
|
+
|
|
15
|
+
const instance: ConfirmOrderRequest = {
|
|
16
|
+
fulfillments,
|
|
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,22 @@
|
|
|
1
|
+
# ConfirmOrderValidationError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ConfirmOrderValidationError } from '@teemill/orders';
|
|
15
|
+
|
|
16
|
+
const instance: ConfirmOrderValidationError = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
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)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ContactInformation
|
|
2
|
+
|
|
3
|
+
Order recipient contact information, used only for courier tracking/updates.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**email** | **string** | | [default to undefined]
|
|
10
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ContactInformation } from '@teemill/orders';
|
|
16
|
+
|
|
17
|
+
const instance: ContactInformation = {
|
|
18
|
+
email,
|
|
19
|
+
phone,
|
|
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,29 @@
|
|
|
1
|
+
# CreateOrder
|
|
2
|
+
|
|
3
|
+
Create an order
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**merchantReference** | **string** | A custom reference to the merchant\'s order. | [optional] [default to undefined]
|
|
10
|
+
**contactInformation** | [**CreateOrderContactInformation**](CreateOrderContactInformation.md) | | [default to undefined]
|
|
11
|
+
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
12
|
+
**customsInformation** | [**CustomsInformation**](CustomsInformation.md) | | [optional] [default to undefined]
|
|
13
|
+
**items** | [**Array<OrderItem1>**](OrderItem1.md) | Items to be ordered | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { CreateOrder } from '@teemill/orders';
|
|
19
|
+
|
|
20
|
+
const instance: CreateOrder = {
|
|
21
|
+
merchantReference,
|
|
22
|
+
contactInformation,
|
|
23
|
+
shippingAddress,
|
|
24
|
+
customsInformation,
|
|
25
|
+
items,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[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,23 @@
|
|
|
1
|
+
# CreateOrderContactInformation
|
|
2
|
+
|
|
3
|
+
Contact information for the order
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**email** | **string** | | [default to undefined]
|
|
10
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateOrderContactInformation } from '@teemill/orders';
|
|
16
|
+
|
|
17
|
+
const instance: CreateOrderContactInformation = {
|
|
18
|
+
email,
|
|
19
|
+
phone,
|
|
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)
|