@wix/auto_sdk_ecom_checkout 1.0.31 → 1.0.33
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-checkout-checkout.types.d.ts +102 -40
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +105 -43
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +102 -40
- package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +105 -43
- package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +102 -40
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +111 -44
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +102 -40
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +111 -44
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -60,7 +60,7 @@ export interface Checkout {
|
|
|
60
60
|
* Weight measurement unit. Defaults to a site's weight unit.
|
|
61
61
|
* @readonly
|
|
62
62
|
*/
|
|
63
|
-
weightUnit?:
|
|
63
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
64
64
|
/**
|
|
65
65
|
* Tax summary.
|
|
66
66
|
* @readonly
|
|
@@ -76,7 +76,7 @@ export interface Checkout {
|
|
|
76
76
|
* Sales channel that submitted the order.
|
|
77
77
|
* @readonly
|
|
78
78
|
*/
|
|
79
|
-
channelType?:
|
|
79
|
+
channelType?: ChannelTypeWithLiterals;
|
|
80
80
|
/**
|
|
81
81
|
* Site language in which original values are shown.
|
|
82
82
|
* @readonly
|
|
@@ -329,7 +329,7 @@ export interface LineItem {
|
|
|
329
329
|
* + `"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.
|
|
330
330
|
* @readonly
|
|
331
331
|
*/
|
|
332
|
-
paymentOption?:
|
|
332
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
333
333
|
/**
|
|
334
334
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
335
335
|
* @readonly
|
|
@@ -576,7 +576,7 @@ export interface TaxBreakdown {
|
|
|
576
576
|
*/
|
|
577
577
|
taxName?: string | null;
|
|
578
578
|
/** The type of the jurisdiction in which this tax detail applies. */
|
|
579
|
-
jurisdictionType?:
|
|
579
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
580
580
|
}
|
|
581
581
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
582
582
|
export declare enum JurisdictionType {
|
|
@@ -587,6 +587,8 @@ export declare enum JurisdictionType {
|
|
|
587
587
|
CITY = "CITY",
|
|
588
588
|
SPECIAL = "SPECIAL"
|
|
589
589
|
}
|
|
590
|
+
/** @enumType */
|
|
591
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
590
592
|
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
591
593
|
/** Description line plain text value. */
|
|
592
594
|
plainText?: PlainTextValue;
|
|
@@ -594,6 +596,11 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
594
596
|
colorInfo?: Color;
|
|
595
597
|
/** Description line name. */
|
|
596
598
|
name?: DescriptionLineName;
|
|
599
|
+
/**
|
|
600
|
+
* Whether the description line originates from a modifier.
|
|
601
|
+
* @internal
|
|
602
|
+
*/
|
|
603
|
+
modifierDescriptionLine?: boolean;
|
|
597
604
|
}
|
|
598
605
|
/** @oneof */
|
|
599
606
|
export interface DescriptionLineValueOneOf {
|
|
@@ -657,6 +664,8 @@ export declare enum DescriptionLineType {
|
|
|
657
664
|
/** Color type. */
|
|
658
665
|
COLOR = "COLOR"
|
|
659
666
|
}
|
|
667
|
+
/** @enumType */
|
|
668
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
660
669
|
export interface FocalPoint {
|
|
661
670
|
/** X-coordinate of the focal point. */
|
|
662
671
|
x?: number;
|
|
@@ -669,7 +678,7 @@ export interface FocalPoint {
|
|
|
669
678
|
}
|
|
670
679
|
export interface ItemAvailabilityInfo {
|
|
671
680
|
/** Item availability status. */
|
|
672
|
-
status?:
|
|
681
|
+
status?: ItemAvailabilityStatusWithLiterals;
|
|
673
682
|
/** Quantity available. */
|
|
674
683
|
quantityAvailable?: number | null;
|
|
675
684
|
}
|
|
@@ -682,6 +691,8 @@ export declare enum ItemAvailabilityStatus {
|
|
|
682
691
|
/** Available quantity is less than requested. */
|
|
683
692
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
684
693
|
}
|
|
694
|
+
/** @enumType */
|
|
695
|
+
export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
|
|
685
696
|
export interface PhysicalProperties {
|
|
686
697
|
/** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
|
|
687
698
|
weight?: number | null;
|
|
@@ -707,14 +718,14 @@ export interface Group {
|
|
|
707
718
|
}
|
|
708
719
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
709
720
|
/** Preset item type. */
|
|
710
|
-
preset?:
|
|
721
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
711
722
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
712
723
|
custom?: string;
|
|
713
724
|
}
|
|
714
725
|
/** @oneof */
|
|
715
726
|
export interface ItemTypeItemTypeDataOneOf {
|
|
716
727
|
/** Preset item type. */
|
|
717
|
-
preset?:
|
|
728
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
718
729
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
719
730
|
custom?: string;
|
|
720
731
|
}
|
|
@@ -725,6 +736,8 @@ export declare enum ItemTypeItemType {
|
|
|
725
736
|
GIFT_CARD = "GIFT_CARD",
|
|
726
737
|
SERVICE = "SERVICE"
|
|
727
738
|
}
|
|
739
|
+
/** @enumType */
|
|
740
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
728
741
|
export interface SubscriptionOptionInfo {
|
|
729
742
|
/** Subscription option settings. */
|
|
730
743
|
subscriptionSettings?: SubscriptionSettings;
|
|
@@ -735,7 +748,7 @@ export interface SubscriptionOptionInfo {
|
|
|
735
748
|
}
|
|
736
749
|
export interface SubscriptionSettings {
|
|
737
750
|
/** Frequency of recurring payment. */
|
|
738
|
-
frequency?:
|
|
751
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
739
752
|
/**
|
|
740
753
|
* Interval of recurring payment.
|
|
741
754
|
*
|
|
@@ -773,9 +786,11 @@ export declare enum SubscriptionFrequency {
|
|
|
773
786
|
MONTH = "MONTH",
|
|
774
787
|
YEAR = "YEAR"
|
|
775
788
|
}
|
|
789
|
+
/** @enumType */
|
|
790
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
776
791
|
export interface FreeTrialPeriod {
|
|
777
792
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
778
|
-
frequency?:
|
|
793
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
779
794
|
/**
|
|
780
795
|
* interval of period
|
|
781
796
|
* @min 1
|
|
@@ -825,7 +840,7 @@ export interface SecuredMedia {
|
|
|
825
840
|
*/
|
|
826
841
|
fileName?: string;
|
|
827
842
|
/** File type. */
|
|
828
|
-
fileType?:
|
|
843
|
+
fileType?: FileTypeWithLiterals;
|
|
829
844
|
}
|
|
830
845
|
export declare enum FileType {
|
|
831
846
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -835,6 +850,8 @@ export declare enum FileType {
|
|
|
835
850
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
836
851
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
837
852
|
}
|
|
853
|
+
/** @enumType */
|
|
854
|
+
export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
838
855
|
/** Type of selected payment option for catalog item */
|
|
839
856
|
export declare enum PaymentOptionType {
|
|
840
857
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -848,6 +865,8 @@ export declare enum PaymentOptionType {
|
|
|
848
865
|
/** 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`. */
|
|
849
866
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
850
867
|
}
|
|
868
|
+
/** @enumType */
|
|
869
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
851
870
|
export interface ServiceProperties {
|
|
852
871
|
/**
|
|
853
872
|
* 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.
|
|
@@ -920,16 +939,16 @@ export interface PaymentOption {
|
|
|
920
939
|
*
|
|
921
940
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
922
941
|
*/
|
|
923
|
-
value?:
|
|
942
|
+
value?: PaymentOptionTypeWithLiterals;
|
|
924
943
|
}
|
|
925
944
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
926
945
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
927
|
-
addressType?:
|
|
946
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
928
947
|
}
|
|
929
948
|
/** @oneof */
|
|
930
949
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
931
950
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
932
|
-
addressType?:
|
|
951
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
933
952
|
}
|
|
934
953
|
export declare enum TaxableAddressType {
|
|
935
954
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -937,6 +956,8 @@ export declare enum TaxableAddressType {
|
|
|
937
956
|
BILLING = "BILLING",
|
|
938
957
|
SHIPPING = "SHIPPING"
|
|
939
958
|
}
|
|
959
|
+
/** @enumType */
|
|
960
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
940
961
|
export interface ExtendedFields {
|
|
941
962
|
/**
|
|
942
963
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -1118,7 +1139,7 @@ export interface CommonVatId {
|
|
|
1118
1139
|
* + `CPF`: for individual tax payers
|
|
1119
1140
|
* + `CNPJ`: for corporations
|
|
1120
1141
|
*/
|
|
1121
|
-
type?:
|
|
1142
|
+
type?: CommonVatTypeWithLiterals;
|
|
1122
1143
|
}
|
|
1123
1144
|
/** tax info types */
|
|
1124
1145
|
export declare enum CommonVatType {
|
|
@@ -1128,6 +1149,8 @@ export declare enum CommonVatType {
|
|
|
1128
1149
|
/** CNPJ - for corporations */
|
|
1129
1150
|
CNPJ = "CNPJ"
|
|
1130
1151
|
}
|
|
1152
|
+
/** @enumType */
|
|
1153
|
+
export type CommonVatTypeWithLiterals = CommonVatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1131
1154
|
export interface ShippingInfo {
|
|
1132
1155
|
/** Shipping address and contact details. */
|
|
1133
1156
|
shippingDestination?: AddressWithContact;
|
|
@@ -1215,13 +1238,15 @@ export interface PickupDetails {
|
|
|
1215
1238
|
*/
|
|
1216
1239
|
businessLocation?: boolean;
|
|
1217
1240
|
/** Pickup method */
|
|
1218
|
-
pickupMethod?:
|
|
1241
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1219
1242
|
}
|
|
1220
1243
|
export declare enum PickupMethod {
|
|
1221
1244
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1222
1245
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1223
1246
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1224
1247
|
}
|
|
1248
|
+
/** @enumType */
|
|
1249
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1225
1250
|
export interface DeliveryTimeSlot {
|
|
1226
1251
|
/** starting time of the delivery time slot */
|
|
1227
1252
|
from?: Date | null;
|
|
@@ -1242,7 +1267,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1242
1267
|
}
|
|
1243
1268
|
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1244
1269
|
/** Type of additional cost. */
|
|
1245
|
-
type?:
|
|
1270
|
+
type?: ChargeTypeWithLiterals;
|
|
1246
1271
|
/**
|
|
1247
1272
|
* Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
|
|
1248
1273
|
* @maxLength 200
|
|
@@ -1255,6 +1280,8 @@ export declare enum ChargeType {
|
|
|
1255
1280
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1256
1281
|
INSURANCE = "INSURANCE"
|
|
1257
1282
|
}
|
|
1283
|
+
/** @enumType */
|
|
1284
|
+
export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
|
|
1258
1285
|
export interface DeliveryAllocation {
|
|
1259
1286
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1260
1287
|
deliveryCarrier?: Carrier;
|
|
@@ -1351,7 +1378,7 @@ export interface ShippingPrice {
|
|
|
1351
1378
|
}
|
|
1352
1379
|
export interface OtherCharge {
|
|
1353
1380
|
/** Type of additional cost. */
|
|
1354
|
-
type?:
|
|
1381
|
+
type?: ChargeTypeWithLiterals;
|
|
1355
1382
|
/** Price of added cost. */
|
|
1356
1383
|
price?: MultiCurrencyPrice;
|
|
1357
1384
|
/**
|
|
@@ -1524,10 +1551,12 @@ export declare enum RuleType {
|
|
|
1524
1551
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1525
1552
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1526
1553
|
}
|
|
1554
|
+
/** @enumType */
|
|
1555
|
+
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';
|
|
1527
1556
|
export interface FieldViolation {
|
|
1528
1557
|
field?: string;
|
|
1529
1558
|
description?: string;
|
|
1530
|
-
violatedRule?:
|
|
1559
|
+
violatedRule?: RuleTypeWithLiterals;
|
|
1531
1560
|
/** applicable when violated_rule=OTHER */
|
|
1532
1561
|
ruleName?: string | null;
|
|
1533
1562
|
data?: Record<string, any> | null;
|
|
@@ -1577,7 +1606,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1577
1606
|
/** Discount rule */
|
|
1578
1607
|
discountRule?: DiscountRule;
|
|
1579
1608
|
/** Discount type. */
|
|
1580
|
-
discountType?:
|
|
1609
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1581
1610
|
/**
|
|
1582
1611
|
* IDs of the line items the discount applies to.
|
|
1583
1612
|
* @format GUID
|
|
@@ -1609,6 +1638,8 @@ export declare enum DiscountType {
|
|
|
1609
1638
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1610
1639
|
SHIPPING = "SHIPPING"
|
|
1611
1640
|
}
|
|
1641
|
+
/** @enumType */
|
|
1642
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1612
1643
|
/** Coupon */
|
|
1613
1644
|
export interface Coupon {
|
|
1614
1645
|
/** Coupon ID. */
|
|
@@ -1688,6 +1719,8 @@ export declare enum WeightUnit {
|
|
|
1688
1719
|
/** Pounds. */
|
|
1689
1720
|
LB = "LB"
|
|
1690
1721
|
}
|
|
1722
|
+
/** @enumType */
|
|
1723
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1691
1724
|
export interface TaxSummary {
|
|
1692
1725
|
/**
|
|
1693
1726
|
* Amount for which tax is calculated, added from line items.
|
|
@@ -1707,16 +1740,16 @@ export interface TaxSummary {
|
|
|
1707
1740
|
}
|
|
1708
1741
|
export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1709
1742
|
/** Reason the manual calculation was used. */
|
|
1710
|
-
manualRateReason?:
|
|
1743
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1711
1744
|
/** Details of the fallback rate calculation. */
|
|
1712
1745
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1713
1746
|
/** Rate calculation type. */
|
|
1714
|
-
rateType?:
|
|
1747
|
+
rateType?: RateTypeWithLiterals;
|
|
1715
1748
|
}
|
|
1716
1749
|
/** @oneof */
|
|
1717
1750
|
export interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1718
1751
|
/** Reason the manual calculation was used. */
|
|
1719
|
-
manualRateReason?:
|
|
1752
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1720
1753
|
/** Details of the fallback rate calculation. */
|
|
1721
1754
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1722
1755
|
}
|
|
@@ -1730,15 +1763,19 @@ export declare enum RateType {
|
|
|
1730
1763
|
/** fallback rate used for calculation */
|
|
1731
1764
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1732
1765
|
}
|
|
1766
|
+
/** @enumType */
|
|
1767
|
+
export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
|
|
1733
1768
|
export declare enum ManualCalculationReason {
|
|
1734
1769
|
/** user set calculator in Business Manager to be Manual */
|
|
1735
1770
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1736
1771
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1737
1772
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1738
1773
|
}
|
|
1774
|
+
/** @enumType */
|
|
1775
|
+
export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
|
|
1739
1776
|
export interface AutoTaxFallbackCalculationDetails {
|
|
1740
1777
|
/** reason for fallback */
|
|
1741
|
-
fallbackReason?:
|
|
1778
|
+
fallbackReason?: FallbackReasonWithLiterals;
|
|
1742
1779
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1743
1780
|
error?: ApplicationError;
|
|
1744
1781
|
}
|
|
@@ -1748,6 +1785,8 @@ export declare enum FallbackReason {
|
|
|
1748
1785
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
1749
1786
|
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
1750
1787
|
}
|
|
1788
|
+
/** @enumType */
|
|
1789
|
+
export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
|
|
1751
1790
|
/**
|
|
1752
1791
|
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
1753
1792
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
@@ -1769,7 +1808,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
1769
1808
|
*/
|
|
1770
1809
|
jurisdiction?: string;
|
|
1771
1810
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1772
|
-
jurisdictionTypeEnum?:
|
|
1811
|
+
jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
|
|
1773
1812
|
/**
|
|
1774
1813
|
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
|
|
1775
1814
|
* @decimalValue options { gte:0, maxScale:6 }
|
|
@@ -1812,6 +1851,8 @@ export declare enum ChannelType {
|
|
|
1812
1851
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1813
1852
|
FAIRE_COM = "FAIRE_COM"
|
|
1814
1853
|
}
|
|
1854
|
+
/** @enumType */
|
|
1855
|
+
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';
|
|
1815
1856
|
export interface CreatedBy extends CreatedByIdOneOf {
|
|
1816
1857
|
/**
|
|
1817
1858
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
@@ -2006,7 +2047,7 @@ export interface AdditionalFee {
|
|
|
2006
2047
|
*/
|
|
2007
2048
|
subscriptionCycles?: number | null;
|
|
2008
2049
|
/** the source the additional fee was added from */
|
|
2009
|
-
source?:
|
|
2050
|
+
source?: AdditionalFeeSourceWithLiterals;
|
|
2010
2051
|
}
|
|
2011
2052
|
export declare enum AdditionalFeeSource {
|
|
2012
2053
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
@@ -2019,6 +2060,8 @@ export declare enum AdditionalFeeSource {
|
|
|
2019
2060
|
/** The additional fee was added by the shipping provider */
|
|
2020
2061
|
SHIPPING = "SHIPPING"
|
|
2021
2062
|
}
|
|
2063
|
+
/** @enumType */
|
|
2064
|
+
export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
|
|
2022
2065
|
export interface ConversionInfo {
|
|
2023
2066
|
/**
|
|
2024
2067
|
* The site currency.
|
|
@@ -2035,7 +2078,7 @@ export interface ConversionInfo {
|
|
|
2035
2078
|
}
|
|
2036
2079
|
export interface Violation {
|
|
2037
2080
|
/** 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. */
|
|
2038
|
-
severity?:
|
|
2081
|
+
severity?: SeverityWithLiterals;
|
|
2039
2082
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
2040
2083
|
target?: Target;
|
|
2041
2084
|
/**
|
|
@@ -2054,6 +2097,8 @@ export declare enum Severity {
|
|
|
2054
2097
|
*/
|
|
2055
2098
|
ERROR = "ERROR"
|
|
2056
2099
|
}
|
|
2100
|
+
/** @enumType */
|
|
2101
|
+
export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
|
|
2057
2102
|
export interface Target extends TargetTargetTypeOneOf {
|
|
2058
2103
|
/** General (other) violation. */
|
|
2059
2104
|
other?: Other;
|
|
@@ -2072,33 +2117,39 @@ export declare enum NameInOther {
|
|
|
2072
2117
|
/** Default location, in case no specific location is specified. */
|
|
2073
2118
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
2074
2119
|
}
|
|
2120
|
+
/** @enumType */
|
|
2121
|
+
export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
|
|
2075
2122
|
/** Available locations on the line item */
|
|
2076
2123
|
export declare enum NameInLineItem {
|
|
2077
2124
|
/** Default location, in case no specific location is specified. */
|
|
2078
2125
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
2079
2126
|
}
|
|
2127
|
+
/** @enumType */
|
|
2128
|
+
export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
|
|
2080
2129
|
export declare enum SuggestedFix {
|
|
2081
2130
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
2082
2131
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
2083
2132
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
2084
2133
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
2085
2134
|
}
|
|
2135
|
+
/** @enumType */
|
|
2136
|
+
export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
|
|
2086
2137
|
/** General (other) violation. */
|
|
2087
2138
|
export interface Other {
|
|
2088
2139
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
2089
|
-
name?:
|
|
2140
|
+
name?: NameInOtherWithLiterals;
|
|
2090
2141
|
}
|
|
2091
2142
|
/** Specific line item violation. */
|
|
2092
2143
|
export interface TargetLineItem {
|
|
2093
2144
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
2094
|
-
name?:
|
|
2145
|
+
name?: NameInLineItemWithLiterals;
|
|
2095
2146
|
/** ID of the line item containing the violation. */
|
|
2096
2147
|
_id?: string | null;
|
|
2097
2148
|
/**
|
|
2098
2149
|
* Suggested fix for resolving the line item violation.
|
|
2099
2150
|
* @internal
|
|
2100
2151
|
*/
|
|
2101
|
-
suggestedFix?:
|
|
2152
|
+
suggestedFix?: SuggestedFixWithLiterals;
|
|
2102
2153
|
}
|
|
2103
2154
|
export interface CustomSettings {
|
|
2104
2155
|
/**
|
|
@@ -2214,7 +2265,7 @@ export interface CreateCheckoutRequest {
|
|
|
2214
2265
|
*/
|
|
2215
2266
|
customLineItems?: CustomLineItem[];
|
|
2216
2267
|
/** Sales channel that submitted the order. */
|
|
2217
|
-
channelType:
|
|
2268
|
+
channelType: ChannelTypeWithLiterals;
|
|
2218
2269
|
/**
|
|
2219
2270
|
* Gift card code.
|
|
2220
2271
|
*
|
|
@@ -2299,7 +2350,7 @@ export interface CustomLineItem {
|
|
|
2299
2350
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
2300
2351
|
* + `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.
|
|
2301
2352
|
*/
|
|
2302
|
-
paymentOption?:
|
|
2353
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
2303
2354
|
/**
|
|
2304
2355
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
2305
2356
|
* Used, among other things, when checking for valid memberships.
|
|
@@ -2815,12 +2866,14 @@ export interface GetCheckoutPaymentSettingsRequest {
|
|
|
2815
2866
|
_id: string;
|
|
2816
2867
|
}
|
|
2817
2868
|
export interface GetCheckoutPaymentSettingsResponse {
|
|
2818
|
-
blockedPaymentOptions?:
|
|
2869
|
+
blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals[];
|
|
2819
2870
|
}
|
|
2820
2871
|
export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2821
2872
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
2822
2873
|
MANUAL = "MANUAL"
|
|
2823
2874
|
}
|
|
2875
|
+
/** @enumType */
|
|
2876
|
+
export type GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals = GetCheckoutPaymentSettingsResponsePaymentOption | 'UNKNOWN_PAYMENT_OPTION' | 'MANUAL';
|
|
2824
2877
|
export interface DeleteCheckoutRequest {
|
|
2825
2878
|
/**
|
|
2826
2879
|
* ID of the checkout to delete.
|
|
@@ -2904,7 +2957,7 @@ export interface V1BuyerInfo {
|
|
|
2904
2957
|
*/
|
|
2905
2958
|
_id?: string;
|
|
2906
2959
|
/** Customer type */
|
|
2907
|
-
identityType?:
|
|
2960
|
+
identityType?: IdentityTypeWithLiterals;
|
|
2908
2961
|
}
|
|
2909
2962
|
export declare enum IdentityType {
|
|
2910
2963
|
UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
|
|
@@ -2913,6 +2966,8 @@ export declare enum IdentityType {
|
|
|
2913
2966
|
/** Contact */
|
|
2914
2967
|
CONTACT = "CONTACT"
|
|
2915
2968
|
}
|
|
2969
|
+
/** @enumType */
|
|
2970
|
+
export type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
|
|
2916
2971
|
export interface V1LineItem {
|
|
2917
2972
|
/** Line item ID (auto-generated) */
|
|
2918
2973
|
index?: number;
|
|
@@ -3014,7 +3069,7 @@ export interface ProductDetails {
|
|
|
3014
3069
|
*/
|
|
3015
3070
|
translatedName?: string | null;
|
|
3016
3071
|
/** Line item type (may be extended) */
|
|
3017
|
-
lineItemType?:
|
|
3072
|
+
lineItemType?: LineItemTypeWithLiterals;
|
|
3018
3073
|
/** Line item primary media for preview */
|
|
3019
3074
|
mediaItem?: MediaItem;
|
|
3020
3075
|
/**
|
|
@@ -3058,12 +3113,14 @@ export declare enum LineItemType {
|
|
|
3058
3113
|
/** Custom item price */
|
|
3059
3114
|
CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
|
|
3060
3115
|
}
|
|
3116
|
+
/** @enumType */
|
|
3117
|
+
export type LineItemTypeWithLiterals = LineItemType | 'UNSPECIFIED_LINE_ITEM_TYPE' | 'PHYSICAL' | 'DIGITAL' | 'CUSTOM_AMOUNT_ITEM';
|
|
3061
3118
|
export interface MediaItem {
|
|
3062
3119
|
/**
|
|
3063
3120
|
* Media type
|
|
3064
3121
|
* @readonly
|
|
3065
3122
|
*/
|
|
3066
|
-
mediaType?:
|
|
3123
|
+
mediaType?: MediaItemTypeWithLiterals;
|
|
3067
3124
|
/**
|
|
3068
3125
|
* Media URL
|
|
3069
3126
|
* @format WEB_URL
|
|
@@ -3098,6 +3155,8 @@ export declare enum MediaItemType {
|
|
|
3098
3155
|
/** Image item type */
|
|
3099
3156
|
IMAGE = "IMAGE"
|
|
3100
3157
|
}
|
|
3158
|
+
/** @enumType */
|
|
3159
|
+
export type MediaItemTypeWithLiterals = MediaItemType | 'UNSPECIFIED_MEDIA_TYPE_ITEM' | 'IMAGE';
|
|
3101
3160
|
export interface Totals {
|
|
3102
3161
|
/**
|
|
3103
3162
|
* Subtotal of all line items, before tax
|
|
@@ -3143,7 +3202,7 @@ export interface StoreSettings {
|
|
|
3143
3202
|
*/
|
|
3144
3203
|
currency?: string | null;
|
|
3145
3204
|
/** Weight unit used in this store */
|
|
3146
|
-
weightUnit?:
|
|
3205
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
3147
3206
|
/**
|
|
3148
3207
|
* The language to be used when communicating with the buyer
|
|
3149
3208
|
* For a site that support multiple languages, this would be the language the buyer selected
|
|
@@ -3251,7 +3310,7 @@ export interface VatId {
|
|
|
3251
3310
|
* + `CPF`: For individual tax payers.
|
|
3252
3311
|
* + `CNPJ`: For corporations.
|
|
3253
3312
|
*/
|
|
3254
|
-
type?:
|
|
3313
|
+
type?: VatTypeWithLiterals;
|
|
3255
3314
|
}
|
|
3256
3315
|
/** Brazilian tax info types */
|
|
3257
3316
|
export declare enum VatType {
|
|
@@ -3262,6 +3321,8 @@ export declare enum VatType {
|
|
|
3262
3321
|
/** CNPJ - for corporations */
|
|
3263
3322
|
CNPJ = "CNPJ"
|
|
3264
3323
|
}
|
|
3324
|
+
/** @enumType */
|
|
3325
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED_TAX_TYPE' | 'CPF' | 'CNPJ';
|
|
3265
3326
|
export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3266
3327
|
/** Shipment details (when this object describes shipment) */
|
|
3267
3328
|
shipmentDetails?: ShipmentDetails;
|
|
@@ -3388,7 +3449,7 @@ export interface V1SubscriptionOptionInfo {
|
|
|
3388
3449
|
}
|
|
3389
3450
|
export interface Discount {
|
|
3390
3451
|
/** Discount type. */
|
|
3391
|
-
type?:
|
|
3452
|
+
type?: DiscountDiscountTypeWithLiterals;
|
|
3392
3453
|
/** Discount value. */
|
|
3393
3454
|
value?: number;
|
|
3394
3455
|
}
|
|
@@ -3398,9 +3459,11 @@ export declare enum DiscountDiscountType {
|
|
|
3398
3459
|
AMOUNT = "AMOUNT",
|
|
3399
3460
|
PERCENT = "PERCENT"
|
|
3400
3461
|
}
|
|
3462
|
+
/** @enumType */
|
|
3463
|
+
export type DiscountDiscountTypeWithLiterals = DiscountDiscountType | 'UNDEFINED' | 'AMOUNT' | 'PERCENT';
|
|
3401
3464
|
export interface ChannelInfo {
|
|
3402
3465
|
/** Sales channel that submitted the subscription */
|
|
3403
|
-
type?:
|
|
3466
|
+
type?: ChannelInfoChannelTypeWithLiterals;
|
|
3404
3467
|
}
|
|
3405
3468
|
export declare enum ChannelInfoChannelType {
|
|
3406
3469
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -3408,9 +3471,11 @@ export declare enum ChannelInfoChannelType {
|
|
|
3408
3471
|
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
3409
3472
|
WIX_APP_STORE = "WIX_APP_STORE"
|
|
3410
3473
|
}
|
|
3474
|
+
/** @enumType */
|
|
3475
|
+
export type ChannelInfoChannelTypeWithLiterals = ChannelInfoChannelType | 'UNSPECIFIED' | 'WEB' | 'OTHER_PLATFORM' | 'WIX_APP_STORE';
|
|
3411
3476
|
export interface V1SubscriptionSettings {
|
|
3412
3477
|
/** Frequency of recurring payment. */
|
|
3413
|
-
frequency?:
|
|
3478
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
3414
3479
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
3415
3480
|
autoRenewal?: boolean;
|
|
3416
3481
|
/**
|
|
@@ -3539,7 +3604,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3539
3604
|
*/
|
|
3540
3605
|
appId?: string;
|
|
3541
3606
|
/** @readonly */
|
|
3542
|
-
identityType?:
|
|
3607
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3543
3608
|
}
|
|
3544
3609
|
/** @oneof */
|
|
3545
3610
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3571,6 +3636,8 @@ export declare enum WebhookIdentityType {
|
|
|
3571
3636
|
WIX_USER = "WIX_USER",
|
|
3572
3637
|
APP = "APP"
|
|
3573
3638
|
}
|
|
3639
|
+
/** @enumType */
|
|
3640
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3574
3641
|
export interface BaseEventMetadata {
|
|
3575
3642
|
/**
|
|
3576
3643
|
* App instance ID.
|
|
@@ -3779,7 +3846,7 @@ export interface CreateCheckoutOptions {
|
|
|
3779
3846
|
*/
|
|
3780
3847
|
customLineItems?: CustomLineItem[];
|
|
3781
3848
|
/** Sales channel that submitted the order. */
|
|
3782
|
-
channelType:
|
|
3849
|
+
channelType: ChannelTypeWithLiterals;
|
|
3783
3850
|
/**
|
|
3784
3851
|
* Gift card code.
|
|
3785
3852
|
*
|
|
@@ -4030,7 +4097,7 @@ export interface UpdateCheckout {
|
|
|
4030
4097
|
* Weight measurement unit. Defaults to a site's weight unit.
|
|
4031
4098
|
* @readonly
|
|
4032
4099
|
*/
|
|
4033
|
-
weightUnit?:
|
|
4100
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
4034
4101
|
/**
|
|
4035
4102
|
* Tax summary.
|
|
4036
4103
|
* @readonly
|
|
@@ -4046,7 +4113,7 @@ export interface UpdateCheckout {
|
|
|
4046
4113
|
* Sales channel that submitted the order.
|
|
4047
4114
|
* @readonly
|
|
4048
4115
|
*/
|
|
4049
|
-
channelType?:
|
|
4116
|
+
channelType?: ChannelTypeWithLiterals;
|
|
4050
4117
|
/**
|
|
4051
4118
|
* Site language in which original values are shown.
|
|
4052
4119
|
* @readonly
|