@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
|
|
@@ -188,7 +188,7 @@ export interface Checkout {
|
|
|
188
188
|
*/
|
|
189
189
|
businessLocationId?: string | null;
|
|
190
190
|
/**
|
|
191
|
-
* Currency used for payment, in three-letter [ISO-4217 alphabetic
|
|
191
|
+
* Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
192
192
|
* @readonly
|
|
193
193
|
* @format CURRENCY
|
|
194
194
|
*/
|
|
@@ -303,7 +303,7 @@ export interface LineItem {
|
|
|
303
303
|
* + `"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.
|
|
304
304
|
* @readonly
|
|
305
305
|
*/
|
|
306
|
-
paymentOption?:
|
|
306
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
307
307
|
/**
|
|
308
308
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
309
309
|
* @readonly
|
|
@@ -524,7 +524,7 @@ export interface TaxBreakdown {
|
|
|
524
524
|
*/
|
|
525
525
|
taxName?: string | null;
|
|
526
526
|
/** The type of the jurisdiction in which this tax detail applies. */
|
|
527
|
-
jurisdictionType?:
|
|
527
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
528
528
|
}
|
|
529
529
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
530
530
|
export declare enum JurisdictionType {
|
|
@@ -535,6 +535,8 @@ export declare enum JurisdictionType {
|
|
|
535
535
|
CITY = "CITY",
|
|
536
536
|
SPECIAL = "SPECIAL"
|
|
537
537
|
}
|
|
538
|
+
/** @enumType */
|
|
539
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
538
540
|
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
539
541
|
/** Description line plain text value. */
|
|
540
542
|
plainText?: PlainTextValue;
|
|
@@ -605,6 +607,8 @@ export declare enum DescriptionLineType {
|
|
|
605
607
|
/** Color type. */
|
|
606
608
|
COLOR = "COLOR"
|
|
607
609
|
}
|
|
610
|
+
/** @enumType */
|
|
611
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
608
612
|
export interface FocalPoint {
|
|
609
613
|
/** X-coordinate of the focal point. */
|
|
610
614
|
x?: number;
|
|
@@ -617,7 +621,7 @@ export interface FocalPoint {
|
|
|
617
621
|
}
|
|
618
622
|
export interface ItemAvailabilityInfo {
|
|
619
623
|
/** Item availability status. */
|
|
620
|
-
status?:
|
|
624
|
+
status?: ItemAvailabilityStatusWithLiterals;
|
|
621
625
|
/** Quantity available. */
|
|
622
626
|
quantityAvailable?: number | null;
|
|
623
627
|
}
|
|
@@ -630,6 +634,8 @@ export declare enum ItemAvailabilityStatus {
|
|
|
630
634
|
/** Available quantity is less than requested. */
|
|
631
635
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
632
636
|
}
|
|
637
|
+
/** @enumType */
|
|
638
|
+
export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
|
|
633
639
|
export interface PhysicalProperties {
|
|
634
640
|
/** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
|
|
635
641
|
weight?: number | null;
|
|
@@ -655,14 +661,14 @@ export interface Group {
|
|
|
655
661
|
}
|
|
656
662
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
657
663
|
/** Preset item type. */
|
|
658
|
-
preset?:
|
|
664
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
659
665
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
660
666
|
custom?: string;
|
|
661
667
|
}
|
|
662
668
|
/** @oneof */
|
|
663
669
|
export interface ItemTypeItemTypeDataOneOf {
|
|
664
670
|
/** Preset item type. */
|
|
665
|
-
preset?:
|
|
671
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
666
672
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
667
673
|
custom?: string;
|
|
668
674
|
}
|
|
@@ -673,6 +679,8 @@ export declare enum ItemTypeItemType {
|
|
|
673
679
|
GIFT_CARD = "GIFT_CARD",
|
|
674
680
|
SERVICE = "SERVICE"
|
|
675
681
|
}
|
|
682
|
+
/** @enumType */
|
|
683
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
676
684
|
export interface SubscriptionOptionInfo {
|
|
677
685
|
/** Subscription option settings. */
|
|
678
686
|
subscriptionSettings?: SubscriptionSettings;
|
|
@@ -683,7 +691,7 @@ export interface SubscriptionOptionInfo {
|
|
|
683
691
|
}
|
|
684
692
|
export interface SubscriptionSettings {
|
|
685
693
|
/** Frequency of recurring payment. */
|
|
686
|
-
frequency?:
|
|
694
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
687
695
|
/**
|
|
688
696
|
* Interval of recurring payment.
|
|
689
697
|
*
|
|
@@ -716,9 +724,11 @@ export declare enum SubscriptionFrequency {
|
|
|
716
724
|
MONTH = "MONTH",
|
|
717
725
|
YEAR = "YEAR"
|
|
718
726
|
}
|
|
727
|
+
/** @enumType */
|
|
728
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
719
729
|
export interface FreeTrialPeriod {
|
|
720
730
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
721
|
-
frequency?:
|
|
731
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
722
732
|
/**
|
|
723
733
|
* interval of period
|
|
724
734
|
* @min 1
|
|
@@ -768,7 +778,7 @@ export interface SecuredMedia {
|
|
|
768
778
|
*/
|
|
769
779
|
fileName?: string;
|
|
770
780
|
/** File type. */
|
|
771
|
-
fileType?:
|
|
781
|
+
fileType?: FileTypeWithLiterals;
|
|
772
782
|
}
|
|
773
783
|
export declare enum FileType {
|
|
774
784
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -778,6 +788,8 @@ export declare enum FileType {
|
|
|
778
788
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
779
789
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
780
790
|
}
|
|
791
|
+
/** @enumType */
|
|
792
|
+
export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
781
793
|
/** Type of selected payment option for catalog item */
|
|
782
794
|
export declare enum PaymentOptionType {
|
|
783
795
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -791,6 +803,8 @@ export declare enum PaymentOptionType {
|
|
|
791
803
|
/** 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`. */
|
|
792
804
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
793
805
|
}
|
|
806
|
+
/** @enumType */
|
|
807
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
794
808
|
export interface ServiceProperties {
|
|
795
809
|
/**
|
|
796
810
|
* 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.
|
|
@@ -863,16 +877,16 @@ export interface PaymentOption {
|
|
|
863
877
|
*
|
|
864
878
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
865
879
|
*/
|
|
866
|
-
value?:
|
|
880
|
+
value?: PaymentOptionTypeWithLiterals;
|
|
867
881
|
}
|
|
868
882
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
869
883
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
870
|
-
addressType?:
|
|
884
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
871
885
|
}
|
|
872
886
|
/** @oneof */
|
|
873
887
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
874
888
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
875
|
-
addressType?:
|
|
889
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
876
890
|
}
|
|
877
891
|
export declare enum TaxableAddressType {
|
|
878
892
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -880,6 +894,8 @@ export declare enum TaxableAddressType {
|
|
|
880
894
|
BILLING = "BILLING",
|
|
881
895
|
SHIPPING = "SHIPPING"
|
|
882
896
|
}
|
|
897
|
+
/** @enumType */
|
|
898
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
883
899
|
export interface ExtendedFields {
|
|
884
900
|
/**
|
|
885
901
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -1061,7 +1077,7 @@ export interface CommonVatId {
|
|
|
1061
1077
|
* + `CPF`: for individual tax payers
|
|
1062
1078
|
* + `CNPJ`: for corporations
|
|
1063
1079
|
*/
|
|
1064
|
-
type?:
|
|
1080
|
+
type?: CommonVatTypeWithLiterals;
|
|
1065
1081
|
}
|
|
1066
1082
|
/** tax info types */
|
|
1067
1083
|
export declare enum CommonVatType {
|
|
@@ -1071,6 +1087,8 @@ export declare enum CommonVatType {
|
|
|
1071
1087
|
/** CNPJ - for corporations */
|
|
1072
1088
|
CNPJ = "CNPJ"
|
|
1073
1089
|
}
|
|
1090
|
+
/** @enumType */
|
|
1091
|
+
export type CommonVatTypeWithLiterals = CommonVatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1074
1092
|
export interface ShippingInfo {
|
|
1075
1093
|
/** Shipping address and contact details. */
|
|
1076
1094
|
shippingDestination?: AddressWithContact;
|
|
@@ -1158,13 +1176,15 @@ export interface PickupDetails {
|
|
|
1158
1176
|
*/
|
|
1159
1177
|
businessLocation?: boolean;
|
|
1160
1178
|
/** Pickup method */
|
|
1161
|
-
pickupMethod?:
|
|
1179
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1162
1180
|
}
|
|
1163
1181
|
export declare enum PickupMethod {
|
|
1164
1182
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1165
1183
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1166
1184
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1167
1185
|
}
|
|
1186
|
+
/** @enumType */
|
|
1187
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1168
1188
|
export interface DeliveryTimeSlot {
|
|
1169
1189
|
/** starting time of the delivery time slot */
|
|
1170
1190
|
from?: Date | null;
|
|
@@ -1185,7 +1205,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1185
1205
|
}
|
|
1186
1206
|
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1187
1207
|
/** Type of additional cost. */
|
|
1188
|
-
type?:
|
|
1208
|
+
type?: ChargeTypeWithLiterals;
|
|
1189
1209
|
/**
|
|
1190
1210
|
* Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
|
|
1191
1211
|
* @maxLength 200
|
|
@@ -1198,6 +1218,8 @@ export declare enum ChargeType {
|
|
|
1198
1218
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1199
1219
|
INSURANCE = "INSURANCE"
|
|
1200
1220
|
}
|
|
1221
|
+
/** @enumType */
|
|
1222
|
+
export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
|
|
1201
1223
|
export interface DeliveryAllocation {
|
|
1202
1224
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1203
1225
|
deliveryCarrier?: Carrier;
|
|
@@ -1294,7 +1316,7 @@ export interface ShippingPrice {
|
|
|
1294
1316
|
}
|
|
1295
1317
|
export interface OtherCharge {
|
|
1296
1318
|
/** Type of additional cost. */
|
|
1297
|
-
type?:
|
|
1319
|
+
type?: ChargeTypeWithLiterals;
|
|
1298
1320
|
/** Price of added cost. */
|
|
1299
1321
|
price?: MultiCurrencyPrice;
|
|
1300
1322
|
/**
|
|
@@ -1467,10 +1489,12 @@ export declare enum RuleType {
|
|
|
1467
1489
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1468
1490
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1469
1491
|
}
|
|
1492
|
+
/** @enumType */
|
|
1493
|
+
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';
|
|
1470
1494
|
export interface FieldViolation {
|
|
1471
1495
|
field?: string;
|
|
1472
1496
|
description?: string;
|
|
1473
|
-
violatedRule?:
|
|
1497
|
+
violatedRule?: RuleTypeWithLiterals;
|
|
1474
1498
|
/** applicable when violated_rule=OTHER */
|
|
1475
1499
|
ruleName?: string | null;
|
|
1476
1500
|
data?: Record<string, any> | null;
|
|
@@ -1520,7 +1544,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1520
1544
|
/** Discount rule */
|
|
1521
1545
|
discountRule?: DiscountRule;
|
|
1522
1546
|
/** Discount type. */
|
|
1523
|
-
discountType?:
|
|
1547
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1524
1548
|
/**
|
|
1525
1549
|
* IDs of the line items the discount applies to.
|
|
1526
1550
|
* @format GUID
|
|
@@ -1544,6 +1568,8 @@ export declare enum DiscountType {
|
|
|
1544
1568
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1545
1569
|
SHIPPING = "SHIPPING"
|
|
1546
1570
|
}
|
|
1571
|
+
/** @enumType */
|
|
1572
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1547
1573
|
/** Coupon */
|
|
1548
1574
|
export interface Coupon {
|
|
1549
1575
|
/** Coupon ID. */
|
|
@@ -1623,6 +1649,8 @@ export declare enum WeightUnit {
|
|
|
1623
1649
|
/** Pounds. */
|
|
1624
1650
|
LB = "LB"
|
|
1625
1651
|
}
|
|
1652
|
+
/** @enumType */
|
|
1653
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1626
1654
|
export interface TaxSummary {
|
|
1627
1655
|
/**
|
|
1628
1656
|
* Amount for which tax is calculated, added from line items.
|
|
@@ -1642,16 +1670,16 @@ export interface TaxSummary {
|
|
|
1642
1670
|
}
|
|
1643
1671
|
export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1644
1672
|
/** Reason the manual calculation was used. */
|
|
1645
|
-
manualRateReason?:
|
|
1673
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1646
1674
|
/** Details of the fallback rate calculation. */
|
|
1647
1675
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1648
1676
|
/** Rate calculation type. */
|
|
1649
|
-
rateType?:
|
|
1677
|
+
rateType?: RateTypeWithLiterals;
|
|
1650
1678
|
}
|
|
1651
1679
|
/** @oneof */
|
|
1652
1680
|
export interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1653
1681
|
/** Reason the manual calculation was used. */
|
|
1654
|
-
manualRateReason?:
|
|
1682
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1655
1683
|
/** Details of the fallback rate calculation. */
|
|
1656
1684
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1657
1685
|
}
|
|
@@ -1665,15 +1693,19 @@ export declare enum RateType {
|
|
|
1665
1693
|
/** fallback rate used for calculation */
|
|
1666
1694
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1667
1695
|
}
|
|
1696
|
+
/** @enumType */
|
|
1697
|
+
export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
|
|
1668
1698
|
export declare enum ManualCalculationReason {
|
|
1669
1699
|
/** user set calculator in Business Manager to be Manual */
|
|
1670
1700
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1671
1701
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1672
1702
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1673
1703
|
}
|
|
1704
|
+
/** @enumType */
|
|
1705
|
+
export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
|
|
1674
1706
|
export interface AutoTaxFallbackCalculationDetails {
|
|
1675
1707
|
/** reason for fallback */
|
|
1676
|
-
fallbackReason?:
|
|
1708
|
+
fallbackReason?: FallbackReasonWithLiterals;
|
|
1677
1709
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1678
1710
|
error?: ApplicationError;
|
|
1679
1711
|
}
|
|
@@ -1683,6 +1715,8 @@ export declare enum FallbackReason {
|
|
|
1683
1715
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
1684
1716
|
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
1685
1717
|
}
|
|
1718
|
+
/** @enumType */
|
|
1719
|
+
export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
|
|
1686
1720
|
/**
|
|
1687
1721
|
* 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.
|
|
1688
1722
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
@@ -1704,7 +1738,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
1704
1738
|
*/
|
|
1705
1739
|
jurisdiction?: string;
|
|
1706
1740
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1707
|
-
jurisdictionTypeEnum?:
|
|
1741
|
+
jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
|
|
1708
1742
|
/**
|
|
1709
1743
|
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
|
|
1710
1744
|
* @decimalValue options { gte:0, maxScale:6 }
|
|
@@ -1747,6 +1781,8 @@ export declare enum ChannelType {
|
|
|
1747
1781
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1748
1782
|
FAIRE_COM = "FAIRE_COM"
|
|
1749
1783
|
}
|
|
1784
|
+
/** @enumType */
|
|
1785
|
+
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';
|
|
1750
1786
|
export interface CreatedBy extends CreatedByIdOneOf {
|
|
1751
1787
|
/**
|
|
1752
1788
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
@@ -1933,7 +1969,7 @@ export interface AdditionalFee {
|
|
|
1933
1969
|
*/
|
|
1934
1970
|
lineItemIds?: string[];
|
|
1935
1971
|
/** the source the additional fee was added from */
|
|
1936
|
-
source?:
|
|
1972
|
+
source?: AdditionalFeeSourceWithLiterals;
|
|
1937
1973
|
}
|
|
1938
1974
|
export declare enum AdditionalFeeSource {
|
|
1939
1975
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
@@ -1946,6 +1982,8 @@ export declare enum AdditionalFeeSource {
|
|
|
1946
1982
|
/** The additional fee was added by the shipping provider */
|
|
1947
1983
|
SHIPPING = "SHIPPING"
|
|
1948
1984
|
}
|
|
1985
|
+
/** @enumType */
|
|
1986
|
+
export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
|
|
1949
1987
|
export interface ConversionInfo {
|
|
1950
1988
|
/**
|
|
1951
1989
|
* The site currency.
|
|
@@ -1962,7 +2000,7 @@ export interface ConversionInfo {
|
|
|
1962
2000
|
}
|
|
1963
2001
|
export interface Violation {
|
|
1964
2002
|
/** 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. */
|
|
1965
|
-
severity?:
|
|
2003
|
+
severity?: SeverityWithLiterals;
|
|
1966
2004
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
1967
2005
|
target?: Target;
|
|
1968
2006
|
/**
|
|
@@ -1981,6 +2019,8 @@ export declare enum Severity {
|
|
|
1981
2019
|
*/
|
|
1982
2020
|
ERROR = "ERROR"
|
|
1983
2021
|
}
|
|
2022
|
+
/** @enumType */
|
|
2023
|
+
export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
|
|
1984
2024
|
export interface Target extends TargetTargetTypeOneOf {
|
|
1985
2025
|
/** General (other) violation. */
|
|
1986
2026
|
other?: Other;
|
|
@@ -1999,26 +2039,32 @@ export declare enum NameInOther {
|
|
|
1999
2039
|
/** Default location, in case no specific location is specified. */
|
|
2000
2040
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
2001
2041
|
}
|
|
2042
|
+
/** @enumType */
|
|
2043
|
+
export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
|
|
2002
2044
|
/** Available locations on the line item */
|
|
2003
2045
|
export declare enum NameInLineItem {
|
|
2004
2046
|
/** Default location, in case no specific location is specified. */
|
|
2005
2047
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
2006
2048
|
}
|
|
2049
|
+
/** @enumType */
|
|
2050
|
+
export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
|
|
2007
2051
|
export declare enum SuggestedFix {
|
|
2008
2052
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
2009
2053
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
2010
2054
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
2011
2055
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
2012
2056
|
}
|
|
2057
|
+
/** @enumType */
|
|
2058
|
+
export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
|
|
2013
2059
|
/** General (other) violation. */
|
|
2014
2060
|
export interface Other {
|
|
2015
2061
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
2016
|
-
name?:
|
|
2062
|
+
name?: NameInOtherWithLiterals;
|
|
2017
2063
|
}
|
|
2018
2064
|
/** Specific line item violation. */
|
|
2019
2065
|
export interface TargetLineItem {
|
|
2020
2066
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
2021
|
-
name?:
|
|
2067
|
+
name?: NameInLineItemWithLiterals;
|
|
2022
2068
|
/** ID of the line item containing the violation. */
|
|
2023
2069
|
_id?: string | null;
|
|
2024
2070
|
}
|
|
@@ -2136,7 +2182,7 @@ export interface CreateCheckoutRequest {
|
|
|
2136
2182
|
*/
|
|
2137
2183
|
customLineItems?: CustomLineItem[];
|
|
2138
2184
|
/** Sales channel that submitted the order. */
|
|
2139
|
-
channelType:
|
|
2185
|
+
channelType: ChannelTypeWithLiterals;
|
|
2140
2186
|
/**
|
|
2141
2187
|
* Gift card code.
|
|
2142
2188
|
*
|
|
@@ -2221,7 +2267,7 @@ export interface CustomLineItem {
|
|
|
2221
2267
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
2222
2268
|
* + `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.
|
|
2223
2269
|
*/
|
|
2224
|
-
paymentOption?:
|
|
2270
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
2225
2271
|
/**
|
|
2226
2272
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
2227
2273
|
* Used, among other things, when checking for valid memberships.
|
|
@@ -2699,12 +2745,14 @@ export interface GetCheckoutPaymentSettingsRequest {
|
|
|
2699
2745
|
_id: string;
|
|
2700
2746
|
}
|
|
2701
2747
|
export interface GetCheckoutPaymentSettingsResponse {
|
|
2702
|
-
blockedPaymentOptions?:
|
|
2748
|
+
blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals[];
|
|
2703
2749
|
}
|
|
2704
2750
|
export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2705
2751
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
2706
2752
|
MANUAL = "MANUAL"
|
|
2707
2753
|
}
|
|
2754
|
+
/** @enumType */
|
|
2755
|
+
export type GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals = GetCheckoutPaymentSettingsResponsePaymentOption | 'UNKNOWN_PAYMENT_OPTION' | 'MANUAL';
|
|
2708
2756
|
export interface DeleteCheckoutRequest {
|
|
2709
2757
|
/**
|
|
2710
2758
|
* ID of the checkout to delete.
|
|
@@ -2788,7 +2836,7 @@ export interface V1BuyerInfo {
|
|
|
2788
2836
|
*/
|
|
2789
2837
|
_id?: string;
|
|
2790
2838
|
/** Customer type */
|
|
2791
|
-
identityType?:
|
|
2839
|
+
identityType?: IdentityTypeWithLiterals;
|
|
2792
2840
|
}
|
|
2793
2841
|
export declare enum IdentityType {
|
|
2794
2842
|
UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
|
|
@@ -2797,6 +2845,8 @@ export declare enum IdentityType {
|
|
|
2797
2845
|
/** Contact */
|
|
2798
2846
|
CONTACT = "CONTACT"
|
|
2799
2847
|
}
|
|
2848
|
+
/** @enumType */
|
|
2849
|
+
export type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
|
|
2800
2850
|
export interface V1LineItem {
|
|
2801
2851
|
/** Line item ID (auto-generated) */
|
|
2802
2852
|
index?: number;
|
|
@@ -2898,7 +2948,7 @@ export interface ProductDetails {
|
|
|
2898
2948
|
*/
|
|
2899
2949
|
translatedName?: string | null;
|
|
2900
2950
|
/** Line item type (may be extended) */
|
|
2901
|
-
lineItemType?:
|
|
2951
|
+
lineItemType?: LineItemTypeWithLiterals;
|
|
2902
2952
|
/** Line item primary media for preview */
|
|
2903
2953
|
mediaItem?: MediaItem;
|
|
2904
2954
|
/**
|
|
@@ -2942,12 +2992,14 @@ export declare enum LineItemType {
|
|
|
2942
2992
|
/** Custom item price */
|
|
2943
2993
|
CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
|
|
2944
2994
|
}
|
|
2995
|
+
/** @enumType */
|
|
2996
|
+
export type LineItemTypeWithLiterals = LineItemType | 'UNSPECIFIED_LINE_ITEM_TYPE' | 'PHYSICAL' | 'DIGITAL' | 'CUSTOM_AMOUNT_ITEM';
|
|
2945
2997
|
export interface MediaItem {
|
|
2946
2998
|
/**
|
|
2947
2999
|
* Media type
|
|
2948
3000
|
* @readonly
|
|
2949
3001
|
*/
|
|
2950
|
-
mediaType?:
|
|
3002
|
+
mediaType?: MediaItemTypeWithLiterals;
|
|
2951
3003
|
/**
|
|
2952
3004
|
* Media URL
|
|
2953
3005
|
* @format WEB_URL
|
|
@@ -2982,6 +3034,8 @@ export declare enum MediaItemType {
|
|
|
2982
3034
|
/** Image item type */
|
|
2983
3035
|
IMAGE = "IMAGE"
|
|
2984
3036
|
}
|
|
3037
|
+
/** @enumType */
|
|
3038
|
+
export type MediaItemTypeWithLiterals = MediaItemType | 'UNSPECIFIED_MEDIA_TYPE_ITEM' | 'IMAGE';
|
|
2985
3039
|
export interface Totals {
|
|
2986
3040
|
/**
|
|
2987
3041
|
* Subtotal of all line items, before tax
|
|
@@ -3027,7 +3081,7 @@ export interface StoreSettings {
|
|
|
3027
3081
|
*/
|
|
3028
3082
|
currency?: string | null;
|
|
3029
3083
|
/** Weight unit used in this store */
|
|
3030
|
-
weightUnit?:
|
|
3084
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
3031
3085
|
/**
|
|
3032
3086
|
* The language to be used when communicating with the buyer
|
|
3033
3087
|
* For a site that support multiple languages, this would be the language the buyer selected
|
|
@@ -3135,7 +3189,7 @@ export interface VatId {
|
|
|
3135
3189
|
* + `CPF`: For individual tax payers.
|
|
3136
3190
|
* + `CNPJ`: For corporations.
|
|
3137
3191
|
*/
|
|
3138
|
-
type?:
|
|
3192
|
+
type?: VatTypeWithLiterals;
|
|
3139
3193
|
}
|
|
3140
3194
|
/** Brazilian tax info types */
|
|
3141
3195
|
export declare enum VatType {
|
|
@@ -3146,6 +3200,8 @@ export declare enum VatType {
|
|
|
3146
3200
|
/** CNPJ - for corporations */
|
|
3147
3201
|
CNPJ = "CNPJ"
|
|
3148
3202
|
}
|
|
3203
|
+
/** @enumType */
|
|
3204
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED_TAX_TYPE' | 'CPF' | 'CNPJ';
|
|
3149
3205
|
export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3150
3206
|
/** Shipment details (when this object describes shipment) */
|
|
3151
3207
|
shipmentDetails?: ShipmentDetails;
|
|
@@ -3272,7 +3328,7 @@ export interface V1SubscriptionOptionInfo {
|
|
|
3272
3328
|
}
|
|
3273
3329
|
export interface Discount {
|
|
3274
3330
|
/** Discount type. */
|
|
3275
|
-
type?:
|
|
3331
|
+
type?: DiscountDiscountTypeWithLiterals;
|
|
3276
3332
|
/** Discount value. */
|
|
3277
3333
|
value?: number;
|
|
3278
3334
|
}
|
|
@@ -3282,9 +3338,11 @@ export declare enum DiscountDiscountType {
|
|
|
3282
3338
|
AMOUNT = "AMOUNT",
|
|
3283
3339
|
PERCENT = "PERCENT"
|
|
3284
3340
|
}
|
|
3341
|
+
/** @enumType */
|
|
3342
|
+
export type DiscountDiscountTypeWithLiterals = DiscountDiscountType | 'UNDEFINED' | 'AMOUNT' | 'PERCENT';
|
|
3285
3343
|
export interface ChannelInfo {
|
|
3286
3344
|
/** Sales channel that submitted the subscription */
|
|
3287
|
-
type?:
|
|
3345
|
+
type?: ChannelInfoChannelTypeWithLiterals;
|
|
3288
3346
|
}
|
|
3289
3347
|
export declare enum ChannelInfoChannelType {
|
|
3290
3348
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -3292,9 +3350,11 @@ export declare enum ChannelInfoChannelType {
|
|
|
3292
3350
|
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
3293
3351
|
WIX_APP_STORE = "WIX_APP_STORE"
|
|
3294
3352
|
}
|
|
3353
|
+
/** @enumType */
|
|
3354
|
+
export type ChannelInfoChannelTypeWithLiterals = ChannelInfoChannelType | 'UNSPECIFIED' | 'WEB' | 'OTHER_PLATFORM' | 'WIX_APP_STORE';
|
|
3295
3355
|
export interface V1SubscriptionSettings {
|
|
3296
3356
|
/** Frequency of recurring payment. */
|
|
3297
|
-
frequency?:
|
|
3357
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
3298
3358
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
3299
3359
|
autoRenewal?: boolean;
|
|
3300
3360
|
/**
|
|
@@ -3423,7 +3483,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3423
3483
|
*/
|
|
3424
3484
|
appId?: string;
|
|
3425
3485
|
/** @readonly */
|
|
3426
|
-
identityType?:
|
|
3486
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3427
3487
|
}
|
|
3428
3488
|
/** @oneof */
|
|
3429
3489
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3455,6 +3515,8 @@ export declare enum WebhookIdentityType {
|
|
|
3455
3515
|
WIX_USER = "WIX_USER",
|
|
3456
3516
|
APP = "APP"
|
|
3457
3517
|
}
|
|
3518
|
+
/** @enumType */
|
|
3519
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3458
3520
|
export interface BaseEventMetadata {
|
|
3459
3521
|
/**
|
|
3460
3522
|
* App instance ID.
|
|
@@ -3663,7 +3725,7 @@ export interface CreateCheckoutOptions {
|
|
|
3663
3725
|
*/
|
|
3664
3726
|
customLineItems?: CustomLineItem[];
|
|
3665
3727
|
/** Sales channel that submitted the order. */
|
|
3666
|
-
channelType:
|
|
3728
|
+
channelType: ChannelTypeWithLiterals;
|
|
3667
3729
|
/**
|
|
3668
3730
|
* Gift card code.
|
|
3669
3731
|
*
|
|
@@ -3886,7 +3948,7 @@ export interface UpdateCheckout {
|
|
|
3886
3948
|
* Weight measurement unit. Defaults to a site's weight unit.
|
|
3887
3949
|
* @readonly
|
|
3888
3950
|
*/
|
|
3889
|
-
weightUnit?:
|
|
3951
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
3890
3952
|
/**
|
|
3891
3953
|
* Tax summary.
|
|
3892
3954
|
* @readonly
|
|
@@ -3902,7 +3964,7 @@ export interface UpdateCheckout {
|
|
|
3902
3964
|
* Sales channel that submitted the order.
|
|
3903
3965
|
* @readonly
|
|
3904
3966
|
*/
|
|
3905
|
-
channelType?:
|
|
3967
|
+
channelType?: ChannelTypeWithLiterals;
|
|
3906
3968
|
/**
|
|
3907
3969
|
* Site language in which original values are shown.
|
|
3908
3970
|
* @readonly
|
|
@@ -4014,7 +4076,7 @@ export interface UpdateCheckout {
|
|
|
4014
4076
|
*/
|
|
4015
4077
|
businessLocationId?: string | null;
|
|
4016
4078
|
/**
|
|
4017
|
-
* Currency used for payment, in three-letter [ISO-4217 alphabetic
|
|
4079
|
+
* Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
4018
4080
|
* @readonly
|
|
4019
4081
|
* @format CURRENCY
|
|
4020
4082
|
*/
|