@wix/auto_sdk_ecom_cart 1.0.31 → 1.0.32
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/build/cjs/src/ecom-v1-cart-cart.types.d.ts +83 -33
- package/build/cjs/src/ecom-v1-cart-cart.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-cart-cart.universal.d.ts +85 -35
- package/build/cjs/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/build/es/src/ecom-v1-cart-cart.types.d.ts +83 -33
- package/build/es/src/ecom-v1-cart-cart.types.js.map +1 -1
- package/build/es/src/ecom-v1-cart-cart.universal.d.ts +85 -35
- package/build/es/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.types.d.ts +83 -33
- package/build/internal/cjs/src/ecom-v1-cart-cart.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.d.ts +87 -37
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-cart-cart.types.d.ts +83 -33
- package/build/internal/es/src/ecom-v1-cart-cart.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-cart-cart.universal.d.ts +87 -37
- package/build/internal/es/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -51,7 +51,7 @@ export interface Cart {
|
|
|
51
51
|
* Weight measurement unit - defaults to site's weight unit.
|
|
52
52
|
* @readonly
|
|
53
53
|
*/
|
|
54
|
-
weightUnit?:
|
|
54
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
55
55
|
/**
|
|
56
56
|
* ID of the checkout that originated from this cart.
|
|
57
57
|
* @readonly
|
|
@@ -185,7 +185,7 @@ export interface LineItem {
|
|
|
185
185
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
186
186
|
* @readonly
|
|
187
187
|
*/
|
|
188
|
-
paymentOption?:
|
|
188
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
189
189
|
/**
|
|
190
190
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
191
191
|
* @readonly
|
|
@@ -424,6 +424,8 @@ export declare enum DescriptionLineType {
|
|
|
424
424
|
/** Color type. */
|
|
425
425
|
COLOR = "COLOR"
|
|
426
426
|
}
|
|
427
|
+
/** @enumType */
|
|
428
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
427
429
|
export interface CommonImage {
|
|
428
430
|
/** WixMedia image ID. */
|
|
429
431
|
id?: string;
|
|
@@ -459,7 +461,7 @@ export interface FocalPoint {
|
|
|
459
461
|
}
|
|
460
462
|
export interface ItemAvailabilityInfo {
|
|
461
463
|
/** Item availability status. */
|
|
462
|
-
status?:
|
|
464
|
+
status?: ItemAvailabilityStatusWithLiterals;
|
|
463
465
|
/** Quantity available. */
|
|
464
466
|
quantityAvailable?: number | null;
|
|
465
467
|
}
|
|
@@ -472,6 +474,8 @@ export declare enum ItemAvailabilityStatus {
|
|
|
472
474
|
/** Available quantity is less than requested. */
|
|
473
475
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
474
476
|
}
|
|
477
|
+
/** @enumType */
|
|
478
|
+
export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
|
|
475
479
|
export interface PhysicalProperties {
|
|
476
480
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
477
481
|
weight?: number | null;
|
|
@@ -497,14 +501,14 @@ export interface Group {
|
|
|
497
501
|
}
|
|
498
502
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
499
503
|
/** Preset item type. */
|
|
500
|
-
preset?:
|
|
504
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
501
505
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
502
506
|
custom?: string;
|
|
503
507
|
}
|
|
504
508
|
/** @oneof */
|
|
505
509
|
export interface ItemTypeItemTypeDataOneOf {
|
|
506
510
|
/** Preset item type. */
|
|
507
|
-
preset?:
|
|
511
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
508
512
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
509
513
|
custom?: string;
|
|
510
514
|
}
|
|
@@ -515,6 +519,8 @@ export declare enum ItemTypeItemType {
|
|
|
515
519
|
GIFT_CARD = "GIFT_CARD",
|
|
516
520
|
SERVICE = "SERVICE"
|
|
517
521
|
}
|
|
522
|
+
/** @enumType */
|
|
523
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
518
524
|
export interface SubscriptionOptionInfo {
|
|
519
525
|
/** Subscription option settings. */
|
|
520
526
|
subscriptionSettings?: SubscriptionSettings;
|
|
@@ -525,7 +531,7 @@ export interface SubscriptionOptionInfo {
|
|
|
525
531
|
}
|
|
526
532
|
export interface SubscriptionSettings {
|
|
527
533
|
/** Frequency of recurring payment. */
|
|
528
|
-
frequency?:
|
|
534
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
529
535
|
/**
|
|
530
536
|
* Interval of recurring payment.
|
|
531
537
|
*
|
|
@@ -558,9 +564,11 @@ export declare enum SubscriptionFrequency {
|
|
|
558
564
|
MONTH = "MONTH",
|
|
559
565
|
YEAR = "YEAR"
|
|
560
566
|
}
|
|
567
|
+
/** @enumType */
|
|
568
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
561
569
|
export interface FreeTrialPeriod {
|
|
562
570
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
563
|
-
frequency?:
|
|
571
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
564
572
|
/**
|
|
565
573
|
* interval of period
|
|
566
574
|
* @min 1
|
|
@@ -610,7 +618,7 @@ export interface SecuredMedia {
|
|
|
610
618
|
*/
|
|
611
619
|
fileName?: string;
|
|
612
620
|
/** File type. */
|
|
613
|
-
fileType?:
|
|
621
|
+
fileType?: FileTypeWithLiterals;
|
|
614
622
|
}
|
|
615
623
|
export declare enum FileType {
|
|
616
624
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -620,6 +628,8 @@ export declare enum FileType {
|
|
|
620
628
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
621
629
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
622
630
|
}
|
|
631
|
+
/** @enumType */
|
|
632
|
+
export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
623
633
|
/** Type of selected payment option for catalog item */
|
|
624
634
|
export declare enum PaymentOptionType {
|
|
625
635
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -633,6 +643,8 @@ export declare enum PaymentOptionType {
|
|
|
633
643
|
/** 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`. */
|
|
634
644
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
635
645
|
}
|
|
646
|
+
/** @enumType */
|
|
647
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
636
648
|
export interface ServiceProperties {
|
|
637
649
|
/**
|
|
638
650
|
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
@@ -731,16 +743,16 @@ export interface PaymentOption {
|
|
|
731
743
|
*
|
|
732
744
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
733
745
|
*/
|
|
734
|
-
value?:
|
|
746
|
+
value?: PaymentOptionTypeWithLiterals;
|
|
735
747
|
}
|
|
736
748
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
737
749
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
738
|
-
addressType?:
|
|
750
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
739
751
|
}
|
|
740
752
|
/** @oneof */
|
|
741
753
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
742
754
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
743
|
-
addressType?:
|
|
755
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
744
756
|
}
|
|
745
757
|
export declare enum TaxableAddressType {
|
|
746
758
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -748,6 +760,8 @@ export declare enum TaxableAddressType {
|
|
|
748
760
|
BILLING = "BILLING",
|
|
749
761
|
SHIPPING = "SHIPPING"
|
|
750
762
|
}
|
|
763
|
+
/** @enumType */
|
|
764
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
751
765
|
export interface ExtendedFields {
|
|
752
766
|
/**
|
|
753
767
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -890,6 +904,8 @@ export declare enum WeightUnit {
|
|
|
890
904
|
/** Pounds. */
|
|
891
905
|
LB = "LB"
|
|
892
906
|
}
|
|
907
|
+
/** @enumType */
|
|
908
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
893
909
|
export interface CartDiscount extends CartDiscountDiscountSourceOneOf {
|
|
894
910
|
/** Coupon details. */
|
|
895
911
|
coupon?: Coupon;
|
|
@@ -946,6 +962,8 @@ export declare enum DiscountType {
|
|
|
946
962
|
/** "SHIPPING" - discount applies to shipping. For example, free shipping. */
|
|
947
963
|
SHIPPING = "SHIPPING"
|
|
948
964
|
}
|
|
965
|
+
/** @enumType */
|
|
966
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
949
967
|
/** Billing Info and shipping details */
|
|
950
968
|
export interface AddressWithContact {
|
|
951
969
|
/** Address. */
|
|
@@ -1045,7 +1063,7 @@ export interface VatId {
|
|
|
1045
1063
|
* + `CPF`: for individual tax payers
|
|
1046
1064
|
* + `CNPJ`: for corporations
|
|
1047
1065
|
*/
|
|
1048
|
-
type?:
|
|
1066
|
+
type?: VatTypeWithLiterals;
|
|
1049
1067
|
}
|
|
1050
1068
|
/** tax info types */
|
|
1051
1069
|
export declare enum VatType {
|
|
@@ -1055,6 +1073,8 @@ export declare enum VatType {
|
|
|
1055
1073
|
/** CNPJ - for corporations */
|
|
1056
1074
|
CNPJ = "CNPJ"
|
|
1057
1075
|
}
|
|
1076
|
+
/** @enumType */
|
|
1077
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1058
1078
|
export interface SelectedShippingOption {
|
|
1059
1079
|
/**
|
|
1060
1080
|
* Carrier ID.
|
|
@@ -1177,7 +1197,7 @@ export interface CustomLineItem {
|
|
|
1177
1197
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
1178
1198
|
* + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
|
|
1179
1199
|
*/
|
|
1180
|
-
paymentOption?:
|
|
1200
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
1181
1201
|
/**
|
|
1182
1202
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
1183
1203
|
* Used, among other things, when checking for valid memberships.
|
|
@@ -1386,7 +1406,7 @@ export interface EstimateTotalsResponse {
|
|
|
1386
1406
|
/** Calculation errors. */
|
|
1387
1407
|
calculationErrors?: CalculationErrors;
|
|
1388
1408
|
/** Weight measurement unit. Defaults to site's weight unit. */
|
|
1389
|
-
weightUnit?:
|
|
1409
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
1390
1410
|
/**
|
|
1391
1411
|
* Currency used for pricing in this store.
|
|
1392
1412
|
* @format CURRENCY
|
|
@@ -1427,7 +1447,7 @@ export interface CalculatedLineItem {
|
|
|
1427
1447
|
* + `"MEMBERSHIP"` - This item cannot be paid via monetary payment options, only via non monetary option such membership. When this option is used, price must be set to 0
|
|
1428
1448
|
* + `"DEPOSIT_ONLINE"` - Partial payment of the given item will happen as part of the checkout. Amount to be paid is defined by deposit_amount field.
|
|
1429
1449
|
*/
|
|
1430
|
-
paymentOption?:
|
|
1450
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
1431
1451
|
/** tax calculation address. */
|
|
1432
1452
|
taxableAddress?: TaxableAddress;
|
|
1433
1453
|
}
|
|
@@ -1519,7 +1539,7 @@ export interface TaxBreakdown {
|
|
|
1519
1539
|
*/
|
|
1520
1540
|
taxName?: string | null;
|
|
1521
1541
|
/** The type of the jurisdiction in which this tax detail applies. */
|
|
1522
|
-
jurisdictionType?:
|
|
1542
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1523
1543
|
}
|
|
1524
1544
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1525
1545
|
export declare enum JurisdictionType {
|
|
@@ -1530,6 +1550,8 @@ export declare enum JurisdictionType {
|
|
|
1530
1550
|
CITY = "CITY",
|
|
1531
1551
|
SPECIAL = "SPECIAL"
|
|
1532
1552
|
}
|
|
1553
|
+
/** @enumType */
|
|
1554
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
1533
1555
|
export interface CalculatedItemModifier {
|
|
1534
1556
|
/**
|
|
1535
1557
|
* Modifier ID.
|
|
@@ -1605,16 +1627,16 @@ export interface TaxSummary {
|
|
|
1605
1627
|
}
|
|
1606
1628
|
export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1607
1629
|
/** Reason the manual calculation was used. */
|
|
1608
|
-
manualRateReason?:
|
|
1630
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1609
1631
|
/** Details of the fallback rate calculation. */
|
|
1610
1632
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1611
1633
|
/** Rate calculation type. */
|
|
1612
|
-
rateType?:
|
|
1634
|
+
rateType?: RateTypeWithLiterals;
|
|
1613
1635
|
}
|
|
1614
1636
|
/** @oneof */
|
|
1615
1637
|
export interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1616
1638
|
/** Reason the manual calculation was used. */
|
|
1617
|
-
manualRateReason?:
|
|
1639
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1618
1640
|
/** Details of the fallback rate calculation. */
|
|
1619
1641
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1620
1642
|
}
|
|
@@ -1628,15 +1650,19 @@ export declare enum RateType {
|
|
|
1628
1650
|
/** fallback rate used for calculation */
|
|
1629
1651
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1630
1652
|
}
|
|
1653
|
+
/** @enumType */
|
|
1654
|
+
export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
|
|
1631
1655
|
export declare enum ManualCalculationReason {
|
|
1632
1656
|
/** user set calculator in Business Manager to be Manual */
|
|
1633
1657
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1634
1658
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1635
1659
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1636
1660
|
}
|
|
1661
|
+
/** @enumType */
|
|
1662
|
+
export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
|
|
1637
1663
|
export interface AutoTaxFallbackCalculationDetails {
|
|
1638
1664
|
/** reason for fallback */
|
|
1639
|
-
fallbackReason?:
|
|
1665
|
+
fallbackReason?: FallbackReasonWithLiterals;
|
|
1640
1666
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1641
1667
|
error?: ApplicationError;
|
|
1642
1668
|
}
|
|
@@ -1646,6 +1672,8 @@ export declare enum FallbackReason {
|
|
|
1646
1672
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
1647
1673
|
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
1648
1674
|
}
|
|
1675
|
+
/** @enumType */
|
|
1676
|
+
export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
|
|
1649
1677
|
export interface ApplicationError {
|
|
1650
1678
|
/** Error code. */
|
|
1651
1679
|
code?: string;
|
|
@@ -1675,7 +1703,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
1675
1703
|
*/
|
|
1676
1704
|
jurisdiction?: string;
|
|
1677
1705
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1678
|
-
jurisdictionTypeEnum?:
|
|
1706
|
+
jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
|
|
1679
1707
|
/**
|
|
1680
1708
|
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
|
|
1681
1709
|
* @decimalValue options { gte:0, maxScale:6 }
|
|
@@ -1776,13 +1804,15 @@ export interface PickupDetails {
|
|
|
1776
1804
|
*/
|
|
1777
1805
|
businessLocation?: boolean;
|
|
1778
1806
|
/** Pickup method */
|
|
1779
|
-
pickupMethod?:
|
|
1807
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1780
1808
|
}
|
|
1781
1809
|
export declare enum PickupMethod {
|
|
1782
1810
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1783
1811
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1784
1812
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1785
1813
|
}
|
|
1814
|
+
/** @enumType */
|
|
1815
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1786
1816
|
export interface DeliveryTimeSlot {
|
|
1787
1817
|
/** starting time of the delivery time slot */
|
|
1788
1818
|
from?: Date | null;
|
|
@@ -1803,7 +1833,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1803
1833
|
}
|
|
1804
1834
|
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1805
1835
|
/** Type of additional cost. */
|
|
1806
|
-
type?:
|
|
1836
|
+
type?: ChargeTypeWithLiterals;
|
|
1807
1837
|
/**
|
|
1808
1838
|
* Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
|
|
1809
1839
|
* @maxLength 200
|
|
@@ -1816,6 +1846,8 @@ export declare enum ChargeType {
|
|
|
1816
1846
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1817
1847
|
INSURANCE = "INSURANCE"
|
|
1818
1848
|
}
|
|
1849
|
+
/** @enumType */
|
|
1850
|
+
export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
|
|
1819
1851
|
export interface DeliveryAllocation {
|
|
1820
1852
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1821
1853
|
deliveryCarrier?: Carrier;
|
|
@@ -1899,7 +1931,7 @@ export interface ShippingPrice {
|
|
|
1899
1931
|
}
|
|
1900
1932
|
export interface OtherCharge {
|
|
1901
1933
|
/** Type of additional cost. */
|
|
1902
|
-
type?:
|
|
1934
|
+
type?: ChargeTypeWithLiterals;
|
|
1903
1935
|
/** Price of added cost. */
|
|
1904
1936
|
price?: MultiCurrencyPrice;
|
|
1905
1937
|
/**
|
|
@@ -1916,7 +1948,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1916
1948
|
/** Discount rule */
|
|
1917
1949
|
discountRule?: V1DiscountRule;
|
|
1918
1950
|
/** Discount type. */
|
|
1919
|
-
discountType?:
|
|
1951
|
+
discountType?: AppliedDiscountDiscountTypeWithLiterals;
|
|
1920
1952
|
/**
|
|
1921
1953
|
* IDs of line items the discount applies to.
|
|
1922
1954
|
* @format GUID
|
|
@@ -1940,6 +1972,8 @@ export declare enum AppliedDiscountDiscountType {
|
|
|
1940
1972
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1941
1973
|
SHIPPING = "SHIPPING"
|
|
1942
1974
|
}
|
|
1975
|
+
/** @enumType */
|
|
1976
|
+
export type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1943
1977
|
/** Coupon */
|
|
1944
1978
|
export interface V1Coupon {
|
|
1945
1979
|
/** Coupon ID. */
|
|
@@ -2097,10 +2131,12 @@ export declare enum RuleType {
|
|
|
2097
2131
|
EXACT_SIZE = "EXACT_SIZE",
|
|
2098
2132
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
2099
2133
|
}
|
|
2134
|
+
/** @enumType */
|
|
2135
|
+
export type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
|
|
2100
2136
|
export interface FieldViolation {
|
|
2101
2137
|
field?: string;
|
|
2102
2138
|
description?: string;
|
|
2103
|
-
violatedRule?:
|
|
2139
|
+
violatedRule?: RuleTypeWithLiterals;
|
|
2104
2140
|
/** applicable when violated_rule=OTHER */
|
|
2105
2141
|
ruleName?: string | null;
|
|
2106
2142
|
data?: Record<string, any> | null;
|
|
@@ -2230,7 +2266,7 @@ export interface AdditionalFee {
|
|
|
2230
2266
|
*/
|
|
2231
2267
|
lineItemIds?: string[];
|
|
2232
2268
|
/** the source the additional fee was added from */
|
|
2233
|
-
source?:
|
|
2269
|
+
source?: AdditionalFeeSourceWithLiterals;
|
|
2234
2270
|
}
|
|
2235
2271
|
export declare enum AdditionalFeeSource {
|
|
2236
2272
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
@@ -2243,9 +2279,11 @@ export declare enum AdditionalFeeSource {
|
|
|
2243
2279
|
/** The additional fee was added by the shipping provider */
|
|
2244
2280
|
SHIPPING = "SHIPPING"
|
|
2245
2281
|
}
|
|
2282
|
+
/** @enumType */
|
|
2283
|
+
export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
|
|
2246
2284
|
export interface Violation {
|
|
2247
2285
|
/** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
|
|
2248
|
-
severity?:
|
|
2286
|
+
severity?: SeverityWithLiterals;
|
|
2249
2287
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
2250
2288
|
target?: Target;
|
|
2251
2289
|
/**
|
|
@@ -2264,6 +2302,8 @@ export declare enum Severity {
|
|
|
2264
2302
|
*/
|
|
2265
2303
|
ERROR = "ERROR"
|
|
2266
2304
|
}
|
|
2305
|
+
/** @enumType */
|
|
2306
|
+
export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
|
|
2267
2307
|
export interface Target extends TargetTargetTypeOneOf {
|
|
2268
2308
|
/** General (other) violation. */
|
|
2269
2309
|
other?: Other;
|
|
@@ -2282,26 +2322,32 @@ export declare enum NameInOther {
|
|
|
2282
2322
|
/** Default location, in case no specific location is specified. */
|
|
2283
2323
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
2284
2324
|
}
|
|
2325
|
+
/** @enumType */
|
|
2326
|
+
export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
|
|
2285
2327
|
/** Available locations on the line item */
|
|
2286
2328
|
export declare enum NameInLineItem {
|
|
2287
2329
|
/** Default location, in case no specific location is specified. */
|
|
2288
2330
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
2289
2331
|
}
|
|
2332
|
+
/** @enumType */
|
|
2333
|
+
export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
|
|
2290
2334
|
export declare enum SuggestedFix {
|
|
2291
2335
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
2292
2336
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
2293
2337
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
2294
2338
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
2295
2339
|
}
|
|
2340
|
+
/** @enumType */
|
|
2341
|
+
export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
|
|
2296
2342
|
/** General (other) violation. */
|
|
2297
2343
|
export interface Other {
|
|
2298
2344
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
2299
|
-
name?:
|
|
2345
|
+
name?: NameInOtherWithLiterals;
|
|
2300
2346
|
}
|
|
2301
2347
|
/** Specific line item violation. */
|
|
2302
2348
|
export interface TargetLineItem {
|
|
2303
2349
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
2304
|
-
name?:
|
|
2350
|
+
name?: NameInLineItemWithLiterals;
|
|
2305
2351
|
/** ID of the line item containing the violation. */
|
|
2306
2352
|
id?: string | null;
|
|
2307
2353
|
}
|
|
@@ -2320,7 +2366,7 @@ export interface RemoveLineItemsResponse {
|
|
|
2320
2366
|
}
|
|
2321
2367
|
export interface CreateCheckoutFromCurrentCartRequest {
|
|
2322
2368
|
/** __Required.__ Sales channel type. */
|
|
2323
|
-
channelType?:
|
|
2369
|
+
channelType?: ChannelTypeWithLiterals;
|
|
2324
2370
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
2325
2371
|
shippingAddress?: Address;
|
|
2326
2372
|
/** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
|
|
@@ -2367,6 +2413,8 @@ export declare enum ChannelType {
|
|
|
2367
2413
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2368
2414
|
FAIRE_COM = "FAIRE_COM"
|
|
2369
2415
|
}
|
|
2416
|
+
/** @enumType */
|
|
2417
|
+
export type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
2370
2418
|
export interface CreateCheckoutResponse {
|
|
2371
2419
|
/** The newly created checkout's ID. */
|
|
2372
2420
|
checkoutId?: string;
|
|
@@ -2530,7 +2578,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2530
2578
|
*/
|
|
2531
2579
|
appId?: string;
|
|
2532
2580
|
/** @readonly */
|
|
2533
|
-
identityType?:
|
|
2581
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2534
2582
|
}
|
|
2535
2583
|
/** @oneof */
|
|
2536
2584
|
export interface IdentificationDataIdOneOf {
|
|
@@ -2562,6 +2610,8 @@ export declare enum WebhookIdentityType {
|
|
|
2562
2610
|
WIX_USER = "WIX_USER",
|
|
2563
2611
|
APP = "APP"
|
|
2564
2612
|
}
|
|
2613
|
+
/** @enumType */
|
|
2614
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2565
2615
|
export interface CreateCartRequest {
|
|
2566
2616
|
/** Cart info. */
|
|
2567
2617
|
cartInfo?: Cart;
|
|
@@ -2661,7 +2711,7 @@ export interface CreateCheckoutRequest {
|
|
|
2661
2711
|
*/
|
|
2662
2712
|
id: string;
|
|
2663
2713
|
/** __Required.__ Sales channel type. */
|
|
2664
|
-
channelType?:
|
|
2714
|
+
channelType?: ChannelTypeWithLiterals;
|
|
2665
2715
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
2666
2716
|
shippingAddress?: Address;
|
|
2667
2717
|
/** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ecom-v1-cart-cart.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-cart-cart.types.ts"],"names":[],"mappings":";;;AA+aA,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,yBAAyB;IACzB,oDAA6B,CAAA;IAC7B,uBAAuB;IACvB,gDAAyB,CAAA;IACzB,kBAAkB;IAClB,sCAAe,CAAA;AACjB,CAAC,EAPW,mBAAmB,mCAAnB,mBAAmB,QAO9B;
|
|
1
|
+
{"version":3,"file":"ecom-v1-cart-cart.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-cart-cart.types.ts"],"names":[],"mappings":";;;AA+aA,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,yBAAyB;IACzB,oDAA6B,CAAA;IAC7B,uBAAuB;IACvB,gDAAyB,CAAA;IACzB,kBAAkB;IAClB,sCAAe,CAAA;AACjB,CAAC,EAPW,mBAAmB,mCAAnB,mBAAmB,QAO9B;AAmDD,IAAY,sBAQX;AARD,WAAY,sBAAsB;IAChC,iDAAuB,CAAA;IACvB,2BAA2B;IAC3B,iDAAuB,CAAA;IACvB,4BAA4B;IAC5B,yDAA+B,CAAA;IAC/B,iDAAiD;IACjD,qEAA2C,CAAA;AAC7C,CAAC,EARW,sBAAsB,sCAAtB,sBAAsB,QAQjC;AAmDD,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;AACrB,CAAC,EANW,gBAAgB,gCAAhB,gBAAgB,QAM3B;AAgDD,0CAA0C;AAC1C,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,gDAAuB,CAAA;IACvB,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,sCAAa,CAAA;AACf,CAAC,EANW,qBAAqB,qCAArB,qBAAqB,QAMhC;AAqED,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,uCAA2B,CAAA;IAC3B,6CAAiC,CAAA;IACjC,yCAA6B,CAAA;IAC7B,+CAAmC,CAAA;IACnC,yCAA6B,CAAA;IAC7B,6CAAiC,CAAA;AACnC,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB;AAYD,uDAAuD;AACvD,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,wEAAwE;IACxE,gEAA2C,CAAA;IAC3C,sIAAsI;IACtI,kEAA6C,CAAA;IAC7C,6FAA6F;IAC7F,8CAAyB,CAAA;IACzB,4IAA4I;IAC5I,sDAAiC,CAAA;IACjC,uKAAuK;IACvK,8DAAyC,CAAA;AAC3C,CAAC,EAXW,iBAAiB,iCAAjB,iBAAiB,QAW5B;AAgID,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yEAAmD,CAAA;IACnD,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;AACvB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAuJD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,iBAAiB;IACjB,uBAAS,CAAA;IACT,cAAc;IACd,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AA+DD,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,6DAA6D;IAC7D,iDAAiC,CAAA;IACjC,6EAA6E;IAC7E,qCAAqB,CAAA;AACvB,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB;AAoHD,qBAAqB;AACrB,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,uBAAP,OAAO,QAMlB;AA0eD,0IAA0I;AAC1I,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,uCAAmB,CAAA;AACrB,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;AA2GD,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,0EAA0E;IAC1E,iDAAqC,CAAA;IACrC,uCAAuC;IACvC,uCAA2B,CAAA;IAC3B,wCAAwC;IACxC,mCAAuB,CAAA;IACvB,yCAAyC;IACzC,2CAA+B,CAAA;AACjC,CAAC,EATW,QAAQ,wBAAR,QAAQ,QASnB;AAUD,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,2DAA2D;IAC3D,gFAAqD,CAAA;IACrD,0EAA0E;IAC1E,gFAAqD,CAAA;AACvD,CAAC,EALW,uBAAuB,uCAAvB,uBAAuB,QAKlC;AAeD,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,uCAAuC;IACvC,qDAAmC,CAAA;IACnC,6DAA6D;IAC7D,+DAA6C,CAAA;AAC/C,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAmJD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,6CAA6B,CAAA;AAC/B,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAyCD,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,2CAA6B,CAAA;IAC7B,qCAAuB,CAAA;AACzB,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB;AAsID,IAAY,2BAIX;AAJD,WAAY,2BAA2B;IACrC,gDAAiB,CAAA;IACjB,gEAAiC,CAAA;IACjC,oDAAqB,CAAA;AACvB,CAAC,EAJW,2BAA2B,2CAA3B,2BAA2B,QAItC;AA0JD,IAAY,QAsBX;AAtBD,WAAY,QAAQ;IAClB,qCAAyB,CAAA;IACzB,2BAAe,CAAA;IACf,uBAAW,CAAA;IACX,uBAAW,CAAA;IACX,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,iCAAqB,CAAA;IACrB,iCAAqB,CAAA;IACrB,6BAAiB,CAAA;IACjB,uCAA2B,CAAA;IAC3B,uCAA2B,CAAA;IAC3B,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,mDAAuC,CAAA;IACvC,qDAAyC,CAAA;IACzC,6CAAiC,CAAA;IACjC,mDAAuC,CAAA;IACvC,iDAAqC,CAAA;IACrC,yCAA6B,CAAA;IAC7B,qCAAyB,CAAA;IACzB,2DAA+C,CAAA;AACjD,CAAC,EAtBW,QAAQ,wBAAR,QAAQ,QAsBnB;AA4KD,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B,sFAA+D,CAAA;IAC/D,uEAAuE;IACvE,wDAAiC,CAAA;IACjC,6FAA6F;IAC7F,oCAAa,CAAA;IACb,2DAA2D;IAC3D,wCAAiB,CAAA;IACjB,4DAA4D;IAC5D,4CAAqB,CAAA;AACvB,CAAC,EAVW,mBAAmB,mCAAnB,mBAAmB,QAU9B;AAwBD,IAAY,QAQX;AARD,WAAY,QAAQ;IAClB,uDAAuD;IACvD,+BAAmB,CAAA;IACnB;;;OAGG;IACH,2BAAe,CAAA;AACjB,CAAC,EARW,QAAQ,wBAAR,QAAQ,QAQnB;AAoBD,yCAAyC;AACzC,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,mEAAmE;IACnE,8CAA+B,CAAA;AACjC,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAKD,2CAA2C;AAC3C,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mEAAmE;IACnE,yDAAuC,CAAA;AACzC,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAKD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,8GAA8G;IAC9G,+DAA+C,CAAA;IAC/C,0FAA0F;IAC1F,qDAAqC,CAAA;AACvC,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAqDD,IAAY,WAiCX;AAjCD,WAAY,WAAW;IACrB,8DAA8D;IAC9D,0CAA2B,CAAA;IAC3B,oBAAoB;IACpB,0BAAW,CAAA;IACX,oFAAoF;IACpF,0BAAW,CAAA;IACX,yGAAyG;IACzG,4BAAa,CAAA;IACb,6GAA6G;IAC7G,gCAAiB,CAAA;IACjB,4BAA4B;IAC5B,gDAAiC,CAAA;IACjC,kFAAkF;IAClF,8CAA+B,CAAA;IAC/B,mRAAmR;IACnR,4CAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAA2C,CAAA;IAC3C,0BAA0B;IAC1B,4BAAa,CAAA;IACb,oIAAoI;IACpI,wCAAyB,CAAA;IACzB,8BAA8B;IAC9B,oCAAqB,CAAA;IACrB,gGAAgG;IAChG,oCAAqB,CAAA;IACrB,kHAAkH;IAClH,4BAAa,CAAA;IACb,sHAAsH;IACtH,gCAAiB,CAAA;IACjB,6IAA6I;IAC7I,sCAAuB,CAAA;AACzB,CAAC,EAjCW,WAAW,2BAAX,WAAW,QAiCtB;AAkOD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|