@wix/auto_sdk_ecom_checkout-templates 1.0.32 → 1.0.34
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-template-checkout-templates.types.d.ts +84 -32
- package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts +101 -33
- package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-template-checkout-templates.types.d.ts +84 -32
- package/build/es/src/ecom-v1-checkout-template-checkout-templates.types.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts +101 -33
- package/build/es/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.types.d.ts +84 -32
- package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts +107 -34
- package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.types.d.ts +84 -32
- package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts +107 -34
- package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -12,7 +12,7 @@ export interface CheckoutTemplate {
|
|
|
12
12
|
*
|
|
13
13
|
* Default: `ACTIVE`
|
|
14
14
|
*/
|
|
15
|
-
status?:
|
|
15
|
+
status?: StatusWithLiterals;
|
|
16
16
|
/** Custom settings to apply to the checkout page created from this template. */
|
|
17
17
|
customization?: CheckoutCustomization;
|
|
18
18
|
/**
|
|
@@ -55,6 +55,8 @@ export declare enum Status {
|
|
|
55
55
|
ACTIVE = "ACTIVE",
|
|
56
56
|
INACTIVE = "INACTIVE"
|
|
57
57
|
}
|
|
58
|
+
/** @enumType */
|
|
59
|
+
export type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
|
|
58
60
|
export interface CheckoutCustomization {
|
|
59
61
|
/** Web client customizations. These customizations only apply to the standard Wix checkout page. */
|
|
60
62
|
webClient?: WebClientCustomization;
|
|
@@ -261,6 +263,8 @@ export declare enum DescriptionLineType {
|
|
|
261
263
|
/** Color type. */
|
|
262
264
|
COLOR = "COLOR"
|
|
263
265
|
}
|
|
266
|
+
/** @enumType */
|
|
267
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
264
268
|
export interface PhysicalProperties {
|
|
265
269
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
266
270
|
weight?: number | null;
|
|
@@ -290,7 +294,7 @@ export interface PaymentOption {
|
|
|
290
294
|
*
|
|
291
295
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
292
296
|
*/
|
|
293
|
-
value?:
|
|
297
|
+
value?: PaymentOptionTypeWithLiterals;
|
|
294
298
|
}
|
|
295
299
|
/** Type of selected payment option for catalog item */
|
|
296
300
|
export declare enum PaymentOptionType {
|
|
@@ -305,6 +309,8 @@ export declare enum PaymentOptionType {
|
|
|
305
309
|
/** 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`. */
|
|
306
310
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
307
311
|
}
|
|
312
|
+
/** @enumType */
|
|
313
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
308
314
|
export interface CustomLineItem {
|
|
309
315
|
/**
|
|
310
316
|
* Custom line item quantity.
|
|
@@ -371,7 +377,7 @@ export interface CustomLineItem {
|
|
|
371
377
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
372
378
|
* + `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.
|
|
373
379
|
*/
|
|
374
|
-
paymentOption?:
|
|
380
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
375
381
|
/**
|
|
376
382
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
377
383
|
* Used, among other things, when checking for valid memberships.
|
|
@@ -454,14 +460,14 @@ export interface PageUrlV2 {
|
|
|
454
460
|
}
|
|
455
461
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
456
462
|
/** Preset item type. */
|
|
457
|
-
preset?:
|
|
463
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
458
464
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
459
465
|
custom?: string;
|
|
460
466
|
}
|
|
461
467
|
/** @oneof */
|
|
462
468
|
export interface ItemTypeItemTypeDataOneOf {
|
|
463
469
|
/** Preset item type. */
|
|
464
|
-
preset?:
|
|
470
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
465
471
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
466
472
|
custom?: string;
|
|
467
473
|
}
|
|
@@ -472,6 +478,8 @@ export declare enum ItemTypeItemType {
|
|
|
472
478
|
GIFT_CARD = "GIFT_CARD",
|
|
473
479
|
SERVICE = "SERVICE"
|
|
474
480
|
}
|
|
481
|
+
/** @enumType */
|
|
482
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
475
483
|
export interface SubscriptionOptionInfo {
|
|
476
484
|
/** Subscription option settings. */
|
|
477
485
|
subscriptionSettings?: SubscriptionSettings;
|
|
@@ -482,7 +490,7 @@ export interface SubscriptionOptionInfo {
|
|
|
482
490
|
}
|
|
483
491
|
export interface SubscriptionSettings {
|
|
484
492
|
/** Frequency of recurring payment. */
|
|
485
|
-
frequency?:
|
|
493
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
486
494
|
/**
|
|
487
495
|
* Interval of recurring payment.
|
|
488
496
|
*
|
|
@@ -515,9 +523,11 @@ export declare enum SubscriptionFrequency {
|
|
|
515
523
|
MONTH = "MONTH",
|
|
516
524
|
YEAR = "YEAR"
|
|
517
525
|
}
|
|
526
|
+
/** @enumType */
|
|
527
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
518
528
|
export interface FreeTrialPeriod {
|
|
519
529
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
520
|
-
frequency?:
|
|
530
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
521
531
|
/**
|
|
522
532
|
* interval of period
|
|
523
533
|
* @min 1
|
|
@@ -567,7 +577,7 @@ export interface SecuredMedia {
|
|
|
567
577
|
*/
|
|
568
578
|
fileName?: string;
|
|
569
579
|
/** File type. */
|
|
570
|
-
fileType?:
|
|
580
|
+
fileType?: FileTypeWithLiterals;
|
|
571
581
|
}
|
|
572
582
|
export declare enum FileType {
|
|
573
583
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -577,6 +587,8 @@ export declare enum FileType {
|
|
|
577
587
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
578
588
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
579
589
|
}
|
|
590
|
+
/** @enumType */
|
|
591
|
+
export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
580
592
|
export interface ServiceProperties {
|
|
581
593
|
/**
|
|
582
594
|
* 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.
|
|
@@ -606,12 +618,12 @@ export interface Policy {
|
|
|
606
618
|
}
|
|
607
619
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
608
620
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
609
|
-
addressType?:
|
|
621
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
610
622
|
}
|
|
611
623
|
/** @oneof */
|
|
612
624
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
613
625
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
614
|
-
addressType?:
|
|
626
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
615
627
|
}
|
|
616
628
|
export declare enum TaxableAddressType {
|
|
617
629
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -619,6 +631,8 @@ export declare enum TaxableAddressType {
|
|
|
619
631
|
BILLING = "BILLING",
|
|
620
632
|
SHIPPING = "SHIPPING"
|
|
621
633
|
}
|
|
634
|
+
/** @enumType */
|
|
635
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
622
636
|
export interface V1ModifierGroup {
|
|
623
637
|
/**
|
|
624
638
|
* Modifier group id.
|
|
@@ -791,7 +805,7 @@ export interface Checkout {
|
|
|
791
805
|
* Weight measurement unit. Defaults to a site's weight unit.
|
|
792
806
|
* @readonly
|
|
793
807
|
*/
|
|
794
|
-
weightUnit?:
|
|
808
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
795
809
|
/**
|
|
796
810
|
* Tax summary.
|
|
797
811
|
* @readonly
|
|
@@ -807,7 +821,7 @@ export interface Checkout {
|
|
|
807
821
|
* Sales channel that submitted the order.
|
|
808
822
|
* @readonly
|
|
809
823
|
*/
|
|
810
|
-
channelType?:
|
|
824
|
+
channelType?: ChannelTypeWithLiterals;
|
|
811
825
|
/**
|
|
812
826
|
* Site language in which original values are shown.
|
|
813
827
|
* @readonly
|
|
@@ -1034,7 +1048,7 @@ export interface LineItem {
|
|
|
1034
1048
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
1035
1049
|
* @readonly
|
|
1036
1050
|
*/
|
|
1037
|
-
paymentOption?:
|
|
1051
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
1038
1052
|
/**
|
|
1039
1053
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
1040
1054
|
* @readonly
|
|
@@ -1205,7 +1219,7 @@ export interface TaxBreakdown {
|
|
|
1205
1219
|
*/
|
|
1206
1220
|
taxName?: string | null;
|
|
1207
1221
|
/** The type of the jurisdiction in which this tax detail applies. */
|
|
1208
|
-
jurisdictionType?:
|
|
1222
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1209
1223
|
}
|
|
1210
1224
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1211
1225
|
export declare enum JurisdictionType {
|
|
@@ -1216,6 +1230,8 @@ export declare enum JurisdictionType {
|
|
|
1216
1230
|
CITY = "CITY",
|
|
1217
1231
|
SPECIAL = "SPECIAL"
|
|
1218
1232
|
}
|
|
1233
|
+
/** @enumType */
|
|
1234
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
1219
1235
|
export interface CommonImage {
|
|
1220
1236
|
/** WixMedia image ID. */
|
|
1221
1237
|
id?: string;
|
|
@@ -1251,7 +1267,7 @@ export interface FocalPoint {
|
|
|
1251
1267
|
}
|
|
1252
1268
|
export interface ItemAvailabilityInfo {
|
|
1253
1269
|
/** Item availability status. */
|
|
1254
|
-
status?:
|
|
1270
|
+
status?: ItemAvailabilityStatusWithLiterals;
|
|
1255
1271
|
/** Quantity available. */
|
|
1256
1272
|
quantityAvailable?: number | null;
|
|
1257
1273
|
}
|
|
@@ -1264,6 +1280,8 @@ export declare enum ItemAvailabilityStatus {
|
|
|
1264
1280
|
/** Available quantity is less than requested. */
|
|
1265
1281
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
1266
1282
|
}
|
|
1283
|
+
/** @enumType */
|
|
1284
|
+
export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
|
|
1267
1285
|
export interface Scope {
|
|
1268
1286
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
1269
1287
|
namespace?: string;
|
|
@@ -1411,7 +1429,7 @@ export interface VatId {
|
|
|
1411
1429
|
* + `CPF`: for individual tax payers
|
|
1412
1430
|
* + `CNPJ`: for corporations
|
|
1413
1431
|
*/
|
|
1414
|
-
type?:
|
|
1432
|
+
type?: VatTypeWithLiterals;
|
|
1415
1433
|
}
|
|
1416
1434
|
/** tax info types */
|
|
1417
1435
|
export declare enum VatType {
|
|
@@ -1421,6 +1439,8 @@ export declare enum VatType {
|
|
|
1421
1439
|
/** CNPJ - for corporations */
|
|
1422
1440
|
CNPJ = "CNPJ"
|
|
1423
1441
|
}
|
|
1442
|
+
/** @enumType */
|
|
1443
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1424
1444
|
export interface ShippingInfo {
|
|
1425
1445
|
/** Shipping address and contact details. */
|
|
1426
1446
|
shippingDestination?: AddressWithContact;
|
|
@@ -1508,13 +1528,15 @@ export interface PickupDetails {
|
|
|
1508
1528
|
*/
|
|
1509
1529
|
businessLocation?: boolean;
|
|
1510
1530
|
/** Pickup method */
|
|
1511
|
-
pickupMethod?:
|
|
1531
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1512
1532
|
}
|
|
1513
1533
|
export declare enum PickupMethod {
|
|
1514
1534
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1515
1535
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1516
1536
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1517
1537
|
}
|
|
1538
|
+
/** @enumType */
|
|
1539
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1518
1540
|
export interface DeliveryTimeSlot {
|
|
1519
1541
|
/** starting time of the delivery time slot */
|
|
1520
1542
|
from?: Date | null;
|
|
@@ -1535,7 +1557,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1535
1557
|
}
|
|
1536
1558
|
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1537
1559
|
/** Type of additional cost. */
|
|
1538
|
-
type?:
|
|
1560
|
+
type?: ChargeTypeWithLiterals;
|
|
1539
1561
|
/**
|
|
1540
1562
|
* Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
|
|
1541
1563
|
* @maxLength 200
|
|
@@ -1548,6 +1570,8 @@ export declare enum ChargeType {
|
|
|
1548
1570
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1549
1571
|
INSURANCE = "INSURANCE"
|
|
1550
1572
|
}
|
|
1573
|
+
/** @enumType */
|
|
1574
|
+
export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
|
|
1551
1575
|
export interface DeliveryAllocation {
|
|
1552
1576
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1553
1577
|
deliveryCarrier?: Carrier;
|
|
@@ -1644,7 +1668,7 @@ export interface ShippingPrice {
|
|
|
1644
1668
|
}
|
|
1645
1669
|
export interface OtherCharge {
|
|
1646
1670
|
/** Type of additional cost. */
|
|
1647
|
-
type?:
|
|
1671
|
+
type?: ChargeTypeWithLiterals;
|
|
1648
1672
|
/** Price of added cost. */
|
|
1649
1673
|
price?: MultiCurrencyPrice;
|
|
1650
1674
|
/**
|
|
@@ -1817,10 +1841,12 @@ export declare enum RuleType {
|
|
|
1817
1841
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1818
1842
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1819
1843
|
}
|
|
1844
|
+
/** @enumType */
|
|
1845
|
+
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';
|
|
1820
1846
|
export interface FieldViolation {
|
|
1821
1847
|
field?: string;
|
|
1822
1848
|
description?: string;
|
|
1823
|
-
violatedRule?:
|
|
1849
|
+
violatedRule?: RuleTypeWithLiterals;
|
|
1824
1850
|
/** applicable when violated_rule=OTHER */
|
|
1825
1851
|
ruleName?: string | null;
|
|
1826
1852
|
data?: Record<string, any> | null;
|
|
@@ -1870,7 +1896,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1870
1896
|
/** Discount rule */
|
|
1871
1897
|
discountRule?: DiscountRule;
|
|
1872
1898
|
/** Discount type. */
|
|
1873
|
-
discountType?:
|
|
1899
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1874
1900
|
/**
|
|
1875
1901
|
* IDs of line items the discount applies to.
|
|
1876
1902
|
* @format GUID
|
|
@@ -1894,6 +1920,8 @@ export declare enum DiscountType {
|
|
|
1894
1920
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1895
1921
|
SHIPPING = "SHIPPING"
|
|
1896
1922
|
}
|
|
1923
|
+
/** @enumType */
|
|
1924
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1897
1925
|
/** Coupon */
|
|
1898
1926
|
export interface Coupon {
|
|
1899
1927
|
/** Coupon ID. */
|
|
@@ -1973,6 +2001,8 @@ export declare enum WeightUnit {
|
|
|
1973
2001
|
/** Pounds. */
|
|
1974
2002
|
LB = "LB"
|
|
1975
2003
|
}
|
|
2004
|
+
/** @enumType */
|
|
2005
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1976
2006
|
export interface TaxSummary {
|
|
1977
2007
|
/**
|
|
1978
2008
|
* Amount for which tax is calculated, added from line items.
|
|
@@ -1992,16 +2022,16 @@ export interface TaxSummary {
|
|
|
1992
2022
|
}
|
|
1993
2023
|
export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1994
2024
|
/** Reason the manual calculation was used. */
|
|
1995
|
-
manualRateReason?:
|
|
2025
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1996
2026
|
/** Details of the fallback rate calculation. */
|
|
1997
2027
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1998
2028
|
/** Rate calculation type. */
|
|
1999
|
-
rateType?:
|
|
2029
|
+
rateType?: RateTypeWithLiterals;
|
|
2000
2030
|
}
|
|
2001
2031
|
/** @oneof */
|
|
2002
2032
|
export interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
2003
2033
|
/** Reason the manual calculation was used. */
|
|
2004
|
-
manualRateReason?:
|
|
2034
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
2005
2035
|
/** Details of the fallback rate calculation. */
|
|
2006
2036
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
2007
2037
|
}
|
|
@@ -2015,15 +2045,19 @@ export declare enum RateType {
|
|
|
2015
2045
|
/** fallback rate used for calculation */
|
|
2016
2046
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
2017
2047
|
}
|
|
2048
|
+
/** @enumType */
|
|
2049
|
+
export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
|
|
2018
2050
|
export declare enum ManualCalculationReason {
|
|
2019
2051
|
/** user set calculator in Business Manager to be Manual */
|
|
2020
2052
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
2021
2053
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
2022
2054
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
2023
2055
|
}
|
|
2056
|
+
/** @enumType */
|
|
2057
|
+
export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
|
|
2024
2058
|
export interface AutoTaxFallbackCalculationDetails {
|
|
2025
2059
|
/** reason for fallback */
|
|
2026
|
-
fallbackReason?:
|
|
2060
|
+
fallbackReason?: FallbackReasonWithLiterals;
|
|
2027
2061
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
2028
2062
|
error?: ApplicationError;
|
|
2029
2063
|
}
|
|
@@ -2033,6 +2067,8 @@ export declare enum FallbackReason {
|
|
|
2033
2067
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
2034
2068
|
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
2035
2069
|
}
|
|
2070
|
+
/** @enumType */
|
|
2071
|
+
export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
|
|
2036
2072
|
/**
|
|
2037
2073
|
* 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.
|
|
2038
2074
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
@@ -2054,7 +2090,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
2054
2090
|
*/
|
|
2055
2091
|
jurisdiction?: string;
|
|
2056
2092
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
2057
|
-
jurisdictionTypeEnum?:
|
|
2093
|
+
jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
|
|
2058
2094
|
/**
|
|
2059
2095
|
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
|
|
2060
2096
|
* @decimalValue options { gte:0, maxScale:6 }
|
|
@@ -2097,6 +2133,8 @@ export declare enum ChannelType {
|
|
|
2097
2133
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2098
2134
|
FAIRE_COM = "FAIRE_COM"
|
|
2099
2135
|
}
|
|
2136
|
+
/** @enumType */
|
|
2137
|
+
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';
|
|
2100
2138
|
export interface CreatedBy extends CreatedByIdOneOf {
|
|
2101
2139
|
/**
|
|
2102
2140
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
@@ -2283,7 +2321,7 @@ export interface AdditionalFee {
|
|
|
2283
2321
|
*/
|
|
2284
2322
|
lineItemIds?: string[];
|
|
2285
2323
|
/** the source the additional fee was added from */
|
|
2286
|
-
source?:
|
|
2324
|
+
source?: AdditionalFeeSourceWithLiterals;
|
|
2287
2325
|
}
|
|
2288
2326
|
export declare enum AdditionalFeeSource {
|
|
2289
2327
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
@@ -2296,6 +2334,8 @@ export declare enum AdditionalFeeSource {
|
|
|
2296
2334
|
/** The additional fee was added by the shipping provider */
|
|
2297
2335
|
SHIPPING = "SHIPPING"
|
|
2298
2336
|
}
|
|
2337
|
+
/** @enumType */
|
|
2338
|
+
export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
|
|
2299
2339
|
export interface ConversionInfo {
|
|
2300
2340
|
/**
|
|
2301
2341
|
* The site currency.
|
|
@@ -2312,7 +2352,7 @@ export interface ConversionInfo {
|
|
|
2312
2352
|
}
|
|
2313
2353
|
export interface Violation {
|
|
2314
2354
|
/** 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. */
|
|
2315
|
-
severity?:
|
|
2355
|
+
severity?: SeverityWithLiterals;
|
|
2316
2356
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
2317
2357
|
target?: Target;
|
|
2318
2358
|
/**
|
|
@@ -2331,6 +2371,8 @@ export declare enum Severity {
|
|
|
2331
2371
|
*/
|
|
2332
2372
|
ERROR = "ERROR"
|
|
2333
2373
|
}
|
|
2374
|
+
/** @enumType */
|
|
2375
|
+
export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
|
|
2334
2376
|
export interface Target extends TargetTargetTypeOneOf {
|
|
2335
2377
|
/** General (other) violation. */
|
|
2336
2378
|
other?: Other;
|
|
@@ -2349,26 +2391,32 @@ export declare enum NameInOther {
|
|
|
2349
2391
|
/** Default location, in case no specific location is specified. */
|
|
2350
2392
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
2351
2393
|
}
|
|
2394
|
+
/** @enumType */
|
|
2395
|
+
export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
|
|
2352
2396
|
/** Available locations on the line item */
|
|
2353
2397
|
export declare enum NameInLineItem {
|
|
2354
2398
|
/** Default location, in case no specific location is specified. */
|
|
2355
2399
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
2356
2400
|
}
|
|
2401
|
+
/** @enumType */
|
|
2402
|
+
export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
|
|
2357
2403
|
export declare enum SuggestedFix {
|
|
2358
2404
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
2359
2405
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
2360
2406
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
2361
2407
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
2362
2408
|
}
|
|
2409
|
+
/** @enumType */
|
|
2410
|
+
export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
|
|
2363
2411
|
/** General (other) violation. */
|
|
2364
2412
|
export interface Other {
|
|
2365
2413
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
2366
|
-
name?:
|
|
2414
|
+
name?: NameInOtherWithLiterals;
|
|
2367
2415
|
}
|
|
2368
2416
|
/** Specific line item violation. */
|
|
2369
2417
|
export interface TargetLineItem {
|
|
2370
2418
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
2371
|
-
name?:
|
|
2419
|
+
name?: NameInLineItemWithLiterals;
|
|
2372
2420
|
/** ID of the line item containing the violation. */
|
|
2373
2421
|
id?: string | null;
|
|
2374
2422
|
}
|
|
@@ -2496,7 +2544,7 @@ export interface Sorting {
|
|
|
2496
2544
|
/** Name of the field to sort by. */
|
|
2497
2545
|
fieldName?: string;
|
|
2498
2546
|
/** Sort order. */
|
|
2499
|
-
order?:
|
|
2547
|
+
order?: SortOrderWithLiterals;
|
|
2500
2548
|
}
|
|
2501
2549
|
export declare enum SortOrder {
|
|
2502
2550
|
/** Ascending order. */
|
|
@@ -2504,6 +2552,8 @@ export declare enum SortOrder {
|
|
|
2504
2552
|
/** Descending order. */
|
|
2505
2553
|
DESC = "DESC"
|
|
2506
2554
|
}
|
|
2555
|
+
/** @enumType */
|
|
2556
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2507
2557
|
export interface CursorPaging {
|
|
2508
2558
|
/**
|
|
2509
2559
|
* Number of items to load.
|
|
@@ -2692,7 +2742,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2692
2742
|
*/
|
|
2693
2743
|
appId?: string;
|
|
2694
2744
|
/** @readonly */
|
|
2695
|
-
identityType?:
|
|
2745
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2696
2746
|
}
|
|
2697
2747
|
/** @oneof */
|
|
2698
2748
|
export interface IdentificationDataIdOneOf {
|
|
@@ -2724,3 +2774,5 @@ export declare enum WebhookIdentityType {
|
|
|
2724
2774
|
WIX_USER = "WIX_USER",
|
|
2725
2775
|
APP = "APP"
|
|
2726
2776
|
}
|
|
2777
|
+
/** @enumType */
|
|
2778
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ecom-v1-checkout-template-checkout-templates.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-checkout-template-checkout-templates.types.ts"],"names":[],"mappings":";;;AAqDA,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;AACvB,CAAC,EAJW,MAAM,sBAAN,MAAM,QAIjB;
|
|
1
|
+
{"version":3,"file":"ecom-v1-checkout-template-checkout-templates.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-checkout-template-checkout-templates.types.ts"],"names":[],"mappings":";;;AAqDA,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;AACvB,CAAC,EAJW,MAAM,sBAAN,MAAM,QAIjB;AA4ND,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,yBAAyB;IACzB,oDAA6B,CAAA;IAC7B,uBAAuB;IACvB,gDAAyB,CAAA;IACzB,kBAAkB;IAClB,sCAAe,CAAA;AACjB,CAAC,EAPW,mBAAmB,mCAAnB,mBAAmB,QAO9B;AA2CD,uDAAuD;AACvD,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,wEAAwE;IACxE,gEAA2C,CAAA;IAC3C,sIAAsI;IACtI,kEAA6C,CAAA;IAC7C,6FAA6F;IAC7F,8CAAyB,CAAA;IACzB,4IAA4I;IAC5I,sDAAiC,CAAA;IACjC,uKAAuK;IACvK,8DAAyC,CAAA;AAC3C,CAAC,EAXW,iBAAiB,iCAAjB,iBAAiB,QAW5B;AAgLD,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;AACrB,CAAC,EANW,gBAAgB,gCAAhB,gBAAgB,QAM3B;AAgDD,0CAA0C;AAC1C,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,gDAAuB,CAAA;IACvB,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,sCAAa,CAAA;AACf,CAAC,EANW,qBAAqB,qCAArB,qBAAqB,QAMhC;AAqED,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,uCAA2B,CAAA;IAC3B,6CAAiC,CAAA;IACjC,yCAA6B,CAAA;IAC7B,+CAAmC,CAAA;IACnC,yCAA6B,CAAA;IAC7B,6CAAiC,CAAA;AACnC,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB;AAoDD,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yEAAmD,CAAA;IACnD,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;AACvB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAmmBD,0IAA0I;AAC1I,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,uCAAmB,CAAA;AACrB,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;AAsDD,IAAY,sBAQX;AARD,WAAY,sBAAsB;IAChC,iDAAuB,CAAA;IACvB,2BAA2B;IAC3B,iDAAuB,CAAA;IACvB,4BAA4B;IAC5B,yDAA+B,CAAA;IAC/B,iDAAiD;IACjD,qEAA2C,CAAA;AAC7C,CAAC,EARW,sBAAsB,sCAAtB,sBAAsB,QAQjC;AAyKD,qBAAqB;AACrB,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,uBAAP,OAAO,QAMlB;AAkGD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,6CAA6B,CAAA;AAC/B,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAyCD,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,2CAA6B,CAAA;IAC7B,qCAAuB,CAAA;AACzB,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB;AA8QD,IAAY,QAsBX;AAtBD,WAAY,QAAQ;IAClB,qCAAyB,CAAA;IACzB,2BAAe,CAAA;IACf,uBAAW,CAAA;IACX,uBAAW,CAAA;IACX,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,iCAAqB,CAAA;IACrB,iCAAqB,CAAA;IACrB,6BAAiB,CAAA;IACjB,uCAA2B,CAAA;IAC3B,uCAA2B,CAAA;IAC3B,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,mDAAuC,CAAA;IACvC,qDAAyC,CAAA;IACzC,6CAAiC,CAAA;IACjC,mDAAuC,CAAA;IACvC,iDAAqC,CAAA;IACrC,yCAA6B,CAAA;IAC7B,qCAAyB,CAAA;IACzB,2DAA+C,CAAA;AACjD,CAAC,EAtBW,QAAQ,wBAAR,QAAQ,QAsBnB;AA0GD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,iDAAiC,CAAA;IACjC,qCAAqB,CAAA;AACvB,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAsFD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,iBAAiB;IACjB,uBAAS,CAAA;IACT,cAAc;IACd,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AA6CD,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,0EAA0E;IAC1E,iDAAqC,CAAA;IACrC,uCAAuC;IACvC,uCAA2B,CAAA;IAC3B,wCAAwC;IACxC,mCAAuB,CAAA;IACvB,yCAAyC;IACzC,2CAA+B,CAAA;AACjC,CAAC,EATW,QAAQ,wBAAR,QAAQ,QASnB;AAUD,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,2DAA2D;IAC3D,gFAAqD,CAAA;IACrD,0EAA0E;IAC1E,gFAAqD,CAAA;AACvD,CAAC,EALW,uBAAuB,uCAAvB,uBAAuB,QAKlC;AAeD,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,uCAAuC;IACvC,qDAAmC,CAAA;IACnC,6DAA6D;IAC7D,+DAA6C,CAAA;AAC/C,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAuCD,IAAY,WAiCX;AAjCD,WAAY,WAAW;IACrB,8DAA8D;IAC9D,0CAA2B,CAAA;IAC3B,oBAAoB;IACpB,0BAAW,CAAA;IACX,oFAAoF;IACpF,0BAAW,CAAA;IACX,yGAAyG;IACzG,4BAAa,CAAA;IACb,6GAA6G;IAC7G,gCAAiB,CAAA;IACjB,4BAA4B;IAC5B,gDAAiC,CAAA;IACjC,kFAAkF;IAClF,8CAA+B,CAAA;IAC/B,mRAAmR;IACnR,4CAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAA2C,CAAA;IAC3C,0BAA0B;IAC1B,4BAAa,CAAA;IACb,oIAAoI;IACpI,wCAAyB,CAAA;IACzB,8BAA8B;IAC9B,oCAAqB,CAAA;IACrB,gGAAgG;IAChG,oCAAqB,CAAA;IACrB,kHAAkH;IAClH,4BAAa,CAAA;IACb,sHAAsH;IACtH,gCAAiB,CAAA;IACjB,6IAA6I;IAC7I,sCAAuB,CAAA;AACzB,CAAC,EAjCW,WAAW,2BAAX,WAAW,QAiCtB;AA4ND,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B,sFAA+D,CAAA;IAC/D,uEAAuE;IACvE,wDAAiC,CAAA;IACjC,6FAA6F;IAC7F,oCAAa,CAAA;IACb,2DAA2D;IAC3D,wCAAiB,CAAA;IACjB,4DAA4D;IAC5D,4CAAqB,CAAA;AACvB,CAAC,EAVW,mBAAmB,mCAAnB,mBAAmB,QAU9B;AAuCD,IAAY,QAQX;AARD,WAAY,QAAQ;IAClB,uDAAuD;IACvD,+BAAmB,CAAA;IACnB;;;OAGG;IACH,2BAAe,CAAA;AACjB,CAAC,EARW,QAAQ,wBAAR,QAAQ,QAQnB;AAoBD,yCAAyC;AACzC,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,mEAAmE;IACnE,8CAA+B,CAAA;AACjC,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAKD,2CAA2C;AAC3C,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mEAAmE;IACnE,yDAAuC,CAAA;AACzC,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAKD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,8GAA8G;IAC9G,+DAA+C,CAAA;IAC/C,0FAA0F;IAC1F,qDAAqC,CAAA;AACvC,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAkKD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,uBAAuB;IACvB,wBAAW,CAAA;IACX,wBAAwB;IACxB,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA6OD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|