@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/dist/esm/api.js CHANGED
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Orders API
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.26.0
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).
@@ -35,6 +35,37 @@ export const ConfirmOrderValidationErrorCodeEnum = {
35
35
  export const CustomsInformationPreRegistrationTypeEnum = {
36
36
  Ioss: 'IOSS'
37
37
  };
38
+ /**
39
+ * 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
40
+ */
41
+ export const OrderImportErrorCode = {
42
+ VariantNotFound: 'VARIANT_NOT_FOUND',
43
+ MissingSku: 'MISSING_SKU',
44
+ ShippingMethodUnavailable: 'SHIPPING_METHOD_UNAVAILABLE',
45
+ TransientSystemError: 'TRANSIENT_SYSTEM_ERROR',
46
+ ImportFailed: 'IMPORT_FAILED'
47
+ };
48
+ /**
49
+ * 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)
50
+ */
51
+ export const OrderImportGroupStatus = {
52
+ Pending: 'pending',
53
+ Processing: 'processing',
54
+ Success: 'success',
55
+ Failed: 'failed',
56
+ Cancelled: 'cancelled'
57
+ };
58
+ /**
59
+ * 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
60
+ */
61
+ export const OrderImportStatus = {
62
+ Queued: 'queued',
63
+ Processing: 'processing',
64
+ CompletedSuccess: 'completedSuccess',
65
+ CompletedPartial: 'completedPartial',
66
+ CompletedFailed: 'completedFailed',
67
+ Cancelled: 'cancelled'
68
+ };
38
69
  export const PaymentAttemptPaymentProviderEnum = {
39
70
  Stripe: 'stripe',
40
71
  Paypal: 'paypal',
@@ -261,10 +292,11 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
261
292
  * @param {string} start Start of the date range to filter by when orders were placed.
262
293
  * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
263
294
  * @param {string} [search] Search term to filter based on order reference, customer name and email
295
+ * @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
264
296
  * @param {*} [options] Override http request option.
265
297
  * @throws {RequiredError}
266
298
  */
267
- 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 = {}) {
299
+ 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 = {}) {
268
300
  // verify required parameter 'project' is not null or undefined
269
301
  assertParamExists('exportOrders', 'project', project);
270
302
  // verify required parameter 'start' is not null or undefined
@@ -300,6 +332,9 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
300
332
  if (search !== undefined) {
301
333
  localVarQueryParameter['search'] = search;
302
334
  }
335
+ if (dateFilterType !== undefined) {
336
+ localVarQueryParameter['dateFilterType'] = dateFilterType;
337
+ }
303
338
  localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
304
339
  setSearchParams(localVarUrlObj, localVarQueryParameter);
305
340
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -354,6 +389,47 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
354
389
  options: localVarRequestOptions,
355
390
  };
356
391
  }),
