@teemill/orders 1.29.0 → 1.29.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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/orders@1.29.0
1
+ ## @teemill/orders@1.29.2
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @teemill/orders@1.29.0 --save
39
+ npm install @teemill/orders@1.29.2 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -62,7 +62,7 @@ Class | Method | HTTP request | Description
62
62
  *OrdersApi* | [**importOrders**](docs/OrdersApi.md#importorders) | **POST** /v1/orders/imports | Import orders
63
63
  *OrdersApi* | [**listOrderImportGroups**](docs/OrdersApi.md#listorderimportgroups) | **GET** /v1/orders/imports/{importId}/groups | List order import groups
64
64
  *OrdersApi* | [**listOrderImports**](docs/OrdersApi.md#listorderimports) | **GET** /v1/orders/imports | List order imports
65
- *OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry
65
+ *OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry platform payment
66
66
 
67
67
 
68
68
  ### Documentation For Models
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
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.29.0
7
+ * The version of the OpenAPI document: 1.29.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -154,12 +154,15 @@ export interface ContactInformation1 {
154
154
  */
155
155
  export interface Coupon {
156
156
  /**
157
- * Unique object identifier
157
+ * The unique identifier of the coupon.
158
158
  */
159
159
  'id': string;
160
+ /**
161
+ * The discount code entered by the customer.
162
+ */
160
163
  'code': string;
161
164
  /**
162
- * Reference to the discount. **Note:** Requires the discounts integration to see the reference.
165
+ * A URI reference to the discount resource. Requires the discounts integration.
163
166
  */
164
167
  'ref'?: string | null;
165
168
  }
@@ -338,11 +341,23 @@ export interface Fulfillment {
338
341
  */
339
342
  'frozen'?: boolean;
340
343
  /**
341
- * List of reason codes why this fulfillment is frozen.
344
+ * List of reason codes why this fulfillment is frozen. - `moderation` - Held for content moderation review. - `internal_screen_print` - Awaiting internal screen print processing. - `manual` - Manually frozen by a user. - `credit_control` - Client is under credit control. - `billing_failed` - Payment for this order failed. - `pickface_flagged` - Flagged on the pickface for review. - `flow_frozen` - Frozen by internal production flow handling. - `fraud` - Frozen due to fraud checks.
342
345
  */
343
- 'frozenReasons'?: Array<string>;
346
+ 'frozenReasons'?: Array<FulfillmentFrozenReasonsEnum>;
344
347
  }
345
348
 
349
+ export const FulfillmentFrozenReasonsEnum = {
350
+ Moderation: 'moderation',
351
+ InternalScreenPrint: 'internal_screen_print',
352
+ Manual: 'manual',
353
+ CreditControl: 'credit_control',
354
+ BillingFailed: 'billing_failed',
355
+ PickfaceFlagged: 'pickface_flagged',
356
+ FlowFrozen: 'flow_frozen',
357
+ Fraud: 'fraud',
358
+ } as const;
359
+
360
+ export type FulfillmentFrozenReasonsEnum = typeof FulfillmentFrozenReasonsEnum[keyof typeof FulfillmentFrozenReasonsEnum];
346
361
 
347
362
  export interface FulfillmentItem {
348
363
  /**
@@ -381,7 +396,7 @@ export interface Image {
381
396
  }
382
397
  export interface ImportOrders202Response {
383
398
  /**
384
- * Unique object identifier
399
+ * Unique identifier of the created import. Use this with the GET /v1/orders/imports/{importId} endpoint to track progress.
385
400
  */
386
401
  'importId'?: string;
387
402
  }
@@ -400,11 +415,11 @@ export interface Option {
400
415
  */
401
416
  export interface Order {
402
417
  /**
403
- * Unique object identifier
418
+ * The unique identifier of the order.
404
419
  */
405
420
  'id'?: string;
406
421
  /**
407
- * A reference to the resource location
422
+ * A URI reference to this order resource.
408
423
  */
409
424
  'ref'?: string;
410
425
  /**
@@ -478,23 +493,41 @@ export interface Order {
478
493
  }
479
494
 
480
495
 
496
+ /**
497
+ * Represents a bulk order import job, tracking the progress and outcome of importing orders from a CSV file.
498
+ */
481
499
  export interface OrderImport {
482
500
  /**
483
- * Unique object identifier
501
+ * The unique identifier of this import job.
484
502
  */
485
503
  'importId': string;
504
+ /**
505
+ * The current lifecycle status of this import.
506
+ */
486
507
  'status': OrderImportStatus;
487
508
  'counts': OrderImportCounts;
488
509
  /**
489
- * ISO 8601 Timestamp
510
+ * The timestamp when the import was created.
490
511
  */
491
512
  'createdAt': string;
513
+ /**
514
+ * The timestamp when the import was cancelled. Null if the import has not been cancelled.
515
+ */
492
516
  'cancelledAt'?: string | null;
517
+ /**
518
+ * The timestamp when the import started processing. Null if processing has not yet begun.
519
+ */
493
520
  'startedAt'?: string | null;
521
+ /**
522
+ * The timestamp when the import finished processing. Null if processing has not yet completed.
523
+ */
494
524
  'finishedAt'?: string | null;
495
525
  }
496
526
 
497
527
 
528
+ /**
529
+ * Counts of import groups in each processing state.
530
+ */
498
531
  export interface OrderImportCounts {
499
532
  'total': number;
500
533
  'pending': number;
@@ -504,7 +537,13 @@ export interface OrderImportCounts {
504
537
  'cancelled': number;
505
538
  'completed': number;
506
539
  }
540
+ /**
541
+ * An error encountered while processing an import group, including a machine-readable code and human-readable message.
542
+ */
507
543
  export interface OrderImportError {
544
+ /**
545
+ * A machine-readable error code identifying the type of import failure.
546
+ */
508
547
  'code': OrderImportErrorCode;
509
548
  /**
510
549
  * A human-readable description of the error.
@@ -544,11 +583,17 @@ export const OrderImportErrorCode = {
544
583
  export type OrderImportErrorCode = typeof OrderImportErrorCode[keyof typeof OrderImportErrorCode];
545
584
 
546
585
 
586
+ /**
587
+ * A single group (order) within a bulk import, representing one merchant reference and its processing outcome.
588
+ */
547
589
  export interface OrderImportGroup {
548
590
  /**
549
- * Unique object identifier
591
+ * Unique identifier for this import group.
550
592
  */
551
593
  'id': string;
594
+ /**
595
+ * The current lifecycle status of this import group.
596
+ */
552
597
  'status': OrderImportGroupStatus;
553
598
  /**
554
599
  * The merchant reference from the CSV rows belonging to this group.
@@ -574,8 +619,17 @@ export interface OrderImportGroup {
574
619
  * Errors encountered while processing this group. Empty when the group succeeded.
575
620
  */
576
621
  'errors': Array<OrderImportError>;
622
+ /**
623
+ * The timestamp when this group was created. Null if not yet set.
624
+ */
577
625
  'createdAt'?: string | null;
626
+ /**
627
+ * The timestamp when this group started processing. Null if processing has not yet begun.
628
+ */
578
629
  'startedAt'?: string | null;
630
+ /**
631
+ * The timestamp when this group finished processing. Null if processing has not yet completed.
632
+ */
579
633
  'finishedAt'?: string | null;
580
634
  }
581
635
 
@@ -628,11 +682,11 @@ export interface OrderItem {
628
682
  */
629
683
  'id'?: string;
630
684
  /**
631
- * A reference to the variant being ordered
685
+ * A reference to the product variant being ordered.
632
686
  */
633
687
  'variantRef': string;
634
688
  /**
635
- * Options associated to an order item\'s variant, such as color and size.
689
+ * The variant attributes (e.g. Colour, Size) for this line item.
636
690
  */
637
691
  'options'?: Array<Option>;
638
692
  /**
@@ -770,6 +824,9 @@ export interface Price {
770
824
  * The item cannot be fulfilled at all — either it is out of stock entirely, or the assigned fulfiller cannot produce it (e.g. missing machinery or variant not configured).
771
825
  */
772
826
  export interface ProductUnavailableError {
827
+ /**
828
+ * The error code identifying this as a product unavailable error.
829
+ */
773
830
  'code': ProductUnavailableErrorCodeEnum;
774
831
  /**
775
832
  * Human-readable description including the product name.
@@ -780,11 +837,11 @@ export interface ProductUnavailableError {
780
837
  */
781
838
  'productTitle': string;
782
839
  /**
783
- * Unique object identifier
840
+ * The unique identifier of the unavailable variant.
784
841
  */
785
842
  'variantId': string;
786
843
  /**
787
- * A reference to the variant being ordered
844
+ * A URI reference to the unavailable variant.
788
845
  */
789
846
  'variantRef': string;
790
847
  /**
@@ -896,6 +953,7 @@ export interface StatusHistoryItem {
896
953
 
897
954
  /**
898
955
  * @type StockConflictError
956
+ * An error indicating that one or more items in the order cannot be fulfilled due to stock or product availability issues. Use the \'code\' field to determine the specific error type.
899
957
  */
900
958
  export type StockConflictError = { code: 'PRODUCT_UNAVAILABLE' } & ProductUnavailableError | { code: 'STOCK_UNAVAILABLE' } & StockUnavailableError;
901
959
 
@@ -903,6 +961,9 @@ export type StockConflictError = { code: 'PRODUCT_UNAVAILABLE' } & ProductUnavai
903
961
  * The requested quantity exceeds available stock. The item can still be ordered in a smaller quantity.
904
962
  */
905
963
  export interface StockUnavailableError {
964
+ /**
965
+ * The error code identifying this as a stock unavailable error.
966
+ */
906
967
  'code': StockUnavailableErrorCodeEnum;
907
968
  /**
908
969
  * Human-readable description including the product name and available quantity.
@@ -913,11 +974,11 @@ export interface StockUnavailableError {
913
974
  */
914
975
  'productTitle': string;
915
976
  /**
916
- * Unique object identifier
977
+ * The unique identifier of the variant with insufficient stock.
917
978
  */
918
979
  'variantId': string;
919
980
  /**
920
- * A reference to the variant being ordered
981
+ * A URI reference to the variant with insufficient stock.
921
982
  */
922
983
  'variantRef': string;
923
984
  /**
@@ -1591,7 +1652,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
1591
1652
  },
1592
1653
  /**
1593
1654
  * Retries failed platform payment, so fulfillment can proceed.
1594
- * @summary Retry
1655
+ * @summary Retry platform payment
1595
1656
  * @param {string} project The project identifier to scope the request to.
1596
1657
  * @param {string} orderId Unique identifier of an order
1597
1658
  * @param {string} [fields] Specifies which fields to return, separated by commas
@@ -1826,7 +1887,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
1826
1887
  },
1827
1888
  /**
1828
1889
  * Retries failed platform payment, so fulfillment can proceed.
1829
- * @summary Retry
1890
+ * @summary Retry platform payment
1830
1891
  * @param {string} project The project identifier to scope the request to.
1831
1892
  * @param {string} orderId Unique identifier of an order
1832
1893
  * @param {string} [fields] Specifies which fields to return, separated by commas
@@ -1960,7 +2021,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
1960
2021
  },
1961
2022
  /**
1962
2023
  * Retries failed platform payment, so fulfillment can proceed.
1963
- * @summary Retry
2024
+ * @summary Retry platform payment
1964
2025
  * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1965
2026
  * @param {*} [options] Override http request option.
1966
2027
  * @throws {RequiredError}
@@ -2378,7 +2439,7 @@ export class OrdersApi extends BaseAPI {
2378
2439
 
2379
2440
  /**
2380
2441
  * Retries failed platform payment, so fulfillment can proceed.
2381
- * @summary Retry
2442
+ * @summary Retry platform payment
2382
2443
  * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
2383
2444
  * @param {*} [options] Override http request option.
2384
2445
  * @throws {RequiredError}
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
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.29.0
7
+ * The version of the OpenAPI document: 1.29.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -4,7 +4,7 @@
4
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.29.0
7
+ * The version of the OpenAPI document: 1.29.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
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.29.0
6
+ * The version of the OpenAPI document: 1.29.2
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
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.29.0
5
+ * The version of the OpenAPI document: 1.29.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -140,12 +140,15 @@ export interface ContactInformation1 {
140
140
  */
141
141
  export interface Coupon {
142
142
  /**
143
- * Unique object identifier
143
+ * The unique identifier of the coupon.
144
144
  */
145
145
  'id': string;
146
+ /**
147
+ * The discount code entered by the customer.
148
+ */
146
149
  'code': string;
147
150
  /**
148
- * Reference to the discount. **Note:** Requires the discounts integration to see the reference.
151
+ * A URI reference to the discount resource. Requires the discounts integration.
149
152
  */
150
153
  'ref'?: string | null;
151
154
  }
@@ -321,10 +324,21 @@ export interface Fulfillment {
321
324
  */
322
325
  'frozen'?: boolean;
323
326
  /**
324
- * List of reason codes why this fulfillment is frozen.
327
+ * List of reason codes why this fulfillment is frozen. - `moderation` - Held for content moderation review. - `internal_screen_print` - Awaiting internal screen print processing. - `manual` - Manually frozen by a user. - `credit_control` - Client is under credit control. - `billing_failed` - Payment for this order failed. - `pickface_flagged` - Flagged on the pickface for review. - `flow_frozen` - Frozen by internal production flow handling. - `fraud` - Frozen due to fraud checks.
325
328
  */
326
- 'frozenReasons'?: Array<string>;
329
+ 'frozenReasons'?: Array<FulfillmentFrozenReasonsEnum>;
327
330
  }
331
+ export declare const FulfillmentFrozenReasonsEnum: {
332
+ readonly Moderation: "moderation";
333
+ readonly InternalScreenPrint: "internal_screen_print";
334
+ readonly Manual: "manual";
335
+ readonly CreditControl: "credit_control";
336
+ readonly BillingFailed: "billing_failed";
337
+ readonly PickfaceFlagged: "pickface_flagged";
338
+ readonly FlowFrozen: "flow_frozen";
339
+ readonly Fraud: "fraud";
340
+ };
341
+ export type FulfillmentFrozenReasonsEnum = typeof FulfillmentFrozenReasonsEnum[keyof typeof FulfillmentFrozenReasonsEnum];
328
342
  export interface FulfillmentItem {
329
343
  /**
330
344
  * Unique identifier for this fulfillment item.
@@ -362,7 +376,7 @@ export interface Image {
362
376
  }
363
377
  export interface ImportOrders202Response {
364
378
  /**
365
- * Unique object identifier
379
+ * Unique identifier of the created import. Use this with the GET /v1/orders/imports/{importId} endpoint to track progress.
366
380
  */
367
381
  'importId'?: string;
368
382
  }
@@ -381,11 +395,11 @@ export interface Option {
381
395
  */
382
396
  export interface Order {
383
397
  /**
384
- * Unique object identifier
398
+ * The unique identifier of the order.
385
399
  */
386
400
  'id'?: string;
387
401
  /**
388
- * A reference to the resource location
402
+ * A URI reference to this order resource.
389
403
  */
390
404
  'ref'?: string;
391
405
  /**
@@ -457,21 +471,39 @@ export interface Order {
457
471
  */
458
472
  'paymentAttempts'?: Array<PaymentAttempt>;
459
473
  }
474
+ /**
475
+ * Represents a bulk order import job, tracking the progress and outcome of importing orders from a CSV file.
476
+ */
460
477
  export interface OrderImport {
461
478
  /**
462
- * Unique object identifier
479
+ * The unique identifier of this import job.
463
480
  */
464
481
  'importId': string;
482
+ /**
483
+ * The current lifecycle status of this import.
484
+ */
465
485
  'status': OrderImportStatus;
466
486
  'counts': OrderImportCounts;
467
487
  /**
468
- * ISO 8601 Timestamp
488
+ * The timestamp when the import was created.
469
489
  */
470
490
  'createdAt': string;
491
+ /**
492
+ * The timestamp when the import was cancelled. Null if the import has not been cancelled.
493
+ */
471
494
  'cancelledAt'?: string | null;
495
+ /**
496
+ * The timestamp when the import started processing. Null if processing has not yet begun.
497
+ */
472
498
  'startedAt'?: string | null;
499
+ /**
500
+ * The timestamp when the import finished processing. Null if processing has not yet completed.
501
+ */
473
502
  'finishedAt'?: string | null;
474
503
  }
504
+ /**
505
+ * Counts of import groups in each processing state.
506
+ */
475
507
  export interface OrderImportCounts {
476
508
  'total': number;
477
509
  'pending': number;
@@ -481,7 +513,13 @@ export interface OrderImportCounts {
481
513
  'cancelled': number;
482
514
  'completed': number;
483
515
  }
516
+ /**
517
+ * An error encountered while processing an import group, including a machine-readable code and human-readable message.
518
+ */
484
519
  export interface OrderImportError {
520
+ /**
521
+ * A machine-readable error code identifying the type of import failure.
522
+ */
485
523
  'code': OrderImportErrorCode;
486
524
  /**
487
525
  * A human-readable description of the error.
@@ -515,11 +553,17 @@ export declare const OrderImportErrorCode: {
515
553
  readonly ImportFailed: "IMPORT_FAILED";
516
554
  };
517
555
  export type OrderImportErrorCode = typeof OrderImportErrorCode[keyof typeof OrderImportErrorCode];
556
+ /**
557
+ * A single group (order) within a bulk import, representing one merchant reference and its processing outcome.
558
+ */
518
559
  export interface OrderImportGroup {
519
560
  /**
520
- * Unique object identifier
561
+ * Unique identifier for this import group.
521
562
  */
522
563
  'id': string;
564
+ /**
565
+ * The current lifecycle status of this import group.
566
+ */
523
567
  'status': OrderImportGroupStatus;
524
568
  /**
525
569
  * The merchant reference from the CSV rows belonging to this group.
@@ -545,8 +589,17 @@ export interface OrderImportGroup {
545
589
  * Errors encountered while processing this group. Empty when the group succeeded.
546
590
  */
547
591
  'errors': Array<OrderImportError>;
592
+ /**
593
+ * The timestamp when this group was created. Null if not yet set.
594
+ */
548
595
  'createdAt'?: string | null;
596
+ /**
597
+ * The timestamp when this group started processing. Null if processing has not yet begun.
598
+ */
549
599
  'startedAt'?: string | null;
600
+ /**
601
+ * The timestamp when this group finished processing. Null if processing has not yet completed.
602
+ */
550
603
  'finishedAt'?: string | null;
551
604
  }
552
605
  /**
@@ -589,11 +642,11 @@ export interface OrderItem {
589
642
  */
590
643
  'id'?: string;
591
644
  /**
592
- * A reference to the variant being ordered
645
+ * A reference to the product variant being ordered.
593
646
  */
594
647
  'variantRef': string;
595
648
  /**
596
- * Options associated to an order item\'s variant, such as color and size.
649
+ * The variant attributes (e.g. Colour, Size) for this line item.
597
650
  */
598
651
  'options'?: Array<Option>;
599
652
  /**
@@ -727,6 +780,9 @@ export interface Price {
727
780
  * The item cannot be fulfilled at all — either it is out of stock entirely, or the assigned fulfiller cannot produce it (e.g. missing machinery or variant not configured).
728
781
  */
729
782
  export interface ProductUnavailableError {
783
+ /**
784
+ * The error code identifying this as a product unavailable error.
785
+ */
730
786
  'code': ProductUnavailableErrorCodeEnum;
731
787
  /**
732
788
  * Human-readable description including the product name.
@@ -737,11 +793,11 @@ export interface ProductUnavailableError {
737
793
  */
738
794
  'productTitle': string;
739
795
  /**
740
- * Unique object identifier
796
+ * The unique identifier of the unavailable variant.
741
797
  */
742
798
  'variantId': string;
743
799
  /**
744
- * A reference to the variant being ordered
800
+ * A URI reference to the unavailable variant.
745
801
  */
746
802
  'variantRef': string;
747
803
  /**
@@ -843,6 +899,7 @@ export interface StatusHistoryItem {
843
899
  }
844
900
  /**
845
901
  * @type StockConflictError
902
+ * An error indicating that one or more items in the order cannot be fulfilled due to stock or product availability issues. Use the \'code\' field to determine the specific error type.
846
903
  */
847
904
  export type StockConflictError = {
848
905
  code: 'PRODUCT_UNAVAILABLE';
@@ -853,6 +910,9 @@ export type StockConflictError = {
853
910
  * The requested quantity exceeds available stock. The item can still be ordered in a smaller quantity.
854
911
  */
855
912
  export interface StockUnavailableError {
913
+ /**
914
+ * The error code identifying this as a stock unavailable error.
915
+ */
856
916
  'code': StockUnavailableErrorCodeEnum;
857
917
  /**
858
918
  * Human-readable description including the product name and available quantity.
@@ -863,11 +923,11 @@ export interface StockUnavailableError {
863
923
  */
864
924
  'productTitle': string;
865
925
  /**
866
- * Unique object identifier
926
+ * The unique identifier of the variant with insufficient stock.
867
927
  */
868
928
  'variantId': string;
869
929
  /**
870
- * A reference to the variant being ordered
930
+ * A URI reference to the variant with insufficient stock.
871
931
  */
872
932
  'variantRef': string;
873
933
  /**
@@ -1011,7 +1071,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
1011
1071
  listOrderImports: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1012
1072
  /**
1013
1073
  * Retries failed platform payment, so fulfillment can proceed.
1014
- * @summary Retry
1074
+ * @summary Retry platform payment
1015
1075
  * @param {string} project The project identifier to scope the request to.
1016
1076
  * @param {string} orderId Unique identifier of an order
1017
1077
  * @param {string} [fields] Specifies which fields to return, separated by commas
@@ -1144,7 +1204,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
1144
1204
  listOrderImports(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderImportsResponse>>;
1145
1205
  /**
1146
1206
  * Retries failed platform payment, so fulfillment can proceed.
1147
- * @summary Retry
1207
+ * @summary Retry platform payment
1148
1208
  * @param {string} project The project identifier to scope the request to.
1149
1209
  * @param {string} orderId Unique identifier of an order
1150
1210
  * @param {string} [fields] Specifies which fields to return, separated by commas
@@ -1247,7 +1307,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
1247
1307
  listOrderImports(requestParameters: OrdersApiListOrderImportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrderImportsResponse>;
1248
1308
  /**
1249
1309
  * Retries failed platform payment, so fulfillment can proceed.
1250
- * @summary Retry
1310
+ * @summary Retry platform payment
1251
1311
  * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1252
1312
  * @param {*} [options] Override http request option.
1253
1313
  * @throws {RequiredError}
@@ -1584,7 +1644,7 @@ export declare class OrdersApi extends BaseAPI {
1584
1644
  listOrderImports(requestParameters: OrdersApiListOrderImportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderImportsResponse, any, {}>>;
1585
1645
  /**
1586
1646
  * Retries failed platform payment, so fulfillment can proceed.
1587
- * @summary Retry
1647
+ * @summary Retry platform payment
1588
1648
  * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1589
1649
  * @param {*} [options] Override http request option.
1590
1650
  * @throws {RequiredError}
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
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.29.0
8
+ * The version of the OpenAPI document: 1.29.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.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;
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.FulfillmentFrozenReasonsEnum = 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,16 @@ exports.ConfirmOrderValidationErrorCodeEnum = {
38
38
  exports.CustomsInformationPreRegistrationTypeEnum = {
39
39
  Ioss: 'IOSS',
40
40
  };
41
+ exports.FulfillmentFrozenReasonsEnum = {
42
+ Moderation: 'moderation',
43
+ InternalScreenPrint: 'internal_screen_print',
44
+ Manual: 'manual',
45
+ CreditControl: 'credit_control',
46
+ BillingFailed: 'billing_failed',
47
+ PickfaceFlagged: 'pickface_flagged',
48
+ FlowFrozen: 'flow_frozen',
49
+ Fraud: 'fraud',
50
+ };
41
51
  /**
42
52
  * 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
53
  */
@@ -652,7 +662,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
652
662
  }),
653
663
  /**
654
664
  * Retries failed platform payment, so fulfillment can proceed.
655
- * @summary Retry
665
+ * @summary Retry platform payment
656
666
  * @param {string} project The project identifier to scope the request to.
657
667
  * @param {string} orderId Unique identifier of an order
658
668
  * @param {string} [fields] Specifies which fields to return, separated by commas
@@ -912,7 +922,7 @@ const OrdersApiFp = function (configuration) {
912
922
  },
913
923
  /**
914
924
  * Retries failed platform payment, so fulfillment can proceed.
915
- * @summary Retry
925
+ * @summary Retry platform payment
916
926
  * @param {string} project The project identifier to scope the request to.
917
927
  * @param {string} orderId Unique identifier of an order
918
928
  * @param {string} [fields] Specifies which fields to return, separated by commas
@@ -1049,7 +1059,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
1049
1059
  },
1050
1060
  /**
1051
1061
  * Retries failed platform payment, so fulfillment can proceed.
1052
- * @summary Retry
1062
+ * @summary Retry platform payment
1053
1063
  * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1054
1064
  * @param {*} [options] Override http request option.
1055
1065
  * @throws {RequiredError}
@@ -1176,7 +1186,7 @@ class OrdersApi extends base_1.BaseAPI {
1176
1186
  }
1177
1187
  /**
1178
1188
  * Retries failed platform payment, so fulfillment can proceed.
1179
- * @summary Retry
1189
+ * @summary Retry platform payment
1180
1190
  * @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
1181
1191
  * @param {*} [options] Override http request option.
1182
1192
  * @throws {RequiredError}
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
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.29.0
5
+ * The version of the OpenAPI document: 1.29.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).