@wix/auto_sdk_ecom_cart 1.0.82 → 1.0.84

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.
@@ -437,6 +437,16 @@ interface Color {
437
437
  /** HEX or RGB color code for display. */
438
438
  code?: string | null;
439
439
  }
440
+ declare enum DescriptionLineType {
441
+ /** Unrecognized type. */
442
+ UNRECOGNISED = "UNRECOGNISED",
443
+ /** Plain text type. */
444
+ PLAIN_TEXT = "PLAIN_TEXT",
445
+ /** Color type. */
446
+ COLOR = "COLOR"
447
+ }
448
+ /** @enumType */
449
+ type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
440
450
  interface CommonImage {
441
451
  /** WixMedia image ID. */
442
452
  id?: string;
@@ -460,6 +470,16 @@ interface CommonImage {
460
470
  */
461
471
  filename?: string | null;
462
472
  }
473
+ interface FocalPoint {
474
+ /** X-coordinate of the focal point. */
475
+ x?: number;
476
+ /** Y-coordinate of the focal point. */
477
+ y?: number;
478
+ /** crop by height */
479
+ height?: number | null;
480
+ /** crop by width */
481
+ width?: number | null;
482
+ }
463
483
  interface ItemAvailabilityInfo {
464
484
  /** Item availability status. */
465
485
  status?: ItemAvailabilityStatusWithLiterals;
@@ -488,6 +508,18 @@ interface PhysicalProperties {
488
508
  /** Whether this line item is shippable. */
489
509
  shippable?: boolean;
490
510
  }
511
+ interface Scope {
512
+ /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
513
+ namespace?: string;
514
+ /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
515
+ group?: Group;
516
+ }
517
+ interface Group {
518
+ /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
519
+ name?: string;
520
+ /** Item ID (when the coupon scope is limited to just one item). */
521
+ entityId?: string | null;
522
+ }
491
523
  interface ItemType extends ItemTypeItemTypeDataOneOf {
492
524
  /** Preset item type. */
493
525
  preset?: ItemTypeItemTypeWithLiterals;
@@ -510,6 +542,115 @@ declare enum ItemTypeItemType {
510
542
  }
511
543
  /** @enumType */
512
544
  type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
545
+ interface SubscriptionOptionInfo {
546
+ /** Subscription option settings. */
547
+ subscriptionSettings?: SubscriptionSettings;
548
+ /** Subscription option title. */
549
+ title?: Title;
550
+ /** Subscription option description. */
551
+ description?: Description;
552
+ }
553
+ interface SubscriptionSettings {
554
+ /** Frequency of recurring payment. */
555
+ frequency?: SubscriptionFrequencyWithLiterals;
556
+ /**
557
+ * Interval of recurring payment.
558
+ *
559
+ * Default: `1`.
560
+ * If SubscriptionFrequency is Day the minimum interval is 7
561
+ * @min 1
562
+ * @max 3650
563
+ */
564
+ interval?: number | null;
565
+ /** Whether subscription is renewed automatically at the end of each period. */
566
+ autoRenewal?: boolean;
567
+ /**
568
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
569
+ * @min 1
570
+ */
571
+ billingCycles?: number | null;
572
+ /** Whether to allow the customer to cancel the subscription.. */
573
+ enableCustomerCancellation?: boolean;
574
+ /**
575
+ * Period until first cycle starts. If applied payNow will be 0
576
+ * If None => no free trial
577
+ */
578
+ freeTrialPeriod?: FreeTrialPeriod;
579
+ }
580
+ /** Frequency unit of recurring payment */
581
+ declare enum SubscriptionFrequency {
582
+ UNDEFINED = "UNDEFINED",
583
+ DAY = "DAY",
584
+ WEEK = "WEEK",
585
+ MONTH = "MONTH",
586
+ YEAR = "YEAR"
587
+ }
588
+ /** @enumType */
589
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
590
+ interface FreeTrialPeriod {
591
+ /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
592
+ frequency?: SubscriptionFrequencyWithLiterals;
593
+ /**
594
+ * interval of period
595
+ * @min 1
596
+ * @max 999
597
+ */
598
+ interval?: number;
599
+ }
600
+ interface Title {
601
+ /**
602
+ * Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
603
+ * @minLength 1
604
+ * @maxLength 150
605
+ */
606
+ original?: string;
607
+ /**
608
+ * Subscription option name translated into the buyer's language.
609
+ *
610
+ * Default: Same as `original`.
611
+ * @minLength 1
612
+ * @maxLength 150
613
+ */
614
+ translated?: string | null;
615
+ }
616
+ interface Description {
617
+ /**
618
+ * Subscription option description.
619
+ * @maxLength 500
620
+ */
621
+ original?: string;
622
+ /**
623
+ * Translated subscription option description.
624
+ * @maxLength 500
625
+ */
626
+ translated?: string | null;
627
+ }
628
+ interface SecuredMedia {
629
+ /**
630
+ * Media ID in Wix Media Manager.
631
+ * @minLength 1
632
+ * @maxLength 100
633
+ */
634
+ id?: string;
635
+ /**
636
+ * Original filename.
637
+ * @minLength 1
638
+ * @maxLength 1000
639
+ */
640
+ fileName?: string;
641
+ /** File type. */
642
+ fileType?: FileTypeWithLiterals;
643
+ }
644
+ declare enum FileType {
645
+ UNSPECIFIED = "UNSPECIFIED",
646
+ SECURE_PICTURE = "SECURE_PICTURE",
647
+ SECURE_VIDEO = "SECURE_VIDEO",
648
+ SECURE_DOCUMENT = "SECURE_DOCUMENT",
649
+ SECURE_MUSIC = "SECURE_MUSIC",
650
+ SECURE_ARCHIVE = "SECURE_ARCHIVE"
651
+ }
652
+ /** @enumType */
653
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
513
654
  /** Type of selected payment option for catalog item */
514
655
  declare enum PaymentOptionType {
515
656
  /** The entire payment for this item happens as part of the checkout. */
@@ -814,6 +955,41 @@ interface MerchantDiscount {
814
955
  /** Discount value. */
815
956
  amount?: MultiCurrencyPrice;
816
957
  }
958
+ interface DiscountRule {
959
+ /**
960
+ * Discount rule ID
961
+ * @format GUID
962
+ */
963
+ id?: string;
964
+ /** Discount rule name */
965
+ name?: DiscountRuleName;
966
+ /** Discount value. */
967
+ amount?: MultiCurrencyPrice;
968
+ }
969
+ interface DiscountRuleName {
970
+ /**
971
+ * Original discount rule name (in site's default language).
972
+ * @minLength 1
973
+ * @maxLength 256
974
+ */
975
+ original?: string;
976
+ /**
977
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
978
+ * @minLength 1
979
+ * @maxLength 500
980
+ */
981
+ translated?: string | null;
982
+ }
983
+ declare enum DiscountType {
984
+ /** "GLOBAL" - discount applies to entire order. */
985
+ GLOBAL = "GLOBAL",
986
+ /** "SPECIFIC-ITEMS" - discount applies to specific items. */
987
+ SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
988
+ /** "SHIPPING" - discount applies to shipping. For example, free shipping. */
989
+ SHIPPING = "SHIPPING"
990
+ }
991
+ /** @enumType */
992
+ type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
817
993
  /** Billing Info and shipping details */
818
994
  interface AddressWithContact {
819
995
  /** Address. */
@@ -940,6 +1116,12 @@ interface SelectedShippingOption {
940
1116
  */
941
1117
  code?: string;
942
1118
  }
1119
+ interface GetCurrentCartRequest {
1120
+ }
1121
+ interface GetCurrentCartResponse {
1122
+ /** Current session's active cart. */
1123
+ cart?: Cart;
1124
+ }
943
1125
  interface UpdateCartRequest {
944
1126
  /** Cart info. */
945
1127
  cartInfo?: Cart;
@@ -1152,10 +1334,67 @@ interface UpdateCartResponse {
1152
1334
  /** Updated Cart. */
1153
1335
  cart?: Cart;
1154
1336
  }
1337
+ interface AddToCurrentCartRequest {
1338
+ /**
1339
+ * Catalog line items.
1340
+ * @maxSize 100
1341
+ */
1342
+ lineItems?: LineItem[];
1343
+ /**
1344
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
1345
+ *
1346
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1347
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1348
+ * @maxSize 100
1349
+ */
1350
+ customLineItems?: CustomLineItem[];
1351
+ /**
1352
+ * Business location ID.
1353
+ * To update a cart's business location ID, use the UpdateCart method.
1354
+ * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
1355
+ * @format GUID
1356
+ */
1357
+ businessLocationId?: string | null;
1358
+ }
1155
1359
  interface AddToCartResponse {
1156
1360
  /** Updated cart. */
1157
1361
  cart?: Cart;
1158
1362
  }
1363
+ interface AddToCurrentCartAndEstimateTotalsRequest {
1364
+ /**
1365
+ * Catalog line items.
1366
+ * @maxSize 100
1367
+ */
1368
+ lineItems?: LineItem[];
1369
+ /**
1370
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
1371
+ *
1372
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1373
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1374
+ * @maxSize 100
1375
+ */
1376
+ customLineItems?: CustomLineItem[];
1377
+ /** Selected shipping option. */
1378
+ selectedShippingOption?: SelectedShippingOption;
1379
+ /** Shipping address. Used for calculating tax and shipping (when applicable). */
1380
+ shippingAddress?: Address;
1381
+ /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
1382
+ billingAddress?: Address;
1383
+ /** The selected membership payment options and which line items they apply to. */
1384
+ selectedMemberships?: SelectedMemberships;
1385
+ /**
1386
+ * Whether to calculate tax in the calculation request.
1387
+ *
1388
+ * Default: `true`
1389
+ */
1390
+ calculateTax?: boolean | null;
1391
+ /**
1392
+ * Whether to calculate shipping in the calculation request.
1393
+ *
1394
+ * Default: `true`
1395
+ */
1396
+ calculateShipping?: boolean | null;
1397
+ }
1159
1398
  interface SelectedMemberships {
1160
1399
  /**
1161
1400
  * Selected memberships.
@@ -1307,6 +1546,71 @@ interface TaxRateBreakdown {
1307
1546
  /** Amount of tax for this tax detail. */
1308
1547
  tax?: MultiCurrencyPrice;
1309
1548
  }
1549
+ /**
1550
+ * TaxBreakdown represents tax information for a line item.
1551
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1552
+ */
1553
+ interface TaxBreakdown {
1554
+ /**
1555
+ * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
1556
+ * @maxLength 200
1557
+ */
1558
+ jurisdiction?: string | null;
1559
+ /** The amount of this line item price that was considered nontaxable. (Decimal value) */
1560
+ nonTaxableAmount?: MultiCurrencyPrice;
1561
+ /**
1562
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
1563
+ * @decimalValue options { gte:0, maxScale:6 }
1564
+ */
1565
+ rate?: string | null;
1566
+ /** The amount of tax estimated for this line item. (Decimal value) */
1567
+ taxAmount?: MultiCurrencyPrice;
1568
+ /** The taxable amount of this line item. */
1569
+ taxableAmount?: MultiCurrencyPrice;
1570
+ /**
1571
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
1572
+ * @maxLength 200
1573
+ */
1574
+ taxType?: string | null;
1575
+ /**
1576
+ * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
1577
+ * This name should be explicit enough to allow the merchant to understand what tax was calculated.
1578
+ * @maxLength 200
1579
+ */
1580
+ taxName?: string | null;
1581
+ /** The type of the jurisdiction in which this tax detail applies. */
1582
+ jurisdictionType?: JurisdictionTypeWithLiterals;
1583
+ }
1584
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1585
+ declare enum JurisdictionType {
1586
+ UNDEFINED = "UNDEFINED",
1587
+ COUNTRY = "COUNTRY",
1588
+ STATE = "STATE",
1589
+ COUNTY = "COUNTY",
1590
+ CITY = "CITY",
1591
+ SPECIAL = "SPECIAL"
1592
+ }
1593
+ /** @enumType */
1594
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1595
+ interface CalculatedItemModifier {
1596
+ /**
1597
+ * Modifier ID.
1598
+ * @minLength 1
1599
+ * @maxLength 36
1600
+ */
1601
+ id?: string;
1602
+ /**
1603
+ * ID of the group this modifier belongs to.
1604
+ * @minLength 1
1605
+ * @maxLength 36
1606
+ */
1607
+ groupId?: string;
1608
+ /**
1609
+ * Modifier price.
1610
+ * @readonly
1611
+ */
1612
+ price?: MultiCurrencyPrice;
1613
+ }
1310
1614
  interface PriceSummary {
1311
1615
  /** Subtotal of all line items, before discounts and before tax. */
1312
1616
  subtotal?: MultiCurrencyPrice;
@@ -1420,6 +1724,38 @@ interface ApplicationError {
1420
1724
  /** Data related to the error. */
1421
1725
  data?: Record<string, any> | null;
1422
1726
  }
1727
+ /**
1728
+ * 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.
1729
+ * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1730
+ */
1731
+ interface AggregatedTaxBreakdown {
1732
+ /**
1733
+ * The name of the tax against which this tax amount was calculated.
1734
+ * @maxLength 200
1735
+ */
1736
+ taxName?: string;
1737
+ /**
1738
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
1739
+ * @maxLength 200
1740
+ */
1741
+ taxType?: string;
1742
+ /**
1743
+ * The name of the jurisdiction in which this tax detail applies.
1744
+ * @maxLength 200
1745
+ */
1746
+ jurisdiction?: string;
1747
+ /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1748
+ jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
1749
+ /**
1750
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
1751
+ * @decimalValue options { gte:0, maxScale:6 }
1752
+ */
1753
+ rate?: string;
1754
+ /** The sum of all the tax from line items that calculated by the tax identifiers. */
1755
+ aggregatedTaxAmount?: MultiCurrencyPrice;
1756
+ /** The sum of all the taxable amount from line items for tax identifiers. */
1757
+ aggregatedTaxableAmount?: MultiCurrencyPrice;
1758
+ }
1423
1759
  interface ShippingInformation {
1424
1760
  /** Shipping region. */
1425
1761
  region?: ShippingRegion;
@@ -1521,6 +1857,12 @@ declare enum PickupMethod {
1521
1857
  }
1522
1858
  /** @enumType */
1523
1859
  type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1860
+ interface DeliveryTimeSlot {
1861
+ /** starting time of the delivery time slot */
1862
+ from?: Date | null;
1863
+ /** ending time of the delivery time slot */
1864
+ to?: Date | null;
1865
+ }
1524
1866
  interface SelectedCarrierServiceOptionPrices {
1525
1867
  /** Total shipping price, after discount and after tax. */
1526
1868
  totalPriceAfterTax?: MultiCurrencyPrice;
@@ -1722,6 +2064,15 @@ interface V1DiscountRuleName {
1722
2064
  */
1723
2065
  translated?: string | null;
1724
2066
  }
2067
+ interface LineItemDiscount {
2068
+ /**
2069
+ * ID of line item the discount applies to.
2070
+ * @format GUID
2071
+ */
2072
+ id?: string;
2073
+ /** Discount value. */
2074
+ totalDiscountAmount?: MultiCurrencyPrice;
2075
+ }
1725
2076
  interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1726
2077
  /** General shipping calculation error. */
1727
2078
  generalShippingCalculationError?: Details;
@@ -2030,6 +2381,14 @@ declare enum NameInLineItem {
2030
2381
  }
2031
2382
  /** @enumType */
2032
2383
  type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2384
+ declare enum SuggestedFix {
2385
+ /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
2386
+ UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
2387
+ /** The line item should be removed from the cart or checkout to resolve the violation. */
2388
+ REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2389
+ }
2390
+ /** @enumType */
2391
+ type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2033
2392
  /** General (other) violation. */
2034
2393
  interface Other {
2035
2394
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
@@ -2042,10 +2401,34 @@ interface TargetLineItem {
2042
2401
  /** ID of the line item containing the violation. */
2043
2402
  id?: string | null;
2044
2403
  }
2404
+ interface RemoveLineItemsFromCurrentCartRequest {
2405
+ /**
2406
+ * Line item IDs to remove from cart.
2407
+ * @format GUID
2408
+ * @minSize 1
2409
+ * @maxSize 100
2410
+ */
2411
+ lineItemIds?: string[];
2412
+ }
2045
2413
  interface RemoveLineItemsResponse {
2046
2414
  /** Updated cart. */
2047
2415
  cart?: Cart;
2048
2416
  }
2417
+ interface CreateCheckoutFromCurrentCartRequest {
2418
+ /** __Required.__ Sales channel type. */
2419
+ channelType?: ChannelTypeWithLiterals;
2420
+ /** Shipping address. Used for calculating tax and shipping (when applicable). */
2421
+ shippingAddress?: Address;
2422
+ /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
2423
+ billingAddress?: Address;
2424
+ /** Selected shipping option. */
2425
+ selectedShippingOption?: SelectedShippingOption;
2426
+ /**
2427
+ * Required when setting billing or shipping address and user is not logged in.
2428
+ * @format EMAIL
2429
+ */
2430
+ email?: string | null;
2431
+ }
2049
2432
  declare enum ChannelType {
2050
2433
  /** Unspecified sales channel. This value is not supported. */
2051
2434
  UNSPECIFIED = "UNSPECIFIED",
@@ -2088,10 +2471,20 @@ interface CreateCheckoutResponse {
2088
2471
  /** The newly created checkout's ID. */
2089
2472
  checkoutId?: string;
2090
2473
  }
2474
+ interface RemoveCouponFromCurrentCartRequest {
2475
+ }
2091
2476
  interface RemoveCouponResponse {
2092
2477
  /** Updated cart. */
2093
2478
  cart?: Cart;
2094
2479
  }
2480
+ interface UpdateCurrentCartLineItemQuantityRequest {
2481
+ /**
2482
+ * Line item IDs and their new quantity.
2483
+ * @minSize 1
2484
+ * @maxSize 100
2485
+ */
2486
+ lineItems?: LineItemQuantityUpdate[];
2487
+ }
2095
2488
  interface LineItemQuantityUpdate {
2096
2489
  /**
2097
2490
  * *Required.** Line item ID.
@@ -2109,8 +2502,168 @@ interface UpdateLineItemsQuantityResponse {
2109
2502
  /** Updated cart. */
2110
2503
  cart?: Cart;
2111
2504
  }
2505
+ interface EstimateCurrentCartTotalsRequest {
2506
+ /** Selected shipping option. */
2507
+ selectedShippingOption?: SelectedShippingOption;
2508
+ /** Shipping address. Used for calculating tax and shipping (when applicable). */
2509
+ shippingAddress?: Address;
2510
+ /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
2511
+ billingAddress?: Address;
2512
+ /** The selected membership payment options and which line items they apply to. */
2513
+ selectedMemberships?: SelectedMemberships;
2514
+ /**
2515
+ * Whether to calculate tax in the calculation request.
2516
+ *
2517
+ * Default: `true`
2518
+ */
2519
+ calculateTax?: boolean | null;
2520
+ /**
2521
+ * Whether to calculate shipping in the calculation request.
2522
+ *
2523
+ * Default: `true`
2524
+ */
2525
+ calculateShipping?: boolean | null;
2526
+ }
2527
+ interface DeleteCurrentCartRequest {
2528
+ }
2112
2529
  interface DeleteCartResponse {
2113
2530
  }
2531
+ interface DomainEvent extends DomainEventBodyOneOf {
2532
+ createdEvent?: EntityCreatedEvent;
2533
+ updatedEvent?: EntityUpdatedEvent;
2534
+ deletedEvent?: EntityDeletedEvent;
2535
+ actionEvent?: ActionEvent;
2536
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2537
+ id?: string;
2538
+ /**
2539
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2540
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2541
+ */
2542
+ entityFqdn?: string;
2543
+ /**
2544
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2545
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2546
+ */
2547
+ slug?: string;
2548
+ /** ID of the entity associated with the event. */
2549
+ entityId?: string;
2550
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2551
+ eventTime?: Date | null;
2552
+ /**
2553
+ * Whether the event was triggered as a result of a privacy regulation application
2554
+ * (for example, GDPR).
2555
+ */
2556
+ triggeredByAnonymizeRequest?: boolean | null;
2557
+ /** If present, indicates the action that triggered the event. */
2558
+ originatedFrom?: string | null;
2559
+ /**
2560
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2561
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2562
+ */
2563
+ entityEventSequence?: string | null;
2564
+ }
2565
+ /** @oneof */
2566
+ interface DomainEventBodyOneOf {
2567
+ createdEvent?: EntityCreatedEvent;
2568
+ updatedEvent?: EntityUpdatedEvent;
2569
+ deletedEvent?: EntityDeletedEvent;
2570
+ actionEvent?: ActionEvent;
2571
+ }
2572
+ interface EntityCreatedEvent {
2573
+ entityAsJson?: string;
2574
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2575
+ restoreInfo?: RestoreInfo;
2576
+ }
2577
+ interface RestoreInfo {
2578
+ deletedDate?: Date | null;
2579
+ }
2580
+ interface EntityUpdatedEvent {
2581
+ /**
2582
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2583
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2584
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2585
+ */
2586
+ currentEntityAsJson?: string;
2587
+ }
2588
+ interface EntityDeletedEvent {
2589
+ /** Entity that was deleted. */
2590
+ deletedEntityAsJson?: string | null;
2591
+ }
2592
+ interface ActionEvent {
2593
+ bodyAsJson?: string;
2594
+ }
2595
+ interface MessageEnvelope {
2596
+ /**
2597
+ * App instance ID.
2598
+ * @format GUID
2599
+ */
2600
+ instanceId?: string | null;
2601
+ /**
2602
+ * Event type.
2603
+ * @maxLength 150
2604
+ */
2605
+ eventType?: string;
2606
+ /** The identification type and identity data. */
2607
+ identity?: IdentificationData;
2608
+ /** Stringify payload. */
2609
+ data?: string;
2610
+ }
2611
+ interface IdentificationData extends IdentificationDataIdOneOf {
2612
+ /**
2613
+ * ID of a site visitor that has not logged in to the site.
2614
+ * @format GUID
2615
+ */
2616
+ anonymousVisitorId?: string;
2617
+ /**
2618
+ * ID of a site visitor that has logged in to the site.
2619
+ * @format GUID
2620
+ */
2621
+ memberId?: string;
2622
+ /**
2623
+ * ID of a Wix user (site owner, contributor, etc.).
2624
+ * @format GUID
2625
+ */
2626
+ wixUserId?: string;
2627
+ /**
2628
+ * ID of an app.
2629
+ * @format GUID
2630
+ */
2631
+ appId?: string;
2632
+ /** @readonly */
2633
+ identityType?: WebhookIdentityTypeWithLiterals;
2634
+ }
2635
+ /** @oneof */
2636
+ interface IdentificationDataIdOneOf {
2637
+ /**
2638
+ * ID of a site visitor that has not logged in to the site.
2639
+ * @format GUID
2640
+ */
2641
+ anonymousVisitorId?: string;
2642
+ /**
2643
+ * ID of a site visitor that has logged in to the site.
2644
+ * @format GUID
2645
+ */
2646
+ memberId?: string;
2647
+ /**
2648
+ * ID of a Wix user (site owner, contributor, etc.).
2649
+ * @format GUID
2650
+ */
2651
+ wixUserId?: string;
2652
+ /**
2653
+ * ID of an app.
2654
+ * @format GUID
2655
+ */
2656
+ appId?: string;
2657
+ }
2658
+ declare enum WebhookIdentityType {
2659
+ UNKNOWN = "UNKNOWN",
2660
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2661
+ MEMBER = "MEMBER",
2662
+ WIX_USER = "WIX_USER",
2663
+ APP = "APP"
2664
+ }
2665
+ /** @enumType */
2666
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2114
2667
  interface CreateCartRequest {
2115
2668
  /** Cart info. */
2116
2669
  cartInfo?: Cart;
@@ -2279,6 +2832,8 @@ interface DeleteCartRequest {
2279
2832
  */
2280
2833
  id: string;
2281
2834
  }
2835
+ interface Empty {
2836
+ }
2282
2837
  interface RemoveBusinessLocationRequest {
2283
2838
  /**
2284
2839
  * Cart ID.
@@ -2290,6 +2845,46 @@ interface RemoveBusinessLocationResponse {
2290
2845
  /** Updated cart. */
2291
2846
  cart?: Cart;
2292
2847
  }
2848
+ /** @docsIgnore */
2849
+ type CreateCartApplicationErrors = {
2850
+ code?: 'CANT_ADD_SELECTED_MEMBERSHIP_FOR_NON_MEMBERSHIP_ITEM';
2851
+ description?: string;
2852
+ data?: Record<string, any>;
2853
+ } | {
2854
+ code?: 'CANT_CREATE_CART_WITHOUT_ITEMS';
2855
+ description?: string;
2856
+ data?: Record<string, any>;
2857
+ };
2858
+ /** @docsIgnore */
2859
+ type UpdateCartApplicationErrors = {
2860
+ code?: 'CAN_ONLY_UPDATE_CONTACT_ID_FOR_NOT_LOGGED_IN_CUSTOMER';
2861
+ description?: string;
2862
+ data?: Record<string, any>;
2863
+ };
2864
+ /** @docsIgnore */
2865
+ type AddToCartApplicationErrors = {
2866
+ code?: 'CART_IS_ALREADY_ASSOCIATED_WITH_DIFFERENT_LOCATION';
2867
+ description?: string;
2868
+ data?: Record<string, any>;
2869
+ };
2870
+ /** @docsIgnore */
2871
+ type CreateCheckoutApplicationErrors = {
2872
+ code?: 'LINE_ITEM_WITH_ZERO_QUANTITY';
2873
+ description?: string;
2874
+ data?: Record<string, any>;
2875
+ } | {
2876
+ code?: 'SITE_MUST_ACCEPT_PAYMENTS_TO_CREATE_CHECKOUT';
2877
+ description?: string;
2878
+ data?: Record<string, any>;
2879
+ } | {
2880
+ code?: 'CUSTOM_LINE_ITEM_ONLY_ACCEPTS_PAYMENTS_ONLINE_AND_OFFLINE';
2881
+ description?: string;
2882
+ data?: Record<string, any>;
2883
+ } | {
2884
+ code?: 'CUSTOM_LINE_ITEM_MUST_HAVE_EXACTLY_ONE_PROPERTIES_TYPE';
2885
+ description?: string;
2886
+ data?: Record<string, any>;
2887
+ };
2293
2888
 
2294
2889
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2295
2890
  getUrl: (context: any) => string;
@@ -2336,4 +2931,4 @@ declare function removeBusinessLocation(): __PublicMethodMetaInfo<'POST', {
2336
2931
  id: string;
2337
2932
  }, RemoveBusinessLocationRequest$1, RemoveBusinessLocationRequest, RemoveBusinessLocationResponse$1, RemoveBusinessLocationResponse>;
2338
2933
 
2339
- export { type __PublicMethodMetaInfo, addToCart, createCart, createCheckout, deleteCart, estimateTotals, getCart, getCartByCheckoutId, removeBusinessLocation, removeCoupon, removeLineItems, updateCart, updateLineItemsQuantity };
2934
+ export { type ActionEvent as ActionEventOriginal, type AddToCartApplicationErrors as AddToCartApplicationErrorsOriginal, type AddToCartRequest as AddToCartRequestOriginal, type AddToCartResponse as AddToCartResponseOriginal, type AddToCurrentCartAndEstimateTotalsRequest as AddToCurrentCartAndEstimateTotalsRequestOriginal, type AddToCurrentCartRequest as AddToCurrentCartRequestOriginal, type AdditionalFee as AdditionalFeeOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, type AggregatedTaxBreakdown as AggregatedTaxBreakdownOriginal, type ApplicableLineItems as ApplicableLineItemsOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, AppliedDiscountDiscountType as AppliedDiscountDiscountTypeOriginal, type AppliedDiscountDiscountTypeWithLiterals as AppliedDiscountDiscountTypeWithLiteralsOriginal, type AppliedDiscount as AppliedDiscountOriginal, type AutoTaxFallbackCalculationDetails as AutoTaxFallbackCalculationDetailsOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type CalculatedItemModifier as CalculatedItemModifierOriginal, type CalculatedLineItem as CalculatedLineItemOriginal, type CalculationErrors as CalculationErrorsOriginal, type CalculationErrorsShippingCalculationErrorOneOf as CalculationErrorsShippingCalculationErrorOneOfOriginal, type CarrierError as CarrierErrorOriginal, type CarrierErrors as CarrierErrorsOriginal, type Carrier as CarrierOriginal, type CarrierServiceOption as CarrierServiceOptionOriginal, type CartDiscountDiscountSourceOneOf as CartDiscountDiscountSourceOneOfOriginal, type CartDiscount as CartDiscountOriginal, type Cart as CartOriginal, type CatalogOverrideFields as CatalogOverrideFieldsOriginal, type CatalogReference as CatalogReferenceOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type Color as ColorOriginal, type CommonImage as CommonImageOriginal, type Coupon as CouponOriginal, type CreateCartApplicationErrors as CreateCartApplicationErrorsOriginal, type CreateCartRequest as CreateCartRequestOriginal, type CreateCartResponse as CreateCartResponseOriginal, type CreateCheckoutApplicationErrors as CreateCheckoutApplicationErrorsOriginal, type CreateCheckoutFromCurrentCartRequest as CreateCheckoutFromCurrentCartRequestOriginal, type CreateCheckoutRequest as CreateCheckoutRequestOriginal, type CreateCheckoutResponse as CreateCheckoutResponseOriginal, type CustomLineItem as CustomLineItemOriginal, type DeleteCartRequest as DeleteCartRequestOriginal, type DeleteCartResponse as DeleteCartResponseOriginal, type DeleteCurrentCartRequest as DeleteCurrentCartRequestOriginal, type DeliveryAllocation as DeliveryAllocationOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type Description as DescriptionOriginal, type DetailsKindOneOf as DetailsKindOneOfOriginal, type Details as DetailsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EstimateCurrentCartTotalsRequest as EstimateCurrentCartTotalsRequestOriginal, type EstimateTotalsRequest as EstimateTotalsRequestOriginal, type EstimateTotalsResponse as EstimateTotalsResponseOriginal, type ExtendedFields as ExtendedFieldsOriginal, FallbackReason as FallbackReasonOriginal, type FallbackReasonWithLiterals as FallbackReasonWithLiteralsOriginal, type FieldViolation as FieldViolationOriginal, FileType as FileTypeOriginal, type FileTypeWithLiterals as FileTypeWithLiteralsOriginal, type FocalPoint as FocalPointOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetCartByCheckoutIdRequest as GetCartByCheckoutIdRequestOriginal, type GetCartByCheckoutIdResponse as GetCartByCheckoutIdResponseOriginal, type GetCartRequest as GetCartRequestOriginal, type GetCartResponse as GetCartResponseOriginal, type GetCurrentCartRequest as GetCurrentCartRequestOriginal, type GetCurrentCartResponse as GetCurrentCartResponseOriginal, type GiftCard as GiftCardOriginal, type Group as GroupOriginal, type HostSelectedMembership as HostSelectedMembershipOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InvalidMembership as InvalidMembershipOriginal, type ItemAvailabilityInfo as ItemAvailabilityInfoOriginal, ItemAvailabilityStatus as ItemAvailabilityStatusOriginal, type ItemAvailabilityStatusWithLiterals as ItemAvailabilityStatusWithLiteralsOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, ItemTypeItemType as ItemTypeItemTypeOriginal, type ItemTypeItemTypeWithLiterals as ItemTypeItemTypeWithLiteralsOriginal, type ItemType as ItemTypeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItem as LineItemOriginal, type LineItemPricesData as LineItemPricesDataOriginal, type LineItemQuantityUpdate as LineItemQuantityUpdateOriginal, ManualCalculationReason as ManualCalculationReasonOriginal, type ManualCalculationReasonWithLiterals as ManualCalculationReasonWithLiteralsOriginal, type MembershipName as MembershipNameOriginal, type MembershipOptions as MembershipOptionsOriginal, type Membership as MembershipOriginal, type MembershipPaymentCredits as MembershipPaymentCreditsOriginal, type MerchantDiscountInput as MerchantDiscountInputOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ModifierGroup as ModifierGroupOriginal, type MultiCurrencyPrice as MultiCurrencyPriceOriginal, NameInLineItem as NameInLineItemOriginal, type NameInLineItemWithLiterals as NameInLineItemWithLiteralsOriginal, NameInOther as NameInOtherOriginal, type NameInOtherWithLiterals as NameInOtherWithLiteralsOriginal, type OtherCharge as OtherChargeOriginal, type Other as OtherOriginal, type PageUrlV2 as PageUrlV2Original, type PaymentOption as PaymentOptionOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type Policy as PolicyOriginal, type PriceDescription as PriceDescriptionOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, RateType as RateTypeOriginal, type RateTypeWithLiterals as RateTypeWithLiteralsOriginal, type Region as RegionOriginal, type RemoveBusinessLocationRequest as RemoveBusinessLocationRequestOriginal, type RemoveBusinessLocationResponse as RemoveBusinessLocationResponseOriginal, type RemoveCouponFromCurrentCartRequest as RemoveCouponFromCurrentCartRequestOriginal, type RemoveCouponRequest as RemoveCouponRequestOriginal, type RemoveCouponResponse as RemoveCouponResponseOriginal, type RemoveLineItemsFromCurrentCartRequest as RemoveLineItemsFromCurrentCartRequestOriginal, type RemoveLineItemsRequest as RemoveLineItemsRequestOriginal, type RemoveLineItemsResponse as RemoveLineItemsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, RuleType as RuleTypeOriginal, type RuleTypeWithLiterals as RuleTypeWithLiteralsOriginal, type Scope as ScopeOriginal, type SecuredMedia as SecuredMediaOriginal, type SelectedCarrierServiceOption as SelectedCarrierServiceOptionOriginal, type SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherChargeOriginal, type SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPricesOriginal, type SelectedMembership as SelectedMembershipOriginal, type SelectedMemberships as SelectedMembershipsOriginal, type SelectedShippingOption as SelectedShippingOptionOriginal, type ServiceProperties as ServicePropertiesOriginal, Severity as SeverityOriginal, type SeverityWithLiterals as SeverityWithLiteralsOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingOption as ShippingOptionOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRegion as ShippingRegionOriginal, type StreetAddress as StreetAddressOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionOptionInfo as SubscriptionOptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, SuggestedFix as SuggestedFixOriginal, type SuggestedFixWithLiterals as SuggestedFixWithLiteralsOriginal, type SystemError as SystemErrorOriginal, type TargetLineItem as TargetLineItemOriginal, type Target as TargetOriginal, type TargetTargetTypeOneOf as TargetTargetTypeOneOfOriginal, type TaxBreakdown as TaxBreakdownOriginal, type TaxCalculationDetailsCalculationDetailsOneOf as TaxCalculationDetailsCalculationDetailsOneOfOriginal, type TaxCalculationDetails as TaxCalculationDetailsOriginal, type TaxRateBreakdown as TaxRateBreakdownOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type Title as TitleOriginal, type TranslatableString as TranslatableStringOriginal, type UpdateCartApplicationErrors as UpdateCartApplicationErrorsOriginal, type UpdateCartRequest as UpdateCartRequestOriginal, type UpdateCartResponse as UpdateCartResponseOriginal, type UpdateCurrentCartLineItemQuantityRequest as UpdateCurrentCartLineItemQuantityRequestOriginal, type UpdateLineItemsQuantityRequest as UpdateLineItemsQuantityRequestOriginal, type UpdateLineItemsQuantityResponse as UpdateLineItemsQuantityResponseOriginal, type V1Coupon as V1CouponOriginal, type V1DiscountRuleName as V1DiscountRuleNameOriginal, type V1DiscountRule as V1DiscountRuleOriginal, type V1ItemModifier as V1ItemModifierOriginal, type V1MerchantDiscount as V1MerchantDiscountOriginal, type V1ModifierGroup as V1ModifierGroupOriginal, type ValidationError as ValidationErrorOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type Violation as ViolationOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type __PublicMethodMetaInfo, addToCart, createCart, createCheckout, deleteCart, estimateTotals, getCart, getCartByCheckoutId, removeBusinessLocation, removeCoupon, removeLineItems, updateCart, updateLineItemsQuantity };