392
+ /**
393
+ * Gets the latest status and summary for an order import.
394
+ * @summary Get order import
395
+ * @param {string} project The project identifier to scope the request to.
396
+ * @param {string} importId Unique identifier of an order import
397
+ * @param {*} [options] Override http request option.
398
+ * @throws {RequiredError}
399
+ */
400
+ getOrderImport: (project_1, importId_1, ...args_1) => __awaiter(this, [project_1, importId_1, ...args_1], void 0, function* (project, importId, options = {}) {
401
+ // verify required parameter 'project' is not null or undefined
402
+ assertParamExists('getOrderImport', 'project', project);
403
+ // verify required parameter 'importId' is not null or undefined
404
+ assertParamExists('getOrderImport', 'importId', importId);
405
+ const localVarPath = `/v1/orders/imports/{importId}`
406
+ .replace(`{${"importId"}}`, encodeURIComponent(String(importId)));
407
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
408
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
409
+ let baseOptions;
410
+ if (configuration) {
411
+ baseOptions = configuration.baseOptions;
412
+ }
413
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
414
+ const localVarHeaderParameter = {};
415
+ const localVarQueryParameter = {};
416
+ // authentication session-oauth required
417
+ // oauth required
418
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
419
+ // authentication api-key required
420
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
421
+ if (project !== undefined) {
422
+ localVarQueryParameter['project'] = project;
423
+ }
424
+ localVarHeaderParameter['Accept'] = 'application/json';
425
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
426
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
427
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
428
+ return {
429
+ url: toPathString(localVarUrlObj),
430
+ options: localVarRequestOptions,
431
+ };
432
+ }),
357
433
  /**
358
434
  * Lists all orders placed on this project, paginated into configurable chunks.
359
435
  * @summary List orders
@@ -432,7 +508,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
432
508
  };
433
509
  }),
434
510
  /**
435
- * Initiates an order import from a CSV file. The import is processed asynchronously.
511
+ * Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
436
512
  * @summary Import orders
437
513
  * @param {string} project The project identifier to scope the request to.
438
514
  * @param {File} file CSV file containing order data
@@ -444,7 +520,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
444
520
  assertParamExists('importOrders', 'project', project);
445
521
  // verify required parameter 'file' is not null or undefined
446
522
  assertParamExists('importOrders', 'file', file);
447
- const localVarPath = `/v1/orders/import`;
523
+ const localVarPath = `/v1/orders/imports`;
448
524
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
449
525
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
450
526
  let baseOptions;
@@ -477,6 +553,100 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
477
553
  options: localVarRequestOptions,
478
554
  };
479
555
  }),
556
+ /**
557
+ * Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
558
+ * @summary List order import groups
559
+ * @param {string} project The project identifier to scope the request to.
560
+ * @param {string} importId Unique identifier of an order import
561
+ * @param {number} [pageToken] Page reference token
562
+ * @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
563
+ * @param {*} [options] Override http request option.
564
+ * @throws {RequiredError}
565
+ */
566
+ 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 = {}) {
567
+ // verify required parameter 'project' is not null or undefined
568
+ assertParamExists('listOrderImportGroups', 'project', project);
569
+ // verify required parameter 'importId' is not null or undefined
570
+ assertParamExists('listOrderImportGroups', 'importId', importId);
571
+ const localVarPath = `/v1/orders/imports/{importId}/groups`
572
+ .replace(`{${"importId"}}`, encodeURIComponent(String(importId)));
573
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
574
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
575
+ let baseOptions;
576
+ if (configuration) {
577
+ baseOptions = configuration.baseOptions;
578
+ }
579
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
580
+ const localVarHeaderParameter = {};
581
+ const localVarQueryParameter = {};
582
+ // authentication session-oauth required
583
+ // oauth required
584
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
585
+ // authentication api-key required
586
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
587
+ if (project !== undefined) {
588
+ localVarQueryParameter['project'] = project;
589
+ }
590
+ if (pageToken !== undefined) {
591
+ localVarQueryParameter['pageToken'] = pageToken;
592
+ }
593
+ if (pageSize !== undefined) {
594
+ localVarQueryParameter['pageSize'] = pageSize;
595
+ }
596
+ localVarHeaderParameter['Accept'] = 'application/json';
597
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
598
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
599
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
600
+ return {
601
+ url: toPathString(localVarUrlObj),
602
+ options: localVarRequestOptions,
603
+ };
604
+ }),
605
+ /**
606
+ * Lists recent order imports for this project, ordered by most recent first.
607
+ * @summary List order imports
608
+ * @param {string} project The project identifier to scope the request to.
609
+ * @param {number} [pageToken] Page reference token
610
+ * @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
611
+ * @param {*} [options] Override http request option.
612
+ * @throws {RequiredError}
613
+ */
614
+ 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 = {}) {
615
+ // verify required parameter 'project' is not null or undefined
616
+ assertParamExists('listOrderImports', 'project', project);
617
+ const localVarPath = `/v1/orders/imports`;
618
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
619
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
620
+ let baseOptions;
621
+ if (configuration) {
622
+ baseOptions = configuration.baseOptions;
623
+ }
624
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
625
+ const localVarHeaderParameter = {};
626
+ const localVarQueryParameter = {};
627
+ // authentication session-oauth required
628
+ // oauth required
629
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
630
+ // authentication api-key required
631
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
632
+ if (project !== undefined) {
633
+ localVarQueryParameter['project'] = project;
634
+ }
635
+ if (pageToken !== undefined) {
636
+ localVarQueryParameter['pageToken'] = pageToken;
637
+ }
638
+ if (pageSize !== undefined) {
639
+ localVarQueryParameter['pageSize'] = pageSize;
640
+ }
641
+ localVarHeaderParameter['Accept'] = 'application/json';
642
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
643
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
644
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
645
+ return {
646
+ url: toPathString(localVarUrlObj),
647
+ options: localVarRequestOptions,
648
+ };
649
+ }),
480
650
  /**
481
651
  * Retries failed platform payment, so fulfillment can proceed.
482
652
  * @summary Retry
@@ -609,13 +779,14 @@ export const OrdersApiFp = function (configuration) {
609
779
  * @param {string} start Start of the date range to filter by when orders were placed.
610
780
  * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
611
781
  * @param {string} [search] Search term to filter based on order reference, customer name and email
782
+ * @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
612
783
  * @param {*} [options] Override http request option.
613
784
  * @throws {RequiredError}
614
785
  */
