@wix/ecom 1.0.854 → 1.0.855

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.
@@ -221,6 +221,7 @@ interface DiscountRule$b {
221
221
  discounts?: Discounts$1;
222
222
  /**
223
223
  * Discount rule status.
224
+ * Default: `UNDEFINED`
224
225
  * @readonly
225
226
  */
226
227
  status?: Status$b;
@@ -242,14 +243,7 @@ interface DiscountTrigger$1 extends DiscountTriggerTriggerOneOf$1 {
242
243
  subtotalRange?: SubtotalRange$1;
243
244
  /** Item quantity trigger range. */
244
245
  itemQuantityRange?: ItemQuantityRange$1;
245
- /**
246
- * Trigger type.
247
- *
248
- * + `AND`: Operator used for chaining multiple triggers. Currently 1 `AND` chain operator is supported.
249
- * + `SUBTOTAL_RANGE`: Subtotal must be within the specified `subtotalRange` values.
250
- * + `ITEM_QUANTITY_RANGE`: Quantity of items in scope must be within specified `itemQuantityRange` values.
251
- * + `CUSTOM`: Custom trigger type defined in `customTrigger` object.
252
- */
246
+ /** Trigger type. */
253
247
  triggerType?: TriggerType$1;
254
248
  }
255
249
  /** @oneof */
@@ -343,13 +337,13 @@ interface ItemQuantityRange$1 {
343
337
  }
344
338
  declare enum TriggerType$1 {
345
339
  UNDEFINED = "UNDEFINED",
346
- /** Chain multiple triggers with AND operator */
340
+ /** Operator used for chaining multiple triggers. Currently 1 `AND` chain operator is supported. */
347
341
  AND = "AND",
348
- /** Subtotal range trigger */
342
+ /** Subtotal must be within the specified `subtotalRange` values. */
349
343
  SUBTOTAL_RANGE = "SUBTOTAL_RANGE",
350
- /** Item quantity range trigger */
344
+ /** Quantity of items in scope must be within specified `itemQuantityRange` values. */
351
345
  ITEM_QUANTITY_RANGE = "ITEM_QUANTITY_RANGE",
352
- /** Custom trigger, see Custom Triggers SPI for more details */
346
+ /** Custom trigger type defined in `customTrigger` object. */
353
347
  CUSTOM = "CUSTOM",
354
348
  /** Chain multiple triggers with OR operator */
355
349
  OR = "OR"
@@ -379,13 +373,7 @@ interface Discount$1 extends DiscountDiscountOneOf$1 {
379
373
  targetType?: Type$1;
380
374
  /** Data related to `SPECIFIC_ITEMS` target type. */
381
375
  specificItemsInfo?: SpecificItemsInfo$1;
382
- /**
383
- * Discount type.
384
- *
385
- * + `PERCENTAGE`: Price is reduced by percentage value.
386
- * + `FIXED_AMOUNT`: Price is reduced by fixed amount.
387
- * + `FIXED_PRICE`: Price will be set to fixed amount.
388
- */
376
+ /** Discount type. */
389
377
  discountType?: DiscountType$f;
390
378
  }
391
379
  /** @oneof */
@@ -409,11 +397,11 @@ interface SpecificItemsInfo$1 {
409
397
  }
410
398
  declare enum DiscountType$f {
411
399
  UNDEFINED = "UNDEFINED",
412
- /** Percentage discount */
400
+ /** Price is reduced by percentage value. */
413
401
  PERCENTAGE = "PERCENTAGE",
414
- /** Fixed amount discount */
402
+ /** Price is reduced by fixed amount. */
415
403
  FIXED_AMOUNT = "FIXED_AMOUNT",
416
- /** Fixed price discount */
404
+ /** Price will be set to fixed amount. */
417
405
  FIXED_PRICE = "FIXED_PRICE"
418
406
  }
419
407
  declare enum Status$b {
@@ -671,6 +659,7 @@ interface DiscountRule$a {
671
659
  discounts?: Discounts;
672
660
  /**
673
661
  * Discount rule status.
662
+ * Default: `UNDEFINED`
674
663
  * @readonly
675
664
  */
676
665
  status?: Status$a;
@@ -793,13 +782,13 @@ interface ItemQuantityRange {
793
782
  }
794
783
  declare enum TriggerType {
795
784
  UNDEFINED = "UNDEFINED",
796
- /** Chain multiple triggers with AND operator */
785
+ /** Operator used for chaining multiple triggers. Currently 1 `AND` chain operator is supported. */
797
786
  AND = "AND",
798
- /** Subtotal range trigger */
787
+ /** Subtotal must be within the specified `subtotalRange` values. */
799
788
  SUBTOTAL_RANGE = "SUBTOTAL_RANGE",
800
- /** Item quantity range trigger */
789
+ /** Quantity of items in scope must be within specified `itemQuantityRange` values. */
801
790
  ITEM_QUANTITY_RANGE = "ITEM_QUANTITY_RANGE",
802
- /** Custom trigger, see Custom Triggers SPI for more details */
791
+ /** Custom trigger type defined in `customTrigger` object. */
803
792
  CUSTOM = "CUSTOM",
804
793
  /** Chain multiple triggers with OR operator */
805
794
  OR = "OR"
@@ -859,11 +848,11 @@ interface SpecificItemsInfo {
859
848
  }
860
849
  declare enum DiscountType$e {
861
850
  UNDEFINED = "UNDEFINED",
862
- /** Percentage discount */
851
+ /** Price is reduced by percentage value. */
863
852
  PERCENTAGE = "PERCENTAGE",
864
- /** Fixed amount discount */
853
+ /** Price is reduced by fixed amount. */
865
854
  FIXED_AMOUNT = "FIXED_AMOUNT",
866
- /** Fixed price discount */
855
+ /** Price will be set to fixed amount. */
867
856
  FIXED_PRICE = "FIXED_PRICE"
868
857
  }
869
858
  declare enum Status$a {
@@ -1763,8 +1752,11 @@ interface Color$d {
1763
1752
  code?: string | null;
1764
1753
  }
1765
1754
  declare enum DescriptionLineType$d {
1755
+ /** Unrecognized type. */
1766
1756
  UNRECOGNISED = "UNRECOGNISED",
1757
+ /** Plain text type. */
1767
1758
  PLAIN_TEXT = "PLAIN_TEXT",
1759
+ /** Color type. */
1768
1760
  COLOR = "COLOR"
1769
1761
  }
1770
1762
  interface Image$8 {
@@ -1822,11 +1814,11 @@ declare enum ItemTypeItemType$f {
1822
1814
  declare enum PaymentOptionType$f {
1823
1815
  /** The entire payment for this item happens as part of the checkout. */
1824
1816
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
1825
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
1817
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
1826
1818
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
1827
1819
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
1828
1820
  MEMBERSHIP = "MEMBERSHIP",
1829
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
1821
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
1830
1822
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
1831
1823
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
1832
1824
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -2074,7 +2066,7 @@ declare enum VatType$d {
2074
2066
  interface ShippingInformation$7 {
2075
2067
  /** App Def Id of external provider which was a source of shipping info */
2076
2068
  carrierId?: string | null;
2077
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
2069
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
2078
2070
  code?: string | null;
2079
2071
  /**
2080
2072
  * Shipping option title.
@@ -2929,8 +2921,11 @@ interface Color$c {
2929
2921
  code?: string | null;
2930
2922
  }
2931
2923
  declare enum DescriptionLineType$c {
2924
+ /** Unrecognized type. */
2932
2925
  UNRECOGNISED = "UNRECOGNISED",
2926
+ /** Plain text type. */
2933
2927
  PLAIN_TEXT = "PLAIN_TEXT",
2928
+ /** Color type. */
2934
2929
  COLOR = "COLOR"
2935
2930
  }
2936
2931
  interface PhysicalProperties$g {
@@ -2965,11 +2960,11 @@ declare enum ItemTypeItemType$e {
2965
2960
  declare enum PaymentOptionType$e {
2966
2961
  /** The entire payment for this item happens as part of the checkout. */
2967
2962
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
2968
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
2963
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
2969
2964
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
2970
2965
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
2971
2966
  MEMBERSHIP = "MEMBERSHIP",
2972
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
2967
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
2973
2968
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
2974
2969
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
2975
2970
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -3207,7 +3202,7 @@ declare enum VatType$c {
3207
3202
  interface ShippingInformation$6 {
3208
3203
  /** App Def Id of external provider which was a source of shipping info */
3209
3204
  carrierId?: string | null;
3210
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
3205
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
3211
3206
  code?: string | null;
3212
3207
  /**
3213
3208
  * Shipping option title.
@@ -3808,16 +3803,24 @@ interface AbandonedCheckout$1 {
3808
3803
  subtotalPrice?: MultiCurrencyPrice$9;
3809
3804
  }
3810
3805
  declare enum ActivityType$5 {
3806
+ /** Not implemented. */
3811
3807
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
3808
+ /** Scheduled. */
3812
3809
  SCHEDULED = "SCHEDULED",
3810
+ /** Email sent. */
3813
3811
  EMAIL_SENT = "EMAIL_SENT",
3812
+ /** Email not sent. */
3814
3813
  EMAIL_NOT_SENT = "EMAIL_NOT_SENT",
3814
+ /** Notification sent. */
3815
3815
  NOTIFICATION_SENT = "NOTIFICATION_SENT",
3816
+ /** Task created. */
3816
3817
  TASK_CREATED = "TASK_CREATED"
3817
3818
  }
3818
3819
  /** Status of the abandoned checkout. */
3819
3820
  declare enum Status$9 {
3821
+ /** Abandoned. */
3820
3822
  ABANDONED = "ABANDONED",
3823
+ /** Recovered. */
3821
3824
  RECOVERED = "RECOVERED"
3822
3825
  }
3823
3826
  /** Buyer information. */
@@ -4036,7 +4039,9 @@ interface CommonSorting$1 {
4036
4039
  order?: CommonSortOrder$1;
4037
4040
  }
4038
4041
  declare enum CommonSortOrder$1 {
4042
+ /** Ascending order. */
4039
4043
  ASC = "ASC",
4044
+ /** Descending order. */
4040
4045
  DESC = "DESC"
4041
4046
  }
4042
4047
  interface SearchDetails$1 {
@@ -4050,9 +4055,9 @@ interface SearchDetails$1 {
4050
4055
  fuzzy?: boolean;
4051
4056
  }
4052
4057
  declare enum Mode$1 {
4053
- /** any */
4058
+ /** Any */
4054
4059
  OR = "OR",
4055
- /** all */
4060
+ /** All */
4056
4061
  AND = "AND"
4057
4062
  }
4058
4063
  interface CommonPaging$1 {
@@ -4203,16 +4208,24 @@ interface AbandonedCheckout {
4203
4208
  subtotalPrice?: MultiCurrencyPrice$8;
4204
4209
  }
4205
4210
  declare enum ActivityType$4 {
4211
+ /** Not implemented. */
4206
4212
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
4213
+ /** Scheduled. */
4207
4214
  SCHEDULED = "SCHEDULED",
4215
+ /** Email sent. */
4208
4216
  EMAIL_SENT = "EMAIL_SENT",
4217
+ /** Email not sent. */
4209
4218
  EMAIL_NOT_SENT = "EMAIL_NOT_SENT",
4219
+ /** Notification sent. */
4210
4220
  NOTIFICATION_SENT = "NOTIFICATION_SENT",
4221
+ /** Task created. */
4211
4222
  TASK_CREATED = "TASK_CREATED"
4212
4223
  }
4213
4224
  /** Status of the abandoned checkout. */
4214
4225
  declare enum Status$8 {
4226
+ /** Abandoned. */
4215
4227
  ABANDONED = "ABANDONED",
4228
+ /** Recovered. */
4216
4229
  RECOVERED = "RECOVERED"
4217
4230
  }
4218
4231
  /** Buyer information. */
@@ -4447,7 +4460,9 @@ interface CommonSorting {
4447
4460
  order?: CommonSortOrder;
4448
4461
  }
4449
4462
  declare enum CommonSortOrder {
4463
+ /** Ascending order. */
4450
4464
  ASC = "ASC",
4465
+ /** Descending order. */
4451
4466
  DESC = "DESC"
4452
4467
  }
4453
4468
  interface SearchDetails {
@@ -4461,9 +4476,9 @@ interface SearchDetails {
4461
4476
  fuzzy?: boolean;
4462
4477
  }
4463
4478
  declare enum Mode {
4464
- /** any */
4479
+ /** Any */
4465
4480
  OR = "OR",
4466
- /** all */
4481
+ /** All */
4467
4482
  AND = "AND"
4468
4483
  }
4469
4484
  interface CommonPaging {
@@ -5674,8 +5689,11 @@ interface Color$b {
5674
5689
  code?: string | null;
5675
5690
  }
5676
5691
  declare enum DescriptionLineType$b {
5692
+ /** Unrecognized type. */
5677
5693
  UNRECOGNISED = "UNRECOGNISED",
5694
+ /** Plain text type. */
5678
5695
  PLAIN_TEXT = "PLAIN_TEXT",
5696
+ /** Color type. */
5679
5697
  COLOR = "COLOR"
5680
5698
  }
5681
5699
  interface CommonImage$2 {
@@ -5702,20 +5720,16 @@ interface CommonImage$2 {
5702
5720
  filename?: string | null;
5703
5721
  }
5704
5722
  interface ItemAvailabilityInfo$5 {
5705
- /**
5706
- * Item availability status.
5707
- * + `"NOT_FOUND"`: Item does not exist
5708
- * + `"NOT_AVAILABLE"`: Item not in stock
5709
- * + `"PARTIALLY_AVAILABLE"`: Available quantity is less than requested
5710
- */
5723
+ /** Item availability status. */
5711
5724
  status?: ItemAvailabilityStatus$5;
5712
5725
  /** Quantity available. */
5713
5726
  quantityAvailable?: number | null;
5714
5727
  }
5715
5728
  declare enum ItemAvailabilityStatus$5 {
5716
5729
  AVAILABLE = "AVAILABLE",
5730
+ /** Item does not exist */
5717
5731
  NOT_FOUND = "NOT_FOUND",
5718
- /** Not in stock */
5732
+ /** Item not in stock */
5719
5733
  NOT_AVAILABLE = "NOT_AVAILABLE",
5720
5734
  /** Available quantity is less than requested */
5721
5735
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -5768,11 +5782,11 @@ declare enum FileType$7 {
5768
5782
  declare enum PaymentOptionType$d {
5769
5783
  /** The entire payment for this item happens as part of the checkout. */
5770
5784
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
5771
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
5785
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
5772
5786
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
5773
5787
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
5774
5788
  MEMBERSHIP = "MEMBERSHIP",
5775
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
5789
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
5776
5790
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
5777
5791
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
5778
5792
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -6747,12 +6761,12 @@ interface TargetTargetTypeOneOf$5 {
6747
6761
  }
6748
6762
  /** Available locations on the webpage */
6749
6763
  declare enum NameInOther$5 {
6750
- /** default location, in case no specific location is specified */
6764
+ /** Default location, in case no specific location is specified. */
6751
6765
  OTHER_DEFAULT = "OTHER_DEFAULT"
6752
6766
  }
6753
6767
  /** Available locations on the line item */
6754
6768
  declare enum NameInLineItem$5 {
6755
- /** default location, in case no specific location is specified */
6769
+ /** Default location, in case no specific location is specified. */
6756
6770
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
6757
6771
  }
6758
6772
  declare enum SuggestedFix$5 {
@@ -7716,8 +7730,11 @@ interface Color$a {
7716
7730
  code?: string | null;
7717
7731
  }
7718
7732
  declare enum DescriptionLineType$a {
7733
+ /** Unrecognized type. */
7719
7734
  UNRECOGNISED = "UNRECOGNISED",
7735
+ /** Plain text type. */
7720
7736
  PLAIN_TEXT = "PLAIN_TEXT",
7737
+ /** Color type. */
7721
7738
  COLOR = "COLOR"
7722
7739
  }
7723
7740
  interface ItemAvailabilityInfo$4 {
@@ -7734,8 +7751,9 @@ interface ItemAvailabilityInfo$4 {
7734
7751
  }
7735
7752
  declare enum ItemAvailabilityStatus$4 {
7736
7753
  AVAILABLE = "AVAILABLE",
7754
+ /** Item does not exist */
7737
7755
  NOT_FOUND = "NOT_FOUND",
7738
- /** Not in stock */
7756
+ /** Item not in stock */
7739
7757
  NOT_AVAILABLE = "NOT_AVAILABLE",
7740
7758
  /** Available quantity is less than requested */
7741
7759
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -7788,11 +7806,11 @@ declare enum FileType$6 {
7788
7806
  declare enum PaymentOptionType$c {
7789
7807
  /** The entire payment for this item happens as part of the checkout. */
7790
7808
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
7791
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
7809
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
7792
7810
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
7793
7811
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
7794
7812
  MEMBERSHIP = "MEMBERSHIP",
7795
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
7813
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
7796
7814
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
7797
7815
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
7798
7816
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -8754,12 +8772,12 @@ interface TargetTargetTypeOneOf$4 {
8754
8772
  }
8755
8773
  /** Available locations on the webpage */
8756
8774
  declare enum NameInOther$4 {
8757
- /** default location, in case no specific location is specified */
8775
+ /** Default location, in case no specific location is specified. */
8758
8776
  OTHER_DEFAULT = "OTHER_DEFAULT"
8759
8777
  }
8760
8778
  /** Available locations on the line item */
8761
8779
  declare enum NameInLineItem$4 {
8762
- /** default location, in case no specific location is specified */
8780
+ /** Default location, in case no specific location is specified. */
8763
8781
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
8764
8782
  }
8765
8783
  declare enum SuggestedFix$4 {
@@ -9781,8 +9799,11 @@ interface Color$9 {
9781
9799
  code?: string | null;
9782
9800
  }
9783
9801
  declare enum DescriptionLineType$9 {
9802
+ /** Unrecognized type. */
9784
9803
  UNRECOGNISED = "UNRECOGNISED",
9804
+ /** Plain text type. */
9785
9805
  PLAIN_TEXT = "PLAIN_TEXT",
9806
+ /** Color type. */
9786
9807
  COLOR = "COLOR"
9787
9808
  }
9788
9809
  interface CommonImage$1 {
@@ -9809,20 +9830,16 @@ interface CommonImage$1 {
9809
9830
  filename?: string | null;
9810
9831
  }
9811
9832
  interface ItemAvailabilityInfo$3 {
9812
- /**
9813
- * Item availability status.
9814
- * + `"NOT_FOUND"`: Item does not exist
9815
- * + `"NOT_AVAILABLE"`: Item not in stock
9816
- * + `"PARTIALLY_AVAILABLE"`: Available quantity is less than requested
9817
- */
9833
+ /** Item availability status. */
9818
9834
  status?: ItemAvailabilityStatus$3;
9819
9835
  /** Quantity available. */
9820
9836
  quantityAvailable?: number | null;
9821
9837
  }
9822
9838
  declare enum ItemAvailabilityStatus$3 {
9823
9839
  AVAILABLE = "AVAILABLE",
9840
+ /** Item does not exist */
9824
9841
  NOT_FOUND = "NOT_FOUND",
9825
- /** Not in stock */
9842
+ /** Item not in stock */
9826
9843
  NOT_AVAILABLE = "NOT_AVAILABLE",
9827
9844
  /** Available quantity is less than requested */
9828
9845
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -9875,11 +9892,11 @@ declare enum FileType$5 {
9875
9892
  declare enum PaymentOptionType$b {
9876
9893
  /** The entire payment for this item happens as part of the checkout. */
9877
9894
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
9878
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
9895
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
9879
9896
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
9880
9897
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
9881
9898
  MEMBERSHIP = "MEMBERSHIP",
9882
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
9899
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
9883
9900
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
9884
9901
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
9885
9902
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -10871,12 +10888,12 @@ interface TargetTargetTypeOneOf$3 {
10871
10888
  }
10872
10889
  /** Available locations on the webpage */
10873
10890
  declare enum NameInOther$3 {
10874
- /** default location, in case no specific location is specified */
10891
+ /** Default location, in case no specific location is specified. */
10875
10892
  OTHER_DEFAULT = "OTHER_DEFAULT"
10876
10893
  }
10877
10894
  /** Available locations on the line item */
10878
10895
  declare enum NameInLineItem$3 {
10879
- /** default location, in case no specific location is specified */
10896
+ /** Default location, in case no specific location is specified. */
10880
10897
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
10881
10898
  }
10882
10899
  declare enum SuggestedFix$3 {
@@ -11783,8 +11800,11 @@ interface Color$8 {
11783
11800
  code?: string | null;
11784
11801
  }
11785
11802
  declare enum DescriptionLineType$8 {
11803
+ /** Unrecognized type. */
11786
11804
  UNRECOGNISED = "UNRECOGNISED",
11805
+ /** Plain text type. */
11787
11806
  PLAIN_TEXT = "PLAIN_TEXT",
11807
+ /** Color type. */
11788
11808
  COLOR = "COLOR"
11789
11809
  }
11790
11810
  interface ItemAvailabilityInfo$2 {
@@ -11801,8 +11821,9 @@ interface ItemAvailabilityInfo$2 {
11801
11821
  }
11802
11822
  declare enum ItemAvailabilityStatus$2 {
11803
11823
  AVAILABLE = "AVAILABLE",
11824
+ /** Item does not exist */
11804
11825
  NOT_FOUND = "NOT_FOUND",
11805
- /** Not in stock */
11826
+ /** Item not in stock */
11806
11827
  NOT_AVAILABLE = "NOT_AVAILABLE",
11807
11828
  /** Available quantity is less than requested */
11808
11829
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -11855,11 +11876,11 @@ declare enum FileType$4 {
11855
11876
  declare enum PaymentOptionType$a {
11856
11877
  /** The entire payment for this item happens as part of the checkout. */
11857
11878
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
11858
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
11879
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
11859
11880
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
11860
11881
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
11861
11882
  MEMBERSHIP = "MEMBERSHIP",
11862
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
11883
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
11863
11884
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
11864
11885
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
11865
11886
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -12838,12 +12859,12 @@ interface TargetTargetTypeOneOf$2 {
12838
12859
  }
12839
12860
  /** Available locations on the webpage */
12840
12861
  declare enum NameInOther$2 {
12841
- /** default location, in case no specific location is specified */
12862
+ /** Default location, in case no specific location is specified. */
12842
12863
  OTHER_DEFAULT = "OTHER_DEFAULT"
12843
12864
  }
12844
12865
  /** Available locations on the line item */
12845
12866
  declare enum NameInLineItem$2 {
12846
- /** default location, in case no specific location is specified */
12867
+ /** Default location, in case no specific location is specified. */
12847
12868
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
12848
12869
  }
12849
12870
  declare enum SuggestedFix$2 {
@@ -13934,8 +13955,11 @@ interface Color$7 {
13934
13955
  code?: string | null;
13935
13956
  }
13936
13957
  declare enum DescriptionLineType$7 {
13958
+ /** Unrecognized type. */
13937
13959
  UNRECOGNISED = "UNRECOGNISED",
13960
+ /** Plain text type. */
13938
13961
  PLAIN_TEXT = "PLAIN_TEXT",
13962
+ /** Color type. */
13939
13963
  COLOR = "COLOR"
13940
13964
  }
13941
13965
  interface CommonImage {
@@ -13962,20 +13986,16 @@ interface CommonImage {
13962
13986
  filename?: string | null;
13963
13987
  }
13964
13988
  interface ItemAvailabilityInfo$1 {
13965
- /**
13966
- * Item availability status.
13967
- * + `"NOT_FOUND"`: Item does not exist
13968
- * + `"NOT_AVAILABLE"`: Item not in stock
13969
- * + `"PARTIALLY_AVAILABLE"`: Available quantity is less than requested
13970
- */
13989
+ /** Item availability status. */
13971
13990
  status?: ItemAvailabilityStatus$1;
13972
13991
  /** Quantity available. */
13973
13992
  quantityAvailable?: number | null;
13974
13993
  }
13975
13994
  declare enum ItemAvailabilityStatus$1 {
13976
13995
  AVAILABLE = "AVAILABLE",
13996
+ /** Item does not exist */
13977
13997
  NOT_FOUND = "NOT_FOUND",
13978
- /** Not in stock */
13998
+ /** Item not in stock */
13979
13999
  NOT_AVAILABLE = "NOT_AVAILABLE",
13980
14000
  /** Available quantity is less than requested */
13981
14001
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -14067,11 +14087,11 @@ declare enum FileType$3 {
14067
14087
  declare enum PaymentOptionType$9 {
14068
14088
  /** The entire payment for this item happens as part of the checkout. */
14069
14089
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
14070
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
14090
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
14071
14091
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
14072
14092
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
14073
14093
  MEMBERSHIP = "MEMBERSHIP",
14074
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
14094
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
14075
14095
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
14076
14096
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
14077
14097
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -14859,12 +14879,12 @@ interface TargetTargetTypeOneOf$1 {
14859
14879
  }
14860
14880
  /** Available locations on the webpage */
14861
14881
  declare enum NameInOther$1 {
14862
- /** default location, in case no specific location is specified */
14882
+ /** Default location, in case no specific location is specified. */
14863
14883
  OTHER_DEFAULT = "OTHER_DEFAULT"
14864
14884
  }
14865
14885
  /** Available locations on the line item */
14866
14886
  declare enum NameInLineItem$1 {
14867
- /** default location, in case no specific location is specified */
14887
+ /** Default location, in case no specific location is specified. */
14868
14888
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
14869
14889
  }
14870
14890
  declare enum SuggestedFix$1 {
@@ -16199,25 +16219,24 @@ interface Color$6 {
16199
16219
  code?: string | null;
16200
16220
  }
16201
16221
  declare enum DescriptionLineType$6 {
16222
+ /** Unrecognized type. */
16202
16223
  UNRECOGNISED = "UNRECOGNISED",
16224
+ /** Plain text type. */
16203
16225
  PLAIN_TEXT = "PLAIN_TEXT",
16226
+ /** Color type. */
16204
16227
  COLOR = "COLOR"
16205
16228
  }
16206
16229
  interface ItemAvailabilityInfo {
16207
- /**
16208
- * Item availability status.
16209
- * + `"NOT_FOUND"`: Item does not exist
16210
- * + `"NOT_AVAILABLE"`: Item not in stock
16211
- * + `"PARTIALLY_AVAILABLE"`: Available quantity is less than requested
16212
- */
16230
+ /** Item availability status. */
16213
16231
  status?: ItemAvailabilityStatus;
16214
16232
  /** Quantity available. */
16215
16233
  quantityAvailable?: number | null;
16216
16234
  }
16217
16235
  declare enum ItemAvailabilityStatus {
16218
16236
  AVAILABLE = "AVAILABLE",
16237
+ /** Item does not exist */
16219
16238
  NOT_FOUND = "NOT_FOUND",
16220
- /** Not in stock */
16239
+ /** Item not in stock */
16221
16240
  NOT_AVAILABLE = "NOT_AVAILABLE",
16222
16241
  /** Available quantity is less than requested */
16223
16242
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -16309,11 +16328,11 @@ declare enum FileType$2 {
16309
16328
  declare enum PaymentOptionType$8 {
16310
16329
  /** The entire payment for this item happens as part of the checkout. */
16311
16330
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
16312
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
16331
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
16313
16332
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
16314
16333
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
16315
16334
  MEMBERSHIP = "MEMBERSHIP",
16316
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
16335
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
16317
16336
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
16318
16337
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
16319
16338
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -17079,12 +17098,12 @@ interface TargetTargetTypeOneOf {
17079
17098
  }
17080
17099
  /** Available locations on the webpage */
17081
17100
  declare enum NameInOther {
17082
- /** default location, in case no specific location is specified */
17101
+ /** Default location, in case no specific location is specified. */
17083
17102
  OTHER_DEFAULT = "OTHER_DEFAULT"
17084
17103
  }
17085
17104
  /** Available locations on the line item */
17086
17105
  declare enum NameInLineItem {
17087
- /** default location, in case no specific location is specified */
17106
+ /** Default location, in case no specific location is specified. */
17088
17107
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
17089
17108
  }
17090
17109
  declare enum SuggestedFix {
@@ -18656,8 +18675,11 @@ interface Color$5 {
18656
18675
  code?: string | null;
18657
18676
  }
18658
18677
  declare enum DescriptionLineType$5 {
18678
+ /** Unrecognized type. */
18659
18679
  UNRECOGNISED = "UNRECOGNISED",
18680
+ /** Plain text type. */
18660
18681
  PLAIN_TEXT = "PLAIN_TEXT",
18682
+ /** Color type. */
18661
18683
  COLOR = "COLOR"
18662
18684
  }
18663
18685
  interface PhysicalProperties$9 {
@@ -18694,11 +18716,11 @@ interface PaymentOption$1 {
18694
18716
  declare enum PaymentOptionType$7 {
18695
18717
  /** The entire payment for this item happens as part of the checkout. */
18696
18718
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
18697
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
18719
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
18698
18720
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
18699
18721
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
18700
18722
  MEMBERSHIP = "MEMBERSHIP",
18701
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
18723
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
18702
18724
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
18703
18725
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
18704
18726
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -18930,7 +18952,9 @@ interface Sorting$l {
18930
18952
  order?: SortOrder$l;
18931
18953
  }
18932
18954
  declare enum SortOrder$l {
18955
+ /** Ascending order. */
18933
18956
  ASC = "ASC",
18957
+ /** Descending order. */
18934
18958
  DESC = "DESC"
18935
18959
  }
18936
18960
  interface CursorPaging$l {
@@ -19364,8 +19388,11 @@ interface Color$4 {
19364
19388
  code?: string | null;
19365
19389
  }
19366
19390
  declare enum DescriptionLineType$4 {
19391
+ /** Unrecognized type. */
19367
19392
  UNRECOGNISED = "UNRECOGNISED",
19393
+ /** Plain text type. */
19368
19394
  PLAIN_TEXT = "PLAIN_TEXT",
19395
+ /** Color type. */
19369
19396
  COLOR = "COLOR"
19370
19397
  }
19371
19398
  interface PhysicalProperties$8 {
@@ -19390,11 +19417,11 @@ interface PaymentOption {
19390
19417
  declare enum PaymentOptionType$6 {
19391
19418
  /** The entire payment for this item happens as part of the checkout. */
19392
19419
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
19393
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
19420
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
19394
19421
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
19395
19422
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
19396
19423
  MEMBERSHIP = "MEMBERSHIP",
19397
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
19424
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
19398
19425
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
19399
19426
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
19400
19427
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -19620,7 +19647,9 @@ interface Sorting$k {
19620
19647
  order?: SortOrder$k;
19621
19648
  }
19622
19649
  declare enum SortOrder$k {
19650
+ /** Ascending order. */
19623
19651
  ASC = "ASC",
19652
+ /** Descending order. */
19624
19653
  DESC = "DESC"
19625
19654
  }
19626
19655
  interface CursorPaging$k {
@@ -21275,8 +21304,11 @@ interface Color$3 {
21275
21304
  code?: string | null;
21276
21305
  }
21277
21306
  declare enum DescriptionLineType$3 {
21307
+ /** Unrecognized type. */
21278
21308
  UNRECOGNISED = "UNRECOGNISED",
21309
+ /** Plain text type. */
21279
21310
  PLAIN_TEXT = "PLAIN_TEXT",
21311
+ /** Color type. */
21280
21312
  COLOR = "COLOR"
21281
21313
  }
21282
21314
  interface Image$2 {
@@ -21334,11 +21366,11 @@ declare enum ItemTypeItemType$5 {
21334
21366
  declare enum PaymentOptionType$5 {
21335
21367
  /** The entire payment for this item happens as part of the checkout. */
21336
21368
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
21337
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
21369
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
21338
21370
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
21339
21371
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
21340
21372
  MEMBERSHIP = "MEMBERSHIP",
21341
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
21373
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
21342
21374
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
21343
21375
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
21344
21376
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -21490,7 +21522,7 @@ interface ShippingDetailsChangeTypeOneOf$1 {
21490
21522
  interface V1ShippingInformation$3 {
21491
21523
  /** App Def Id of external provider which was a source of shipping info */
21492
21524
  carrierId?: string | null;
21493
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
21525
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
21494
21526
  code?: string | null;
21495
21527
  /**
21496
21528
  * Shipping option title.
@@ -22648,14 +22680,14 @@ declare enum PaymentStatus$3 {
22648
22680
  PARTIALLY_PAID = "PARTIALLY_PAID"
22649
22681
  }
22650
22682
  declare enum FulfillmentStatus$3 {
22651
- /** none of the order items are fulfilled or order was manually marked as unfulfilled */
22683
+ /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
22652
22684
  NOT_FULFILLED = "NOT_FULFILLED",
22653
22685
  /**
22654
- * All of the order items are fulfilled or order was manually marked as fulfilled
22655
- * Orders without shipping info are fulfilled automatically
22686
+ * All of the order items are fulfilled or the order was manually marked as fulfilled.
22687
+ * Orders without shipping info are fulfilled automatically.
22656
22688
  */
22657
22689
  FULFILLED = "FULFILLED",
22658
- /** Some, but not all of the order items are fulfilled */
22690
+ /** Some, but not all, of the order items are fulfilled. */
22659
22691
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
22660
22692
  }
22661
22693
  declare enum OrderStatus$3 {
@@ -22719,7 +22751,9 @@ interface OrderRefunded$3 {
22719
22751
  reason?: string;
22720
22752
  }
22721
22753
  declare enum LineItemQuantityChangeType$3 {
22754
+ /** Quantity increased. */
22722
22755
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
22756
+ /** Quantity decreased. */
22723
22757
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
22724
22758
  }
22725
22759
  declare enum ActivityType$3 {
@@ -23921,8 +23955,11 @@ interface Color$2 {
23921
23955
  code?: string | null;
23922
23956
  }
23923
23957
  declare enum DescriptionLineType$2 {
23958
+ /** Unrecognized type. */
23924
23959
  UNRECOGNISED = "UNRECOGNISED",
23960
+ /** Plain text type. */
23925
23961
  PLAIN_TEXT = "PLAIN_TEXT",
23962
+ /** Color type. */
23926
23963
  COLOR = "COLOR"
23927
23964
  }
23928
23965
  interface PhysicalProperties$6 {
@@ -23957,11 +23994,11 @@ declare enum ItemTypeItemType$4 {
23957
23994
  declare enum PaymentOptionType$4 {
23958
23995
  /** The entire payment for this item happens as part of the checkout. */
23959
23996
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
23960
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
23997
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
23961
23998
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
23962
23999
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
23963
24000
  MEMBERSHIP = "MEMBERSHIP",
23964
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
24001
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
23965
24002
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
23966
24003
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
23967
24004
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -24113,7 +24150,7 @@ interface ShippingDetailsChangeTypeOneOf {
24113
24150
  interface V1ShippingInformation$2 {
24114
24151
  /** App Def Id of external provider which was a source of shipping info */
24115
24152
  carrierId?: string | null;
24116
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
24153
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
24117
24154
  code?: string | null;
24118
24155
  /**
24119
24156
  * Shipping option title.
@@ -25245,14 +25282,14 @@ declare enum PaymentStatus$2 {
25245
25282
  PARTIALLY_PAID = "PARTIALLY_PAID"
25246
25283
  }
25247
25284
  declare enum FulfillmentStatus$2 {
25248
- /** none of the order items are fulfilled or order was manually marked as unfulfilled */
25285
+ /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
25249
25286
  NOT_FULFILLED = "NOT_FULFILLED",
25250
25287
  /**
25251
- * All of the order items are fulfilled or order was manually marked as fulfilled
25252
- * Orders without shipping info are fulfilled automatically
25288
+ * All of the order items are fulfilled or the order was manually marked as fulfilled.
25289
+ * Orders without shipping info are fulfilled automatically.
25253
25290
  */
25254
25291
  FULFILLED = "FULFILLED",
25255
- /** Some, but not all of the order items are fulfilled */
25292
+ /** Some, but not all, of the order items are fulfilled. */
25256
25293
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
25257
25294
  }
25258
25295
  declare enum OrderStatus$2 {
@@ -25316,7 +25353,9 @@ interface OrderRefunded$2 {
25316
25353
  reason?: string;
25317
25354
  }
25318
25355
  declare enum LineItemQuantityChangeType$2 {
25356
+ /** Quantity increased. */
25319
25357
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
25358
+ /** Quantity decreased. */
25320
25359
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
25321
25360
  }
25322
25361
  declare enum ActivityType$2 {
@@ -26758,12 +26797,7 @@ interface GiftCard$3 {
26758
26797
  obfuscatedCode?: string;
26759
26798
  /** Gift card balance. */
26760
26799
  balance?: Money$1;
26761
- /**
26762
- * Current gift card status. Supported values:
26763
- * + **VALID**: Gift card is active and can be used for purchases.
26764
- * + **EXPIRED**: Gift card expiration date has passed and can no longer be used.
26765
- * + **DISABLED**: Gift card has been disabled by the merchant and can no longer be used.
26766
- */
26800
+ /** Current gift card status. */
26767
26801
  status?: Status$3;
26768
26802
  /** App ID of the gift card provider, as returned in eCommerce Get Checkout or List Transactions for Single Order. */
26769
26803
  appId?: string;
@@ -26781,8 +26815,11 @@ interface Money$1 {
26781
26815
  }
26782
26816
  declare enum Status$3 {
26783
26817
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
26818
+ /** Gift card is active and can be used for purchases. */
26784
26819
  VALID = "VALID",
26820
+ /** Gift card expiration date has passed and can no longer be used. */
26785
26821
  EXPIRED = "EXPIRED",
26822
+ /** Gift card has been disabled by the merchant and can no longer be used. */
26786
26823
  DISABLED = "DISABLED"
26787
26824
  }
26788
26825
  interface GetGiftCardRequest$1 {
@@ -26851,12 +26888,7 @@ interface GiftCard$2 {
26851
26888
  obfuscatedCode?: string;
26852
26889
  /** Gift card balance. */
26853
26890
  balance?: Money;
26854
- /**
26855
- * Current gift card status. Supported values:
26856
- * + **VALID**: Gift card is active and can be used for purchases.
26857
- * + **EXPIRED**: Gift card expiration date has passed and can no longer be used.
26858
- * + **DISABLED**: Gift card has been disabled by the merchant and can no longer be used.
26859
- */
26891
+ /** Current gift card status. */
26860
26892
  status?: Status$2;
26861
26893
  /** App ID of the gift card provider, as returned in eCommerce Get Checkout or List Transactions for Single Order. */
26862
26894
  appId?: string;
@@ -26874,8 +26906,11 @@ interface Money {
26874
26906
  }
26875
26907
  declare enum Status$2 {
26876
26908
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
26909
+ /** Gift card is active and can be used for purchases. */
26877
26910
  VALID = "VALID",
26911
+ /** Gift card expiration date has passed and can no longer be used. */
26878
26912
  EXPIRED = "EXPIRED",
26913
+ /** Gift card has been disabled by the merchant and can no longer be used. */
26879
26914
  DISABLED = "DISABLED"
26880
26915
  }
26881
26916
  interface GetGiftCardRequest {
@@ -28215,8 +28250,11 @@ interface Color$1 {
28215
28250
  code?: string | null;
28216
28251
  }
28217
28252
  declare enum DescriptionLineType$1 {
28253
+ /** Unrecognized type. */
28218
28254
  UNRECOGNISED = "UNRECOGNISED",
28255
+ /** Plain text type. */
28219
28256
  PLAIN_TEXT = "PLAIN_TEXT",
28257
+ /** Color type. */
28220
28258
  COLOR = "COLOR"
28221
28259
  }
28222
28260
  interface Image$1 {
@@ -28274,11 +28312,11 @@ declare enum ItemTypeItemType$3 {
28274
28312
  declare enum PaymentOptionType$3 {
28275
28313
  /** The entire payment for this item happens as part of the checkout. */
28276
28314
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
28277
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
28315
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
28278
28316
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
28279
28317
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
28280
28318
  MEMBERSHIP = "MEMBERSHIP",
28281
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
28319
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
28282
28320
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
28283
28321
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
28284
28322
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -28444,14 +28482,14 @@ declare enum PaymentStatus$1 {
28444
28482
  PARTIALLY_PAID = "PARTIALLY_PAID"
28445
28483
  }
28446
28484
  declare enum FulfillmentStatus$1 {
28447
- /** none of the order items are fulfilled or order was manually marked as unfulfilled */
28485
+ /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
28448
28486
  NOT_FULFILLED = "NOT_FULFILLED",
28449
28487
  /**
28450
- * All of the order items are fulfilled or order was manually marked as fulfilled
28451
- * Orders without shipping info are fulfilled automatically
28488
+ * All of the order items are fulfilled or the order was manually marked as fulfilled.
28489
+ * Orders without shipping info are fulfilled automatically.
28452
28490
  */
28453
28491
  FULFILLED = "FULFILLED",
28454
- /** Some, but not all of the order items are fulfilled */
28492
+ /** Some, but not all, of the order items are fulfilled. */
28455
28493
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
28456
28494
  }
28457
28495
  declare enum WeightUnit$5 {
@@ -28552,7 +28590,7 @@ declare enum VatType$3 {
28552
28590
  interface V1ShippingInformation$1 {
28553
28591
  /** App Def Id of external provider which was a source of shipping info */
28554
28592
  carrierId?: string | null;
28555
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
28593
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
28556
28594
  code?: string | null;
28557
28595
  /**
28558
28596
  * Shipping option title.
@@ -28848,7 +28886,9 @@ interface OrderRefunded$1 {
28848
28886
  reason?: string;
28849
28887
  }
28850
28888
  declare enum LineItemQuantityChangeType$1 {
28889
+ /** Quantity increased. */
28851
28890
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
28891
+ /** Quantity decreased. */
28852
28892
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
28853
28893
  }
28854
28894
  declare enum ActivityType$1 {
@@ -29195,11 +29235,11 @@ interface AuthorizationCapture$3 {
29195
29235
  }
29196
29236
  declare enum AuthorizationCaptureStatus$3 {
29197
29237
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
29198
- /** Whether capture operation still in progress */
29238
+ /** Capture operation still in progress. */
29199
29239
  PENDING = "PENDING",
29200
- /** The capture operation was succeeded */
29240
+ /** Capture operation succeeded. */
29201
29241
  SUCCEEDED = "SUCCEEDED",
29202
- /** The capture operation was failed */
29242
+ /** Capture operation failed. */
29203
29243
  FAILED = "FAILED"
29204
29244
  }
29205
29245
  interface AuthorizationActionFailureDetails$3 {
@@ -29217,28 +29257,25 @@ interface AuthorizationVoid$3 {
29217
29257
  }
29218
29258
  declare enum AuthorizationVoidStatus$3 {
29219
29259
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
29220
- /** Whether void operation still in progress */
29260
+ /** Void operation still in progress. */
29221
29261
  PENDING = "PENDING",
29222
- /** The void operation was succeeded */
29262
+ /** Void operation succeeded. */
29223
29263
  SUCCEEDED = "SUCCEEDED",
29224
- /** The void operation was failed */
29264
+ /** Void operation failed. */
29225
29265
  FAILED = "FAILED"
29226
29266
  }
29227
- /**
29228
- * Reason the authorization was voided.
29229
- *
29230
- * + `MANUAL`: Authorization was voided by user.
29231
- * + `SCHEDULED`: Authorization passed execution date.
29232
- */
29267
+ /** Reason the authorization was voided. */
29233
29268
  declare enum Reason$3 {
29234
29269
  UNKNOWN_REASON = "UNKNOWN_REASON",
29270
+ /** Authorization was voided by user. */
29235
29271
  MANUAL = "MANUAL",
29272
+ /** Authorization passed execution date. */
29236
29273
  SCHEDULED = "SCHEDULED"
29237
29274
  }
29238
29275
  interface V1ScheduledAction$1 {
29239
- /** type of the action */
29276
+ /** Type of the action. */
29240
29277
  actionType?: ActionType$3;
29241
- /** the date and time of the action */
29278
+ /** The date and time of the action. */
29242
29279
  executionDate?: Date | null;
29243
29280
  }
29244
29281
  declare enum ActionType$3 {
@@ -29258,9 +29295,9 @@ interface GiftCardPaymentDetails$3 {
29258
29295
  voided?: boolean;
29259
29296
  }
29260
29297
  declare enum MembershipPaymentStatus$3 {
29261
- /** CHARGED - Payment was charged */
29298
+ /** Payment was charged. */
29262
29299
  CHARGED = "CHARGED",
29263
- /** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
29300
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
29264
29301
  CHARGE_FAILED = "CHARGE_FAILED"
29265
29302
  }
29266
29303
  interface Refund$3 {
@@ -29296,19 +29333,17 @@ interface RefundTransaction$3 {
29296
29333
  /** Whether refund was made externally and manually on the payment provider's side. */
29297
29334
  externalRefund?: boolean;
29298
29335
  }
29299
- /**
29300
- * Refund transaction status.
29301
- * + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
29302
- * + `SUCCEEDED`: Refund transaction succeeded.
29303
- * + `FAILED`: Refund transaction failed.
29304
- * + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
29305
- * + `STARTED`: Refund was initiated on payment provider side.
29306
- */
29336
+ /** Refund transaction status. */
29307
29337
  declare enum RefundStatus$3 {
29338
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
29308
29339
  PENDING = "PENDING",
29340
+ /** Refund transaction succeeded. */
29309
29341
  SUCCEEDED = "SUCCEEDED",
29342
+ /** Refund transaction failed. */
29310
29343
  FAILED = "FAILED",
29344
+ /** Refund request acknowledged, and will be executed soon. */
29311
29345
  SCHEDULED = "SCHEDULED",
29346
+ /** Refund was initiated on payment provider side. */
29312
29347
  STARTED = "STARTED"
29313
29348
  }
29314
29349
  /** Business model of a refund request */
@@ -30539,8 +30574,11 @@ interface Color {
30539
30574
  code?: string | null;
30540
30575
  }
30541
30576
  declare enum DescriptionLineType {
30577
+ /** Unrecognized type. */
30542
30578
  UNRECOGNISED = "UNRECOGNISED",
30579
+ /** Plain text type. */
30543
30580
  PLAIN_TEXT = "PLAIN_TEXT",
30581
+ /** Color type. */
30544
30582
  COLOR = "COLOR"
30545
30583
  }
30546
30584
  interface PhysicalProperties$4 {
@@ -30575,11 +30613,11 @@ declare enum ItemTypeItemType$2 {
30575
30613
  declare enum PaymentOptionType$2 {
30576
30614
  /** The entire payment for this item happens as part of the checkout. */
30577
30615
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
30578
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
30616
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
30579
30617
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
30580
30618
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
30581
30619
  MEMBERSHIP = "MEMBERSHIP",
30582
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
30620
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
30583
30621
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
30584
30622
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
30585
30623
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -30745,14 +30783,14 @@ declare enum PaymentStatus {
30745
30783
  PARTIALLY_PAID = "PARTIALLY_PAID"
30746
30784
  }
30747
30785
  declare enum FulfillmentStatus {
30748
- /** none of the order items are fulfilled or order was manually marked as unfulfilled */
30786
+ /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
30749
30787
  NOT_FULFILLED = "NOT_FULFILLED",
30750
30788
  /**
30751
- * All of the order items are fulfilled or order was manually marked as fulfilled
30752
- * Orders without shipping info are fulfilled automatically
30789
+ * All of the order items are fulfilled or the order was manually marked as fulfilled.
30790
+ * Orders without shipping info are fulfilled automatically.
30753
30791
  */
30754
30792
  FULFILLED = "FULFILLED",
30755
- /** Some, but not all of the order items are fulfilled */
30793
+ /** Some, but not all, of the order items are fulfilled. */
30756
30794
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
30757
30795
  }
30758
30796
  declare enum WeightUnit$4 {
@@ -30843,7 +30881,7 @@ declare enum VatType$2 {
30843
30881
  interface V1ShippingInformation {
30844
30882
  /** App Def Id of external provider which was a source of shipping info */
30845
30883
  carrierId?: string | null;
30846
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
30884
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
30847
30885
  code?: string | null;
30848
30886
  /**
30849
30887
  * Shipping option title.
@@ -31129,7 +31167,9 @@ interface OrderRefunded {
31129
31167
  reason?: string;
31130
31168
  }
31131
31169
  declare enum LineItemQuantityChangeType {
31170
+ /** Quantity increased. */
31132
31171
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
31172
+ /** Quantity decreased. */
31133
31173
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
31134
31174
  }
31135
31175
  declare enum ActivityType {
@@ -31476,11 +31516,11 @@ interface AuthorizationCapture$2 {
31476
31516
  }
31477
31517
  declare enum AuthorizationCaptureStatus$2 {
31478
31518
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
31479
- /** Whether capture operation still in progress */
31519
+ /** Capture operation still in progress. */
31480
31520
  PENDING = "PENDING",
31481
- /** The capture operation was succeeded */
31521
+ /** Capture operation succeeded. */
31482
31522
  SUCCEEDED = "SUCCEEDED",
31483
- /** The capture operation was failed */
31523
+ /** Capture operation failed. */
31484
31524
  FAILED = "FAILED"
31485
31525
  }
31486
31526
  interface AuthorizationActionFailureDetails$2 {
@@ -31498,28 +31538,25 @@ interface AuthorizationVoid$2 {
31498
31538
  }
31499
31539
  declare enum AuthorizationVoidStatus$2 {
31500
31540
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
31501
- /** Whether void operation still in progress */
31541
+ /** Void operation still in progress. */
31502
31542
  PENDING = "PENDING",
31503
- /** The void operation was succeeded */
31543
+ /** Void operation succeeded. */
31504
31544
  SUCCEEDED = "SUCCEEDED",
31505
- /** The void operation was failed */
31545
+ /** Void operation failed. */
31506
31546
  FAILED = "FAILED"
31507
31547
  }
31508
- /**
31509
- * Reason the authorization was voided.
31510
- *
31511
- * + `MANUAL`: Authorization was voided by user.
31512
- * + `SCHEDULED`: Authorization passed execution date.
31513
- */
31548
+ /** Reason the authorization was voided. */
31514
31549
  declare enum Reason$2 {
31515
31550
  UNKNOWN_REASON = "UNKNOWN_REASON",
31551
+ /** Authorization was voided by user. */
31516
31552
  MANUAL = "MANUAL",
31553
+ /** Authorization passed execution date. */
31517
31554
  SCHEDULED = "SCHEDULED"
31518
31555
  }
31519
31556
  interface V1ScheduledAction {
31520
- /** type of the action */
31557
+ /** Type of the action. */
31521
31558
  actionType?: ActionType$2;
31522
- /** the date and time of the action */
31559
+ /** The date and time of the action. */
31523
31560
  executionDate?: Date | null;
31524
31561
  }
31525
31562
  declare enum ActionType$2 {
@@ -31539,9 +31576,9 @@ interface GiftCardPaymentDetails$2 {
31539
31576
  voided?: boolean;
31540
31577
  }
31541
31578
  declare enum MembershipPaymentStatus$2 {
31542
- /** CHARGED - Payment was charged */
31579
+ /** Payment was charged. */
31543
31580
  CHARGED = "CHARGED",
31544
- /** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
31581
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
31545
31582
  CHARGE_FAILED = "CHARGE_FAILED"
31546
31583
  }
31547
31584
  interface Refund$2 {
@@ -31577,19 +31614,17 @@ interface RefundTransaction$2 {
31577
31614
  /** Whether refund was made externally and manually on the payment provider's side. */
31578
31615
  externalRefund?: boolean;
31579
31616
  }
31580
- /**
31581
- * Refund transaction status.
31582
- * + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
31583
- * + `SUCCEEDED`: Refund transaction succeeded.
31584
- * + `FAILED`: Refund transaction failed.
31585
- * + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
31586
- * + `STARTED`: Refund was initiated on payment provider side.
31587
- */
31617
+ /** Refund transaction status. */
31588
31618
  declare enum RefundStatus$2 {
31619
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
31589
31620
  PENDING = "PENDING",
31621
+ /** Refund transaction succeeded. */
31590
31622
  SUCCEEDED = "SUCCEEDED",
31623
+ /** Refund transaction failed. */
31591
31624
  FAILED = "FAILED",
31625
+ /** Refund request acknowledged, and will be executed soon. */
31592
31626
  SCHEDULED = "SCHEDULED",
31627
+ /** Refund was initiated on payment provider side. */
31593
31628
  STARTED = "STARTED"
31594
31629
  }
31595
31630
  /** Business model of a refund request */
@@ -33213,11 +33248,11 @@ interface AuthorizationCapture$1 {
33213
33248
  }
33214
33249
  declare enum AuthorizationCaptureStatus$1 {
33215
33250
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
33216
- /** Whether capture operation still in progress */
33251
+ /** Capture operation still in progress. */
33217
33252
  PENDING = "PENDING",
33218
- /** The capture operation was succeeded */
33253
+ /** Capture operation succeeded. */
33219
33254
  SUCCEEDED = "SUCCEEDED",
33220
- /** The capture operation was failed */
33255
+ /** Capture operation failed. */
33221
33256
  FAILED = "FAILED"
33222
33257
  }
33223
33258
  interface Price$3 {
@@ -33244,28 +33279,25 @@ interface AuthorizationVoid$1 {
33244
33279
  }
33245
33280
  declare enum AuthorizationVoidStatus$1 {
33246
33281
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
33247
- /** Whether void operation still in progress */
33282
+ /** Void operation still in progress. */
33248
33283
  PENDING = "PENDING",
33249
- /** The void operation was succeeded */
33284
+ /** Void operation succeeded. */
33250
33285
  SUCCEEDED = "SUCCEEDED",
33251
- /** The void operation was failed */
33286
+ /** Void operation failed. */
33252
33287
  FAILED = "FAILED"
33253
33288
  }
33254
- /**
33255
- * Reason the authorization was voided.
33256
- *
33257
- * + `MANUAL`: Authorization was voided by user.
33258
- * + `SCHEDULED`: Authorization passed execution date.
33259
- */
33289
+ /** Reason the authorization was voided. */
33260
33290
  declare enum Reason$1 {
33261
33291
  UNKNOWN_REASON = "UNKNOWN_REASON",
33292
+ /** Authorization was voided by user. */
33262
33293
  MANUAL = "MANUAL",
33294
+ /** Authorization passed execution date. */
33263
33295
  SCHEDULED = "SCHEDULED"
33264
33296
  }
33265
33297
  interface ScheduledAction$1 {
33266
- /** type of the action */
33298
+ /** Type of the action. */
33267
33299
  actionType?: ActionType$1;
33268
- /** the date and time of the action */
33300
+ /** The date and time of the action. */
33269
33301
  executionDate?: Date | null;
33270
33302
  }
33271
33303
  declare enum ActionType$1 {
@@ -33285,9 +33317,9 @@ interface GiftCardPaymentDetails$1 {
33285
33317
  voided?: boolean;
33286
33318
  }
33287
33319
  declare enum MembershipPaymentStatus$1 {
33288
- /** CHARGED - Payment was charged */
33320
+ /** Payment was charged. */
33289
33321
  CHARGED = "CHARGED",
33290
- /** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
33322
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
33291
33323
  CHARGE_FAILED = "CHARGE_FAILED"
33292
33324
  }
33293
33325
  interface Refund$1 {
@@ -33323,19 +33355,17 @@ interface RefundTransaction$1 {
33323
33355
  /** Whether refund was made externally and manually on the payment provider's side. */
33324
33356
  externalRefund?: boolean;
33325
33357
  }
33326
- /**
33327
- * Refund transaction status.
33328
- * + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
33329
- * + `SUCCEEDED`: Refund transaction succeeded.
33330
- * + `FAILED`: Refund transaction failed.
33331
- * + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
33332
- * + `STARTED`: Refund was initiated on payment provider side.
33333
- */
33358
+ /** Refund transaction status. */
33334
33359
  declare enum RefundStatus$1 {
33360
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
33335
33361
  PENDING = "PENDING",
33362
+ /** Refund transaction succeeded. */
33336
33363
  SUCCEEDED = "SUCCEEDED",
33364
+ /** Refund transaction failed. */
33337
33365
  FAILED = "FAILED",
33366
+ /** Refund request acknowledged, and will be executed soon. */
33338
33367
  SCHEDULED = "SCHEDULED",
33368
+ /** Refund was initiated on payment provider side. */
33339
33369
  STARTED = "STARTED"
33340
33370
  }
33341
33371
  /** Business model of a refund request */
@@ -33711,11 +33741,11 @@ interface AuthorizationCapture {
33711
33741
  }
33712
33742
  declare enum AuthorizationCaptureStatus {
33713
33743
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
33714
- /** Whether capture operation still in progress */
33744
+ /** Capture operation still in progress. */
33715
33745
  PENDING = "PENDING",
33716
- /** The capture operation was succeeded */
33746
+ /** Capture operation succeeded. */
33717
33747
  SUCCEEDED = "SUCCEEDED",
33718
- /** The capture operation was failed */
33748
+ /** Capture operation failed. */
33719
33749
  FAILED = "FAILED"
33720
33750
  }
33721
33751
  interface Price$2 {
@@ -33742,28 +33772,25 @@ interface AuthorizationVoid {
33742
33772
  }
33743
33773
  declare enum AuthorizationVoidStatus {
33744
33774
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
33745
- /** Whether void operation still in progress */
33775
+ /** Void operation still in progress. */
33746
33776
  PENDING = "PENDING",
33747
- /** The void operation was succeeded */
33777
+ /** Void operation succeeded. */
33748
33778
  SUCCEEDED = "SUCCEEDED",
33749
- /** The void operation was failed */
33779
+ /** Void operation failed. */
33750
33780
  FAILED = "FAILED"
33751
33781
  }
33752
- /**
33753
- * Reason the authorization was voided.
33754
- *
33755
- * + `MANUAL`: Authorization was voided by user.
33756
- * + `SCHEDULED`: Authorization passed execution date.
33757
- */
33782
+ /** Reason the authorization was voided. */
33758
33783
  declare enum Reason {
33759
33784
  UNKNOWN_REASON = "UNKNOWN_REASON",
33785
+ /** Authorization was voided by user. */
33760
33786
  MANUAL = "MANUAL",
33787
+ /** Authorization passed execution date. */
33761
33788
  SCHEDULED = "SCHEDULED"
33762
33789
  }
33763
33790
  interface ScheduledAction {
33764
- /** type of the action */
33791
+ /** Type of the action. */
33765
33792
  actionType?: ActionType;
33766
- /** the date and time of the action */
33793
+ /** The date and time of the action. */
33767
33794
  executionDate?: Date | null;
33768
33795
  }
33769
33796
  declare enum ActionType {
@@ -33783,9 +33810,9 @@ interface GiftCardPaymentDetails {
33783
33810
  voided?: boolean;
33784
33811
  }
33785
33812
  declare enum MembershipPaymentStatus {
33786
- /** CHARGED - Payment was charged */
33813
+ /** Payment was charged. */
33787
33814
  CHARGED = "CHARGED",
33788
- /** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
33815
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
33789
33816
  CHARGE_FAILED = "CHARGE_FAILED"
33790
33817
  }
33791
33818
  interface Refund {
@@ -33821,19 +33848,17 @@ interface RefundTransaction {
33821
33848
  /** Whether refund was made externally and manually on the payment provider's side. */
33822
33849
  externalRefund?: boolean;
33823
33850
  }
33824
- /**
33825
- * Refund transaction status.
33826
- * + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
33827
- * + `SUCCEEDED`: Refund transaction succeeded.
33828
- * + `FAILED`: Refund transaction failed.
33829
- * + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
33830
- * + `STARTED`: Refund was initiated on payment provider side.
33831
- */
33851
+ /** Refund transaction status. */
33832
33852
  declare enum RefundStatus {
33853
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
33833
33854
  PENDING = "PENDING",
33855
+ /** Refund transaction succeeded. */
33834
33856
  SUCCEEDED = "SUCCEEDED",
33857
+ /** Refund transaction failed. */
33835
33858
  FAILED = "FAILED",
33859
+ /** Refund request acknowledged, and will be executed soon. */
33836
33860
  SCHEDULED = "SCHEDULED",
33861
+ /** Refund was initiated on payment provider side. */
33837
33862
  STARTED = "STARTED"
33838
33863
  }
33839
33864
  /** Business model of a refund request */
@@ -34118,11 +34143,7 @@ declare namespace meta$a {
34118
34143
 
34119
34144
  interface OrdersSettings$1 {
34120
34145
  /**
34121
- * Defines when to update the store inventory:
34122
- *
34123
- * - `ON_ORDER_PAID`: Stock quantities will update only after the payment is approved.
34124
- * - `ON_ORDER_PLACED`: Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock.
34125
- *
34146
+ * Defines when to update the store inventory.
34126
34147
  * Default: `ON_ORDER_PLACED`
34127
34148
  */
34128
34149
  inventoryUpdateTrigger?: InventoryUpdateTrigger$1;
@@ -34147,7 +34168,9 @@ interface OrdersSettings$1 {
34147
34168
  }
34148
34169
  declare enum InventoryUpdateTrigger$1 {
34149
34170
  UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
34171
+ /** Stock quantities will update only after the payment is approved. */
34150
34172
  ON_ORDER_PAID = "ON_ORDER_PAID",
34173
+ /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
34151
34174
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
34152
34175
  }
34153
34176
  interface GetOrdersSettingsRequest$1 {
@@ -34202,7 +34225,9 @@ interface OrdersSettings {
34202
34225
  }
34203
34226
  declare enum InventoryUpdateTrigger {
34204
34227
  UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
34228
+ /** Stock quantities will update only after the payment is approved. */
34205
34229
  ON_ORDER_PAID = "ON_ORDER_PAID",
34230
+ /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
34206
34231
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
34207
34232
  }
34208
34233
  interface GetOrdersSettingsRequest {