@teemill/orders 1.26.0 → 1.27.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 +15 -3
- package/api.ts +476 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +288 -6
- package/dist/api.js +287 -7
- 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 +288 -6
- package/dist/esm/api.js +286 -6
- 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/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 +190 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.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.27.0
|
|
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.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',
|
|
@@ -357,6 +388,47 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
357
388
|
options: localVarRequestOptions,
|
|
358
389
|
};
|
|
359
390
|
}),
|
|
391
|
+
/**
|
|
392
|
+
* Gets the latest status and summary for an order import.
|
|
393
|
+
* @summary Get order import
|
|
394
|
+
* @param {string} project The project identifier to scope the request to.
|
|
395
|
+
* @param {string} importId Unique identifier of an order import
|
|
396
|
+
* @param {*} [options] Override http request option.
|
|
397
|
+
* @throws {RequiredError}
|
|
398
|
+
*/
|
|
399
|
+
getOrderImport: (project_1, importId_1, ...args_1) => __awaiter(this, [project_1, importId_1, ...args_1], void 0, function* (project, importId, options = {}) {
|
|
400
|
+
// verify required parameter 'project' is not null or undefined
|
|
401
|
+
(0, common_1.assertParamExists)('getOrderImport', 'project', project);
|
|
402
|
+
// verify required parameter 'importId' is not null or undefined
|
|
403
|
+
(0, common_1.assertParamExists)('getOrderImport', 'importId', importId);
|
|
404
|
+
const localVarPath = `/v1/orders/imports/{importId}`
|
|
405
|
+
.replace(`{${"importId"}}`, encodeURIComponent(String(importId)));
|
|
406
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
407
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
408
|
+
let baseOptions;
|
|
409
|
+
if (configuration) {
|
|
410
|
+
baseOptions = configuration.baseOptions;
|
|
411
|
+
}
|
|
412
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
413
|
+
const localVarHeaderParameter = {};
|
|
414
|
+
const localVarQueryParameter = {};
|
|
415
|
+
// authentication session-oauth required
|
|
416
|
+
// oauth required
|
|
417
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
418
|
+
// authentication api-key required
|
|
419
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
420
|
+
if (project !== undefined) {
|
|
421
|
+
localVarQueryParameter['project'] = project;
|
|
422
|
+
}
|
|
423
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
424
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
425
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
426
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
427
|
+
return {
|
|
428
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
429
|
+
options: localVarRequestOptions,
|
|
430
|
+
};
|
|
431
|
+
}),
|
|
360
432
|
/**
|
|
361
433
|
* Lists all orders placed on this project, paginated into configurable chunks.
|
|
362
434
|
* @summary List orders
|
|
@@ -435,7 +507,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
435
507
|
};
|
|
436
508
|
}),
|
|
437
509
|
/**
|
|
438
|
-
* Initiates an order import from a CSV file. The import is processed asynchronously.
|
|
510
|
+
* 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
511
|
* @summary Import orders
|
|
440
512
|
* @param {string} project The project identifier to scope the request to.
|
|
441
513
|
* @param {File} file CSV file containing order data
|
|
@@ -447,7 +519,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
447
519
|
(0, common_1.assertParamExists)('importOrders', 'project', project);
|
|
448
520
|
// verify required parameter 'file' is not null or undefined
|
|
449
521
|
(0, common_1.assertParamExists)('importOrders', 'file', file);
|
|
450
|
-
const localVarPath = `/v1/orders/
|
|
522
|
+
const localVarPath = `/v1/orders/imports`;
|
|
451
523
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
452
524
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
453
525
|
let baseOptions;
|
|
@@ -480,6 +552,100 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
480
552
|
options: localVarRequestOptions,
|
|
481
553
|
};
|
|
482
554
|
}),
|
|
555
|
+
/**
|
|
556
|
+
* Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
|
|
557
|
+
* @summary List order import groups
|
|
558
|
+
* @param {string} project The project identifier to scope the request to.
|
|
559
|
+
* @param {string} importId Unique identifier of an order import
|
|
560
|
+
* @param {number} [pageToken] Page reference token
|
|
561
|
+
* @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
|
|
562
|
+
* @param {*} [options] Override http request option.
|
|
563
|
+
* @throws {RequiredError}
|
|
564
|
+
*/
|
|
565
|
+
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 = {}) {
|
|
566
|
+
// verify required parameter 'project' is not null or undefined
|
|
567
|
+
(0, common_1.assertParamExists)('listOrderImportGroups', 'project', project);
|
|
568
|
+
// verify required parameter 'importId' is not null or undefined
|
|
569
|
+
(0, common_1.assertParamExists)('listOrderImportGroups', 'importId', importId);
|
|
570
|
+
const localVarPath = `/v1/orders/imports/{importId}/groups`
|
|
571
|
+
.replace(`{${"importId"}}`, encodeURIComponent(String(importId)));
|
|
572
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
573
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
574
|
+
let baseOptions;
|
|
575
|
+
if (configuration) {
|
|
576
|
+
baseOptions = configuration.baseOptions;
|
|
577
|
+
}
|
|
578
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
579
|
+
const localVarHeaderParameter = {};
|
|
580
|
+
const localVarQueryParameter = {};
|
|
581
|
+
// authentication session-oauth required
|
|
582
|
+
// oauth required
|
|
583
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
584
|
+
// authentication api-key required
|
|
585
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
586
|
+
if (project !== undefined) {
|
|
587
|
+
localVarQueryParameter['project'] = project;
|
|
588
|
+
}
|
|
589
|
+
if (pageToken !== undefined) {
|
|
590
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
591
|
+
}
|
|
592
|
+
if (pageSize !== undefined) {
|
|
593
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
594
|
+
}
|
|
595
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
596
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
597
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
598
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
599
|
+
return {
|
|
600
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
601
|
+
options: localVarRequestOptions,
|
|
602
|
+
};
|
|
603
|
+
}),
|
|
604
|
+
/**
|
|
605
|
+
* Lists recent order imports for this project, ordered by most recent first.
|
|
606
|
+
* @summary List order imports
|
|
607
|
+
* @param {string} project The project identifier to scope the request to.
|
|
608
|
+
* @param {number} [pageToken] Page reference token
|
|
609
|
+
* @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
|
|
610
|
+
* @param {*} [options] Override http request option.
|
|
611
|
+
* @throws {RequiredError}
|
|
612
|
+
*/
|
|
613
|
+
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 = {}) {
|
|
614
|
+
// verify required parameter 'project' is not null or undefined
|
|
615
|
+
(0, common_1.assertParamExists)('listOrderImports', 'project', project);
|
|
616
|
+
const localVarPath = `/v1/orders/imports`;
|
|
617
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
618
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
619
|
+
let baseOptions;
|
|
620
|
+
if (configuration) {
|
|
621
|
+
baseOptions = configuration.baseOptions;
|
|
622
|
+
}
|
|
623
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
624
|
+
const localVarHeaderParameter = {};
|
|
625
|
+
const localVarQueryParameter = {};
|
|
626
|
+
// authentication session-oauth required
|
|
627
|
+
// oauth required
|
|
628
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
629
|
+
// authentication api-key required
|
|
630
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
631
|
+
if (project !== undefined) {
|
|
632
|
+
localVarQueryParameter['project'] = project;
|
|
633
|
+
}
|
|
634
|
+
if (pageToken !== undefined) {
|
|
635
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
636
|
+
}
|
|
637
|
+
if (pageSize !== undefined) {
|
|
638
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
639
|
+
}
|
|
640
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
641
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
642
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
643
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
644
|
+
return {
|
|
645
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
646
|
+
options: localVarRequestOptions,
|
|
647
|
+
};
|
|
648
|
+
}),
|
|
483
649
|
/**
|
|
484
650
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
485
651
|
* @summary Retry
|
|
@@ -643,6 +809,23 @@ const OrdersApiFp = function (configuration) {
|
|
|
643
809
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
644
810
|
});
|
|
645
811
|
},
|
|
812
|
+
/**
|
|
813
|
+
* Gets the latest status and summary for an order import.
|
|
814
|
+
* @summary Get order import
|
|
815
|
+
* @param {string} project The project identifier to scope the request to.
|
|
816
|
+
* @param {string} importId Unique identifier of an order import
|
|
817
|
+
* @param {*} [options] Override http request option.
|
|
818
|
+
* @throws {RequiredError}
|
|
819
|
+
*/
|
|
820
|
+
getOrderImport(project, importId, options) {
|
|
821
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
822
|
+
var _a, _b, _c;
|
|
823
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrderImport(project, importId, options);
|
|
824
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
825
|
+
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;
|
|
826
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
827
|
+
});
|
|
828
|
+
},
|
|
646
829
|
/**
|
|
647
830
|
* Lists all orders placed on this project, paginated into configurable chunks.
|
|
648
831
|
* @summary List orders
|
|
@@ -669,7 +852,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
669
852
|
});
|
|
670
853
|
},
|
|
671
854
|
/**
|
|
672
|
-
* Initiates an order import from a CSV file. The import is processed asynchronously.
|
|
855
|
+
* 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
856
|
* @summary Import orders
|
|
674
857
|
* @param {string} project The project identifier to scope the request to.
|
|
675
858
|
* @param {File} file CSV file containing order data
|
|
@@ -685,6 +868,43 @@ const OrdersApiFp = function (configuration) {
|
|
|
685
868
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
686
869
|
});
|
|
687
870
|
},
|
|
871
|
+
/**
|
|
872
|
+
* Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
|
|
873
|
+
* @summary List order import groups
|
|
874
|
+
* @param {string} project The project identifier to scope the request to.
|
|
875
|
+
* @param {string} importId Unique identifier of an order import
|
|
876
|
+
* @param {number} [pageToken] Page reference token
|
|
877
|
+
* @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
|
|
878
|
+
* @param {*} [options] Override http request option.
|
|
879
|
+
* @throws {RequiredError}
|
|
880
|
+
*/
|
|
881
|
+
listOrderImportGroups(project, importId, pageToken, pageSize, options) {
|
|
882
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
883
|
+
var _a, _b, _c;
|
|
884
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrderImportGroups(project, importId, pageToken, pageSize, options);
|
|
885
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
886
|
+
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;
|
|
887
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
888
|
+
});
|
|
889
|
+
},
|
|
890
|
+
/**
|
|
891
|
+
* Lists recent order imports for this project, ordered by most recent first.
|
|
892
|
+
* @summary List order imports
|
|
893
|
+
* @param {string} project The project identifier to scope the request to.
|
|
894
|
+
* @param {number} [pageToken] Page reference token
|
|
895
|
+
* @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
|
|
896
|
+
* @param {*} [options] Override http request option.
|
|
897
|
+
* @throws {RequiredError}
|
|
898
|
+
*/
|
|
899
|
+
listOrderImports(project, pageToken, pageSize, options) {
|
|
900
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
901
|
+
var _a, _b, _c;
|
|
902
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrderImports(project, pageToken, pageSize, options);
|
|
903
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
904
|
+
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;
|
|
905
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
906
|
+
});
|
|
907
|
+
},
|
|
688
908
|
/**
|
|
689
909
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
690
910
|
* @summary Retry
|
|
@@ -772,6 +992,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
772
992
|
getOrder(requestParameters, options) {
|
|
773
993
|
return localVarFp.getOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
774
994
|
},
|
|
995
|
+
/**
|
|
996
|
+
* Gets the latest status and summary for an order import.
|
|
997
|
+
* @summary Get order import
|
|
998
|
+
* @param {OrdersApiGetOrderImportRequest} requestParameters Request parameters.
|
|
999
|
+
* @param {*} [options] Override http request option.
|
|
1000
|
+
* @throws {RequiredError}
|
|
1001
|
+
*/
|
|
1002
|
+
getOrderImport(requestParameters, options) {
|
|
1003
|
+
return localVarFp.getOrderImport(requestParameters.project, requestParameters.importId, options).then((request) => request(axios, basePath));
|
|
1004
|
+
},
|
|
775
1005
|
/**
|
|
776
1006
|
* Lists all orders placed on this project, paginated into configurable chunks.
|
|
777
1007
|
* @summary List orders
|
|
@@ -783,7 +1013,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
783
1013
|
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
1014
|
},
|
|
785
1015
|
/**
|
|
786
|
-
* Initiates an order import from a CSV file. The import is processed asynchronously.
|
|
1016
|
+
* 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
1017
|
* @summary Import orders
|
|
788
1018
|
* @param {OrdersApiImportOrdersRequest} requestParameters Request parameters.
|
|
789
1019
|
* @param {*} [options] Override http request option.
|
|
@@ -792,6 +1022,26 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
792
1022
|
importOrders(requestParameters, options) {
|
|
793
1023
|
return localVarFp.importOrders(requestParameters.project, requestParameters.file, options).then((request) => request(axios, basePath));
|
|
794
1024
|
},
|
|
1025
|
+
/**
|
|
1026
|
+
* Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
|
|
1027
|
+
* @summary List order import groups
|
|
1028
|
+
* @param {OrdersApiListOrderImportGroupsRequest} requestParameters Request parameters.
|
|
1029
|
+
* @param {*} [options] Override http request option.
|
|
1030
|
+
* @throws {RequiredError}
|
|
1031
|
+
*/
|
|
1032
|
+
listOrderImportGroups(requestParameters, options) {
|
|
1033
|
+
return localVarFp.listOrderImportGroups(requestParameters.project, requestParameters.importId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1034
|
+
},
|
|
1035
|
+
/**
|
|
1036
|
+
* Lists recent order imports for this project, ordered by most recent first.
|
|
1037
|
+
* @summary List order imports
|
|
1038
|
+
* @param {OrdersApiListOrderImportsRequest} requestParameters Request parameters.
|
|
1039
|
+
* @param {*} [options] Override http request option.
|
|
1040
|
+
* @throws {RequiredError}
|
|
1041
|
+
*/
|
|
1042
|
+
listOrderImports(requestParameters, options) {
|
|
1043
|
+
return localVarFp.listOrderImports(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1044
|
+
},
|
|
795
1045
|
/**
|
|
796
1046
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
797
1047
|
* @summary Retry
|
|
@@ -869,6 +1119,16 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
869
1119
|
getOrder(requestParameters, options) {
|
|
870
1120
|
return (0, exports.OrdersApiFp)(this.configuration).getOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
871
1121
|
}
|
|
1122
|
+
/**
|
|
1123
|
+
* Gets the latest status and summary for an order import.
|
|
1124
|
+
* @summary Get order import
|
|
1125
|
+
* @param {OrdersApiGetOrderImportRequest} requestParameters Request parameters.
|
|
1126
|
+
* @param {*} [options] Override http request option.
|
|
1127
|
+
* @throws {RequiredError}
|
|
1128
|
+
*/
|
|
1129
|
+
getOrderImport(requestParameters, options) {
|
|
1130
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderImport(requestParameters.project, requestParameters.importId, options).then((request) => request(this.axios, this.basePath));
|
|
1131
|
+
}
|
|
872
1132
|
/**
|
|
873
1133
|
* Lists all orders placed on this project, paginated into configurable chunks.
|
|
874
1134
|
* @summary List orders
|
|
@@ -880,7 +1140,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
880
1140
|
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
1141
|
}
|
|
882
1142
|
/**
|
|
883
|
-
* Initiates an order import from a CSV file. The import is processed asynchronously.
|
|
1143
|
+
* 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
1144
|
* @summary Import orders
|
|
885
1145
|
* @param {OrdersApiImportOrdersRequest} requestParameters Request parameters.
|
|
886
1146
|
* @param {*} [options] Override http request option.
|
|
@@ -889,6 +1149,26 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
889
1149
|
importOrders(requestParameters, options) {
|
|
890
1150
|
return (0, exports.OrdersApiFp)(this.configuration).importOrders(requestParameters.project, requestParameters.file, options).then((request) => request(this.axios, this.basePath));
|
|
891
1151
|
}
|
|
1152
|
+
/**
|
|
1153
|
+
* Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
|
|
1154
|
+
* @summary List order import groups
|
|
1155
|
+
* @param {OrdersApiListOrderImportGroupsRequest} requestParameters Request parameters.
|
|
1156
|
+
* @param {*} [options] Override http request option.
|
|
1157
|
+
* @throws {RequiredError}
|
|
1158
|
+
*/
|
|
1159
|
+
listOrderImportGroups(requestParameters, options) {
|
|
1160
|
+
return (0, exports.OrdersApiFp)(this.configuration).listOrderImportGroups(requestParameters.project, requestParameters.importId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1161
|
+
}
|
|
1162
|
+
/**
|
|
1163
|
+
* Lists recent order imports for this project, ordered by most recent first.
|
|
1164
|
+
* @summary List order imports
|
|
1165
|
+
* @param {OrdersApiListOrderImportsRequest} requestParameters Request parameters.
|
|
1166
|
+
* @param {*} [options] Override http request option.
|
|
1167
|
+
* @throws {RequiredError}
|
|
1168
|
+
*/
|
|
1169
|
+
listOrderImports(requestParameters, options) {
|
|
1170
|
+
return (0, exports.OrdersApiFp)(this.configuration).listOrderImports(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1171
|
+
}
|
|
892
1172
|
/**
|
|
893
1173
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
894
1174
|
* @summary Retry
|
package/dist/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.27.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.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.27.0
|
|
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
|
@@ -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.27.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
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.27.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.27.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
|
@@ -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.27.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|