615
- exportOrders(project, start, end, search, options) {
786
+ exportOrders(project, start, end, search, dateFilterType, options) {
616
787
  return __awaiter(this, void 0, void 0, function* () {
617
788
  var _a, _b, _c;
618
- const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, start, end, search, options);
789
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOrders(project, start, end, search, dateFilterType, options);
619
790
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
620
791
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.exportOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
621
792
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -639,6 +810,23 @@ export const OrdersApiFp = function (configuration) {
639
810
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
640
811
  });
641
812
  },
813
+ /**
814
+ * Gets the latest status and summary for an order import.
815
+ * @summary Get order import
816
+ * @param {string} project The project identifier to scope the request to.
817
+ * @param {string} importId Unique identifier of an order import
818
+ * @param {*} [options] Override http request option.
819
+ * @throws {RequiredError}
820
+ */
821
+ getOrderImport(project, importId, options) {
822
+ return __awaiter(this, void 0, void 0, function* () {
823
+ var _a, _b, _c;
824
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrderImport(project, importId, options);
825
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
826
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.getOrderImport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
827
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
828
+ });
829
+ },
642
830
  /**
643
831
  * Lists all orders placed on this project, paginated into configurable chunks.
644
832
  * @summary List orders
@@ -665,7 +853,7 @@ export const OrdersApiFp = function (configuration) {
665
853
  });
666
854
  },
667
855
  /**
668
- * Initiates an order import from a CSV file. The import is processed asynchronously.
856
+ * Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
669
857
  * @summary Import orders
670
858
  * @param {string} project The project identifier to scope the request to.
671
859
  * @param {File} file CSV file containing order data
@@ -681,6 +869,43 @@ export const OrdersApiFp = function (configuration) {
681
869
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
682
870
  });
683
871
  },
872
+ /**
873
+ * Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
874
+ * @summary List order import groups
875
+ * @param {string} project The project identifier to scope the request to.
876
+ * @param {string} importId Unique identifier of an order import
877
+ * @param {number} [pageToken] Page reference token
878
+ * @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
879
+ * @param {*} [options] Override http request option.
880
+ * @throws {RequiredError}
881
+ */
882
+ listOrderImportGroups(project, importId, pageToken, pageSize, options) {
883
+ return __awaiter(this, void 0, void 0, function* () {
884
+ var _a, _b, _c;
885
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrderImportGroups(project, importId, pageToken, pageSize, options);
886
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
887
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.listOrderImportGroups']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
888
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
889
+ });
890
+ },
891
+ /**
892
+ * Lists recent order imports for this project, ordered by most recent first.
893
+ * @summary List order imports
894
+ * @param {string} project The project identifier to scope the request to.
895
+ * @param {number} [pageToken] Page reference token
896
+ * @param {number} [pageSize] Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller.
897
+ * @param {*} [options] Override http request option.
898
+ * @throws {RequiredError}
899
+ */
900
+ listOrderImports(project, pageToken, pageSize, options) {
901
+ return __awaiter(this, void 0, void 0, function* () {
902
+ var _a, _b, _c;
903
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrderImports(project, pageToken, pageSize, options);
904
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
905
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.listOrderImports']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
906
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
907
+ });
908
+ },
684
909
  /**
685
910
  * Retries failed platform payment, so fulfillment can proceed.
686
911
  * @summary Retry
@@ -755,7 +980,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
755
980
  * @throws {RequiredError}
756
981
  */
757
982
  exportOrders(requestParameters, options) {
758
- return localVarFp.exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
983
+ return localVarFp.exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
759
984
  },
760
985
  /**
761
986
  * Get an order by a given ID.
@@ -767,6 +992,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
767
992
  getOrder(requestParameters, options) {
768
993
  return localVarFp.getOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(axios, basePath));
769
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
+ },
770
1005
  /**
771
1006
  * Lists all orders placed on this project, paginated into configurable chunks.
772
1007
  * @summary List orders
@@ -778,7 +1013,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
778
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));
779
1014
  },
780
1015
  /**
781
- * 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.
782
1017
  * @summary Import orders
783
1018
  * @param {OrdersApiImportOrdersRequest} requestParameters Request parameters.
784
1019
  * @param {*} [options] Override http request option.
@@ -787,6 +1022,26 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
787
1022
  importOrders(requestParameters, options) {
788
1023
  return localVarFp.importOrders(requestParameters.project, requestParameters.file, options).then((request) => request(axios, basePath));
789
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
+ },
790
1045
  /**
791
1046
  * Retries failed platform payment, so fulfillment can proceed.
792
1047
  * @summary Retry
@@ -851,7 +1106,7 @@ export class OrdersApi extends BaseAPI {
851
1106
  * @throws {RequiredError}
852
1107
  */
853
1108
  exportOrders(requestParameters, options) {
854
- return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
1109
+ return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
855
1110
  }
856
1111
  /**
857
1112
  * Get an order by a given ID.
@@ -863,6 +1118,16 @@ export class OrdersApi extends BaseAPI {
863
1118
  getOrder(requestParameters, options) {
864
1119
  return OrdersApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
865
1120
  }
1121
+ /**
1122
+ * Gets the latest status and summary for an order import.
1123
+ * @summary Get order import
1124
+ * @param {OrdersApiGetOrderImportRequest} requestParameters Request parameters.
1125
+ * @param {*} [options] Override http request option.
1126
+ * @throws {RequiredError}
1127
+ */
1128
+ getOrderImport(requestParameters, options) {
1129
+ return OrdersApiFp(this.configuration).getOrderImport(requestParameters.project, requestParameters.importId, options).then((request) => request(this.axios, this.basePath));
1130
+ }
866
1131
  /**
867
1132
  * Lists all orders placed on this project, paginated into configurable chunks.
868
1133
  * @summary List orders
@@ -874,7 +1139,7 @@ export class OrdersApi extends BaseAPI {
874
1139
  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));
875
1140
  }
876
1141
  /**
877
- * Initiates an order import from a CSV file. The import is processed asynchronously.
1142
+ * Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
878
1143
  * @summary Import orders
879
1144
  * @param {OrdersApiImportOrdersRequest} requestParameters Request parameters.
880
1145
  * @param {*} [options] Override http request option.
@@ -883,6 +1148,26 @@ export class OrdersApi extends BaseAPI {
883
1148
  importOrders(requestParameters, options) {
884
1149
  return OrdersApiFp(this.configuration).importOrders(requestParameters.project, requestParameters.file, options).then((request) => request(this.axios, this.basePath));
885
1150
  }
1151
+ /**
1152
+ * Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
1153
+ * @summary List order import groups
1154
+ * @param {OrdersApiListOrderImportGroupsRequest} requestParameters Request parameters.
1155
+ * @param {*} [options] Override http request option.
1156
+ * @throws {RequiredError}
1157
+ */
1158
+ listOrderImportGroups(requestParameters, options) {
1159
+ return OrdersApiFp(this.configuration).listOrderImportGroups(requestParameters.project, requestParameters.importId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1160
+ }
1161
+ /**
1162
+ * Lists recent order imports for this project, ordered by most recent first.
1163
+ * @summary List order imports
1164
+ * @param {OrdersApiListOrderImportsRequest} requestParameters Request parameters.
1165
+ * @param {*} [options] Override http request option.
1166
+ * @throws {RequiredError}
1167
+ */
1168
+ listOrderImports(requestParameters, options) {
1169
+ return OrdersApiFp(this.configuration).listOrderImports(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1170
+ }
886
1171
  /**
887
1172
  * Retries failed platform payment, so fulfillment can proceed.
888
1173
  * @summary Retry
@@ -894,8 +1179,21 @@ export class OrdersApi extends BaseAPI {
894
1179
  return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.orderId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
895
1180
  }
896
1181
  }
1182
+ export const ExportOrdersDateFilterTypeEnum = {
1183
+ CreatedAt: 'createdAt',
1184
+ UpdatedAt: 'updatedAt',
1185
+ PaidAt: 'paidAt',
1186
+ StatusChangedAt: 'statusChangedAt',
1187
+ CompletedAt: 'completedAt',
1188
+ RefundedAt: 'refundedAt',
1189
+ QuoteAt: 'quoteAt'
1190
+ };
897
1191
  export const GetOrdersDateFilterTypeEnum = {
898
1192
  CreatedAt: 'createdAt',
899
1193
  UpdatedAt: 'updatedAt',
900
- StatusChangedAt: 'statusChangedAt'
1194
+ PaidAt: 'paidAt',
1195
+ StatusChangedAt: 'statusChangedAt',
1196
+ CompletedAt: 'completedAt',
1197
+ RefundedAt: 'refundedAt',
1198
+ QuoteAt: 'quoteAt'
901
1199
  };
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Orders API
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.26.0
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/esm/base.js CHANGED
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Orders API
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.26.0
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).
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Orders API
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.26.0
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).
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Orders API
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.26.0
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).
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Orders API
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.26.0
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).
@@ -1,9 +1,9 @@
1
1
  /* tslint:disable */
2
2
  /**
3
- * Orders API
3
+ * Orders
4
4
  * 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.
5
5
  *
6
- * The version of the OpenAPI document: 1.26.0
6
+ * The version of the OpenAPI document: 1.28.2
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Orders API
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.26.0
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/esm/index.js CHANGED
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Orders API
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.26.0
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).
package/dist/index.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Orders API
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.26.0
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/index.js CHANGED
@@ -2,10 +2,10 @@
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
4
  /**
5
- * Orders API
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.26.0
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).
@@ -5,7 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **importId** | **string** | Id of the order import | [optional] [default to undefined]
8
+ **importId** | **string** | Unique object identifier | [optional] [default to undefined]
9
9
 
10
10
  ## Example
11
11
 
@@ -0,0 +1,32 @@
1
+ # OrderImport
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **importId** | **string** | Unique object identifier | [default to undefined]
9
+ **status** | [**OrderImportStatus**](OrderImportStatus.md) | | [default to undefined]
10
+ **counts** | [**OrderImportCounts**](OrderImportCounts.md) | | [default to undefined]
11
+ **createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
12
+ **cancelledAt** | **string** | | [optional] [default to undefined]
13
+ **startedAt** | **string** | | [optional] [default to undefined]
14
+ **finishedAt** | **string** | | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { OrderImport } from '@teemill/orders';
20
+
21
+ const instance: OrderImport = {
22
+ importId,
23
+ status,
24
+ counts,
25
+ createdAt,
26
+ cancelledAt,
27
+ startedAt,
28
+ finishedAt,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)