@teemill/orders 1.26.0 → 1.28.2
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/.openapi-generator/FILES +49 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +15 -3
- package/api.ts +508 -14
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +311 -9
- package/dist/api.js +312 -14
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +311 -9
- package/dist/esm/api.js +311 -13
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/ImportOrders202Response.md +1 -1
- package/docs/OrderImport.md +32 -0
- package/docs/OrderImportCounts.md +32 -0
- package/docs/OrderImportError.md +30 -0
- package/docs/OrderImportErrorCode.md +17 -0
- package/docs/OrderImportGroup.md +40 -0
- package/docs/OrderImportGroupStatus.md +17 -0
- package/docs/OrderImportGroupsResponse.md +22 -0
- package/docs/OrderImportStatus.md +19 -0
- package/docs/OrderImportsResponse.md +22 -0
- package/docs/OrdersApi.md +196 -5
- package/index.ts +2 -2
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
|
-
* Orders
|
|
5
|
+
* Orders
|
|
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.28.2
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.GetOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.StockUnavailableErrorCodeEnum = exports.Status = exports.ProductUnavailableErrorAvailableQuantityEnum = exports.ProductUnavailableErrorCodeEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
|
|
25
|
+
exports.GetOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.StockUnavailableErrorCodeEnum = exports.Status = exports.ProductUnavailableErrorAvailableQuantityEnum = exports.ProductUnavailableErrorCodeEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.OrderImportStatus = exports.OrderImportGroupStatus = exports.OrderImportErrorCode = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -38,6 +38,37 @@ exports.ConfirmOrderValidationErrorCodeEnum = {
|
|
|
38
38
|
exports.CustomsInformationPreRegistrationTypeEnum = {
|
|
39
39
|
Ioss: 'IOSS'
|
|
40
40
|
};
|
|
41
|
+
/**
|
|
42
|
+
* Machine-readable error code identifying the type of import failure: - `VARIANT_NOT_FOUND` — The SKU does not match any variant in the project\'s catalog - `MISSING_SKU` — A required SKU field was empty or missing - `SHIPPING_METHOD_UNAVAILABLE` — No shipping methods are available for the fulfillment - `TRANSIENT_SYSTEM_ERROR` — A temporary system issue occurred; the import may succeed on retry - `IMPORT_FAILED` — A general import failure that does not match a more specific code
|
|
43
|
+
*/
|
|
44
|
+
exports.OrderImportErrorCode = {
|
|
45
|
+
VariantNotFound: 'VARIANT_NOT_FOUND',
|
|
46
|
+
MissingSku: 'MISSING_SKU',
|
|
47
|
+
ShippingMethodUnavailable: 'SHIPPING_METHOD_UNAVAILABLE',
|
|
48
|
+
TransientSystemError: 'TRANSIENT_SYSTEM_ERROR',
|
|
49
|
+
ImportFailed: 'IMPORT_FAILED'
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* The lifecycle status of a single group (order) within an import: - `pending` — Group is queued and has not started processing - `processing` — Group is currently being processed - `success` — Order was created and confirmed successfully - `failed` — Order creation or confirmation failed - `cancelled` — Group was cancelled (e.g. parent import was cancelled)
|
|
53
|
+
*/
|
|
54
|
+
exports.OrderImportGroupStatus = {
|
|
55
|
+
Pending: 'pending',
|
|
56
|
+
Processing: 'processing',
|
|
57
|
+
Success: 'success',
|
|
58
|
+
Failed: 'failed',
|
|
59
|
+
Cancelled: 'cancelled'
|
|
60
|
+
};
|
|
61
|
+
/**
|
|
62
|
+
* The lifecycle status of an order import: - `queued` — Import has been accepted but no groups have started processing yet - `processing` — One or more groups are currently being processed - `completedSuccess` — All groups were imported successfully - `completedPartial` — Some groups succeeded but others failed or were cancelled - `completedFailed` — All groups failed or were cancelled, with none succeeding - `cancelled` — The entire import was cancelled before completion
|
|
63
|
+
*/
|
|
64
|
+
exports.OrderImportStatus = {
|
|
65
|
+
Queued: 'queued',
|
|
66
|
+
Processing: 'processing',
|
|
67
|
+
CompletedSuccess: 'completedSuccess',
|
|
68
|
+
CompletedPartial: 'completedPartial',
|
|
69
|
+
CompletedFailed: 'completedFailed',
|
|
70
|
+
Cancelled: 'cancelled'
|
|
71
|
+
};
|
|
41
72
|
exports.PaymentAttemptPaymentProviderEnum = {
|
|
42
73
|
Stripe: 'stripe',
|
|
43
74
|
Paypal: 'paypal',
|
|
@@ -264,10 +295,11 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
264
295
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
265
296
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
266
297
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
298
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
267
299
|
* @param {*} [options] Override http request option.
|
|
268
300
|
* @throws {RequiredError}
|
|
269
301
|
*/
|
|
270
|
-
exportOrders: (project_1, start_1, end_1, search_1, ...args_1) => __awaiter(this, [project_1, start_1, end_1, search_1, ...args_1], void 0, function* (project, start, end, search, options = {}) {
|
|
302
|
+
exportOrders: (project_1, start_1, end_1, search_1, dateFilterType_1, ...args_1) => __awaiter(this, [project_1, start_1, end_1, search_1, dateFilterType_1, ...args_1], void 0, function* (project, start, end, search, dateFilterType, options = {}) {
|
|
271
303
|
// verify required parameter 'project' is not null or undefined
|
|
272
304
|
(0, common_1.assertParamExists)('exportOrders', 'project', project);
|
|
273
305
|
// verify required parameter 'start' is not null or undefined
|
|
@@ -303,6 +335,9 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
303
335
|
if (search !== undefined) {
|
|
304
336
|
localVarQueryParameter['search'] = search;
|
|
305
337
|
}
|
|
338
|
+
if (dateFilterType !== undefined) {
|
|
339
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
340
|
+
}
|
|
306
341
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
307
342
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
308
343
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -357,6 +392,47 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
357
392
|
options: localVarRequestOptions,
|
|
358
393
|
};
|
|
359
394
|
}),
|
|
395
|
+
/**
|
|
396
|
+
* Gets the latest status and summary for an order import.
|
|
397
|
+
* @summary Get order import
|
|
398
|
+
* @param {string} project The project identifier to scope the request to.
|
|
399
|
+
* @param {string} importId Unique identifier of an order import
|
|
400
|
+
* @param {*} [options] Override http request option.
|
|
401
|
+
* @throws {RequiredError}
|
|
402
|
+
*/
|
|
403
|
+
getOrderImport: (project_1, importId_1, ...args_1) => __awaiter(this, [project_1, importId_1, ...args_1], void 0, function* (project, importId, options = {}) {
|
|
404
|
+
// verify required parameter 'project' is not null or undefined
|
|
405
|
+
(0, common_1.assertParamExists)('getOrderImport', 'project', project);
|
|
406
|
+
// verify required parameter 'importId' is not null or undefined
|
|
407
|
+
(0, common_1.assertParamExists)('getOrderImport', 'importId', importId);
|
|
408
|
+
const localVarPath = `/v1/orders/imports/{importId}`
|
|
409
|
+
.replace(`{${"importId"}}`, encodeURIComponent(String(importId)));
|
|
410
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
411
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
412
|
+
let baseOptions;
|
|
413
|
+
if (configuration) {
|
|
414
|
+
baseOptions = configuration.baseOptions;
|
|
415
|
+
}
|
|
416
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
417
|
+
const localVarHeaderParameter = {};
|
|
418
|
+
const localVarQueryParameter = {};
|
|
419
|
+
// authentication session-oauth required
|
|
420
|
+
// oauth required
|
|
421
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
422
|
+
// authentication api-key required
|
|
423
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
424
|
+
if (project !== undefined) {
|
|
425
|
+
localVarQueryParameter['project'] = project;
|
|
426
|
+
}
|
|
427
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
428
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
429
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
430
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
431
|
+
return {
|
|
432
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
433
|
+
options: localVarRequestOptions,
|
|
434
|
+
};
|
|
435
|
+
}),
|
|
360
436
|
/**
|
|
361
437
|
* Lists all orders placed on this project, paginated into configurable chunks.
|
|
362
438
|
* @summary List orders
|
|
@@ -435,7 +511,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
435
511
|
};
|
|
436
512
|
}),
|
|
437
513
|
/**
|
|
438
|
-
* Initiates an order import from a CSV file. The import is processed asynchronously.
|
|
514
|
+
* Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
|
|
439
515
|
* @summary Import orders
|
|
440
516
|
* @param {string} project The project identifier to scope the request to.
|
|
441
517
|
* @param {File} file CSV file containing order data
|
|
@@ -447,7 +523,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
447
523
|
(0, common_1.assertParamExists)('importOrders', 'project', project);
|
|
448
524
|
// verify required parameter 'file' is not null or undefined
|
|
449
525
|
(0, common_1.assertParamExists)('importOrders', 'file', file);
|
|
450
|
-
const localVarPath = `/v1/orders/
|
|
526
|
+
const localVarPath = `/v1/orders/imports`;
|
|
451
527
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
452
528
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
453
529
|
let baseOptions;
|
|
@@ -480,6 +556,100 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
480
556
|
options: localVarRequestOptions,
|
|
481
557
|
};
|
|
482
558
|
}),
|
|
559
|
+
/**
|
|
560
|
+
* Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
|
|
561
|
+
* @summary List order import groups
|
|
562
|
+
* @param {string} project The project identifier to scope the request to.
|
|
563
|
+
* @param {string} importId Unique identifier of an order import
|
|
564
|
+
* @param {number} [pageToken] Page reference token
|
|
565
|
+
* @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
|
|
566
|
+
* @param {*} [options] Override http request option.
|
|
567
|
+
* @throws {RequiredError}
|
|
568
|
+
*/
|
|
569
|
+
listOrderImportGroups: (project_1, importId_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, importId_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, importId, pageToken, pageSize, options = {}) {
|
|
570
|
+
// verify required parameter 'project' is not null or undefined
|
|
571
|
+
(0, common_1.assertParamExists)('listOrderImportGroups', 'project', project);
|
|
572
|
+
// verify required parameter 'importId' is not null or undefined
|
|
573
|
+
(0, common_1.assertParamExists)('listOrderImportGroups', 'importId', importId);
|
|
574
|
+
const localVarPath = `/v1/orders/imports/{importId}/groups`
|
|
575
|
+
.replace(`{${"importId"}}`, encodeURIComponent(String(importId)));
|
|
576
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
577
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
578
|
+
let baseOptions;
|
|
579
|
+
if (configuration) {
|
|
580
|
+
baseOptions = configuration.baseOptions;
|
|
581
|
+
}
|
|
582
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
583
|
+
const localVarHeaderParameter = {};
|
|
584
|
+
const localVarQueryParameter = {};
|
|
585
|
+
// authentication session-oauth required
|
|
586
|
+
// oauth required
|
|
587
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
588
|
+
// authentication api-key required
|
|
589
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
590
|
+
if (project !== undefined) {
|
|
591
|
+
localVarQueryParameter['project'] = project;
|
|
592
|
+
}
|
|
593
|
+
if (pageToken !== undefined) {
|
|
594
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
595
|
+
}
|
|
596
|
+
if (pageSize !== undefined) {
|
|
597
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
598
|
+
}
|
|
599
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
600
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
601
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
602
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
603
|
+
return {
|
|
604
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
605
|
+
options: localVarRequestOptions,
|
|
606
|
+
};
|
|
607
|
+
}),
|
|
608
|
+
/**
|
|
609
|
+
* Lists recent order imports for this project, ordered by most recent first.
|
|
610
|
+
* @summary List order imports
|
|
611
|
+
* @param {string} project The project identifier to scope the request to.
|
|
612
|
+
* @param {number} [pageToken] Page reference token
|
|
613
|
+
* @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
|
|
614
|
+
* @param {*} [options] Override http request option.
|
|
615
|
+
* @throws {RequiredError}
|
|
616
|
+
*/
|
|
617
|
+
listOrderImports: (project_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, pageToken, pageSize, options = {}) {
|
|
618
|
+
// verify required parameter 'project' is not null or undefined
|
|
619
|
+
(0, common_1.assertParamExists)('listOrderImports', 'project', project);
|
|
620
|
+
const localVarPath = `/v1/orders/imports`;
|
|
621
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
622
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
623
|
+
let baseOptions;
|
|
624
|
+
if (configuration) {
|
|
625
|
+
baseOptions = configuration.baseOptions;
|
|
626
|
+
}
|
|
627
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
628
|
+
const localVarHeaderParameter = {};
|
|
629
|
+
const localVarQueryParameter = {};
|
|
630
|
+
// authentication session-oauth required
|
|
631
|
+
// oauth required
|
|
632
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
633
|
+
// authentication api-key required
|
|
634
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
635
|
+
if (project !== undefined) {
|
|
636
|
+
localVarQueryParameter['project'] = project;
|
|
637
|
+
}
|
|
638
|
+
if (pageToken !== undefined) {
|
|
639
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
640
|
+
}
|
|
641
|
+
if (pageSize !== undefined) {
|
|
642
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
643
|
+
}
|
|
644
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
645
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
646
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
647
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
648
|
+
return {
|
|
649
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
650
|
+
options: localVarRequestOptions,
|
|
651
|
+
};
|
|
652
|
+
}),
|
|
483
653
|
/**
|
|
484
654
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
485
655
|
* @summary Retry
|
|
@@ -613,13 +783,14 @@ const OrdersApiFp = function (configuration) {
|
|
|
613
783
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
614
784
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
615
785
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
786
|
+
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
616
787
|
* @param {*} [options] Override http request option.
|
|
617
788
|
* @throws {RequiredError}
|
|
618
789
|
*/
|
|
619
|
-
exportOrders(project, start, end, search, options) {
|
|
790
|
+
exportOrders(project, start, end, search, dateFilterType, options) {
|
|
620
791
|
return __awaiter(this, void 0, void 0, function* () {
|
|
621
792
|
var _a, _b, _c;
|
|
622
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, start, end, search, options);
|
|
793
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, start, end, search, dateFilterType, options);
|
|
623
794
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
624
795
|
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;
|
|
625
796
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -643,6 +814,23 @@ const OrdersApiFp = function (configuration) {
|
|
|
643
814
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
644
815
|
});
|
|
645
816
|
},
|
|
817
|
+
/**
|
|
818
|
+
* Gets the latest status and summary for an order import.
|
|
819
|
+
* @summary Get order import
|
|
820
|
+
* @param {string} project The project identifier to scope the request to.
|
|
821
|
+
* @param {string} importId Unique identifier of an order import
|
|
822
|
+
* @param {*} [options] Override http request option.
|
|
823
|
+
* @throws {RequiredError}
|
|
824
|
+
*/
|
|
825
|
+
getOrderImport(project, importId, options) {
|
|
826
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
827
|
+
var _a, _b, _c;
|
|
828
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrderImport(project, importId, options);
|
|
829
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
830
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.getOrderImport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
831
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
832
|
+
});
|
|
833
|
+
},
|
|
646
834
|
/**
|
|
647
835
|
* Lists all orders placed on this project, paginated into configurable chunks.
|
|
648
836
|
* @summary List orders
|
|
@@ -669,7 +857,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
669
857
|
});
|
|
670
858
|
},
|
|
671
859
|
/**
|
|
672
|
-
* Initiates an order import from a CSV file. The import is processed asynchronously.
|
|
860
|
+
* Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
|
|
673
861
|
* @summary Import orders
|
|
674
862
|
* @param {string} project The project identifier to scope the request to.
|
|
675
863
|
* @param {File} file CSV file containing order data
|
|
@@ -685,6 +873,43 @@ const OrdersApiFp = function (configuration) {
|
|
|
685
873
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
686
874
|
});
|
|
687
875
|
},
|
|
876
|
+
/**
|
|
877
|
+
* Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
|
|
878
|
+
* @summary List order import groups
|
|
879
|
+
* @param {string} project The project identifier to scope the request to.
|
|
880
|
+
* @param {string} importId Unique identifier of an order import
|
|
881
|
+
* @param {number} [pageToken] Page reference token
|
|
882
|
+
* @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
|
|
883
|
+
* @param {*} [options] Override http request option.
|
|
884
|
+
* @throws {RequiredError}
|
|
885
|
+
*/
|
|
886
|
+
listOrderImportGroups(project, importId, pageToken, pageSize, options) {
|
|
887
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
888
|
+
var _a, _b, _c;
|
|
889
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrderImportGroups(project, importId, pageToken, pageSize, options);
|
|
890
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
891
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.listOrderImportGroups']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
892
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
893
|
+
});
|
|
894
|
+
},
|
|
895
|
+
/**
|
|
896
|
+
* Lists recent order imports for this project, ordered by most recent first.
|
|
897
|
+
* @summary List order imports
|
|
898
|
+
* @param {string} project The project identifier to scope the request to.
|
|
899
|
+
* @param {number} [pageToken] Page reference token
|
|
900
|
+
* @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
|
|
901
|
+
* @param {*} [options] Override http request option.
|
|
902
|
+
* @throws {RequiredError}
|
|
903
|
+
*/
|
|
904
|
+
listOrderImports(project, pageToken, pageSize, options) {
|
|
905
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
906
|
+
var _a, _b, _c;
|
|
907
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrderImports(project, pageToken, pageSize, options);
|
|
908
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
909
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.listOrderImports']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
910
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
911
|
+
});
|
|
912
|
+
},
|
|
688
913
|
/**
|
|
689
914
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
690
915
|
* @summary Retry
|
|
@@ -760,7 +985,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
760
985
|
* @throws {RequiredError}
|
|
761
986
|
*/
|
|
762
987
|
exportOrders(requestParameters, options) {
|
|
763
|
-
return localVarFp.exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
988
|
+
return localVarFp.exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
764
989
|
},
|
|
765
990
|
/**
|
|
766
991
|
* Get an order by a given ID.
|
|
@@ -772,6 +997,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
772
997
|
getOrder(requestParameters, options) {
|
|
773
998
|
return localVarFp.getOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
774
999
|
},
|
|
1000
|
+
/**
|
|
1001
|
+
* Gets the latest status and summary for an order import.
|
|
1002
|
+
* @summary Get order import
|
|
1003
|
+
* @param {OrdersApiGetOrderImportRequest} requestParameters Request parameters.
|
|
1004
|
+
* @param {*} [options] Override http request option.
|
|
1005
|
+
* @throws {RequiredError}
|
|
1006
|
+
*/
|
|
1007
|
+
getOrderImport(requestParameters, options) {
|
|
1008
|
+
return localVarFp.getOrderImport(requestParameters.project, requestParameters.importId, options).then((request) => request(axios, basePath));
|
|
1009
|
+
},
|
|
775
1010
|
/**
|
|
776
1011
|
* Lists all orders placed on this project, paginated into configurable chunks.
|
|
777
1012
|
* @summary List orders
|
|
@@ -783,7 +1018,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
783
1018
|
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));
|
|
784
1019
|
},
|
|
785
1020
|
/**
|
|
786
|
-
* Initiates an order import from a CSV file. The import is processed asynchronously.
|
|
1021
|
+
* Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
|
|
787
1022
|
* @summary Import orders
|
|
788
1023
|
* @param {OrdersApiImportOrdersRequest} requestParameters Request parameters.
|
|
789
1024
|
* @param {*} [options] Override http request option.
|
|
@@ -792,6 +1027,26 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
792
1027
|
importOrders(requestParameters, options) {
|
|
793
1028
|
return localVarFp.importOrders(requestParameters.project, requestParameters.file, options).then((request) => request(axios, basePath));
|
|
794
1029
|
},
|
|
1030
|
+
/**
|
|
1031
|
+
* Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
|
|
1032
|
+
* @summary List order import groups
|
|
1033
|
+
* @param {OrdersApiListOrderImportGroupsRequest} requestParameters Request parameters.
|
|
1034
|
+
* @param {*} [options] Override http request option.
|
|
1035
|
+
* @throws {RequiredError}
|
|
1036
|
+
*/
|
|
1037
|
+
listOrderImportGroups(requestParameters, options) {
|
|
1038
|
+
return localVarFp.listOrderImportGroups(requestParameters.project, requestParameters.importId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1039
|
+
},
|
|
1040
|
+
/**
|
|
1041
|
+
* Lists recent order imports for this project, ordered by most recent first.
|
|
1042
|
+
* @summary List order imports
|
|
1043
|
+
* @param {OrdersApiListOrderImportsRequest} requestParameters Request parameters.
|
|
1044
|
+
* @param {*} [options] Override http request option.
|
|
1045
|
+
* @throws {RequiredError}
|
|
1046
|
+
*/
|
|
1047
|
+
listOrderImports(requestParameters, options) {
|
|
1048
|
+
return localVarFp.listOrderImports(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1049
|
+
},
|
|
795
1050
|
/**
|
|
796
1051
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
797
1052
|
* @summary Retry
|
|
@@ -857,7 +1112,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
857
1112
|
* @throws {RequiredError}
|
|
858
1113
|
*/
|
|
859
1114
|
exportOrders(requestParameters, options) {
|
|
860
|
-
return (0, exports.OrdersApiFp)(this.configuration).exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1115
|
+
return (0, exports.OrdersApiFp)(this.configuration).exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
861
1116
|
}
|
|
862
1117
|
/**
|
|
863
1118
|
* Get an order by a given ID.
|
|
@@ -869,6 +1124,16 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
869
1124
|
getOrder(requestParameters, options) {
|
|
870
1125
|
return (0, exports.OrdersApiFp)(this.configuration).getOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
871
1126
|
}
|
|
1127
|
+
/**
|
|
1128
|
+
* Gets the latest status and summary for an order import.
|
|
1129
|
+
* @summary Get order import
|
|
1130
|
+
* @param {OrdersApiGetOrderImportRequest} requestParameters Request parameters.
|
|
1131
|
+
* @param {*} [options] Override http request option.
|
|
1132
|
+
* @throws {RequiredError}
|
|
1133
|
+
*/
|
|
1134
|
+
getOrderImport(requestParameters, options) {
|
|
1135
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderImport(requestParameters.project, requestParameters.importId, options).then((request) => request(this.axios, this.basePath));
|
|
1136
|
+
}
|
|
872
1137
|
/**
|
|
873
1138
|
* Lists all orders placed on this project, paginated into configurable chunks.
|
|
874
1139
|
* @summary List orders
|
|
@@ -880,7 +1145,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
880
1145
|
return (0, exports.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));
|
|
881
1146
|
}
|
|
882
1147
|
/**
|
|
883
|
-
* Initiates an order import from a CSV file. The import is processed asynchronously.
|
|
1148
|
+
* Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
|
|
884
1149
|
* @summary Import orders
|
|
885
1150
|
* @param {OrdersApiImportOrdersRequest} requestParameters Request parameters.
|
|
886
1151
|
* @param {*} [options] Override http request option.
|
|
@@ -889,6 +1154,26 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
889
1154
|
importOrders(requestParameters, options) {
|
|
890
1155
|
return (0, exports.OrdersApiFp)(this.configuration).importOrders(requestParameters.project, requestParameters.file, options).then((request) => request(this.axios, this.basePath));
|
|
891
1156
|
}
|
|
1157
|
+
/**
|
|
1158
|
+
* Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
|
|
1159
|
+
* @summary List order import groups
|
|
1160
|
+
* @param {OrdersApiListOrderImportGroupsRequest} requestParameters Request parameters.
|
|
1161
|
+
* @param {*} [options] Override http request option.
|
|
1162
|
+
* @throws {RequiredError}
|
|
1163
|
+
*/
|
|
1164
|
+
listOrderImportGroups(requestParameters, options) {
|
|
1165
|
+
return (0, exports.OrdersApiFp)(this.configuration).listOrderImportGroups(requestParameters.project, requestParameters.importId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1166
|
+
}
|
|
1167
|
+
/**
|
|
1168
|
+
* Lists recent order imports for this project, ordered by most recent first.
|
|
1169
|
+
* @summary List order imports
|
|
1170
|
+
* @param {OrdersApiListOrderImportsRequest} requestParameters Request parameters.
|
|
1171
|
+
* @param {*} [options] Override http request option.
|
|
1172
|
+
* @throws {RequiredError}
|
|
1173
|
+
*/
|
|
1174
|
+
listOrderImports(requestParameters, options) {
|
|
1175
|
+
return (0, exports.OrdersApiFp)(this.configuration).listOrderImports(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1176
|
+
}
|
|
892
1177
|
/**
|
|
893
1178
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
894
1179
|
* @summary Retry
|
|
@@ -901,8 +1186,21 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
901
1186
|
}
|
|
902
1187
|
}
|
|
903
1188
|
exports.OrdersApi = OrdersApi;
|
|
1189
|
+
exports.ExportOrdersDateFilterTypeEnum = {
|
|
1190
|
+
CreatedAt: 'createdAt',
|
|
1191
|
+
UpdatedAt: 'updatedAt',
|
|
1192
|
+
PaidAt: 'paidAt',
|
|
1193
|
+
StatusChangedAt: 'statusChangedAt',
|
|
1194
|
+
CompletedAt: 'completedAt',
|
|
1195
|
+
RefundedAt: 'refundedAt',
|
|
1196
|
+
QuoteAt: 'quoteAt'
|
|
1197
|
+
};
|
|
904
1198
|
exports.GetOrdersDateFilterTypeEnum = {
|
|
905
1199
|
CreatedAt: 'createdAt',
|
|
906
1200
|
UpdatedAt: 'updatedAt',
|
|
907
|
-
|
|
1201
|
+
PaidAt: 'paidAt',
|
|
1202
|
+
StatusChangedAt: 'statusChangedAt',
|
|
1203
|
+
CompletedAt: 'completedAt',
|
|
1204
|
+
RefundedAt: 'refundedAt',
|
|
1205
|
+
QuoteAt: 'quoteAt'
|
|
908
1206
|
};
|
package/dist/base.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Orders
|
|
2
|
+
* Orders
|
|
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.28.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
|
-
* Orders
|
|
5
|
+
* Orders
|
|
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.28.2
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Orders
|
|
2
|
+
* Orders
|
|
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.28.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
|
-
* Orders
|
|
5
|
+
* Orders
|
|
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.28.2
|
|
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
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Orders
|
|
2
|
+
* Orders
|
|
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.28.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/**
|
|
4
|
-
* Orders
|
|
4
|
+
* Orders
|
|
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.28.2
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|