@wix/auto_sdk_ecom_checkout 1.0.30 → 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-checkout-checkout.types.d.ts +103 -41
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +107 -45
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +103 -41
- package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +107 -45
- 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 +103 -41
- 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 +108 -46
- 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 +103 -41
- 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 +108 -46
- 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
|
|
@@ -214,7 +214,7 @@ export interface Checkout {
|
|
|
214
214
|
*/
|
|
215
215
|
subscriptionCharges?: SubscriptionCharges[];
|
|
216
216
|
/**
|
|
217
|
-
* Currency used for payment, in three-letter [ISO-4217 alphabetic
|
|
217
|
+
* Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
218
218
|
* @readonly
|
|
219
219
|
* @format CURRENCY
|
|
220
220
|
*/
|
|
@@ -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;
|
|
@@ -657,6 +659,8 @@ export declare enum DescriptionLineType {
|
|
|
657
659
|
/** Color type. */
|
|
658
660
|
COLOR = "COLOR"
|
|
659
661
|
}
|
|
662
|
+
/** @enumType */
|
|
663
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
660
664
|
export interface FocalPoint {
|
|
661
665
|
/** X-coordinate of the focal point. */
|
|
662
666
|
x?: number;
|
|
@@ -669,7 +673,7 @@ export interface FocalPoint {
|
|
|
669
673
|
}
|
|
670
674
|
export interface ItemAvailabilityInfo {
|
|
671
675
|
/** Item availability status. */
|
|
672
|
-
status?:
|
|
676
|
+
status?: ItemAvailabilityStatusWithLiterals;
|
|
673
677
|
/** Quantity available. */
|
|
674
678
|
quantityAvailable?: number | null;
|
|
675
679
|
}
|
|
@@ -682,6 +686,8 @@ export declare enum ItemAvailabilityStatus {
|
|
|
682
686
|
/** Available quantity is less than requested. */
|
|
683
687
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
684
688
|
}
|
|
689
|
+
/** @enumType */
|
|
690
|
+
export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
|
|
685
691
|
export interface PhysicalProperties {
|
|
686
692
|
/** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
|
|
687
693
|
weight?: number | null;
|
|
@@ -707,14 +713,14 @@ export interface Group {
|
|
|
707
713
|
}
|
|
708
714
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
709
715
|
/** Preset item type. */
|
|
710
|
-
preset?:
|
|
716
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
711
717
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
712
718
|
custom?: string;
|
|
713
719
|
}
|
|
714
720
|
/** @oneof */
|
|
715
721
|
export interface ItemTypeItemTypeDataOneOf {
|
|
716
722
|
/** Preset item type. */
|
|
717
|
-
preset?:
|
|
723
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
718
724
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
719
725
|
custom?: string;
|
|
720
726
|
}
|
|
@@ -725,6 +731,8 @@ export declare enum ItemTypeItemType {
|
|
|
725
731
|
GIFT_CARD = "GIFT_CARD",
|
|
726
732
|
SERVICE = "SERVICE"
|
|
727
733
|
}
|
|
734
|
+
/** @enumType */
|
|
735
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
728
736
|
export interface SubscriptionOptionInfo {
|
|
729
737
|
/** Subscription option settings. */
|
|
730
738
|
subscriptionSettings?: SubscriptionSettings;
|
|
@@ -735,7 +743,7 @@ export interface SubscriptionOptionInfo {
|
|
|
735
743
|
}
|
|
736
744
|
export interface SubscriptionSettings {
|
|
737
745
|
/** Frequency of recurring payment. */
|
|
738
|
-
frequency?:
|
|
746
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
739
747
|
/**
|
|
740
748
|
* Interval of recurring payment.
|
|
741
749
|
*
|
|
@@ -773,9 +781,11 @@ export declare enum SubscriptionFrequency {
|
|
|
773
781
|
MONTH = "MONTH",
|
|
774
782
|
YEAR = "YEAR"
|
|
775
783
|
}
|
|
784
|
+
/** @enumType */
|
|
785
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
776
786
|
export interface FreeTrialPeriod {
|
|
777
787
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
778
|
-
frequency?:
|
|
788
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
779
789
|
/**
|
|
780
790
|
* interval of period
|
|
781
791
|
* @min 1
|
|
@@ -825,7 +835,7 @@ export interface SecuredMedia {
|
|
|
825
835
|
*/
|
|
826
836
|
fileName?: string;
|
|
827
837
|
/** File type. */
|
|
828
|
-
fileType?:
|
|
838
|
+
fileType?: FileTypeWithLiterals;
|
|
829
839
|
}
|
|
830
840
|
export declare enum FileType {
|
|
831
841
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -835,6 +845,8 @@ export declare enum FileType {
|
|
|
835
845
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
836
846
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
837
847
|
}
|
|
848
|
+
/** @enumType */
|
|
849
|
+
export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
838
850
|
/** Type of selected payment option for catalog item */
|
|
839
851
|
export declare enum PaymentOptionType {
|
|
840
852
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -848,6 +860,8 @@ export declare enum PaymentOptionType {
|
|
|
848
860
|
/** 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
861
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
850
862
|
}
|
|
863
|
+
/** @enumType */
|
|
864
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
851
865
|
export interface ServiceProperties {
|
|
852
866
|
/**
|
|
853
867
|
* 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 +934,16 @@ export interface PaymentOption {
|
|
|
920
934
|
*
|
|
921
935
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
922
936
|
*/
|
|
923
|
-
value?:
|
|
937
|
+
value?: PaymentOptionTypeWithLiterals;
|
|
924
938
|
}
|
|
925
939
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
926
940
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
927
|
-
addressType?:
|
|
941
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
928
942
|
}
|
|
929
943
|
/** @oneof */
|
|
930
944
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
931
945
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
932
|
-
addressType?:
|
|
946
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
933
947
|
}
|
|
934
948
|
export declare enum TaxableAddressType {
|
|
935
949
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -937,6 +951,8 @@ export declare enum TaxableAddressType {
|
|
|
937
951
|
BILLING = "BILLING",
|
|
938
952
|
SHIPPING = "SHIPPING"
|
|
939
953
|
}
|
|
954
|
+
/** @enumType */
|
|
955
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
940
956
|
export interface ExtendedFields {
|
|
941
957
|
/**
|
|
942
958
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -1118,7 +1134,7 @@ export interface CommonVatId {
|
|
|
1118
1134
|
* + `CPF`: for individual tax payers
|
|
1119
1135
|
* + `CNPJ`: for corporations
|
|
1120
1136
|
*/
|
|
1121
|
-
type?:
|
|
1137
|
+
type?: CommonVatTypeWithLiterals;
|
|
1122
1138
|
}
|
|
1123
1139
|
/** tax info types */
|
|
1124
1140
|
export declare enum CommonVatType {
|
|
@@ -1128,6 +1144,8 @@ export declare enum CommonVatType {
|
|
|
1128
1144
|
/** CNPJ - for corporations */
|
|
1129
1145
|
CNPJ = "CNPJ"
|
|
1130
1146
|
}
|
|
1147
|
+
/** @enumType */
|
|
1148
|
+
export type CommonVatTypeWithLiterals = CommonVatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1131
1149
|
export interface ShippingInfo {
|
|
1132
1150
|
/** Shipping address and contact details. */
|
|
1133
1151
|
shippingDestination?: AddressWithContact;
|
|
@@ -1215,13 +1233,15 @@ export interface PickupDetails {
|
|
|
1215
1233
|
*/
|
|
1216
1234
|
businessLocation?: boolean;
|
|
1217
1235
|
/** Pickup method */
|
|
1218
|
-
pickupMethod?:
|
|
1236
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1219
1237
|
}
|
|
1220
1238
|
export declare enum PickupMethod {
|
|
1221
1239
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1222
1240
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1223
1241
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1224
1242
|
}
|
|
1243
|
+
/** @enumType */
|
|
1244
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1225
1245
|
export interface DeliveryTimeSlot {
|
|
1226
1246
|
/** starting time of the delivery time slot */
|
|
1227
1247
|
from?: Date | null;
|
|
@@ -1242,7 +1262,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1242
1262
|
}
|
|
1243
1263
|
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1244
1264
|
/** Type of additional cost. */
|
|
1245
|
-
type?:
|
|
1265
|
+
type?: ChargeTypeWithLiterals;
|
|
1246
1266
|
/**
|
|
1247
1267
|
* Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
|
|
1248
1268
|
* @maxLength 200
|
|
@@ -1255,6 +1275,8 @@ export declare enum ChargeType {
|
|
|
1255
1275
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1256
1276
|
INSURANCE = "INSURANCE"
|
|
1257
1277
|
}
|
|
1278
|
+
/** @enumType */
|
|
1279
|
+
export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
|
|
1258
1280
|
export interface DeliveryAllocation {
|
|
1259
1281
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1260
1282
|
deliveryCarrier?: Carrier;
|
|
@@ -1351,7 +1373,7 @@ export interface ShippingPrice {
|
|
|
1351
1373
|
}
|
|
1352
1374
|
export interface OtherCharge {
|
|
1353
1375
|
/** Type of additional cost. */
|
|
1354
|
-
type?:
|
|
1376
|
+
type?: ChargeTypeWithLiterals;
|
|
1355
1377
|
/** Price of added cost. */
|
|
1356
1378
|
price?: MultiCurrencyPrice;
|
|
1357
1379
|
/**
|
|
@@ -1524,10 +1546,12 @@ export declare enum RuleType {
|
|
|
1524
1546
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1525
1547
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1526
1548
|
}
|
|
1549
|
+
/** @enumType */
|
|
1550
|
+
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
1551
|
export interface FieldViolation {
|
|
1528
1552
|
field?: string;
|
|
1529
1553
|
description?: string;
|
|
1530
|
-
violatedRule?:
|
|
1554
|
+
violatedRule?: RuleTypeWithLiterals;
|
|
1531
1555
|
/** applicable when violated_rule=OTHER */
|
|
1532
1556
|
ruleName?: string | null;
|
|
1533
1557
|
data?: Record<string, any> | null;
|
|
@@ -1577,7 +1601,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1577
1601
|
/** Discount rule */
|
|
1578
1602
|
discountRule?: DiscountRule;
|
|
1579
1603
|
/** Discount type. */
|
|
1580
|
-
discountType?:
|
|
1604
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1581
1605
|
/**
|
|
1582
1606
|
* IDs of the line items the discount applies to.
|
|
1583
1607
|
* @format GUID
|
|
@@ -1609,6 +1633,8 @@ export declare enum DiscountType {
|
|
|
1609
1633
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1610
1634
|
SHIPPING = "SHIPPING"
|
|
1611
1635
|
}
|
|
1636
|
+
/** @enumType */
|
|
1637
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1612
1638
|
/** Coupon */
|
|
1613
1639
|
export interface Coupon {
|
|
1614
1640
|
/** Coupon ID. */
|
|
@@ -1688,6 +1714,8 @@ export declare enum WeightUnit {
|
|
|
1688
1714
|
/** Pounds. */
|
|
1689
1715
|
LB = "LB"
|
|
1690
1716
|
}
|
|
1717
|
+
/** @enumType */
|
|
1718
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1691
1719
|
export interface TaxSummary {
|
|
1692
1720
|
/**
|
|
1693
1721
|
* Amount for which tax is calculated, added from line items.
|
|
@@ -1707,16 +1735,16 @@ export interface TaxSummary {
|
|
|
1707
1735
|
}
|
|
1708
1736
|
export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1709
1737
|
/** Reason the manual calculation was used. */
|
|
1710
|
-
manualRateReason?:
|
|
1738
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1711
1739
|
/** Details of the fallback rate calculation. */
|
|
1712
1740
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1713
1741
|
/** Rate calculation type. */
|
|
1714
|
-
rateType?:
|
|
1742
|
+
rateType?: RateTypeWithLiterals;
|
|
1715
1743
|
}
|
|
1716
1744
|
/** @oneof */
|
|
1717
1745
|
export interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1718
1746
|
/** Reason the manual calculation was used. */
|
|
1719
|
-
manualRateReason?:
|
|
1747
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1720
1748
|
/** Details of the fallback rate calculation. */
|
|
1721
1749
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1722
1750
|
}
|
|
@@ -1730,15 +1758,19 @@ export declare enum RateType {
|
|
|
1730
1758
|
/** fallback rate used for calculation */
|
|
1731
1759
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1732
1760
|
}
|
|
1761
|
+
/** @enumType */
|
|
1762
|
+
export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
|
|
1733
1763
|
export declare enum ManualCalculationReason {
|
|
1734
1764
|
/** user set calculator in Business Manager to be Manual */
|
|
1735
1765
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1736
1766
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1737
1767
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1738
1768
|
}
|
|
1769
|
+
/** @enumType */
|
|
1770
|
+
export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
|
|
1739
1771
|
export interface AutoTaxFallbackCalculationDetails {
|
|
1740
1772
|
/** reason for fallback */
|
|
1741
|
-
fallbackReason?:
|
|
1773
|
+
fallbackReason?: FallbackReasonWithLiterals;
|
|
1742
1774
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1743
1775
|
error?: ApplicationError;
|
|
1744
1776
|
}
|
|
@@ -1748,6 +1780,8 @@ export declare enum FallbackReason {
|
|
|
1748
1780
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
1749
1781
|
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
1750
1782
|
}
|
|
1783
|
+
/** @enumType */
|
|
1784
|
+
export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
|
|
1751
1785
|
/**
|
|
1752
1786
|
* 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
1787
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
@@ -1769,7 +1803,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
1769
1803
|
*/
|
|
1770
1804
|
jurisdiction?: string;
|
|
1771
1805
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1772
|
-
jurisdictionTypeEnum?:
|
|
1806
|
+
jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
|
|
1773
1807
|
/**
|
|
1774
1808
|
* 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
1809
|
* @decimalValue options { gte:0, maxScale:6 }
|
|
@@ -1812,6 +1846,8 @@ export declare enum ChannelType {
|
|
|
1812
1846
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1813
1847
|
FAIRE_COM = "FAIRE_COM"
|
|
1814
1848
|
}
|
|
1849
|
+
/** @enumType */
|
|
1850
|
+
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
1851
|
export interface CreatedBy extends CreatedByIdOneOf {
|
|
1816
1852
|
/**
|
|
1817
1853
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
@@ -2006,7 +2042,7 @@ export interface AdditionalFee {
|
|
|
2006
2042
|
*/
|
|
2007
2043
|
subscriptionCycles?: number | null;
|
|
2008
2044
|
/** the source the additional fee was added from */
|
|
2009
|
-
source?:
|
|
2045
|
+
source?: AdditionalFeeSourceWithLiterals;
|
|
2010
2046
|
}
|
|
2011
2047
|
export declare enum AdditionalFeeSource {
|
|
2012
2048
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
@@ -2019,6 +2055,8 @@ export declare enum AdditionalFeeSource {
|
|
|
2019
2055
|
/** The additional fee was added by the shipping provider */
|
|
2020
2056
|
SHIPPING = "SHIPPING"
|
|
2021
2057
|
}
|
|
2058
|
+
/** @enumType */
|
|
2059
|
+
export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
|
|
2022
2060
|
export interface ConversionInfo {
|
|
2023
2061
|
/**
|
|
2024
2062
|
* The site currency.
|
|
@@ -2035,7 +2073,7 @@ export interface ConversionInfo {
|
|
|
2035
2073
|
}
|
|
2036
2074
|
export interface Violation {
|
|
2037
2075
|
/** 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?:
|
|
2076
|
+
severity?: SeverityWithLiterals;
|
|
2039
2077
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
2040
2078
|
target?: Target;
|
|
2041
2079
|
/**
|
|
@@ -2054,6 +2092,8 @@ export declare enum Severity {
|
|
|
2054
2092
|
*/
|
|
2055
2093
|
ERROR = "ERROR"
|
|
2056
2094
|
}
|
|
2095
|
+
/** @enumType */
|
|
2096
|
+
export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
|
|
2057
2097
|
export interface Target extends TargetTargetTypeOneOf {
|
|
2058
2098
|
/** General (other) violation. */
|
|
2059
2099
|
other?: Other;
|
|
@@ -2072,33 +2112,39 @@ export declare enum NameInOther {
|
|
|
2072
2112
|
/** Default location, in case no specific location is specified. */
|
|
2073
2113
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
2074
2114
|
}
|
|
2115
|
+
/** @enumType */
|
|
2116
|
+
export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
|
|
2075
2117
|
/** Available locations on the line item */
|
|
2076
2118
|
export declare enum NameInLineItem {
|
|
2077
2119
|
/** Default location, in case no specific location is specified. */
|
|
2078
2120
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
2079
2121
|
}
|
|
2122
|
+
/** @enumType */
|
|
2123
|
+
export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
|
|
2080
2124
|
export declare enum SuggestedFix {
|
|
2081
2125
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
2082
2126
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
2083
2127
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
2084
2128
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
2085
2129
|
}
|
|
2130
|
+
/** @enumType */
|
|
2131
|
+
export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
|
|
2086
2132
|
/** General (other) violation. */
|
|
2087
2133
|
export interface Other {
|
|
2088
2134
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
2089
|
-
name?:
|
|
2135
|
+
name?: NameInOtherWithLiterals;
|
|
2090
2136
|
}
|
|
2091
2137
|
/** Specific line item violation. */
|
|
2092
2138
|
export interface TargetLineItem {
|
|
2093
2139
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
2094
|
-
name?:
|
|
2140
|
+
name?: NameInLineItemWithLiterals;
|
|
2095
2141
|
/** ID of the line item containing the violation. */
|
|
2096
2142
|
_id?: string | null;
|
|
2097
2143
|
/**
|
|
2098
2144
|
* Suggested fix for resolving the line item violation.
|
|
2099
2145
|
* @internal
|
|
2100
2146
|
*/
|
|
2101
|
-
suggestedFix?:
|
|
2147
|
+
suggestedFix?: SuggestedFixWithLiterals;
|
|
2102
2148
|
}
|
|
2103
2149
|
export interface CustomSettings {
|
|
2104
2150
|
/**
|
|
@@ -2214,7 +2260,7 @@ export interface CreateCheckoutRequest {
|
|
|
2214
2260
|
*/
|
|
2215
2261
|
customLineItems?: CustomLineItem[];
|
|
2216
2262
|
/** Sales channel that submitted the order. */
|
|
2217
|
-
channelType:
|
|
2263
|
+
channelType: ChannelTypeWithLiterals;
|
|
2218
2264
|
/**
|
|
2219
2265
|
* Gift card code.
|
|
2220
2266
|
*
|
|
@@ -2299,7 +2345,7 @@ export interface CustomLineItem {
|
|
|
2299
2345
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
2300
2346
|
* + `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
2347
|
*/
|
|
2302
|
-
paymentOption?:
|
|
2348
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
2303
2349
|
/**
|
|
2304
2350
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
2305
2351
|
* Used, among other things, when checking for valid memberships.
|
|
@@ -2815,12 +2861,14 @@ export interface GetCheckoutPaymentSettingsRequest {
|
|
|
2815
2861
|
_id: string;
|
|
2816
2862
|
}
|
|
2817
2863
|
export interface GetCheckoutPaymentSettingsResponse {
|
|
2818
|
-
blockedPaymentOptions?:
|
|
2864
|
+
blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals[];
|
|
2819
2865
|
}
|
|
2820
2866
|
export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2821
2867
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
2822
2868
|
MANUAL = "MANUAL"
|
|
2823
2869
|
}
|
|
2870
|
+
/** @enumType */
|
|
2871
|
+
export type GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals = GetCheckoutPaymentSettingsResponsePaymentOption | 'UNKNOWN_PAYMENT_OPTION' | 'MANUAL';
|
|
2824
2872
|
export interface DeleteCheckoutRequest {
|
|
2825
2873
|
/**
|
|
2826
2874
|
* ID of the checkout to delete.
|
|
@@ -2904,7 +2952,7 @@ export interface V1BuyerInfo {
|
|
|
2904
2952
|
*/
|
|
2905
2953
|
_id?: string;
|
|
2906
2954
|
/** Customer type */
|
|
2907
|
-
identityType?:
|
|
2955
|
+
identityType?: IdentityTypeWithLiterals;
|
|
2908
2956
|
}
|
|
2909
2957
|
export declare enum IdentityType {
|
|
2910
2958
|
UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
|
|
@@ -2913,6 +2961,8 @@ export declare enum IdentityType {
|
|
|
2913
2961
|
/** Contact */
|
|
2914
2962
|
CONTACT = "CONTACT"
|
|
2915
2963
|
}
|
|
2964
|
+
/** @enumType */
|
|
2965
|
+
export type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
|
|
2916
2966
|
export interface V1LineItem {
|
|
2917
2967
|
/** Line item ID (auto-generated) */
|
|
2918
2968
|
index?: number;
|
|
@@ -3014,7 +3064,7 @@ export interface ProductDetails {
|
|
|
3014
3064
|
*/
|
|
3015
3065
|
translatedName?: string | null;
|
|
3016
3066
|
/** Line item type (may be extended) */
|
|
3017
|
-
lineItemType?:
|
|
3067
|
+
lineItemType?: LineItemTypeWithLiterals;
|
|
3018
3068
|
/** Line item primary media for preview */
|
|
3019
3069
|
mediaItem?: MediaItem;
|
|
3020
3070
|
/**
|
|
@@ -3058,12 +3108,14 @@ export declare enum LineItemType {
|
|
|
3058
3108
|
/** Custom item price */
|
|
3059
3109
|
CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
|
|
3060
3110
|
}
|
|
3111
|
+
/** @enumType */
|
|
3112
|
+
export type LineItemTypeWithLiterals = LineItemType | 'UNSPECIFIED_LINE_ITEM_TYPE' | 'PHYSICAL' | 'DIGITAL' | 'CUSTOM_AMOUNT_ITEM';
|
|
3061
3113
|
export interface MediaItem {
|
|
3062
3114
|
/**
|
|
3063
3115
|
* Media type
|
|
3064
3116
|
* @readonly
|
|
3065
3117
|
*/
|
|
3066
|
-
mediaType?:
|
|
3118
|
+
mediaType?: MediaItemTypeWithLiterals;
|
|
3067
3119
|
/**
|
|
3068
3120
|
* Media URL
|
|
3069
3121
|
* @format WEB_URL
|
|
@@ -3098,6 +3150,8 @@ export declare enum MediaItemType {
|
|
|
3098
3150
|
/** Image item type */
|
|
3099
3151
|
IMAGE = "IMAGE"
|
|
3100
3152
|
}
|
|
3153
|
+
/** @enumType */
|
|
3154
|
+
export type MediaItemTypeWithLiterals = MediaItemType | 'UNSPECIFIED_MEDIA_TYPE_ITEM' | 'IMAGE';
|
|
3101
3155
|
export interface Totals {
|
|
3102
3156
|
/**
|
|
3103
3157
|
* Subtotal of all line items, before tax
|
|
@@ -3143,7 +3197,7 @@ export interface StoreSettings {
|
|
|
3143
3197
|
*/
|
|
3144
3198
|
currency?: string | null;
|
|
3145
3199
|
/** Weight unit used in this store */
|
|
3146
|
-
weightUnit?:
|
|
3200
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
3147
3201
|
/**
|
|
3148
3202
|
* The language to be used when communicating with the buyer
|
|
3149
3203
|
* For a site that support multiple languages, this would be the language the buyer selected
|
|
@@ -3251,7 +3305,7 @@ export interface VatId {
|
|
|
3251
3305
|
* + `CPF`: For individual tax payers.
|
|
3252
3306
|
* + `CNPJ`: For corporations.
|
|
3253
3307
|
*/
|
|
3254
|
-
type?:
|
|
3308
|
+
type?: VatTypeWithLiterals;
|
|
3255
3309
|
}
|
|
3256
3310
|
/** Brazilian tax info types */
|
|
3257
3311
|
export declare enum VatType {
|
|
@@ -3262,6 +3316,8 @@ export declare enum VatType {
|
|
|
3262
3316
|
/** CNPJ - for corporations */
|
|
3263
3317
|
CNPJ = "CNPJ"
|
|
3264
3318
|
}
|
|
3319
|
+
/** @enumType */
|
|
3320
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED_TAX_TYPE' | 'CPF' | 'CNPJ';
|
|
3265
3321
|
export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3266
3322
|
/** Shipment details (when this object describes shipment) */
|
|
3267
3323
|
shipmentDetails?: ShipmentDetails;
|
|
@@ -3388,7 +3444,7 @@ export interface V1SubscriptionOptionInfo {
|
|
|
3388
3444
|
}
|
|
3389
3445
|
export interface Discount {
|
|
3390
3446
|
/** Discount type. */
|
|
3391
|
-
type?:
|
|
3447
|
+
type?: DiscountDiscountTypeWithLiterals;
|
|
3392
3448
|
/** Discount value. */
|
|
3393
3449
|
value?: number;
|
|
3394
3450
|
}
|
|
@@ -3398,9 +3454,11 @@ export declare enum DiscountDiscountType {
|
|
|
3398
3454
|
AMOUNT = "AMOUNT",
|
|
3399
3455
|
PERCENT = "PERCENT"
|
|
3400
3456
|
}
|
|
3457
|
+
/** @enumType */
|
|
3458
|
+
export type DiscountDiscountTypeWithLiterals = DiscountDiscountType | 'UNDEFINED' | 'AMOUNT' | 'PERCENT';
|
|
3401
3459
|
export interface ChannelInfo {
|
|
3402
3460
|
/** Sales channel that submitted the subscription */
|
|
3403
|
-
type?:
|
|
3461
|
+
type?: ChannelInfoChannelTypeWithLiterals;
|
|
3404
3462
|
}
|
|
3405
3463
|
export declare enum ChannelInfoChannelType {
|
|
3406
3464
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -3408,9 +3466,11 @@ export declare enum ChannelInfoChannelType {
|
|
|
3408
3466
|
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
3409
3467
|
WIX_APP_STORE = "WIX_APP_STORE"
|
|
3410
3468
|
}
|
|
3469
|
+
/** @enumType */
|
|
3470
|
+
export type ChannelInfoChannelTypeWithLiterals = ChannelInfoChannelType | 'UNSPECIFIED' | 'WEB' | 'OTHER_PLATFORM' | 'WIX_APP_STORE';
|
|
3411
3471
|
export interface V1SubscriptionSettings {
|
|
3412
3472
|
/** Frequency of recurring payment. */
|
|
3413
|
-
frequency?:
|
|
3473
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
3414
3474
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
3415
3475
|
autoRenewal?: boolean;
|
|
3416
3476
|
/**
|
|
@@ -3539,7 +3599,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3539
3599
|
*/
|
|
3540
3600
|
appId?: string;
|
|
3541
3601
|
/** @readonly */
|
|
3542
|
-
identityType?:
|
|
3602
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3543
3603
|
}
|
|
3544
3604
|
/** @oneof */
|
|
3545
3605
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3571,6 +3631,8 @@ export declare enum WebhookIdentityType {
|
|
|
3571
3631
|
WIX_USER = "WIX_USER",
|
|
3572
3632
|
APP = "APP"
|
|
3573
3633
|
}
|
|
3634
|
+
/** @enumType */
|
|
3635
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3574
3636
|
export interface BaseEventMetadata {
|
|
3575
3637
|
/**
|
|
3576
3638
|
* App instance ID.
|
|
@@ -3779,7 +3841,7 @@ export interface CreateCheckoutOptions {
|
|
|
3779
3841
|
*/
|
|
3780
3842
|
customLineItems?: CustomLineItem[];
|
|
3781
3843
|
/** Sales channel that submitted the order. */
|
|
3782
|
-
channelType:
|
|
3844
|
+
channelType: ChannelTypeWithLiterals;
|
|
3783
3845
|
/**
|
|
3784
3846
|
* Gift card code.
|
|
3785
3847
|
*
|
|
@@ -4030,7 +4092,7 @@ export interface UpdateCheckout {
|
|
|
4030
4092
|
* Weight measurement unit. Defaults to a site's weight unit.
|
|
4031
4093
|
* @readonly
|
|
4032
4094
|
*/
|
|
4033
|
-
weightUnit?:
|
|
4095
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
4034
4096
|
/**
|
|
4035
4097
|
* Tax summary.
|
|
4036
4098
|
* @readonly
|
|
@@ -4046,7 +4108,7 @@ export interface UpdateCheckout {
|
|
|
4046
4108
|
* Sales channel that submitted the order.
|
|
4047
4109
|
* @readonly
|
|
4048
4110
|
*/
|
|
4049
|
-
channelType?:
|
|
4111
|
+
channelType?: ChannelTypeWithLiterals;
|
|
4050
4112
|
/**
|
|
4051
4113
|
* Site language in which original values are shown.
|
|
4052
4114
|
* @readonly
|
|
@@ -4184,7 +4246,7 @@ export interface UpdateCheckout {
|
|
|
4184
4246
|
*/
|
|
4185
4247
|
subscriptionCharges?: SubscriptionCharges[];
|
|
4186
4248
|
/**
|
|
4187
|
-
* Currency used for payment, in three-letter [ISO-4217 alphabetic
|
|
4249
|
+
* Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
4188
4250
|
* @readonly
|
|
4189
4251
|
* @format CURRENCY
|
|
4190
4252
|
*/
|