@wix/auto_sdk_ecom_orders 1.0.69 → 1.0.70

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.
Files changed (41) hide show
  1. package/build/{internal/cjs/ecom-v1-order-orders.universal-BAE6DVkA.d.ts → cjs/ecom-v1-order-orders.universal-C73TYoI7.d.ts} +1857 -885
  2. package/build/cjs/index.d.ts +59 -6
  3. package/build/cjs/index.js +1118 -56
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +1295 -333
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1006 -38
  9. package/build/cjs/meta.js +665 -3
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/{internal/es/ecom-v1-order-orders.universal-BAE6DVkA.d.mts → es/ecom-v1-order-orders.universal-C73TYoI7.d.mts} +1857 -885
  12. package/build/es/index.d.mts +59 -6
  13. package/build/es/index.mjs +1090 -55
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +1267 -332
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1006 -38
  19. package/build/es/meta.mjs +653 -2
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/{cjs/ecom-v1-order-orders.universal-Br3Nippn.d.ts → internal/cjs/ecom-v1-order-orders.universal-KCtJReRk.d.ts} +2528 -365
  22. package/build/internal/cjs/index.d.ts +165 -6
  23. package/build/internal/cjs/index.js +1118 -56
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +2 -2
  26. package/build/internal/cjs/index.typings.js +1295 -333
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +1006 -38
  29. package/build/internal/cjs/meta.js +665 -3
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/{es/ecom-v1-order-orders.universal-Br3Nippn.d.mts → internal/es/ecom-v1-order-orders.universal-KCtJReRk.d.mts} +2528 -365
  32. package/build/internal/es/index.d.mts +165 -6
  33. package/build/internal/es/index.mjs +1090 -55
  34. package/build/internal/es/index.mjs.map +1 -1
  35. package/build/internal/es/index.typings.d.mts +2 -2
  36. package/build/internal/es/index.typings.mjs +1267 -332
  37. package/build/internal/es/index.typings.mjs.map +1 -1
  38. package/build/internal/es/meta.d.mts +1006 -38
  39. package/build/internal/es/meta.mjs +653 -2
  40. package/build/internal/es/meta.mjs.map +1 -1
  41. package/package.json +2 -2
@@ -283,25 +283,12 @@ interface OrderLineItem {
283
283
  locations?: LocationAndQuantity[];
284
284
  /** Address used for tax calculation. */
285
285
  taxableAddress?: TaxableAddress;
286
- /**
287
- * ID of the app managing the inventory.
288
- * @internal
289
- * @format GUID
290
- */
291
- inventoryAppId?: string | null;
292
286
  /**
293
287
  * Custom extended fields for the line item object.
294
288
  *
295
289
  * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
296
290
  */
297
291
  extendedFields?: ExtendedFields;
298
- /**
299
- * Modifier groups that were added to the item.
300
- * @internal
301
- * @readonly
302
- * @maxSize 10
303
- */
304
- modifierGroups?: ModifierGroup[];
305
292
  }
306
293
  interface ProductName {
307
294
  /**
@@ -372,11 +359,6 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
372
359
  colorInfo?: Color;
373
360
  /** Description line name. */
374
361
  name?: DescriptionLineName;
375
- /**
376
- * Whether the description line originates from a modifier.
377
- * @internal
378
- */
379
- modifierDescriptionLine?: boolean;
380
362
  }
381
363
  /** @oneof */
382
364
  interface DescriptionLineValueOneOf {
@@ -621,11 +603,6 @@ interface SubscriptionInfo {
621
603
  * @targetRemovalDate 2025-10-01
622
604
  */
623
605
  subscriptionOptionTitle?: string;
624
- /**
625
- * Subscription title. For example, `"Monthly coffee Subscription"`.
626
- * @internal
627
- */
628
- title?: SubscriptionTitle;
629
606
  /**
630
607
  * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
631
608
  * @maxLength 60
@@ -634,11 +611,6 @@ interface SubscriptionInfo {
634
611
  * @targetRemovalDate 2025-10-01
635
612
  */
636
613
  subscriptionOptionDescription?: string | null;
637
- /**
638
- * Subscription description. For example, `"1kg of selected coffee, once a month"`.
639
- * @internal
640
- */
641
- description?: SubscriptionDescription;
642
614
  /**
643
615
  * Subscription detailed information.
644
616
  * @immutable
@@ -649,11 +621,6 @@ interface SubscriptionInfo {
649
621
  * @maxLength 1000
650
622
  */
651
623
  chargesDescription?: string | null;
652
- /**
653
- * Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
654
- * @internal
655
- */
656
- billingAdjustment?: BillingAdjustment;
657
624
  }
658
625
  interface SubscriptionTitle {
659
626
  /**
@@ -703,11 +670,6 @@ interface SubscriptionSettings {
703
670
  enableCustomerCancellation?: boolean;
704
671
  /** Period until first cycle starts. If None => no free trial */
705
672
  freeTrialPeriod?: FreeTrialPeriod;
706
- /**
707
- * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
708
- * @internal
709
- */
710
- startDate?: Date | null;
711
673
  }
712
674
  /** Frequency unit of recurring payment */
713
675
  declare enum SubscriptionFrequency {
@@ -1384,14 +1346,6 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1384
1346
  * @immutable
1385
1347
  */
1386
1348
  _id?: string | null;
1387
- /**
1388
- * Number of subscription billing cycles the discount applies to.
1389
- * If None and discount is linked to subscription line item, it applies to all cycles.
1390
- * @internal
1391
- * @min 1
1392
- * @max 999
1393
- */
1394
- subscriptionCycles?: number | null;
1395
1349
  }
1396
1350
  /** @oneof */
1397
1351
  interface AppliedDiscountDiscountSourceOneOf {
@@ -1433,13 +1387,6 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1433
1387
  description?: string | null;
1434
1388
  /** Discount amount. */
1435
1389
  amount?: Price;
1436
- /**
1437
- * Discount percentage.
1438
- * @internal
1439
- * @format DECIMAL_VALUE
1440
- * @decimalValue options { gte:0, lte:100, maxScale:2 }
1441
- */
1442
- percentage?: string | null;
1443
1390
  }
1444
1391
  /** @oneof */
1445
1392
  interface MerchantDiscountMerchantDiscountReasonOneOf {
@@ -1502,70 +1449,6 @@ interface Activity extends ActivityContentOneOf {
1502
1449
  merchantComment?: MerchantComment;
1503
1450
  /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
1504
1451
  orderRefunded?: OrderRefunded;
1505
- /**
1506
- * Details of an initiated refund process.
1507
- *
1508
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1509
- * > In these cases, the `refund_id` will be identical across the activities.
1510
- * @internal
1511
- */
1512
- refundInitiated?: RefundInitiated;
1513
- /**
1514
- * Details of a refunded payment.
1515
- *
1516
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1517
- * > In these cases, the `refund_id` will be identical across the activities.
1518
- * @internal
1519
- */
1520
- paymentRefunded?: PaymentRefunded;
1521
- /**
1522
- * Details of a failed payment refund.
1523
- *
1524
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1525
- * > In these cases, the `refund_id` will be identical across the activities.
1526
- * @internal
1527
- */
1528
- paymentRefundFailed?: PaymentRefundFailed;
1529
- /**
1530
- * Details of refund to store credit.
1531
- * @internal
1532
- */
1533
- refundedAsStoreCredit?: RefundedAsStoreCredit;
1534
- /**
1535
- * Details of a pending payment
1536
- * @internal
1537
- */
1538
- paymentPending?: PaymentPending;
1539
- /**
1540
- * Details of a canceled payment
1541
- * @internal
1542
- */
1543
- paymentCanceled?: PaymentCanceled;
1544
- /**
1545
- * Details of a declined payment
1546
- * @internal
1547
- */
1548
- paymentDeclined?: PaymentDeclined;
1549
- /**
1550
- * Receipt was added for associated payment
1551
- * @internal
1552
- */
1553
- receiptCreated?: ReceiptCreated;
1554
- /**
1555
- * Receipt sent to customer
1556
- * @internal
1557
- */
1558
- receiptSent?: ReceiptSent;
1559
- /**
1560
- * Order received a chargeback for one of its' payments.
1561
- * @internal
1562
- */
1563
- chargebackCreated?: ChargebackCreated;
1564
- /**
1565
- * Chargeback reversed for one of the order's payments.
1566
- * @internal
1567
- */
1568
- chargebackReversed?: ChargebackReversed;
1569
1452
  /**
1570
1453
  * Activity ID.
1571
1454
  * @format GUID
@@ -1594,70 +1477,6 @@ interface ActivityContentOneOf {
1594
1477
  merchantComment?: MerchantComment;
1595
1478
  /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
1596
1479
  orderRefunded?: OrderRefunded;
1597
- /**
1598
- * Details of an initiated refund process.
1599
- *
1600
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1601
- * > In these cases, the `refund_id` will be identical across the activities.
1602
- * @internal
1603
- */
1604
- refundInitiated?: RefundInitiated;
1605
- /**
1606
- * Details of a refunded payment.
1607
- *
1608
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1609
- * > In these cases, the `refund_id` will be identical across the activities.
1610
- * @internal
1611
- */
1612
- paymentRefunded?: PaymentRefunded;
1613
- /**
1614
- * Details of a failed payment refund.
1615
- *
1616
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1617
- * > In these cases, the `refund_id` will be identical across the activities.
1618
- * @internal
1619
- */
1620
- paymentRefundFailed?: PaymentRefundFailed;
1621
- /**
1622
- * Details of refund to store credit.
1623
- * @internal
1624
- */
1625
- refundedAsStoreCredit?: RefundedAsStoreCredit;
1626
- /**
1627
- * Details of a pending payment
1628
- * @internal
1629
- */
1630
- paymentPending?: PaymentPending;
1631
- /**
1632
- * Details of a canceled payment
1633
- * @internal
1634
- */
1635
- paymentCanceled?: PaymentCanceled;
1636
- /**
1637
- * Details of a declined payment
1638
- * @internal
1639
- */
1640
- paymentDeclined?: PaymentDeclined;
1641
- /**
1642
- * Receipt was added for associated payment
1643
- * @internal
1644
- */
1645
- receiptCreated?: ReceiptCreated;
1646
- /**
1647
- * Receipt sent to customer
1648
- * @internal
1649
- */
1650
- receiptSent?: ReceiptSent;
1651
- /**
1652
- * Order received a chargeback for one of its' payments.
1653
- * @internal
1654
- */
1655
- chargebackCreated?: ChargebackCreated;
1656
- /**
1657
- * Chargeback reversed for one of the order's payments.
1658
- * @internal
1659
- */
1660
- chargebackReversed?: ChargebackReversed;
1661
1480
  }
1662
1481
  interface CustomActivity {
1663
1482
  /**
@@ -2409,29 +2228,11 @@ interface BalanceSummary {
2409
2228
  * @readonly
2410
2229
  */
2411
2230
  authorized?: Price;
2412
- /**
2413
- * Sum of all pending refund transactions.
2414
- * @internal
2415
- * @readonly
2416
- */
2417
- pendingRefund?: Price;
2418
2231
  /**
2419
2232
  * Sum of all pending transactions.
2420
2233
  * @readonly
2421
2234
  */
2422
2235
  pending?: Price;
2423
- /**
2424
- * Sum of all transaction chargebacks.
2425
- * @internal
2426
- * @readonly
2427
- */
2428
- chargeback?: Price;
2429
- /**
2430
- * Sum of all chargeback reversals.
2431
- * @internal
2432
- * @readonly
2433
- */
2434
- chargebackReversal?: Price;
2435
2236
  }
2436
2237
  /**
2437
2238
  * Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
@@ -2493,14 +2294,6 @@ interface AdditionalFee {
2493
2294
  * @format GUID
2494
2295
  */
2495
2296
  lineItemIds?: string[];
2496
- /**
2497
- * Number of subscription billing cycles the additional fee applies to.
2498
- * If None and additional fee is linked to subscription line item, it applies to all cycles.
2499
- * @internal
2500
- * @min 1
2501
- * @max 999
2502
- */
2503
- subscriptionCycles?: number | null;
2504
2297
  }
2505
2298
  interface FulfillmentStatusesAggregate {
2506
2299
  /** Unique string values based on Fulfillment entities statuses */
@@ -2557,21 +2350,10 @@ interface Location {
2557
2350
  */
2558
2351
  name?: string;
2559
2352
  }
2560
- interface DiffmatokyPayload {
2561
- left?: string;
2562
- right?: string;
2563
- compareChannel?: string;
2564
- entityId?: string;
2565
- errorInformation?: ErrorInformation;
2566
- tags?: string[];
2567
- }
2568
- interface ErrorInformation {
2569
- stackTrace?: string;
2570
- }
2571
- interface ContinueSideEffectsFlowInLegacyData {
2572
- storeId?: string;
2573
- orderId?: string;
2574
- ordersExperiments?: OrdersExperiments;
2353
+ /** Triggered when the order status changes to approved */
2354
+ interface OrderApproved {
2355
+ /** The order that was updated */
2356
+ order?: Order;
2575
2357
  }
2576
2358
  interface OrdersExperiments {
2577
2359
  epCommitTax?: boolean;
@@ -2580,20 +2362,6 @@ interface OrdersExperiments {
2580
2362
  producedByEpBridge?: boolean;
2581
2363
  enableRewrittenSideEffects?: boolean;
2582
2364
  }
2583
- interface SnapshotMessage {
2584
- _id?: string;
2585
- opType?: number;
2586
- }
2587
- interface IndexingMessage {
2588
- _id?: string;
2589
- opType?: number;
2590
- requiredVersions?: string[];
2591
- }
2592
- /** Triggered when the order status changes to approved */
2593
- interface OrderApproved {
2594
- /** The order that was updated */
2595
- order?: Order;
2596
- }
2597
2365
  interface OrderRejectedEventOrderRejected {
2598
2366
  /** The order that was rejected */
2599
2367
  order?: Order;
@@ -2603,9 +2371,9 @@ interface OrderItemsRestocked {
2603
2371
  /** The order which items were restocked */
2604
2372
  order?: Order;
2605
2373
  /** Restocked items and quantities */
2606
- restockItems?: RestockItem[];
2374
+ restockItems?: V1RestockItem[];
2607
2375
  }
2608
- interface RestockItem {
2376
+ interface V1RestockItem {
2609
2377
  /**
2610
2378
  * ID of the line item being restocked.
2611
2379
  * @format GUID
@@ -2618,131 +2386,1590 @@ interface RestockItem {
2618
2386
  */
2619
2387
  quantity?: number;
2620
2388
  }
2621
- interface GetOrderRequest {
2389
+ interface PreparePaymentCollectionRequest {
2622
2390
  /**
2623
- * ID of the order to retrieve.
2391
+ * Ecom order ID.
2624
2392
  * @minLength 1
2625
2393
  * @maxLength 100
2626
2394
  */
2627
- _id: string;
2628
- }
2629
- interface GetOrderResponse {
2630
- /** The requested order. */
2631
- order?: Order;
2632
- }
2633
- interface InternalQueryOrdersRequest {
2634
- /** Query options. */
2635
- query?: PlatformQuery;
2636
- }
2637
- interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2638
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
2639
- paging?: PlatformPaging;
2640
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
2641
- cursorPaging?: CursorPaging;
2642
- /** Filter object. */
2643
- filter?: Record<string, any> | null;
2644
- /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
2645
- sort?: Sorting[];
2646
- }
2647
- /** @oneof */
2648
- interface PlatformQueryPagingMethodOneOf {
2649
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
2650
- paging?: PlatformPaging;
2651
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
2652
- cursorPaging?: CursorPaging;
2653
- }
2654
- interface Sorting {
2395
+ ecomOrderId: string;
2396
+ /** Amount to collect */
2397
+ amount: Price;
2655
2398
  /**
2656
- * Name of the field to sort by.
2657
- * @maxLength 512
2399
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
2400
+ * Existing payment gateway order will be updated with a new amount.
2401
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
2658
2402
  */
2659
- fieldName?: string;
2660
- /** Sort order. */
2661
- order?: SortOrderWithLiterals;
2662
- }
2663
- declare enum SortOrder {
2664
- ASC = "ASC",
2665
- DESC = "DESC"
2666
- }
2667
- /** @enumType */
2668
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2669
- interface PlatformPaging {
2403
+ paymentGatewayOrderId?: string | null;
2670
2404
  /**
2671
- * Number of items to load.
2672
- * @max 100
2405
+ * Whether to delay capture of the payment.
2406
+ * Default: false
2407
+ * @deprecated Whether to delay capture of the payment.
2408
+ * Default: false
2409
+ * @replacedBy delayed_capture_settings.scheduled_action
2410
+ * @targetRemovalDate 2024-09-30
2673
2411
  */
2674
- limit?: number | null;
2675
- /** Number of items to skip in the current sort order. */
2676
- offset?: number | null;
2412
+ delayedCapture?: boolean;
2413
+ /** Delayed capture payment settings */
2414
+ delayedCaptureSettings?: DelayedCaptureSettings;
2677
2415
  }
2678
- interface CursorPaging {
2416
+ interface RedirectUrls {
2679
2417
  /**
2680
- * Maximum number of items to return in the results.
2681
- * @max 100
2418
+ * URL to redirect buyer in case of approved (successful) transaction
2419
+ * @format WEB_URL
2682
2420
  */
2683
- limit?: number | null;
2421
+ successUrl?: string | null;
2684
2422
  /**
2685
- * Pointer to the next or previous page in the list of results.
2686
- *
2687
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2688
- * Not relevant for the first request.
2689
- * @maxLength 16000
2423
+ * URL to redirect buyer in case of buyer canceled the transaction
2424
+ * @format WEB_URL
2690
2425
  */
2691
- cursor?: string | null;
2426
+ cancelUrl?: string | null;
2427
+ /**
2428
+ * URL to redirect buyer in case of failed/rejected transaction
2429
+ * @format WEB_URL
2430
+ */
2431
+ errorUrl?: string | null;
2432
+ /**
2433
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
2434
+ * @format WEB_URL
2435
+ */
2436
+ pendingUrl?: string | null;
2692
2437
  }
2693
- interface InternalQueryOrdersResponse {
2694
- /** List of orders. */
2695
- orders?: Order[];
2696
- /** Details on the paged set of results returned. */
2697
- metadata?: PlatformPagingMetadata;
2438
+ interface DelayedCaptureSettings {
2439
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
2440
+ scheduledAction?: ScheduledActionWithLiterals;
2441
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
2442
+ delayDuration?: Duration;
2698
2443
  }
2699
- interface PlatformPagingMetadata {
2700
- /** The number of items returned in this response. */
2701
- count?: number | null;
2702
- /** The offset which was requested. Returned if offset paging was used. */
2703
- offset?: number | null;
2704
- /** The total number of items that match the query. Returned if offset paging was used. */
2705
- total?: number | null;
2706
- /** Cursors to navigate through result pages. Returned if cursor paging was used. */
2707
- cursors?: Cursors;
2444
+ declare enum ScheduledAction {
2445
+ UNSPECIFIED = "UNSPECIFIED",
2446
+ /** Whether payment will be auto-voided when duration passes */
2447
+ VOID = "VOID",
2448
+ /** Whether payment will be auto-captured when duration passes */
2449
+ CAPTURE = "CAPTURE"
2708
2450
  }
2709
- interface Cursors {
2451
+ /** @enumType */
2452
+ type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
2453
+ interface Duration {
2710
2454
  /**
2711
- * Cursor string pointing to the next page in the list of results.
2712
- * @maxLength 16000
2455
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
2456
+ * @min 1
2713
2457
  */
2714
- next?: string | null;
2458
+ count?: number;
2459
+ /** Duration unit: MINUTES, HOURS and DAYS */
2460
+ unit?: DurationUnitWithLiterals;
2461
+ }
2462
+ declare enum DurationUnit {
2463
+ UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
2464
+ MINUTES = "MINUTES",
2465
+ HOURS = "HOURS",
2466
+ DAYS = "DAYS"
2467
+ }
2468
+ /** @enumType */
2469
+ type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
2470
+ interface PreparePaymentCollectionResponse {
2471
+ /** Payment gateway order id which is associated with given payment */
2472
+ paymentGatewayOrderId?: string;
2473
+ }
2474
+ interface GetPaymentCollectabilityStatusRequest {
2715
2475
  /**
2716
- * Cursor pointing to the previous page in the list of results.
2717
- * @maxLength 16000
2476
+ * Ecom order ID.
2477
+ * @minLength 1
2478
+ * @maxLength 100
2718
2479
  */
2719
- prev?: string | null;
2480
+ ecomOrderId: string;
2720
2481
  }
2721
- interface QueryOrderRequest {
2722
- /** Query options. */
2723
- query?: PlatformQuery;
2724
- }
2725
- interface QueryOrderResponse {
2726
- /** List of orders. */
2727
- orders?: Order[];
2728
- /** Details on the paged set of results returned. */
2729
- metadata?: PlatformPagingMetadata;
2482
+ interface GetPaymentCollectabilityStatusResponse {
2483
+ /** Payment collectability status */
2484
+ status?: PaymentCollectabilityStatusWithLiterals;
2485
+ /** Collectable order amount */
2486
+ amount?: Price;
2730
2487
  }
2731
- interface SearchOrdersRequest {
2732
- /** Search options. */
2733
- search?: CursorSearch;
2488
+ declare enum PaymentCollectabilityStatus {
2489
+ UNKNOWN = "UNKNOWN",
2490
+ COLLECTABLE = "COLLECTABLE",
2491
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
2492
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
2493
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
2494
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
2495
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
2496
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
2734
2497
  }
2735
- interface CursorSearch extends CursorSearchPagingMethodOneOf {
2498
+ /** @enumType */
2499
+ type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS';
2500
+ interface RecordManuallyCollectedPaymentRequest {
2736
2501
  /**
2737
- * Cursor paging options.
2738
- *
2739
- * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2502
+ * Order ID.
2503
+ * @minLength 1
2504
+ * @maxLength 100
2740
2505
  */
2741
- cursorPaging?: CursorPaging;
2506
+ orderId: string;
2507
+ /** Amount to be recorded as approved manual payment for given order */
2508
+ amount: Price;
2509
+ }
2510
+ interface RecordManuallyCollectedPaymentResponse {
2511
+ }
2512
+ interface MarkOrderAsPaidRequest {
2742
2513
  /**
2743
- * Filter object.
2744
- *
2745
- * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
2514
+ * Ecom order ID.
2515
+ * @minLength 1
2516
+ * @maxLength 100
2517
+ */
2518
+ ecomOrderId: string;
2519
+ }
2520
+ interface MarkOrderAsPaidResponse {
2521
+ /** Updated order. */
2522
+ order?: Order;
2523
+ }
2524
+ interface BulkMarkOrdersAsPaidRequest {
2525
+ /**
2526
+ * IDs of orders to mark as paid.
2527
+ * @minSize 1
2528
+ * @maxSize 100
2529
+ * @minLength 1
2530
+ * @maxLength 100
2531
+ */
2532
+ ecomOrderIds: string[];
2533
+ }
2534
+ interface BulkMarkOrdersAsPaidResponse {
2535
+ /**
2536
+ * Items updated by the bulk action.
2537
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
2538
+ */
2539
+ results?: BulkOrderResult[];
2540
+ /** Bulk action metadata. */
2541
+ bulkActionMetadata?: BulkActionMetadata;
2542
+ }
2543
+ interface BulkOrderResult {
2544
+ /** Item metadata. */
2545
+ itemMetadata?: ItemMetadata;
2546
+ /**
2547
+ * Updated order.
2548
+ *
2549
+ * Returned when `returnFullEntity = true`.
2550
+ */
2551
+ item?: Order;
2552
+ }
2553
+ interface ItemMetadata {
2554
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2555
+ _id?: string | null;
2556
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2557
+ originalIndex?: number;
2558
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2559
+ success?: boolean;
2560
+ /** Details about the error in case of failure. */
2561
+ error?: ApplicationError;
2562
+ }
2563
+ interface ApplicationError {
2564
+ /** Error code. */
2565
+ code?: string;
2566
+ /** Description of the error. */
2567
+ description?: string;
2568
+ /** Data related to the error. */
2569
+ data?: Record<string, any> | null;
2570
+ }
2571
+ interface BulkActionMetadata {
2572
+ /** Number of items that were successfully processed. */
2573
+ totalSuccesses?: number;
2574
+ /** Number of items that couldn't be processed. */
2575
+ totalFailures?: number;
2576
+ /** Number of failures without details because detailed failure threshold was exceeded. */
2577
+ undetailedFailures?: number;
2578
+ }
2579
+ interface GetRefundabilityStatusRequest {
2580
+ /**
2581
+ * Order ID.
2582
+ * @minLength 1
2583
+ * @maxLength 100
2584
+ */
2585
+ ecomOrderId: string;
2586
+ }
2587
+ interface GetRefundabilityStatusResponse {
2588
+ /**
2589
+ * Refundability details.
2590
+ * @maxSize 300
2591
+ */
2592
+ refundabilities?: Refundability[];
2593
+ /**
2594
+ * Whether the order supports refunding per item.
2595
+ * @deprecated
2596
+ */
2597
+ refundablePerItem?: boolean;
2598
+ }
2599
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2600
+ /** Reason why payment is not refundable. */
2601
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
2602
+ /** Reason why payment is only refundable manually. */
2603
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
2604
+ /** Payment ID. */
2605
+ paymentId?: string;
2606
+ /** Payment refundability status. */
2607
+ refundabilityStatus?: RefundableStatusWithLiterals;
2608
+ /** Link to payment provider dashboard. */
2609
+ providerLink?: string | null;
2610
+ }
2611
+ /** @oneof */
2612
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
2613
+ /** Reason why payment is not refundable. */
2614
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
2615
+ /** Reason why payment is only refundable manually. */
2616
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
2617
+ }
2618
+ declare enum RefundableStatus {
2619
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
2620
+ MANUAL = "MANUAL",
2621
+ REFUNDABLE = "REFUNDABLE"
2622
+ }
2623
+ /** @enumType */
2624
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
2625
+ declare enum NonRefundableReason {
2626
+ NONE = "NONE",
2627
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
2628
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
2629
+ INTERNAL_ERROR = "INTERNAL_ERROR",
2630
+ NOT_PAID = "NOT_PAID",
2631
+ ACCESS_DENIED = "ACCESS_DENIED",
2632
+ ZERO_PRICE = "ZERO_PRICE",
2633
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
2634
+ PENDING_REFUND = "PENDING_REFUND",
2635
+ FORBIDDEN = "FORBIDDEN",
2636
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
2637
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
2638
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
2639
+ }
2640
+ /** @enumType */
2641
+ type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
2642
+ declare enum ManuallyRefundableReason {
2643
+ EXPIRED = "EXPIRED",
2644
+ NOT_SUPPORTED = "NOT_SUPPORTED",
2645
+ OFFLINE = "OFFLINE",
2646
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
2647
+ }
2648
+ /** @enumType */
2649
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
2650
+ interface CreatePaymentGatewayOrderRequest {
2651
+ /**
2652
+ * Ecom order ID.
2653
+ * @minLength 1
2654
+ * @maxLength 100
2655
+ */
2656
+ ecomOrderId: string;
2657
+ /** Information about the user who initiated the payment. */
2658
+ chargedBy?: ChargedBy;
2659
+ }
2660
+ interface ChargedBy {
2661
+ /**
2662
+ * ID - id of the user who initiated the payment
2663
+ * @format GUID
2664
+ */
2665
+ _id?: string;
2666
+ /**
2667
+ * Full name - name of the user who initiated the payment
2668
+ * @minLength 1
2669
+ * @maxLength 200
2670
+ */
2671
+ fullName?: string | null;
2672
+ }
2673
+ interface CreatePaymentGatewayOrderResponse {
2674
+ /** ID of the order created in the payment gateway */
2675
+ paymentGatewayOrderId?: string;
2676
+ }
2677
+ interface ChargeMembershipsRequest {
2678
+ /**
2679
+ * Order ID.
2680
+ * @minLength 1
2681
+ * @maxLength 100
2682
+ */
2683
+ ecomOrderId: string;
2684
+ /**
2685
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
2686
+ * but a user which is using the membership on behalf of the a member
2687
+ * @format GUID
2688
+ */
2689
+ memberId: string;
2690
+ /**
2691
+ * List of items to be paid by memberships
2692
+ * @minSize 1
2693
+ * @maxSize 300
2694
+ */
2695
+ membershipCharges?: MembershipChargeItem[];
2696
+ }
2697
+ interface MembershipChargeItem {
2698
+ /**
2699
+ * The id of used membership
2700
+ * @minLength 1
2701
+ * @maxLength 100
2702
+ */
2703
+ membershipId?: string;
2704
+ /**
2705
+ * ID of the application providing this payment option
2706
+ * @format GUID
2707
+ */
2708
+ appId?: string;
2709
+ /** The name of used membership */
2710
+ membershipName?: MembershipName;
2711
+ /** Additional data about this membership */
2712
+ membershipAdditionalData?: Record<string, any> | null;
2713
+ /** Catalog and item reference info. */
2714
+ catalogReference?: CatalogReference;
2715
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
2716
+ serviceProperties?: ServiceProperties;
2717
+ /**
2718
+ * Usually would be the same as catalogReference.catalogItemId
2719
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
2720
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
2721
+ * @minLength 1
2722
+ * @maxLength 36
2723
+ */
2724
+ rootCatalogItemId?: string | null;
2725
+ /**
2726
+ * line item id of Checkout/Order line item
2727
+ * @minLength 1
2728
+ * @maxLength 100
2729
+ */
2730
+ lineItemId?: string;
2731
+ }
2732
+ interface MembershipName {
2733
+ /**
2734
+ * Membership name.
2735
+ * @maxLength 100
2736
+ */
2737
+ original?: string;
2738
+ /**
2739
+ * Translated membership name. Defaults to `original` when not provided.
2740
+ * @maxLength 100
2741
+ */
2742
+ translated?: string | null;
2743
+ }
2744
+ interface ServiceProperties {
2745
+ /**
2746
+ * 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.
2747
+ * For example, the start time of a class.
2748
+ */
2749
+ scheduledDate?: Date | null;
2750
+ /**
2751
+ * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
2752
+ * @min 1
2753
+ * @max 10000
2754
+ */
2755
+ numberOfParticipants?: number | null;
2756
+ }
2757
+ interface ChargeMembershipsResponse {
2758
+ }
2759
+ interface TriggerRefundRequest {
2760
+ /**
2761
+ * The order this refund related to
2762
+ * @minLength 1
2763
+ * @maxLength 100
2764
+ */
2765
+ ecomOrderId: string;
2766
+ /**
2767
+ * Refund operations information
2768
+ * @minSize 1
2769
+ * @maxSize 1
2770
+ */
2771
+ payments: PaymentRefund[];
2772
+ /** Business model of a refund */
2773
+ details?: RefundDetails;
2774
+ /** Side effect details related to refund */
2775
+ sideEffects?: RefundSideEffects;
2776
+ }
2777
+ interface PaymentRefund {
2778
+ /**
2779
+ * Specific payment within the order to refund
2780
+ * @format GUID
2781
+ */
2782
+ paymentId?: string;
2783
+ /** Refund amount. Not relevant for membership and gift card refunds. */
2784
+ amount?: Price;
2785
+ /**
2786
+ * Whether refund is made externally and manually (on the payment provider's side)
2787
+ * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
2788
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
2789
+ */
2790
+ externalRefund?: boolean;
2791
+ }
2792
+ /** Business model of a refund request */
2793
+ interface RefundDetails {
2794
+ /**
2795
+ * Order line item IDs and quantities that were refunded.
2796
+ * @maxSize 300
2797
+ */
2798
+ items?: RefundItem[];
2799
+ /** Whether the shipping fee was also refunded. */
2800
+ shippingIncluded?: boolean;
2801
+ /**
2802
+ * Reason for the refund, provided by customer (optional).
2803
+ * @maxLength 200
2804
+ */
2805
+ reason?: string | null;
2806
+ /**
2807
+ * Line items that were refunded.
2808
+ * @maxSize 300
2809
+ */
2810
+ lineItems?: LineItemRefund[];
2811
+ /**
2812
+ * Additional fees that were refunded.
2813
+ * @maxSize 100
2814
+ */
2815
+ additionalFees?: AdditionalFeeRefund[];
2816
+ /** Shipping amount that was refunded. */
2817
+ shipping?: ShippingRefund;
2818
+ }
2819
+ interface RefundItem {
2820
+ /**
2821
+ * Line item ID the refunded line item.
2822
+ * @format GUID
2823
+ */
2824
+ lineItemId?: string;
2825
+ /**
2826
+ * Line item quantity refunded.
2827
+ * @min 1
2828
+ * @max 100000
2829
+ */
2830
+ quantity?: number;
2831
+ }
2832
+ interface LineItemRefund {
2833
+ /**
2834
+ * Line item ID.
2835
+ * @format GUID
2836
+ * @immutable
2837
+ */
2838
+ lineItemId?: string;
2839
+ /**
2840
+ * Refund quantity.
2841
+ * @min 1
2842
+ * @max 100000
2843
+ * @immutable
2844
+ */
2845
+ quantity?: number;
2846
+ }
2847
+ interface AdditionalFeeRefund {
2848
+ /**
2849
+ * Additional fee ID.
2850
+ * @format GUID
2851
+ * @immutable
2852
+ */
2853
+ additionalFeeId?: string;
2854
+ /**
2855
+ * Refund amount.
2856
+ * @immutable
2857
+ */
2858
+ amount?: Price;
2859
+ }
2860
+ interface ShippingRefund {
2861
+ /**
2862
+ * Refund amount.
2863
+ * @immutable
2864
+ */
2865
+ amount?: Price;
2866
+ }
2867
+ interface RefundSideEffects {
2868
+ /** Inventory restock details as part of this refund. */
2869
+ restockInfo?: RestockInfo;
2870
+ /** Whether to send a refund confirmation email to the customer. */
2871
+ sendOrderRefundedEmail?: boolean;
2872
+ /**
2873
+ * Custom message added to the refund confirmation email.
2874
+ * @minLength 1
2875
+ * @maxLength 1000
2876
+ */
2877
+ customMessage?: string | null;
2878
+ }
2879
+ interface RestockInfo {
2880
+ /** Restock type. */
2881
+ type?: RestockTypeWithLiterals;
2882
+ /**
2883
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
2884
+ * @maxSize 300
2885
+ */
2886
+ items?: RestockItem[];
2887
+ }
2888
+ declare enum RestockType {
2889
+ NO_ITEMS = "NO_ITEMS",
2890
+ ALL_ITEMS = "ALL_ITEMS",
2891
+ SOME_ITEMS = "SOME_ITEMS"
2892
+ }
2893
+ /** @enumType */
2894
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
2895
+ interface RestockItem {
2896
+ /**
2897
+ * ID of the line item being restocked.
2898
+ * @format GUID
2899
+ */
2900
+ lineItemId?: string;
2901
+ /**
2902
+ * Line item quantity being restocked.
2903
+ * @min 1
2904
+ * @max 100000
2905
+ */
2906
+ quantity?: number;
2907
+ }
2908
+ interface TriggerRefundResponse {
2909
+ /** All order's transactions after the refunds were added */
2910
+ orderTransactions?: OrderTransactions;
2911
+ /** Created refund ID */
2912
+ refundId?: string | null;
2913
+ /** Payment ID's that the refund execution had failed for */
2914
+ failedPaymentIds?: ItemMetadata[];
2915
+ }
2916
+ interface OrderTransactions {
2917
+ /**
2918
+ * Order ID.
2919
+ * @format GUID
2920
+ */
2921
+ orderId?: string;
2922
+ /**
2923
+ * Record of payments made to the merchant.
2924
+ * @maxSize 100
2925
+ */
2926
+ payments?: Payment[];
2927
+ /**
2928
+ * Record of refunds made to the buyer.
2929
+ * @maxSize 300
2930
+ */
2931
+ refunds?: Refund[];
2932
+ }
2933
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
2934
+ /** Regular payment details. */
2935
+ regularPaymentDetails?: RegularPaymentDetails;
2936
+ /** Gift card payment details. */
2937
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
2938
+ /**
2939
+ * Payment ID.
2940
+ * @format GUID
2941
+ * @readonly
2942
+ */
2943
+ _id?: string | null;
2944
+ /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
2945
+ _createdDate?: Date | null;
2946
+ /**
2947
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2948
+ * @readonly
2949
+ */
2950
+ _updatedDate?: Date | null;
2951
+ /** Payment amount. */
2952
+ amount?: Price;
2953
+ /**
2954
+ * Whether refunds for this payment are disabled.
2955
+ * + `true`: This payment is not refundable.
2956
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
2957
+ */
2958
+ refundDisabled?: boolean;
2959
+ }
2960
+ /** @oneof */
2961
+ interface PaymentPaymentDetailsOneOf {
2962
+ /** Regular payment details. */
2963
+ regularPaymentDetails?: RegularPaymentDetails;
2964
+ /** Gift card payment details. */
2965
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
2966
+ }
2967
+ /** @oneof */
2968
+ interface PaymentReceiptInfoOneOf {
2969
+ }
2970
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
2971
+ /** Whether regular card used */
2972
+ creditCardDetails?: CreditCardPaymentMethodDetails;
2973
+ /**
2974
+ * Wix Payments order ID.
2975
+ * @maxLength 100
2976
+ */
2977
+ paymentOrderId?: string | null;
2978
+ /**
2979
+ * Payment gateway's transaction ID.
2980
+ * This field is only returned when the value of `offline_payment` is `false`.
2981
+ * @maxLength 100
2982
+ */
2983
+ gatewayTransactionId?: string | null;
2984
+ /**
2985
+ * Payment method. Non-exhaustive list of supported values:
2986
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
2987
+ * @maxLength 100
2988
+ */
2989
+ paymentMethod?: string | null;
2990
+ /**
2991
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
2992
+ * @maxLength 100
2993
+ */
2994
+ providerTransactionId?: string | null;
2995
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
2996
+ offlinePayment?: boolean;
2997
+ /** Payment status. */
2998
+ status?: TransactionStatusWithLiterals;
2999
+ /**
3000
+ * Whether there is a payment agreement that allows for future charges.
3001
+ * @immutable
3002
+ */
3003
+ savedPaymentMethod?: boolean;
3004
+ /** Authorization details. */
3005
+ authorizationDetails?: AuthorizationDetails;
3006
+ /**
3007
+ * Record of chargebacks made by the buyer.
3008
+ * @maxSize 6
3009
+ */
3010
+ chargebacks?: Chargeback[];
3011
+ }
3012
+ /** @oneof */
3013
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
3014
+ /** Whether regular card used */
3015
+ creditCardDetails?: CreditCardPaymentMethodDetails;
3016
+ }
3017
+ declare enum TransactionStatus {
3018
+ UNDEFINED = "UNDEFINED",
3019
+ APPROVED = "APPROVED",
3020
+ PENDING = "PENDING",
3021
+ PENDING_MERCHANT = "PENDING_MERCHANT",
3022
+ CANCELED = "CANCELED",
3023
+ DECLINED = "DECLINED",
3024
+ REFUNDED = "REFUNDED",
3025
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
3026
+ AUTHORIZED = "AUTHORIZED",
3027
+ VOIDED = "VOIDED"
3028
+ }
3029
+ /** @enumType */
3030
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
3031
+ interface CreditCardPaymentMethodDetails {
3032
+ /**
3033
+ * The last 4 digits of the card number.
3034
+ * @maxLength 4
3035
+ */
3036
+ lastFourDigits?: string | null;
3037
+ /**
3038
+ * Card issuer's brand.
3039
+ * @maxLength 100
3040
+ */
3041
+ brand?: string | null;
3042
+ }
3043
+ interface AuthorizationDetails {
3044
+ /**
3045
+ * Whether the authorized payment is of a delayed capture.
3046
+ * @readonly
3047
+ */
3048
+ delayedCapture?: boolean;
3049
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
3050
+ authorizedDate?: Date | null;
3051
+ /**
3052
+ * List of captures associated with payment
3053
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
3054
+ * @maxSize 1
3055
+ */
3056
+ captures?: AuthorizationCapture[];
3057
+ /** Void associated with payment */
3058
+ void?: AuthorizationVoid;
3059
+ /** Scheduled action for this transaction */
3060
+ scheduledAction?: V1ScheduledAction;
3061
+ }
3062
+ interface AuthorizationCapture {
3063
+ /**
3064
+ * Capture ID.
3065
+ * @format GUID
3066
+ * @readonly
3067
+ */
3068
+ _id?: string | null;
3069
+ /** Status of this capture action */
3070
+ status?: AuthorizationCaptureStatusWithLiterals;
3071
+ /**
3072
+ * Amount of this capture
3073
+ * @immutable
3074
+ */
3075
+ amount?: Price;
3076
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
3077
+ _createdDate?: Date | null;
3078
+ /** In case of status is FAILED may contain failure details */
3079
+ failureDetails?: AuthorizationActionFailureDetails;
3080
+ }
3081
+ declare enum AuthorizationCaptureStatus {
3082
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
3083
+ /** Capture operation still in progress. */
3084
+ PENDING = "PENDING",
3085
+ /** Capture operation succeeded. */
3086
+ SUCCEEDED = "SUCCEEDED",
3087
+ /** Capture operation failed. */
3088
+ FAILED = "FAILED"
3089
+ }
3090
+ /** @enumType */
3091
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
3092
+ interface AuthorizationActionFailureDetails {
3093
+ /** @maxLength 100 */
3094
+ failureCode?: string;
3095
+ }
3096
+ interface AuthorizationVoid {
3097
+ /** Status of this void action */
3098
+ status?: AuthorizationVoidStatusWithLiterals;
3099
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
3100
+ voidedDate?: Date | null;
3101
+ /** In case of status is FAILED may contain failure details */
3102
+ failureDetails?: AuthorizationActionFailureDetails;
3103
+ /** Reason of void action */
3104
+ reason?: ReasonWithLiterals;
3105
+ }
3106
+ declare enum AuthorizationVoidStatus {
3107
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
3108
+ /** Void operation still in progress. */
3109
+ PENDING = "PENDING",
3110
+ /** Void operation succeeded. */
3111
+ SUCCEEDED = "SUCCEEDED",
3112
+ /** Void operation failed. */
3113
+ FAILED = "FAILED"
3114
+ }
3115
+ /** @enumType */
3116
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
3117
+ /** Reason the authorization was voided. */
3118
+ declare enum Reason {
3119
+ UNKNOWN_REASON = "UNKNOWN_REASON",
3120
+ /** Authorization was voided by user. */
3121
+ MANUAL = "MANUAL",
3122
+ /** Authorization passed execution date. */
3123
+ SCHEDULED = "SCHEDULED"
3124
+ }
3125
+ /** @enumType */
3126
+ type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
3127
+ interface V1ScheduledAction {
3128
+ /** Type of the action. */
3129
+ actionType?: ActionTypeWithLiterals;
3130
+ /** The date and time of the action. */
3131
+ executionDate?: Date | null;
3132
+ }
3133
+ declare enum ActionType {
3134
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
3135
+ VOID = "VOID",
3136
+ CAPTURE = "CAPTURE"
3137
+ }
3138
+ /** @enumType */
3139
+ type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
3140
+ interface Chargeback {
3141
+ /**
3142
+ * Chargeback ID.
3143
+ * @format GUID
3144
+ * @readonly
3145
+ * @immutable
3146
+ */
3147
+ _id?: string;
3148
+ /**
3149
+ * Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
3150
+ * @readonly
3151
+ * @immutable
3152
+ */
3153
+ _createdDate?: Date | null;
3154
+ /**
3155
+ * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
3156
+ * @readonly
3157
+ */
3158
+ _updatedDate?: Date | null;
3159
+ /**
3160
+ * Amount.
3161
+ * @readonly
3162
+ * @immutable
3163
+ */
3164
+ amount?: Price;
3165
+ /**
3166
+ * Reversal amount. Present only when status is REVERSED.
3167
+ * @readonly
3168
+ */
3169
+ reversalAmount?: Price;
3170
+ /**
3171
+ * Status.
3172
+ *
3173
+ * Default: `"APPROVED"`.
3174
+ */
3175
+ status?: ChargebackStatusWithLiterals;
3176
+ /**
3177
+ * External chargeback ID.
3178
+ * @format GUID
3179
+ * @readonly
3180
+ * @immutable
3181
+ */
3182
+ externalId?: string | null;
3183
+ }
3184
+ declare enum ChargebackStatus {
3185
+ UNSPECIFIED = "UNSPECIFIED",
3186
+ /** Chargeback was approved. */
3187
+ APPROVED = "APPROVED",
3188
+ /** Chargeback was reversed. */
3189
+ REVERSED = "REVERSED"
3190
+ }
3191
+ /** @enumType */
3192
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'UNSPECIFIED' | 'APPROVED' | 'REVERSED';
3193
+ interface GiftCardPaymentDetails {
3194
+ /**
3195
+ * Gift card payment ID.
3196
+ * @minLength 1
3197
+ * @maxLength 100
3198
+ */
3199
+ giftCardPaymentId?: string;
3200
+ /**
3201
+ * ID of the app that created the gift card.
3202
+ * @format GUID
3203
+ */
3204
+ appId?: string;
3205
+ /**
3206
+ * Whether the gift card is voided.
3207
+ * @readonly
3208
+ */
3209
+ voided?: boolean;
3210
+ }
3211
+ interface MembershipPaymentDetails {
3212
+ /**
3213
+ * Membership ID.
3214
+ * @minLength 1
3215
+ * @maxLength 100
3216
+ */
3217
+ membershipId?: string;
3218
+ /**
3219
+ * ID of the line item this membership applies to.
3220
+ * @minLength 1
3221
+ * @maxLength 100
3222
+ */
3223
+ lineItemId?: string;
3224
+ /** Payment status. */
3225
+ status?: MembershipPaymentStatusWithLiterals;
3226
+ /** Membership name. */
3227
+ name?: MembershipName;
3228
+ /**
3229
+ * The transaction ID in the membership system. Can be used to void the transaction.
3230
+ * @minLength 1
3231
+ * @maxLength 100
3232
+ */
3233
+ externalTransactionId?: string | null;
3234
+ /**
3235
+ * Whether the membership is voided.
3236
+ * @readonly
3237
+ */
3238
+ voided?: boolean;
3239
+ /**
3240
+ * ID of the application providing this payment option.
3241
+ * @format GUID
3242
+ */
3243
+ providerAppId?: string;
3244
+ }
3245
+ declare enum MembershipPaymentStatus {
3246
+ /** Payment was charged. */
3247
+ CHARGED = "CHARGED",
3248
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
3249
+ CHARGE_FAILED = "CHARGE_FAILED"
3250
+ }
3251
+ /** @enumType */
3252
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
3253
+ interface WixReceiptInfo {
3254
+ /**
3255
+ * Receipt ID
3256
+ * @format GUID
3257
+ */
3258
+ receiptId?: string;
3259
+ /**
3260
+ * Display number of receipt
3261
+ * @minLength 1
3262
+ * @maxLength 40
3263
+ */
3264
+ displayNumber?: string | null;
3265
+ }
3266
+ interface ExternalReceiptInfo {
3267
+ /**
3268
+ * External receipt ID
3269
+ * @maxLength 100
3270
+ */
3271
+ receiptId?: string | null;
3272
+ /**
3273
+ * ID of the app providing the receipt
3274
+ * @format GUID
3275
+ */
3276
+ appId?: string | null;
3277
+ /**
3278
+ * Display number of receipt
3279
+ * @minLength 1
3280
+ * @maxLength 40
3281
+ */
3282
+ displayNumber?: string | null;
3283
+ }
3284
+ interface Refund {
3285
+ /**
3286
+ * Refund ID.
3287
+ * @format GUID
3288
+ * @readonly
3289
+ */
3290
+ _id?: string;
3291
+ /**
3292
+ * List of transactions.
3293
+ * @maxSize 50
3294
+ */
3295
+ transactions?: RefundTransaction[];
3296
+ /** Refund business details. */
3297
+ details?: RefundDetails;
3298
+ /**
3299
+ * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
3300
+ * @readonly
3301
+ * @immutable
3302
+ */
3303
+ _createdDate?: Date | null;
3304
+ /**
3305
+ * Aggregated refund summary.
3306
+ * @readonly
3307
+ */
3308
+ summary?: AggregatedRefundSummary;
3309
+ /**
3310
+ * ID of the app that initiated this refund.
3311
+ * @format GUID
3312
+ * @readonly
3313
+ * @immutable
3314
+ */
3315
+ requestingServiceAppId?: string | null;
3316
+ }
3317
+ interface RefundTransaction {
3318
+ /**
3319
+ * ID of the payment associated with this refund.
3320
+ * @format GUID
3321
+ * @immutable
3322
+ */
3323
+ paymentId?: string;
3324
+ /**
3325
+ * Refund amount.
3326
+ * @immutable
3327
+ */
3328
+ amount?: Price;
3329
+ /** Refund status. */
3330
+ refundStatus?: RefundStatusWithLiterals;
3331
+ /** Optional details of current refund status. */
3332
+ refundStatusInfo?: RefundStatusInfo;
3333
+ /**
3334
+ * Payment gateway's refund ID.
3335
+ * This field is only returned when the value of `external_refund` is `false`.
3336
+ * @format GUID
3337
+ */
3338
+ gatewayRefundId?: string | null;
3339
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
3340
+ providerRefundId?: string | null;
3341
+ /**
3342
+ * Whether refund was made externally and manually on the payment provider's side.
3343
+ * @immutable
3344
+ */
3345
+ externalRefund?: boolean;
3346
+ }
3347
+ /** Refund transaction status. */
3348
+ declare enum RefundStatus {
3349
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
3350
+ PENDING = "PENDING",
3351
+ /** Refund transaction succeeded. */
3352
+ SUCCEEDED = "SUCCEEDED",
3353
+ /** Refund transaction failed. */
3354
+ FAILED = "FAILED",
3355
+ /** Refund request acknowledged, and will be executed soon. */
3356
+ SCHEDULED = "SCHEDULED",
3357
+ /** Refund was initiated on payment provider side. */
3358
+ STARTED = "STARTED"
3359
+ }
3360
+ /** @enumType */
3361
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
3362
+ interface RefundStatusInfo {
3363
+ /**
3364
+ * Reason code for the refund's current status.
3365
+ *
3366
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
3367
+ * @minLength 1
3368
+ * @maxLength 10
3369
+ */
3370
+ paymentGatewayReasonCode?: string | null;
3371
+ /**
3372
+ * Free text explanation of current refund status.
3373
+ * @minLength 1
3374
+ * @maxLength 1000
3375
+ */
3376
+ description?: string | null;
3377
+ }
3378
+ interface AggregatedRefundSummary {
3379
+ /** Total amount requested for refund. */
3380
+ requestedRefund?: Price;
3381
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
3382
+ pendingRefund?: Price;
3383
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
3384
+ refunded?: Price;
3385
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
3386
+ failedRefundAmount?: Price;
3387
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
3388
+ pending?: boolean;
3389
+ /** Breakdown of refunded items. Available only after refund is complete. */
3390
+ breakdown?: RefundItemsBreakdown;
3391
+ }
3392
+ interface RefundItemsBreakdown {
3393
+ /**
3394
+ * Refunded line items and the amount refunded for each.
3395
+ * @maxSize 300
3396
+ */
3397
+ lineItems?: LineItemRefundSummary[];
3398
+ }
3399
+ interface LineItemRefundSummary {
3400
+ /**
3401
+ * ID of the refunded line item.
3402
+ * @format GUID
3403
+ */
3404
+ lineItemId?: string;
3405
+ /** Total refunded amount for the line item. */
3406
+ totalRefundedAmount?: Price;
3407
+ }
3408
+ interface CalculateRefundRequest {
3409
+ /**
3410
+ * Order ID
3411
+ * @minLength 1
3412
+ * @maxLength 100
3413
+ */
3414
+ ecomOrderId?: string;
3415
+ /**
3416
+ * Refunded line items and quantity
3417
+ * @maxSize 300
3418
+ */
3419
+ refundItems?: CalculateRefundItemRequest[];
3420
+ /** Should include shipping in refund calculation */
3421
+ refundShipping?: boolean;
3422
+ }
3423
+ interface CalculateRefundItemRequest {
3424
+ /**
3425
+ * ID of the line item being refunded
3426
+ * @format GUID
3427
+ */
3428
+ _id?: string;
3429
+ /**
3430
+ * How much of that line item is being refunded
3431
+ * @min 1
3432
+ * @max 100000
3433
+ */
3434
+ quantity?: number;
3435
+ }
3436
+ interface CalculateRefundResponse {
3437
+ /** Total refundable amount */
3438
+ total?: Price;
3439
+ /** Tax cost of the order */
3440
+ tax?: Price;
3441
+ /** Discount given for this order */
3442
+ discount?: Price;
3443
+ /** Total cost of the order (without tax) */
3444
+ subtotal?: Price;
3445
+ /** Total shipping cost for order */
3446
+ shipping?: Price;
3447
+ /** Previous refund given on that order */
3448
+ previouslyRefundedAmount?: Price;
3449
+ /**
3450
+ * The refundable items of that order
3451
+ * @maxSize 300
3452
+ */
3453
+ items?: CalculateRefundItemResponse[];
3454
+ }
3455
+ interface CalculateRefundItemResponse {
3456
+ /**
3457
+ * Line item ID
3458
+ * @format GUID
3459
+ */
3460
+ _id?: string;
3461
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
3462
+ price?: Price;
3463
+ }
3464
+ interface VoidAuthorizedPaymentsRequest {
3465
+ /**
3466
+ * Wix eCommerce order ID
3467
+ * @minLength 1
3468
+ * @maxLength 100
3469
+ */
3470
+ ecomOrderId: string;
3471
+ /**
3472
+ * Payment IDs
3473
+ * @minSize 1
3474
+ * @maxSize 100
3475
+ * @format GUID
3476
+ */
3477
+ paymentIds: string[];
3478
+ }
3479
+ interface VoidAuthorizedPaymentsResponse {
3480
+ /** All order's transactions after the void was triggered */
3481
+ orderTransactions?: OrderTransactions;
3482
+ }
3483
+ interface CaptureAuthorizedPaymentsRequest {
3484
+ /**
3485
+ * Wix eCommerce order ID
3486
+ * @minLength 1
3487
+ * @maxLength 100
3488
+ */
3489
+ ecomOrderId: string;
3490
+ /**
3491
+ * Capture payments information
3492
+ * @minSize 1
3493
+ * @maxSize 100
3494
+ */
3495
+ payments: PaymentCapture[];
3496
+ }
3497
+ interface PaymentCapture {
3498
+ /**
3499
+ * Payment ID
3500
+ * @format GUID
3501
+ */
3502
+ paymentId?: string | null;
3503
+ /**
3504
+ * Capture amount.
3505
+ * If not provided - full authorized amount will be captured.
3506
+ */
3507
+ amount?: Price;
3508
+ }
3509
+ interface CaptureAuthorizedPaymentsResponse {
3510
+ /** All order's transactions after the capture was triggered */
3511
+ orderTransactions?: OrderTransactions;
3512
+ }
3513
+ interface ChargeSavedPaymentMethodRequest {
3514
+ /**
3515
+ * Ecom Order ID.
3516
+ * @minLength 1
3517
+ * @maxLength 100
3518
+ */
3519
+ ecomOrderId?: string;
3520
+ /** Amount to be charged */
3521
+ amount?: Price;
3522
+ }
3523
+ interface ChargeSavedPaymentMethodResponse {
3524
+ /** Payment gateway's order ID (e.g Wix Payments) */
3525
+ paymentGatewayOrderId?: string;
3526
+ }
3527
+ interface DomainEvent extends DomainEventBodyOneOf {
3528
+ createdEvent?: EntityCreatedEvent;
3529
+ updatedEvent?: EntityUpdatedEvent;
3530
+ deletedEvent?: EntityDeletedEvent;
3531
+ actionEvent?: ActionEvent;
3532
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3533
+ _id?: string;
3534
+ /**
3535
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3536
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3537
+ */
3538
+ entityFqdn?: string;
3539
+ /**
3540
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3541
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3542
+ */
3543
+ slug?: string;
3544
+ /** ID of the entity associated with the event. */
3545
+ entityId?: string;
3546
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3547
+ eventTime?: Date | null;
3548
+ /**
3549
+ * Whether the event was triggered as a result of a privacy regulation application
3550
+ * (for example, GDPR).
3551
+ */
3552
+ triggeredByAnonymizeRequest?: boolean | null;
3553
+ /** If present, indicates the action that triggered the event. */
3554
+ originatedFrom?: string | null;
3555
+ /**
3556
+ * 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.
3557
+ * 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.
3558
+ */
3559
+ entityEventSequence?: string | null;
3560
+ }
3561
+ /** @oneof */
3562
+ interface DomainEventBodyOneOf {
3563
+ createdEvent?: EntityCreatedEvent;
3564
+ updatedEvent?: EntityUpdatedEvent;
3565
+ deletedEvent?: EntityDeletedEvent;
3566
+ actionEvent?: ActionEvent;
3567
+ }
3568
+ interface EntityCreatedEvent {
3569
+ entity?: string;
3570
+ }
3571
+ interface RestoreInfo {
3572
+ deletedDate?: Date | null;
3573
+ }
3574
+ interface EntityUpdatedEvent {
3575
+ /**
3576
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3577
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3578
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3579
+ */
3580
+ currentEntity?: string;
3581
+ }
3582
+ interface EntityDeletedEvent {
3583
+ /** Entity that was deleted. */
3584
+ deletedEntity?: string | null;
3585
+ }
3586
+ interface ActionEvent {
3587
+ body?: string;
3588
+ }
3589
+ interface Empty {
3590
+ }
3591
+ interface MessageEnvelope {
3592
+ /**
3593
+ * App instance ID.
3594
+ * @format GUID
3595
+ */
3596
+ instanceId?: string | null;
3597
+ /**
3598
+ * Event type.
3599
+ * @maxLength 150
3600
+ */
3601
+ eventType?: string;
3602
+ /** The identification type and identity data. */
3603
+ identity?: IdentificationData;
3604
+ /** Stringify payload. */
3605
+ data?: string;
3606
+ }
3607
+ interface IdentificationData extends IdentificationDataIdOneOf {
3608
+ /**
3609
+ * ID of a site visitor that has not logged in to the site.
3610
+ * @format GUID
3611
+ */
3612
+ anonymousVisitorId?: string;
3613
+ /**
3614
+ * ID of a site visitor that has logged in to the site.
3615
+ * @format GUID
3616
+ */
3617
+ memberId?: string;
3618
+ /**
3619
+ * ID of a Wix user (site owner, contributor, etc.).
3620
+ * @format GUID
3621
+ */
3622
+ wixUserId?: string;
3623
+ /**
3624
+ * ID of an app.
3625
+ * @format GUID
3626
+ */
3627
+ appId?: string;
3628
+ /** @readonly */
3629
+ identityType?: WebhookIdentityTypeWithLiterals;
3630
+ }
3631
+ /** @oneof */
3632
+ interface IdentificationDataIdOneOf {
3633
+ /**
3634
+ * ID of a site visitor that has not logged in to the site.
3635
+ * @format GUID
3636
+ */
3637
+ anonymousVisitorId?: string;
3638
+ /**
3639
+ * ID of a site visitor that has logged in to the site.
3640
+ * @format GUID
3641
+ */
3642
+ memberId?: string;
3643
+ /**
3644
+ * ID of a Wix user (site owner, contributor, etc.).
3645
+ * @format GUID
3646
+ */
3647
+ wixUserId?: string;
3648
+ /**
3649
+ * ID of an app.
3650
+ * @format GUID
3651
+ */
3652
+ appId?: string;
3653
+ }
3654
+ declare enum WebhookIdentityType {
3655
+ UNKNOWN = "UNKNOWN",
3656
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3657
+ MEMBER = "MEMBER",
3658
+ WIX_USER = "WIX_USER",
3659
+ APP = "APP"
3660
+ }
3661
+ /** @enumType */
3662
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3663
+ interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
3664
+ /** insert/update documents */
3665
+ update?: InternalDocumentUpdateOperation;
3666
+ /** delete by document ids */
3667
+ deleteByIds?: DeleteByIdsOperation;
3668
+ /** delete documents matching filter */
3669
+ deleteByFilter?: DeleteByFilterOperation;
3670
+ /** update internal documents matching filter */
3671
+ updateByFilter?: InternalDocumentUpdateByFilterOperation;
3672
+ /** update only existing documents */
3673
+ updateExisting?: InternalUpdateExistingOperation;
3674
+ /** insert/update documents with versioning */
3675
+ versionedUpdate?: VersionedDocumentUpdateOperation;
3676
+ /** delete by document ids with versioning */
3677
+ versionedDeleteByIds?: VersionedDeleteByIdsOperation;
3678
+ /**
3679
+ * type of the documents
3680
+ * @minLength 2
3681
+ */
3682
+ documentType?: string;
3683
+ /**
3684
+ * language of the documents (mandatory)
3685
+ * @minLength 2
3686
+ */
3687
+ language?: string | null;
3688
+ /**
3689
+ * one or more search documents
3690
+ * @deprecated
3691
+ */
3692
+ addDocuments?: InternalDocument[];
3693
+ /**
3694
+ * one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
3695
+ * @deprecated
3696
+ */
3697
+ removeDocumentIds?: string[];
3698
+ /** id to pass to processing notification */
3699
+ correlationId?: string | null;
3700
+ /** when event was created / issued */
3701
+ issuedAt?: Date | null;
3702
+ }
3703
+ /** @oneof */
3704
+ interface UpdateInternalDocumentsEventOperationOneOf {
3705
+ /** insert/update documents */
3706
+ update?: InternalDocumentUpdateOperation;
3707
+ /** delete by document ids */
3708
+ deleteByIds?: DeleteByIdsOperation;
3709
+ /** delete documents matching filter */
3710
+ deleteByFilter?: DeleteByFilterOperation;
3711
+ /** update internal documents matching filter */
3712
+ updateByFilter?: InternalDocumentUpdateByFilterOperation;
3713
+ /** update only existing documents */
3714
+ updateExisting?: InternalUpdateExistingOperation;
3715
+ /** insert/update documents with versioning */
3716
+ versionedUpdate?: VersionedDocumentUpdateOperation;
3717
+ /** delete by document ids with versioning */
3718
+ versionedDeleteByIds?: VersionedDeleteByIdsOperation;
3719
+ }
3720
+ interface InternalDocument {
3721
+ /** document with mandatory fields (id) and with fields specific to the type of the document */
3722
+ document?: Record<string, any> | null;
3723
+ }
3724
+ interface InternalDocumentUpdateOperation {
3725
+ /** documents to index or update */
3726
+ documents?: InternalDocument[];
3727
+ }
3728
+ interface DeleteByIdsOperation {
3729
+ /** ids of the documents to delete */
3730
+ documentIds?: string[];
3731
+ /**
3732
+ * tenant id for custom tenancy strategy
3733
+ * @minLength 2
3734
+ * @maxLength 300
3735
+ */
3736
+ tenantId?: string | null;
3737
+ }
3738
+ interface DeleteByFilterOperation {
3739
+ /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
3740
+ filter?: Record<string, any> | null;
3741
+ /**
3742
+ * tenant id for custom tenancy strategy
3743
+ * @minLength 2
3744
+ * @maxLength 300
3745
+ */
3746
+ tenantId?: string | null;
3747
+ }
3748
+ interface InternalDocumentUpdateByFilterOperation {
3749
+ /** documents matching this filter will be updated */
3750
+ filter?: Record<string, any> | null;
3751
+ /** partial document to apply */
3752
+ document?: InternalDocument;
3753
+ /**
3754
+ * tenant id for custom tenancy strategy
3755
+ * @minLength 2
3756
+ * @maxLength 300
3757
+ */
3758
+ tenantId?: string | null;
3759
+ }
3760
+ interface InternalUpdateExistingOperation {
3761
+ /** documents to update */
3762
+ documents?: InternalDocument[];
3763
+ }
3764
+ interface VersionedDocumentUpdateOperation {
3765
+ /** documents to create or overwrite */
3766
+ documents?: InternalDocument[];
3767
+ /** versioning mode to use instead of default */
3768
+ versioningMode?: VersioningModeWithLiterals;
3769
+ }
3770
+ declare enum VersioningMode {
3771
+ /** use default versioning mode agreed with search team */
3772
+ DEFAULT = "DEFAULT",
3773
+ /** execute only if version is greater than existing */
3774
+ GREATER_THAN = "GREATER_THAN",
3775
+ /** execute only if version is greater or equal to existing */
3776
+ GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
3777
+ }
3778
+ /** @enumType */
3779
+ type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
3780
+ interface VersionedDeleteByIdsOperation {
3781
+ /** ids with version of the documents to delete */
3782
+ documentIds?: VersionedDocumentId[];
3783
+ /**
3784
+ * tenant id for custom tenancy strategy
3785
+ * @minLength 2
3786
+ * @maxLength 300
3787
+ */
3788
+ tenantId?: string | null;
3789
+ }
3790
+ interface VersionedDocumentId {
3791
+ /** document id */
3792
+ documentId?: string;
3793
+ /** document version */
3794
+ version?: string;
3795
+ /** versioning mode to use instead of default */
3796
+ versioningMode?: VersioningModeWithLiterals;
3797
+ }
3798
+ interface TriggerReindexRequest {
3799
+ /** @format GUID */
3800
+ metasiteId?: string;
3801
+ /**
3802
+ * @minLength 1
3803
+ * @maxLength 100
3804
+ * @maxSize 100
3805
+ */
3806
+ orderIds?: string[];
3807
+ }
3808
+ interface TriggerReindexResponse {
3809
+ }
3810
+ interface BatchOfTriggerReindexOrderRequest {
3811
+ /** @maxSize 25 */
3812
+ requests?: TriggerReindexOrderRequest[];
3813
+ }
3814
+ interface TriggerReindexOrderRequest {
3815
+ /** @format GUID */
3816
+ metasiteId?: string;
3817
+ /**
3818
+ * @minLength 1
3819
+ * @maxLength 100
3820
+ */
3821
+ orderId?: string;
3822
+ }
3823
+ interface DiffmatokyPayload {
3824
+ left?: string;
3825
+ right?: string;
3826
+ compareChannel?: string;
3827
+ entityId?: string;
3828
+ errorInformation?: ErrorInformation;
3829
+ tags?: string[];
3830
+ }
3831
+ interface ErrorInformation {
3832
+ stackTrace?: string;
3833
+ }
3834
+ interface ContinueSideEffectsFlowInLegacyData {
3835
+ storeId?: string;
3836
+ orderId?: string;
3837
+ ordersExperiments?: OrdersExperiments;
3838
+ }
3839
+ interface SnapshotMessage {
3840
+ _id?: string;
3841
+ opType?: number;
3842
+ }
3843
+ interface IndexingMessage {
3844
+ _id?: string;
3845
+ opType?: number;
3846
+ requiredVersions?: string[];
3847
+ }
3848
+ interface GetOrderRequest {
3849
+ /**
3850
+ * ID of the order to retrieve.
3851
+ * @minLength 1
3852
+ * @maxLength 100
3853
+ */
3854
+ _id: string;
3855
+ }
3856
+ interface GetOrderResponse {
3857
+ /** The requested order. */
3858
+ order?: Order;
3859
+ }
3860
+ interface InternalQueryOrdersRequest {
3861
+ /** Query options. */
3862
+ query?: PlatformQuery;
3863
+ }
3864
+ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
3865
+ /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
3866
+ paging?: PlatformPaging;
3867
+ /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
3868
+ cursorPaging?: CursorPaging;
3869
+ /** Filter object. */
3870
+ filter?: Record<string, any> | null;
3871
+ /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
3872
+ sort?: Sorting[];
3873
+ }
3874
+ /** @oneof */
3875
+ interface PlatformQueryPagingMethodOneOf {
3876
+ /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
3877
+ paging?: PlatformPaging;
3878
+ /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
3879
+ cursorPaging?: CursorPaging;
3880
+ }
3881
+ interface Sorting {
3882
+ /**
3883
+ * Name of the field to sort by.
3884
+ * @maxLength 512
3885
+ */
3886
+ fieldName?: string;
3887
+ /** Sort order. */
3888
+ order?: SortOrderWithLiterals;
3889
+ }
3890
+ declare enum SortOrder {
3891
+ ASC = "ASC",
3892
+ DESC = "DESC"
3893
+ }
3894
+ /** @enumType */
3895
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
3896
+ interface PlatformPaging {
3897
+ /**
3898
+ * Number of items to load.
3899
+ * @max 100
3900
+ */
3901
+ limit?: number | null;
3902
+ /** Number of items to skip in the current sort order. */
3903
+ offset?: number | null;
3904
+ }
3905
+ interface CursorPaging {
3906
+ /**
3907
+ * Maximum number of items to return in the results.
3908
+ * @max 100
3909
+ */
3910
+ limit?: number | null;
3911
+ /**
3912
+ * Pointer to the next or previous page in the list of results.
3913
+ *
3914
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
3915
+ * Not relevant for the first request.
3916
+ * @maxLength 16000
3917
+ */
3918
+ cursor?: string | null;
3919
+ }
3920
+ interface InternalQueryOrdersResponse {
3921
+ /** List of orders. */
3922
+ orders?: Order[];
3923
+ /** Details on the paged set of results returned. */
3924
+ metadata?: PlatformPagingMetadata;
3925
+ }
3926
+ interface PlatformPagingMetadata {
3927
+ /** The number of items returned in this response. */
3928
+ count?: number | null;
3929
+ /** The offset which was requested. Returned if offset paging was used. */
3930
+ offset?: number | null;
3931
+ /** The total number of items that match the query. Returned if offset paging was used. */
3932
+ total?: number | null;
3933
+ /** Cursors to navigate through result pages. Returned if cursor paging was used. */
3934
+ cursors?: Cursors;
3935
+ }
3936
+ interface Cursors {
3937
+ /**
3938
+ * Cursor string pointing to the next page in the list of results.
3939
+ * @maxLength 16000
3940
+ */
3941
+ next?: string | null;
3942
+ /**
3943
+ * Cursor pointing to the previous page in the list of results.
3944
+ * @maxLength 16000
3945
+ */
3946
+ prev?: string | null;
3947
+ }
3948
+ interface QueryOrderRequest {
3949
+ /** Query options. */
3950
+ query?: PlatformQuery;
3951
+ }
3952
+ interface QueryOrderResponse {
3953
+ /** List of orders. */
3954
+ orders?: Order[];
3955
+ /** Details on the paged set of results returned. */
3956
+ metadata?: PlatformPagingMetadata;
3957
+ }
3958
+ interface SearchOrdersRequest {
3959
+ /** Search options. */
3960
+ search?: CursorSearch;
3961
+ }
3962
+ interface CursorSearch extends CursorSearchPagingMethodOneOf {
3963
+ /**
3964
+ * Cursor paging options.
3965
+ *
3966
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3967
+ */
3968
+ cursorPaging?: CursorPaging;
3969
+ /**
3970
+ * Filter object.
3971
+ *
3972
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
2746
3973
  */
2747
3974
  filter?: Record<string, any> | null;
2748
3975
  /**
@@ -2850,51 +4077,15 @@ interface MaskedOrder {
2850
4077
  /** Order to be updated. */
2851
4078
  order?: Order;
2852
4079
  }
2853
- interface BulkUpdateOrdersResponse {
2854
- /**
2855
- * Bulk action results.
2856
- * @minSize 1
2857
- * @maxSize 100
2858
- */
2859
- results?: BulkOrderResult[];
2860
- /** Bulk action metadata. */
2861
- bulkActionMetadata?: BulkActionMetadata;
2862
- }
2863
- interface BulkOrderResult {
2864
- /** Item metadata. */
2865
- itemMetadata?: ItemMetadata;
2866
- /**
2867
- * Updated order.
2868
- *
2869
- * Returned when `returnFullEntity = true`.
2870
- */
2871
- item?: Order;
2872
- }
2873
- interface ItemMetadata {
2874
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2875
- _id?: string | null;
2876
- /** Index of the item within the request array. Allows for correlation between request and response items. */
2877
- originalIndex?: number;
2878
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2879
- success?: boolean;
2880
- /** Details about the error in case of failure. */
2881
- error?: ApplicationError;
2882
- }
2883
- interface ApplicationError {
2884
- /** Error code. */
2885
- code?: string;
2886
- /** Description of the error. */
2887
- description?: string;
2888
- /** Data related to the error. */
2889
- data?: Record<string, any> | null;
2890
- }
2891
- interface BulkActionMetadata {
2892
- /** Number of items that were successfully processed. */
2893
- totalSuccesses?: number;
2894
- /** Number of items that couldn't be processed. */
2895
- totalFailures?: number;
2896
- /** Number of failures without details because detailed failure threshold was exceeded. */
2897
- undetailedFailures?: number;
4080
+ interface BulkUpdateOrdersResponse {
4081
+ /**
4082
+ * Bulk action results.
4083
+ * @minSize 1
4084
+ * @maxSize 100
4085
+ */
4086
+ results?: BulkOrderResult[];
4087
+ /** Bulk action metadata. */
4088
+ bulkActionMetadata?: BulkActionMetadata;
2898
4089
  }
2899
4090
  interface CommitDeltasRequest {
2900
4091
  /** Order id to be updated */
@@ -2920,36 +4111,6 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
2920
4111
  changedShippingInfo?: V1ShippingInformation;
2921
4112
  /** Remove existing shipping info. */
2922
4113
  shippingInfoRemoved?: boolean;
2923
- /**
2924
- * Buyer info and selected buyer option details.
2925
- * @internal
2926
- */
2927
- changedBuyerInfo?: BuyerInfo;
2928
- /**
2929
- * Remove existing buyer info.
2930
- * @internal
2931
- */
2932
- buyerInfoRemoved?: boolean;
2933
- /**
2934
- * Updated billing info.
2935
- * @internal
2936
- */
2937
- changedBillingInfo?: AddressWithContact;
2938
- /**
2939
- * Remove existing billing info.
2940
- * @internal
2941
- */
2942
- billingInfoRemoved?: boolean;
2943
- /**
2944
- * Updated recipient info.
2945
- * @internal
2946
- */
2947
- changedRecipientInfo?: AddressWithContact;
2948
- /**
2949
- * Remove existing recipient info.
2950
- * @internal
2951
- */
2952
- recipientInfoRemoved?: boolean;
2953
4114
  /**
2954
4115
  * Added/updated/removed order line items.
2955
4116
  * @maxSize 300
@@ -2991,42 +4152,12 @@ interface DraftOrderDiffsShippingUpdateInfoOneOf {
2991
4152
  }
2992
4153
  /** @oneof */
2993
4154
  interface DraftOrderDiffsBuyerUpdateInfoOneOf {
2994
- /**
2995
- * Buyer info and selected buyer option details.
2996
- * @internal
2997
- */
2998
- changedBuyerInfo?: BuyerInfo;
2999
- /**
3000
- * Remove existing buyer info.
3001
- * @internal
3002
- */
3003
- buyerInfoRemoved?: boolean;
3004
4155
  }
3005
4156
  /** @oneof */
3006
4157
  interface DraftOrderDiffsBillingUpdateInfoOneOf {
3007
- /**
3008
- * Updated billing info.
3009
- * @internal
3010
- */
3011
- changedBillingInfo?: AddressWithContact;
3012
- /**
3013
- * Remove existing billing info.
3014
- * @internal
3015
- */
3016
- billingInfoRemoved?: boolean;
3017
4158
  }
3018
4159
  /** @oneof */
3019
4160
  interface DraftOrderDiffsRecipientUpdateInfoOneOf {
3020
- /**
3021
- * Updated recipient info.
3022
- * @internal
3023
- */
3024
- changedRecipientInfo?: AddressWithContact;
3025
- /**
3026
- * Remove existing recipient info.
3027
- * @internal
3028
- */
3029
- recipientInfoRemoved?: boolean;
3030
4161
  }
3031
4162
  interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
3032
4163
  /** The line item was added. */
@@ -3126,21 +4257,8 @@ interface OrderLineItemChangedDetails {
3126
4257
  * @maxSize 5
3127
4258
  */
3128
4259
  locations?: LocationAndQuantity[];
3129
- /**
3130
- * ID of the app managing the inventory.
3131
- * @internal
3132
- * @format GUID
3133
- */
3134
- inventoryAppId?: string | null;
3135
4260
  /** Subscription info. */
3136
4261
  subscriptionInfo?: SubscriptionInfo;
3137
- /**
3138
- * Modifier groups that were added to the item.
3139
- * @internal
3140
- * @readonly
3141
- * @maxSize 10
3142
- */
3143
- modifierGroups?: ModifierGroup[];
3144
4262
  }
3145
4263
  /** Type of selected payment option for catalog item */
3146
4264
  declare enum DeltaPaymentOptionType {
@@ -3527,35 +4645,6 @@ interface InternalActivity extends InternalActivityContentOneOf {
3527
4645
  draftOrderChangesApplied?: DraftOrderChangesApplied;
3528
4646
  /** Payment method is saved for order */
3529
4647
  savedPaymentMethod?: SavedPaymentMethod;
3530
- /**
3531
- * Details of an initiated refund process.
3532
- *
3533
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
3534
- * > In these cases, the `refund_id` will be identical across the activities.
3535
- * @internal
3536
- */
3537
- refundInitiated?: RefundInitiated;
3538
- /**
3539
- * Details of a refunded payment.
3540
- *
3541
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
3542
- * > In these cases, the `refund_id` will be identical across the activities.
3543
- * @internal
3544
- */
3545
- paymentRefunded?: PaymentRefunded;
3546
- /**
3547
- * Details of a failed payment refund.
3548
- *
3549
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
3550
- * > In these cases, the `refund_id` will be identical across the activities.
3551
- * @internal
3552
- */
3553
- paymentRefundFailed?: PaymentRefundFailed;
3554
- /**
3555
- * Details of refund to store credit.
3556
- * @internal
3557
- */
3558
- refundedAsStoreCredit?: RefundedAsStoreCredit;
3559
4648
  /** Details of a pending payment */
3560
4649
  paymentPending?: PaymentPending;
3561
4650
  /** Details of a canceled payment */
@@ -3566,26 +4655,6 @@ interface InternalActivity extends InternalActivityContentOneOf {
3566
4655
  orderPending?: OrderPending;
3567
4656
  /** Order rejected */
3568
4657
  orderRejected?: OrderRejected;
3569
- /**
3570
- * Receipt was added for associated payment
3571
- * @internal
3572
- */
3573
- receiptCreated?: ReceiptCreated;
3574
- /**
3575
- * Receipt sent to customer
3576
- * @internal
3577
- */
3578
- receiptSent?: ReceiptSent;
3579
- /**
3580
- * Chargeback created for one of the order's payments.
3581
- * @internal
3582
- */
3583
- chargebackCreated?: ChargebackCreated;
3584
- /**
3585
- * Chargeback reversed for one of the order's payments.
3586
- * @internal
3587
- */
3588
- chargebackReversed?: ChargebackReversed;
3589
4658
  /**
3590
4659
  * Internal activity ID.
3591
4660
  * @format GUID
@@ -3650,35 +4719,6 @@ interface InternalActivityContentOneOf {
3650
4719
  draftOrderChangesApplied?: DraftOrderChangesApplied;
3651
4720
  /** Payment method is saved for order */
3652
4721
  savedPaymentMethod?: SavedPaymentMethod;
3653
- /**
3654
- * Details of an initiated refund process.
3655
- *
3656
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
3657
- * > In these cases, the `refund_id` will be identical across the activities.
3658
- * @internal
3659
- */
3660
- refundInitiated?: RefundInitiated;
3661
- /**
3662
- * Details of a refunded payment.
3663
- *
3664
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
3665
- * > In these cases, the `refund_id` will be identical across the activities.
3666
- * @internal
3667
- */
3668
- paymentRefunded?: PaymentRefunded;
3669
- /**
3670
- * Details of a failed payment refund.
3671
- *
3672
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
3673
- * > In these cases, the `refund_id` will be identical across the activities.
3674
- * @internal
3675
- */
3676
- paymentRefundFailed?: PaymentRefundFailed;
3677
- /**
3678
- * Details of refund to store credit.
3679
- * @internal
3680
- */
3681
- refundedAsStoreCredit?: RefundedAsStoreCredit;
3682
4722
  /** Details of a pending payment */
3683
4723
  paymentPending?: PaymentPending;
3684
4724
  /** Details of a canceled payment */
@@ -3689,26 +4729,6 @@ interface InternalActivityContentOneOf {
3689
4729
  orderPending?: OrderPending;
3690
4730
  /** Order rejected */
3691
4731
  orderRejected?: OrderRejected;
3692
- /**
3693
- * Receipt was added for associated payment
3694
- * @internal
3695
- */
3696
- receiptCreated?: ReceiptCreated;
3697
- /**
3698
- * Receipt sent to customer
3699
- * @internal
3700
- */
3701
- receiptSent?: ReceiptSent;
3702
- /**
3703
- * Chargeback created for one of the order's payments.
3704
- * @internal
3705
- */
3706
- chargebackCreated?: ChargebackCreated;
3707
- /**
3708
- * Chargeback reversed for one of the order's payments.
3709
- * @internal
3710
- */
3711
- chargebackReversed?: ChargebackReversed;
3712
4732
  }
3713
4733
  /** Order placed */
3714
4734
  interface OrderPlaced {
@@ -4069,7 +5089,7 @@ interface BulkSetBusinessLocationResponse {
4069
5089
  interface BulkSetBusinessLocationResult {
4070
5090
  itemMetadata?: ItemMetadata;
4071
5091
  }
4072
- interface MarkOrderAsPaidRequest {
5092
+ interface V1MarkOrderAsPaidRequest {
4073
5093
  /**
4074
5094
  * Order ID.
4075
5095
  * @minLength 1
@@ -4077,7 +5097,7 @@ interface MarkOrderAsPaidRequest {
4077
5097
  */
4078
5098
  _id?: string;
4079
5099
  }
4080
- interface MarkOrderAsPaidResponse {
5100
+ interface V1MarkOrderAsPaidResponse {
4081
5101
  /** Updated order. */
4082
5102
  order?: Order;
4083
5103
  }
@@ -4088,7 +5108,7 @@ interface PaymentStatusUpdated {
4088
5108
  /** The previous status (before the update) */
4089
5109
  previousPaymentStatus?: PaymentStatusWithLiterals;
4090
5110
  }
4091
- interface BulkMarkOrdersAsPaidRequest {
5111
+ interface V1BulkMarkOrdersAsPaidRequest {
4092
5112
  /**
4093
5113
  * IDs of orders to mark as paid.
4094
5114
  * @minSize 1
@@ -4098,7 +5118,7 @@ interface BulkMarkOrdersAsPaidRequest {
4098
5118
  */
4099
5119
  ids?: string[];
4100
5120
  }
4101
- interface BulkMarkOrdersAsPaidResponse {
5121
+ interface V1BulkMarkOrdersAsPaidResponse {
4102
5122
  /**
4103
5123
  * Items updated by the bulk action.
4104
5124
  * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
@@ -4107,7 +5127,7 @@ interface BulkMarkOrdersAsPaidResponse {
4107
5127
  /** Bulk action metadata. */
4108
5128
  bulkActionMetadata?: BulkActionMetadata;
4109
5129
  }
4110
- interface CreatePaymentGatewayOrderRequest {
5130
+ interface V1CreatePaymentGatewayOrderRequest {
4111
5131
  /**
4112
5132
  * eCom Order ID
4113
5133
  * @minLength 1
@@ -4115,7 +5135,7 @@ interface CreatePaymentGatewayOrderRequest {
4115
5135
  */
4116
5136
  ecomOrderId?: string;
4117
5137
  }
4118
- interface CreatePaymentGatewayOrderResponse {
5138
+ interface V1CreatePaymentGatewayOrderResponse {
4119
5139
  /** ID of the order created in the payment gateway */
4120
5140
  paymentGatewayOrderId?: string;
4121
5141
  }
@@ -4205,70 +5225,6 @@ interface BulkUpdateOrderTagsResponse {
4205
5225
  interface BulkUpdateOrderTagsResult {
4206
5226
  itemMetadata?: ItemMetadata;
4207
5227
  }
4208
- interface DomainEvent extends DomainEventBodyOneOf {
4209
- createdEvent?: EntityCreatedEvent;
4210
- updatedEvent?: EntityUpdatedEvent;
4211
- deletedEvent?: EntityDeletedEvent;
4212
- actionEvent?: ActionEvent;
4213
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
4214
- _id?: string;
4215
- /**
4216
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
4217
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
4218
- */
4219
- entityFqdn?: string;
4220
- /**
4221
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
4222
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
4223
- */
4224
- slug?: string;
4225
- /** ID of the entity associated with the event. */
4226
- entityId?: string;
4227
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
4228
- eventTime?: Date | null;
4229
- /**
4230
- * Whether the event was triggered as a result of a privacy regulation application
4231
- * (for example, GDPR).
4232
- */
4233
- triggeredByAnonymizeRequest?: boolean | null;
4234
- /** If present, indicates the action that triggered the event. */
4235
- originatedFrom?: string | null;
4236
- /**
4237
- * 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.
4238
- * 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.
4239
- */
4240
- entityEventSequence?: string | null;
4241
- }
4242
- /** @oneof */
4243
- interface DomainEventBodyOneOf {
4244
- createdEvent?: EntityCreatedEvent;
4245
- updatedEvent?: EntityUpdatedEvent;
4246
- deletedEvent?: EntityDeletedEvent;
4247
- actionEvent?: ActionEvent;
4248
- }
4249
- interface EntityCreatedEvent {
4250
- entity?: string;
4251
- }
4252
- interface RestoreInfo {
4253
- deletedDate?: Date | null;
4254
- }
4255
- interface EntityUpdatedEvent {
4256
- /**
4257
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
4258
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
4259
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
4260
- */
4261
- currentEntity?: string;
4262
- }
4263
- interface EntityDeletedEvent {
4264
- /** Entity that was deleted. */
4265
- deletedEntity?: string | null;
4266
- }
4267
- interface ActionEvent {
4268
- body?: string;
4269
- }
4270
- interface Empty {
4271
- }
4272
5228
  interface Task {
4273
5229
  key?: TaskKey;
4274
5230
  executeAt?: Date | null;
@@ -4587,9 +5543,9 @@ interface CalculatedTax {
4587
5543
  code?: string | null;
4588
5544
  }
4589
5545
  interface Payments {
4590
- payments?: Payment[];
5546
+ payments?: InvoicesPayment[];
4591
5547
  }
4592
- interface Payment {
5548
+ interface InvoicesPayment {
4593
5549
  /** document */
4594
5550
  _id?: string;
4595
5551
  type?: string;
@@ -4695,107 +5651,154 @@ declare enum DepositType {
4695
5651
  PERCENTAGE = "PERCENTAGE"
4696
5652
  }
4697
5653
  /** @enumType */
4698
- type DepositTypeWithLiterals = DepositType | 'UNKNOWN' | 'FLAT' | 'PERCENTAGE';
4699
- /**
4700
- * InvoiceStatus allowed transitions based on current status:
4701
- * Draft -> Deleted, Paid, Partially Paid, Sent
4702
- * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
4703
- * Processing -> PartiallyPaid, Paid, Sent
4704
- * Paid -> Void
4705
- * PartiallyPaid -> Void, (PartialAndOverdue)
4706
- * Void -> Deleted
4707
- * Deleted
4708
- */
4709
- declare enum InvoiceStatus {
4710
- Draft = "Draft",
4711
- Sent = "Sent",
4712
- Processing = "Processing",
4713
- Paid = "Paid",
4714
- Overdue = "Overdue",
4715
- Void = "Void",
4716
- Deleted = "Deleted",
4717
- PartiallyPaid = "PartiallyPaid",
4718
- PartialAndOverdue = "PartialAndOverdue"
4719
- }
4720
- /** @enumType */
4721
- type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
4722
- interface TriggerSideEffectsFromLegacyData {
4723
- storeId?: string;
4724
- orderId?: string;
4725
- ordersExperiments?: OrdersExperiments;
4726
- }
4727
- interface MessageEnvelope {
4728
- /**
4729
- * App instance ID.
4730
- * @format GUID
4731
- */
4732
- instanceId?: string | null;
4733
- /**
4734
- * Event type.
4735
- * @maxLength 150
4736
- */
4737
- eventType?: string;
4738
- /** The identification type and identity data. */
4739
- identity?: IdentificationData;
4740
- /** Stringify payload. */
4741
- data?: string;
4742
- }
4743
- interface IdentificationData extends IdentificationDataIdOneOf {
4744
- /**
4745
- * ID of a site visitor that has not logged in to the site.
4746
- * @format GUID
4747
- */
4748
- anonymousVisitorId?: string;
4749
- /**
4750
- * ID of a site visitor that has logged in to the site.
4751
- * @format GUID
4752
- */
4753
- memberId?: string;
4754
- /**
4755
- * ID of a Wix user (site owner, contributor, etc.).
4756
- * @format GUID
4757
- */
4758
- wixUserId?: string;
4759
- /**
4760
- * ID of an app.
4761
- * @format GUID
4762
- */
4763
- appId?: string;
4764
- /** @readonly */
4765
- identityType?: WebhookIdentityTypeWithLiterals;
4766
- }
4767
- /** @oneof */
4768
- interface IdentificationDataIdOneOf {
4769
- /**
4770
- * ID of a site visitor that has not logged in to the site.
4771
- * @format GUID
4772
- */
4773
- anonymousVisitorId?: string;
4774
- /**
4775
- * ID of a site visitor that has logged in to the site.
4776
- * @format GUID
4777
- */
4778
- memberId?: string;
4779
- /**
4780
- * ID of a Wix user (site owner, contributor, etc.).
4781
- * @format GUID
4782
- */
4783
- wixUserId?: string;
4784
- /**
4785
- * ID of an app.
4786
- * @format GUID
4787
- */
4788
- appId?: string;
4789
- }
4790
- declare enum WebhookIdentityType {
4791
- UNKNOWN = "UNKNOWN",
4792
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
4793
- MEMBER = "MEMBER",
4794
- WIX_USER = "WIX_USER",
4795
- APP = "APP"
4796
- }
4797
- /** @enumType */
4798
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
5654
+ type DepositTypeWithLiterals = DepositType | 'UNKNOWN' | 'FLAT' | 'PERCENTAGE';
5655
+ /**
5656
+ * InvoiceStatus allowed transitions based on current status:
5657
+ * Draft -> Deleted, Paid, Partially Paid, Sent
5658
+ * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
5659
+ * Processing -> PartiallyPaid, Paid, Sent
5660
+ * Paid -> Void
5661
+ * PartiallyPaid -> Void, (PartialAndOverdue)
5662
+ * Void -> Deleted
5663
+ * Deleted
5664
+ */
5665
+ declare enum InvoiceStatus {
5666
+ Draft = "Draft",
5667
+ Sent = "Sent",
5668
+ Processing = "Processing",
5669
+ Paid = "Paid",
5670
+ Overdue = "Overdue",
5671
+ Void = "Void",
5672
+ Deleted = "Deleted",
5673
+ PartiallyPaid = "PartiallyPaid",
5674
+ PartialAndOverdue = "PartialAndOverdue"
5675
+ }
5676
+ /** @enumType */
5677
+ type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
5678
+ interface TriggerSideEffectsFromLegacyData {
5679
+ storeId?: string;
5680
+ orderId?: string;
5681
+ ordersExperiments?: OrdersExperiments;
5682
+ }
5683
+ type PreparePaymentCollectionApplicationErrors = {
5684
+ code?: 'PAYMENT_METHODS_NOT_FOUND';
5685
+ description?: string;
5686
+ data?: Record<string, any>;
5687
+ } | {
5688
+ code?: 'ORDER_CANCELED';
5689
+ description?: string;
5690
+ data?: Record<string, any>;
5691
+ } | {
5692
+ code?: 'INVALID_AMOUNT';
5693
+ description?: string;
5694
+ data?: Record<string, any>;
5695
+ } | {
5696
+ code?: 'ORDER_ALREADY_PAID';
5697
+ description?: string;
5698
+ data?: Record<string, any>;
5699
+ } | {
5700
+ code?: 'NO_ASSOCIATED_ECOM_ORDER';
5701
+ description?: string;
5702
+ data?: Record<string, any>;
5703
+ };
5704
+ type RecordManuallyCollectedPaymentApplicationErrors = {
5705
+ code?: 'ORDER_ALREADY_PAID';
5706
+ description?: string;
5707
+ data?: Record<string, any>;
5708
+ } | {
5709
+ code?: 'INVALID_AMOUNT';
5710
+ description?: string;
5711
+ data?: Record<string, any>;
5712
+ } | {
5713
+ code?: 'ORDER_CANCELED';
5714
+ description?: string;
5715
+ data?: Record<string, any>;
5716
+ };
5717
+ type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
5718
+ code?: 'ORDER_ALREADY_PAID';
5719
+ description?: string;
5720
+ data?: Record<string, any>;
5721
+ } | {
5722
+ code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
5723
+ description?: string;
5724
+ data?: Record<string, any>;
5725
+ };
5726
+ type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
5727
+ code?: 'ORDER_ALREADY_PAID';
5728
+ description?: string;
5729
+ data?: Record<string, any>;
5730
+ } | {
5731
+ code?: 'ORDER_CANCELED';
5732
+ description?: string;
5733
+ data?: Record<string, any>;
5734
+ };
5735
+ type TriggerRefundApplicationErrors = {
5736
+ code?: 'PAYMENTS_NOT_FOUND';
5737
+ description?: string;
5738
+ data?: Record<string, any>;
5739
+ } | {
5740
+ code?: 'REFUND_NOT_AVAILABLE';
5741
+ description?: string;
5742
+ data?: Record<string, any>;
5743
+ } | {
5744
+ code?: 'INVALID_AMOUNT';
5745
+ description?: string;
5746
+ data?: Record<string, any>;
5747
+ };
5748
+ type VoidAuthorizedPaymentsApplicationErrors = {
5749
+ code?: 'PAYMENT_ALREADY_VOIDED';
5750
+ description?: string;
5751
+ data?: Record<string, any>;
5752
+ } | {
5753
+ code?: 'PAYMENT_ALREADY_CAPTURED';
5754
+ description?: string;
5755
+ data?: Record<string, any>;
5756
+ } | {
5757
+ code?: 'PAYMENT_NOT_AUTHORIZED';
5758
+ description?: string;
5759
+ data?: Record<string, any>;
5760
+ } | {
5761
+ code?: 'PAYMENT_NOT_FOUND';
5762
+ description?: string;
5763
+ data?: Record<string, any>;
5764
+ } | {
5765
+ code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
5766
+ description?: string;
5767
+ data?: Record<string, any>;
5768
+ };
5769
+ type CaptureAuthorizedPaymentsApplicationErrors = {
5770
+ code?: 'INVALID_AMOUNT';
5771
+ description?: string;
5772
+ data?: Record<string, any>;
5773
+ } | {
5774
+ code?: 'NOT_REGULAR_ONLINE_PAYMENT';
5775
+ description?: string;
5776
+ data?: Record<string, any>;
5777
+ } | {
5778
+ code?: 'PAYMENT_ALREADY_VOIDED';
5779
+ description?: string;
5780
+ data?: Record<string, any>;
5781
+ } | {
5782
+ code?: 'PAYMENT_ALREADY_CAPTURED';
5783
+ description?: string;
5784
+ data?: Record<string, any>;
5785
+ } | {
5786
+ code?: 'PAYMENT_NOT_AUTHORIZED';
5787
+ description?: string;
5788
+ data?: Record<string, any>;
5789
+ } | {
5790
+ code?: 'PAYMENT_NOT_FOUND';
5791
+ description?: string;
5792
+ data?: Record<string, any>;
5793
+ } | {
5794
+ code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
5795
+ description?: string;
5796
+ data?: Record<string, any>;
5797
+ } | {
5798
+ code?: 'PAYMENT_HAS_PENDING_CAPTURE';
5799
+ description?: string;
5800
+ data?: Record<string, any>;
5801
+ };
4799
5802
  type GetOrderApplicationErrors = {
4800
5803
  code?: 'ORDER_NOT_FOUND';
4801
5804
  description?: string;
@@ -4916,6 +5919,32 @@ interface OrderApprovedEnvelope {
4916
5919
  * @slug approved
4917
5920
  */
4918
5921
  declare function onOrderApproved(handler: (event: OrderApprovedEnvelope) => void | Promise<void>): void;
5922
+ interface OrderUpdatedEnvelope {
5923
+ entity: Order;
5924
+ metadata: EventMetadata;
5925
+ }
5926
+ /** @permissionScope Manage Stores - all permissions
5927
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
5928
+ * @permissionScope Manage Stores
5929
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
5930
+ * @permissionScope Read eCommerce - all read permissions
5931
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
5932
+ * @permissionScope Read Orders
5933
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
5934
+ * @permissionScope Read Stores - all read permissions
5935
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
5936
+ * @permissionScope Manage Restaurants - all permissions
5937
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
5938
+ * @permissionScope Manage eCommerce - all permissions
5939
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
5940
+ * @permissionScope Manage Orders
5941
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
5942
+ * @permissionId ECOM.READ_ORDERS
5943
+ * @webhook
5944
+ * @eventType wix.ecom.v1.order_updated
5945
+ * @slug updated
5946
+ */
5947
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
4919
5948
  interface OrderCanceledEnvelope {
4920
5949
  data: OrderCanceledEventOrderCanceled;
4921
5950
  metadata: EventMetadata;
@@ -5005,33 +6034,109 @@ interface OrderPaymentStatusUpdatedEnvelope {
5005
6034
  * @slug payment_status_updated
5006
6035
  */
5007
6036
  declare function onOrderPaymentStatusUpdated(handler: (event: OrderPaymentStatusUpdatedEnvelope) => void | Promise<void>): void;
5008
- interface OrderUpdatedEnvelope {
5009
- entity: Order;
5010
- metadata: EventMetadata;
6037
+ type OrderNonNullablePaths = `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `status` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.amount.amount` | `activities.${number}.orderRefunded.amount.formattedAmount` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `payAfterFreeTrial.subtotal.amount` | `payAfterFreeTrial.subtotal.formattedAmount`;
6038
+ /**
6039
+ * Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
6040
+ * Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
6041
+ * 2nd step is an actual charge of prepared payment gateway order. This could be done either
6042
+ * via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
6043
+ * or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
6044
+ * @param ecomOrderId - Ecom order ID.
6045
+ * @param amount - Amount to collect
6046
+ * @public
6047
+ * @documentationMaturity preview
6048
+ * @requiredField amount
6049
+ * @requiredField ecomOrderId
6050
+ * @permissionId ECOM.COLLECT_PAYMENTS
6051
+ * @applicableIdentity APP
6052
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
6053
+ */
6054
+ declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
6055
+ __applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
6056
+ }>;
6057
+ interface PreparePaymentCollectionOptions {
6058
+ /**
6059
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
6060
+ * Existing payment gateway order will be updated with a new amount.
6061
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
6062
+ */
6063
+ paymentGatewayOrderId?: string | null;
6064
+ /**
6065
+ * Whether to delay capture of the payment.
6066
+ * Default: false
6067
+ * @deprecated Whether to delay capture of the payment.
6068
+ * Default: false
6069
+ * @replacedBy delayed_capture_settings.scheduled_action
6070
+ * @targetRemovalDate 2024-09-30
6071
+ */
6072
+ delayedCapture?: boolean;
6073
+ /** Delayed capture payment settings */
6074
+ delayedCaptureSettings?: DelayedCaptureSettings;
5011
6075
  }
5012
- /** @permissionScope Manage Stores - all permissions
5013
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
5014
- * @permissionScope Manage Stores
5015
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
5016
- * @permissionScope Read eCommerce - all read permissions
5017
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
5018
- * @permissionScope Read Orders
5019
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
5020
- * @permissionScope Read Stores - all read permissions
5021
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
5022
- * @permissionScope Manage Restaurants - all permissions
5023
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
5024
- * @permissionScope Manage eCommerce - all permissions
5025
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
5026
- * @permissionScope Manage Orders
5027
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
5028
- * @permissionId ECOM.READ_ORDERS
5029
- * @webhook
5030
- * @eventType wix.ecom.v1.order_updated
5031
- * @slug updated
6076
+ /**
6077
+ * Provides payment collectability status for given order. If payment collection is possible
6078
+ * response will contain collectable amount for given ecom order. If not - response will contain
6079
+ * reason why payment collection is not possible.
6080
+ * @param ecomOrderId - Ecom order ID.
6081
+ * @public
6082
+ * @documentationMaturity preview
6083
+ * @requiredField ecomOrderId
6084
+ * @permissionId ECOM.COLLECT_PAYMENTS
6085
+ * @applicableIdentity APP
6086
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
5032
6087
  */
5033
- declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
5034
- type OrderNonNullablePaths = `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `status` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.amount.amount` | `activities.${number}.orderRefunded.amount.formattedAmount` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `payAfterFreeTrial.subtotal.amount` | `payAfterFreeTrial.subtotal.formattedAmount`;
6088
+ declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
6089
+ interface PaymentCollectionCreatePaymentGatewayOrderOptions {
6090
+ /** Information about the user who initiated the payment. */
6091
+ chargedBy?: ChargedBy;
6092
+ }
6093
+ interface ChargeMembershipsOptions {
6094
+ /**
6095
+ * List of items to be paid by memberships
6096
+ * @minSize 1
6097
+ * @maxSize 300
6098
+ */
6099
+ membershipCharges?: MembershipChargeItem[];
6100
+ }
6101
+ interface TriggerRefundOptions {
6102
+ /** Business model of a refund */
6103
+ details?: RefundDetails;
6104
+ /** Side effect details related to refund */
6105
+ sideEffects?: RefundSideEffects;
6106
+ }
6107
+ /**
6108
+ * Void authorized payments
6109
+ * Transaction statuses for related payments will be updated in async way
6110
+ * @param ecomOrderId - Wix eCommerce order ID
6111
+ * @param paymentIds - Payment IDs
6112
+ * @public
6113
+ * @documentationMaturity preview
6114
+ * @requiredField ecomOrderId
6115
+ * @requiredField paymentIds
6116
+ * @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
6117
+ * @applicableIdentity APP
6118
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
6119
+ */
6120
+ declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
6121
+ __applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
6122
+ }>;
6123
+ /**
6124
+ * Capture authorized payments
6125
+ * Transaction statuses for related payments will be updated in async way
6126
+ * @param ecomOrderId - Wix eCommerce order ID
6127
+ * @param payments - Capture payments information
6128
+ * @public
6129
+ * @documentationMaturity preview
6130
+ * @requiredField ecomOrderId
6131
+ * @requiredField payments
6132
+ * @requiredField payments.paymentId
6133
+ * @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
6134
+ * @applicableIdentity APP
6135
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
6136
+ */
6137
+ declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
6138
+ __applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
6139
+ }>;
5035
6140
  /**
5036
6141
  * Retrieves an order.
5037
6142
  *
@@ -5467,23 +6572,6 @@ interface BulkUpdateOrdersOptions {
5467
6572
  */
5468
6573
  returnEntity?: boolean;
5469
6574
  }
5470
- /** @param _id - Order id to be updated
5471
- * @internal
5472
- * @documentationMaturity preview
5473
- * @requiredField _id
5474
- * @requiredField options.changes
5475
- * @requiredField options.changes.priceSummary.subtotal
5476
- * @requiredField options.changes.priceSummary.total
5477
- * @permissionId ECOM.ORDERS_DELTAS_COMMIT
5478
- * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
5479
- * @applicableIdentity APP
5480
- * @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
5481
- */
5482
- declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
5483
- [P in OrderNonNullablePaths]: `order.${P}`;
5484
- }[OrderNonNullablePaths]> & {
5485
- __applicationErrorsType?: CommitDeltasApplicationErrors;
5486
- }>;
5487
6575
  interface CommitDeltasOptions {
5488
6576
  /**
5489
6577
  * Draft order Id representing this change.
@@ -5501,21 +6589,6 @@ interface CommitDeltasOptions {
5501
6589
  */
5502
6590
  reason?: string | null;
5503
6591
  }
5504
- /** @internal
5505
- * @documentationMaturity preview
5506
- * @requiredField identifiers
5507
- * @requiredField identifiers._id
5508
- * @requiredField identifiers.lineItemId
5509
- * @requiredField lineItem
5510
- * @permissionId ECOM.MODIFY_ORDERS
5511
- * @applicableIdentity APP
5512
- * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
5513
- * @deprecated
5514
- * @targetRemovalDate 2024-02-15
5515
- */
5516
- declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
5517
- [P in OrderNonNullablePaths]: `order.${P}`;
5518
- }[OrderNonNullablePaths]>>;
5519
6592
  interface UpdateOrderLineItemIdentifiers {
5520
6593
  /**
5521
6594
  * Order ID
@@ -5639,61 +6712,13 @@ interface UpdateOrderLineItem {
5639
6712
  locations?: LocationAndQuantity[];
5640
6713
  /** Address used for tax calculation. */
5641
6714
  taxableAddress?: TaxableAddress;
5642
- /**
5643
- * ID of the app managing the inventory.
5644
- * @internal
5645
- * @format GUID
5646
- */
5647
- inventoryAppId?: string | null;
5648
6715
  /**
5649
6716
  * Custom extended fields for the line item object.
5650
6717
  *
5651
6718
  * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
5652
6719
  */
5653
6720
  extendedFields?: ExtendedFields;
5654
- /**
5655
- * Modifier groups that were added to the item.
5656
- * @internal
5657
- * @readonly
5658
- * @maxSize 10
5659
- */
5660
- modifierGroups?: ModifierGroup[];
5661
6721
  }
5662
- /**
5663
- * Adds a merchant comment to an order.
5664
- * > **Note:** Activities with type CustomActivity not supported
5665
- * @param _id - Order ID.
5666
- * @param activity - Activity info.
5667
- * @internal
5668
- * @documentationMaturity preview
5669
- * @requiredField _id
5670
- * @requiredField activity
5671
- * @permissionId ECOM.MODIFY_ORDERS
5672
- * @applicableIdentity APP
5673
- * @fqn com.wix.ecom.orders.v1.Orders.AddActivity
5674
- * @deprecated
5675
- * @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
5676
- * @targetRemovalDate 2024-11-01
5677
- */
5678
- declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
5679
- [P in OrderNonNullablePaths]: `order.${P}`;
5680
- }[OrderNonNullablePaths] | `activityId`>>;
5681
- /**
5682
- * Updates an order's activity.
5683
- * @param activity - Activity info.
5684
- * @internal
5685
- * @documentationMaturity preview
5686
- * @requiredField activity
5687
- * @requiredField identifiers
5688
- * @requiredField identifiers._id
5689
- * @requiredField identifiers.activityId
5690
- * @permissionId ECOM.MODIFY_ORDERS
5691
- * @applicableIdentity APP
5692
- * @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
5693
- */
5694
- declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
5695
- [P in OrderNonNullablePaths]: `order.${P}`;
5696
- }[OrderNonNullablePaths]>>;
5697
6722
  interface UpdateActivityIdentifiers {
5698
6723
  /**
5699
6724
  * Order ID.
@@ -5707,22 +6732,6 @@ interface UpdateActivityIdentifiers {
5707
6732
  */
5708
6733
  activityId: string;
5709
6734
  }
5710
- /**
5711
- * Delete's an order's activity.
5712
- *
5713
- * Only custom activities and merchant comments can be deleted.
5714
- * @internal
5715
- * @documentationMaturity preview
5716
- * @requiredField identifiers
5717
- * @requiredField identifiers._id
5718
- * @requiredField identifiers.activityId
5719
- * @permissionId ECOM.MODIFY_ORDERS
5720
- * @applicableIdentity APP
5721
- * @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
5722
- */
5723
- declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
5724
- [P in OrderNonNullablePaths]: `order.${P}`;
5725
- }[OrderNonNullablePaths]>>;
5726
6735
  interface DeleteActivityIdentifiers {
5727
6736
  /**
5728
6737
  * Order ID.
@@ -5765,43 +6774,6 @@ interface CancelOrderOptions {
5765
6774
  /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
5766
6775
  restockAllItems?: boolean;
5767
6776
  }
5768
- /**
5769
- * Updates order status.
5770
- *
5771
- * >CANCELED and REJECTED are final statuses. Update from either of those will fail.
5772
- * >Updates into INITIALIZED are not supported.
5773
- *
5774
- * Approving order:
5775
- * APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
5776
- *
5777
- * Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
5778
- * will cause an error.
5779
- *
5780
- * Setting PENDING status:
5781
- * Only orders in INITIALIZED status can be updated into PENDING.
5782
- * @param orderId - Order ID.
5783
- * @param status - New order status.
5784
- * @internal
5785
- * @documentationMaturity preview
5786
- * @requiredField orderId
5787
- * @requiredField status
5788
- * @permissionId ECOM.ORDER_UPDATE_STATUS
5789
- * @applicableIdentity APP
5790
- * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
5791
- */
5792
- declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
5793
- [P in OrderNonNullablePaths]: `order.${P}`;
5794
- }[OrderNonNullablePaths]> & {
5795
- __applicationErrorsType?: UpdateOrderStatusApplicationErrors;
5796
- }>;
5797
- /** @internal
5798
- * @documentationMaturity preview
5799
- * @requiredField options.aggregation
5800
- * @permissionId ECOM.READ_ORDERS
5801
- * @applicableIdentity APP
5802
- * @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
5803
- */
5804
- declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
5805
6777
  interface AggregateOrdersOptions {
5806
6778
  /** Filter applied to original data */
5807
6779
  filter?: Record<string, any> | null;
@@ -5838,4 +6810,4 @@ interface BulkUpdateOrderTagsOptions {
5838
6810
  unassignTags?: Tags;
5839
6811
  }
5840
6812
 
5841
- export { LineItemQuantityChangeType as $, type AddActivityResponse as A, type BulkUpdateOrdersOptions as B, type CreateOrderOptions as C, type DeleteActivityIdentifiers as D, type OrderPaymentStatusUpdatedEnvelope as E, type OrderUpdatedEnvelope as F, type GetOrderApplicationErrors as G, DescriptionLineType as H, ItemTypeItemType as I, PaymentOptionType as J, JurisdictionType as K, SubscriptionFrequency as L, type MaskedOrder as M, AdjustmentType as N, type Order as O, type PublicActivity as P, PaymentStatus as Q, FulfillmentStatus as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, VatType as V, WeightUnit as W, PickupMethod as X, OrderStatus as Y, DiscountType as Z, DiscountReason as _, type OrderSearch as a, type DeliveryTimeSlot as a$, ActivityType as a0, AttributionSource as a1, ChannelType as a2, SortOrder as a3, OrderApprovalStrategy as a4, DeltaPaymentOptionType as a5, InventoryAction as a6, Placement as a7, SubdivisionType as a8, SourceType as a9, type SubscriptionSettings as aA, type FreeTrialPeriod as aB, type BillingAdjustment as aC, type BillingAdjustmentPriceSummary as aD, type PriceDescription as aE, type LocationAndQuantity as aF, type TaxableAddress as aG, type TaxableAddressTaxableAddressDataOneOf as aH, type ExtendedFields as aI, type ModifierGroup as aJ, type TranslatableString as aK, type ItemModifier as aL, type BuyerInfo as aM, type BuyerInfoIdOneOf as aN, type CurrencyConversionDetails as aO, type PriceSummary as aP, type AddressWithContact as aQ, type Address as aR, type StreetAddress as aS, type AddressLocation as aT, type FullAddressContactDetails as aU, type VatId as aV, type V1ShippingInformation as aW, type DeliveryLogistics as aX, type DeliveryLogisticsAddressOneOf as aY, type PickupDetails as aZ, type PickupAddress as a_, CustomFieldGroup as aa, ValueType as ab, DepositType as ac, InvoiceStatus as ad, WebhookIdentityType as ae, type OrderLineItem as af, type ProductName as ag, type CatalogReference as ah, type Price as ai, type DescriptionLine as aj, type DescriptionLineValueOneOf as ak, type DescriptionLineDescriptionLineValueOneOf as al, type DescriptionLineName as am, type PlainTextValue as an, type Color as ao, type FocalPoint as ap, type PhysicalProperties as aq, type ItemType as ar, type ItemTypeItemTypeDataOneOf as as, type ItemTaxFullDetails as at, type LineItemTaxInfo as au, type LineItemTaxBreakdown as av, type DigitalFile as aw, type SubscriptionInfo as ax, type SubscriptionTitle as ay, type SubscriptionDescription as az, type CreateOrderApplicationErrors as b, type ChargebackCreated as b$, type ShippingPrice as b0, type ShippingRegion as b1, type TaxSummary as b2, type OrderTaxInfo as b3, type OrderTaxBreakdown as b4, type AppliedDiscount as b5, type AppliedDiscountDiscountSourceOneOf as b6, type Coupon as b7, type MerchantDiscount as b8, type MerchantDiscountMerchantDiscountReasonOneOf as b9, type AuthorizedPaymentCreated as bA, type AuthorizedPaymentCaptured as bB, type AuthorizedPaymentVoided as bC, type RefundInitiated as bD, type RefundedPayment as bE, type RefundedPaymentKindOneOf as bF, type RegularPaymentRefund as bG, type GiftCardPaymentRefund as bH, type MembershipPaymentRefund as bI, type PaymentRefunded as bJ, type PaymentRefundFailed as bK, type RefundedAsStoreCredit as bL, type PaymentPending as bM, type PaymentPendingPaymentDetailsOneOf as bN, type RegularPayment as bO, type RegularPaymentPaymentMethodDetailsOneOf as bP, type CreditCardDetails as bQ, type PaymentCanceled as bR, type PaymentCanceledPaymentDetailsOneOf as bS, type PaymentDeclined as bT, type PaymentDeclinedPaymentDetailsOneOf as bU, type ReceiptCreated as bV, type ReceiptCreatedReceiptInfoOneOf as bW, type WixReceipt as bX, type ExternalReceipt as bY, type ReceiptSent as bZ, type ReceiptSentReceiptInfoOneOf as b_, type DiscountRule as ba, type DiscountRuleName as bb, type LineItemDiscount as bc, type Activity as bd, type ActivityContentOneOf as be, type CustomActivity as bf, type MerchantComment as bg, type OrderRefunded as bh, type OrderCreatedFromExchange as bi, type NewExchangeOrderCreated as bj, type LineItemExchangeData as bk, type DraftOrderChangesApplied as bl, type OrderChange as bm, type OrderChangeValueOneOf as bn, type LineItemChanges as bo, type LineItemQuantityChange as bp, type LineItemPriceChange as bq, type ManagedLineItem as br, type ManagedDiscount as bs, type TranslatedValue as bt, type LineItemAmount as bu, type ManagedAdditionalFee as bv, type TotalPriceChange as bw, type ShippingInformationChange as bx, type ShippingInformation as by, type SavedPaymentMethod as bz, type UpdateOrderApplicationErrors as c, type AdditionalFeeDeltaDeltaOneOf as c$, type ChargebackReversed as c0, type CreatedBy as c1, type CreatedByStringOneOf as c2, type ChannelInfo as c3, type CustomField as c4, type BalanceSummary as c5, type Balance as c6, type AdditionalFee as c7, type FulfillmentStatusesAggregate as c8, type Tags as c9, type CursorSearch as cA, type CursorSearchPagingMethodOneOf as cB, type CursorPagingMetadata as cC, type CreateOrderRequest as cD, type OrderCreationSettings as cE, type OrderCreateNotifications as cF, type CreateOrderResponse as cG, type UpdateOrderRequest as cH, type UpdateOrderResponse as cI, type BulkUpdateOrdersRequest as cJ, type BulkOrderResult as cK, type ItemMetadata as cL, type ApplicationError as cM, type BulkActionMetadata as cN, type CommitDeltasRequest as cO, type DraftOrderDiffs as cP, type DraftOrderDiffsShippingUpdateInfoOneOf as cQ, type DraftOrderDiffsBuyerUpdateInfoOneOf as cR, type DraftOrderDiffsBillingUpdateInfoOneOf as cS, type DraftOrderDiffsRecipientUpdateInfoOneOf as cT, type V1LineItemDelta as cU, type V1LineItemDeltaDeltaOneOf as cV, type OrderLineItemChangedDetails as cW, type ItemChangedDetails as cX, type AppliedDiscountDelta as cY, type AppliedDiscountDeltaDeltaOneOf as cZ, type AdditionalFeeDelta as c_, type TagList as ca, type Location as cb, type DiffmatokyPayload as cc, type ErrorInformation as cd, type ContinueSideEffectsFlowInLegacyData as ce, type OrdersExperiments as cf, type SnapshotMessage as cg, type IndexingMessage as ch, type OrderApproved as ci, type OrderRejectedEventOrderRejected as cj, type OrderItemsRestocked as ck, type RestockItem as cl, type GetOrderRequest as cm, type GetOrderResponse as cn, type InternalQueryOrdersRequest as co, type PlatformQuery as cp, type PlatformQueryPagingMethodOneOf as cq, type Sorting as cr, type PlatformPaging as cs, type CursorPaging as ct, type InternalQueryOrdersResponse as cu, type PlatformPagingMetadata as cv, type Cursors as cw, type QueryOrderRequest as cx, type QueryOrderResponse as cy, type SearchOrdersRequest as cz, type BulkUpdateOrdersResponse as d, type LineItemUpdate as d$, type DraftOrderCommitSettings as d0, type InventoryUpdateDetails as d1, type OrderDeltasCommitted as d2, type CommittedDiffs as d3, type CommittedDiffsShippingUpdateInfoOneOf as d4, type LineItemDelta as d5, type LineItemDeltaDeltaOneOf as d6, type ArchiveOrderRequest as d7, type ArchiveOrderResponse as d8, type BulkArchiveOrdersRequest as d9, type OrderPlaced as dA, type OrderPaid as dB, type OrderFulfilled as dC, type OrderNotFulfilled as dD, type OrderCanceled as dE, type DownloadLinkSent as dF, type TrackingNumberAdded as dG, type TrackingNumberEdited as dH, type TrackingLinkAdded as dI, type ShippingConfirmationEmailSent as dJ, type InvoiceAdded as dK, type InvoiceSent as dL, type FulfillerEmailSent as dM, type ShippingAddressEdited as dN, type EmailEdited as dO, type PickupReadyEmailSent as dP, type OrderPartiallyPaid as dQ, type OrderPending as dR, type OrderRejected as dS, type AddInternalActivityResponse as dT, type AddActivityRequest as dU, type PublicActivityContentOneOf as dV, type AddActivitiesRequest as dW, type AddActivitiesResponse as dX, type UpdateActivityRequest as dY, type DeleteActivityRequest as dZ, type UpdateLineItemsDescriptionLinesRequest as d_, type BulkArchiveOrdersResponse as da, type BulkArchiveOrdersByFilterRequest as db, type BulkArchiveOrdersByFilterResponse as dc, type UnArchiveOrderRequest as dd, type UnArchiveOrderResponse as de, type BulkUnArchiveOrdersRequest as df, type BulkUnArchiveOrdersResponse as dg, type BulkUnArchiveOrdersByFilterRequest as dh, type BulkUnArchiveOrdersByFilterResponse as di, type UpdateBuyerInfoRequest as dj, type BuyerInfoUpdate as dk, type UpdateBuyerInfoResponse as dl, type UpdateBuyerEmailRequest as dm, type UpdateBuyerEmailResponse as dn, type UpdateOrderShippingAddressRequest as dp, type UpdateOrderShippingAddressResponse as dq, type UpdateBillingContactDetailsRequest as dr, type UpdateBillingContactDetailsResponse as ds, type UpdateOrderLineItemRequest as dt, type UpdateOrderLineItemsRequest as du, type MaskedOrderLineItem as dv, type UpdateOrderLineItemsResponse as dw, type AddInternalActivityRequest as dx, type InternalActivity as dy, type InternalActivityContentOneOf as dz, type CommitDeltasOptions as e, type Subdivision as e$, type UpdateLineItemsDescriptionLinesResponse as e0, type MarkOrderAsSeenByHumanRequest as e1, type MarkOrderAsSeenByHumanResponse as e2, type CancelOrderRequest as e3, type OrderCanceledEventOrderCanceled as e4, type UpdateOrderStatusRequest as e5, type MarkAsFulfilledRequest as e6, type MarkAsFulfilledResponse as e7, type FulfillmentStatusUpdated as e8, type BulkMarkAsFulfilledRequest as e9, type BulkUpdateOrderTagsResult as eA, type DomainEvent as eB, type DomainEventBodyOneOf as eC, type EntityCreatedEvent as eD, type RestoreInfo as eE, type EntityUpdatedEvent as eF, type EntityDeletedEvent as eG, type ActionEvent as eH, type Empty as eI, type Task as eJ, type TaskKey as eK, type TaskAction as eL, type TaskActionActionOneOf as eM, type Complete as eN, type Cancel as eO, type Reschedule as eP, type InvoiceSentEvent as eQ, type IdAndVersion as eR, type InvoiceFields as eS, type Customer as eT, type Email as eU, type QuotesAddress as eV, type AddressDescription as eW, type Phone as eX, type Company as eY, type CommonAddress as eZ, type CommonAddressStreetOneOf as e_, type BulkMarkAsFulfilledResponse as ea, type BulkMarkAsFulfilledByFilterRequest as eb, type BulkMarkAsFulfilledByFilterResponse as ec, type MarkAsUnfulfilledRequest as ed, type MarkAsUnfulfilledResponse as ee, type BulkMarkAsUnfulfilledRequest as ef, type BulkMarkAsUnfulfilledResponse as eg, type BulkMarkAsUnfulfilledByFilterRequest as eh, type BulkMarkAsUnfulfilledByFilterResponse as ei, type BulkSetBusinessLocationRequest as ej, type BulkSetBusinessLocationResponse as ek, type BulkSetBusinessLocationResult as el, type MarkOrderAsPaidRequest as em, type MarkOrderAsPaidResponse as en, type PaymentStatusUpdated as eo, type BulkMarkOrdersAsPaidRequest as ep, type BulkMarkOrdersAsPaidResponse as eq, type CreatePaymentGatewayOrderRequest as er, type CreatePaymentGatewayOrderResponse as es, type GetShipmentsRequest as et, type GetShipmentsResponse as eu, type AggregateOrdersRequest as ev, type DecrementItemsQuantityRequest as ew, type DecrementData as ex, type DecrementItemsQuantityResponse as ey, type BulkUpdateOrderTagsRequest as ez, type CommitDeltasResponse as f, onOrderUpdated as f$, type StandardDetails as f0, type InvoiceDates as f1, type LineItems as f2, type LineItem as f3, type BigDecimalWrapper as f4, type LineItemTax as f5, type Source as f6, type LineItemMetaData as f7, type Locale as f8, type TotalPrice as f9, type PaymentStatusWithLiterals as fA, type FulfillmentStatusWithLiterals as fB, type WeightUnitWithLiterals as fC, type VatTypeWithLiterals as fD, type PickupMethodWithLiterals as fE, type DiscountTypeWithLiterals as fF, type DiscountReasonWithLiterals as fG, type LineItemQuantityChangeTypeWithLiterals as fH, type ActivityTypeWithLiterals as fI, type AttributionSourceWithLiterals as fJ, type ChannelTypeWithLiterals as fK, type SortOrderWithLiterals as fL, type OrderApprovalStrategyWithLiterals as fM, type DeltaPaymentOptionTypeWithLiterals as fN, type InventoryActionWithLiterals as fO, type PlacementWithLiterals as fP, type SubdivisionTypeWithLiterals as fQ, type SourceTypeWithLiterals as fR, type CustomFieldGroupWithLiterals as fS, type ValueTypeWithLiterals as fT, type DepositTypeWithLiterals as fU, type InvoiceStatusWithLiterals as fV, type WebhookIdentityTypeWithLiterals as fW, onOrderApproved as fX, onOrderCanceled as fY, onOrderCreated as fZ, onOrderPaymentStatusUpdated as f_, type ItemizedFee as fa, type Discount as fb, type DiscountOneDiscountTypeOneOf as fc, type CalculatedTaxes as fd, type CalculatedTax as fe, type Payments as ff, type Payment as fg, type MetaData as fh, type InvoiceDynamicPriceTotals as fi, type CustomFieldValue as fj, type Value as fk, type Deposit as fl, type TriggerSideEffectsFromLegacyData as fm, type MessageEnvelope as fn, type IdentificationData as fo, type IdentificationDataIdOneOf as fp, type BaseEventMetadata as fq, type EventMetadata as fr, type OrderSearchSpec as fs, type DescriptionLineTypeWithLiterals as ft, type ItemTypeItemTypeWithLiterals as fu, type PaymentOptionTypeWithLiterals as fv, type JurisdictionTypeWithLiterals as fw, type SubscriptionFrequencyWithLiterals as fx, type AdjustmentTypeWithLiterals as fy, type TaxableAddressTypeWithLiterals as fz, type CommitDeltasApplicationErrors as g, getOrder as g0, type CommonSearchWithEntityContext as g1, createOrder as g2, updateOrder as g3, bulkUpdateOrders as g4, commitDeltas as g5, updateOrderLineItem as g6, addActivity as g7, updateActivity as g8, deleteActivity as g9, cancelOrder as ga, updateOrderStatus as gb, aggregateOrders as gc, bulkUpdateOrderTags as gd, type UpdateOrderLineItemIdentifiers as h, type UpdateOrderLineItem as i, type UpdateOrderLineItemResponse as j, type UpdateActivityIdentifiers as k, type UpdateActivityResponse as l, type DeleteActivityResponse as m, type CancelOrderOptions as n, type CancelOrderResponse as o, type CancelOrderApplicationErrors as p, type OrderStatusWithLiterals as q, type UpdateOrderStatusResponse as r, type UpdateOrderStatusApplicationErrors as s, type AggregateOrdersOptions as t, type AggregateOrdersResponse as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCreatedEnvelope as z };
6813
+ export { RefundableStatus as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, PickupMethod as E, FulfillmentStatus as F, type GetPaymentCollectabilityStatusResponse as G, OrderStatus as H, ItemTypeItemType as I, JurisdictionType as J, DiscountType as K, DiscountReason as L, type MaskedOrder as M, LineItemQuantityChangeType as N, type Order as O, type Price as P, ActivityType as Q, AttributionSource as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, ChannelType as X, ScheduledAction as Y, DurationUnit as Z, PaymentCollectabilityStatus as _, type PreparePaymentCollectionOptions as a, type AddressLocation as a$, NonRefundableReason as a0, ManuallyRefundableReason as a1, RestockType as a2, TransactionStatus as a3, AuthorizationCaptureStatus as a4, AuthorizationVoidStatus as a5, Reason as a6, ActionType as a7, ChargebackStatus as a8, MembershipPaymentStatus as a9, type ItemTypeItemTypeDataOneOf as aA, type ItemTaxFullDetails as aB, type LineItemTaxInfo as aC, type LineItemTaxBreakdown as aD, type DigitalFile as aE, type SubscriptionInfo as aF, type SubscriptionTitle as aG, type SubscriptionDescription as aH, type SubscriptionSettings as aI, type FreeTrialPeriod as aJ, type BillingAdjustment as aK, type BillingAdjustmentPriceSummary as aL, type PriceDescription as aM, type LocationAndQuantity as aN, type TaxableAddress as aO, type TaxableAddressTaxableAddressDataOneOf as aP, type ExtendedFields as aQ, type ModifierGroup as aR, type TranslatableString as aS, type ItemModifier as aT, type BuyerInfo as aU, type BuyerInfoIdOneOf as aV, type CurrencyConversionDetails as aW, type PriceSummary as aX, type AddressWithContact as aY, type Address as aZ, type StreetAddress as a_, RefundStatus as aa, WebhookIdentityType as ab, VersioningMode as ac, SortOrder as ad, OrderApprovalStrategy as ae, DeltaPaymentOptionType as af, InventoryAction as ag, Placement as ah, SubdivisionType as ai, SourceType as aj, CustomFieldGroup as ak, ValueType as al, DepositType as am, InvoiceStatus as an, type OrderLineItem as ao, type ProductName as ap, type CatalogReference as aq, type DescriptionLine as ar, type DescriptionLineValueOneOf as as, type DescriptionLineDescriptionLineValueOneOf as at, type DescriptionLineName as au, type PlainTextValue as av, type Color as aw, type FocalPoint as ax, type PhysicalProperties as ay, type ItemType as az, type PreparePaymentCollectionResponse as b, type PaymentDeclined as b$, type FullAddressContactDetails as b0, type VatId as b1, type V1ShippingInformation as b2, type DeliveryLogistics as b3, type DeliveryLogisticsAddressOneOf as b4, type PickupDetails as b5, type PickupAddress as b6, type DeliveryTimeSlot as b7, type ShippingPrice as b8, type ShippingRegion as b9, type ManagedDiscount as bA, type TranslatedValue as bB, type LineItemAmount as bC, type ManagedAdditionalFee as bD, type TotalPriceChange as bE, type ShippingInformationChange as bF, type ShippingInformation as bG, type SavedPaymentMethod as bH, type AuthorizedPaymentCreated as bI, type AuthorizedPaymentCaptured as bJ, type AuthorizedPaymentVoided as bK, type RefundInitiated as bL, type RefundedPayment as bM, type RefundedPaymentKindOneOf as bN, type RegularPaymentRefund as bO, type GiftCardPaymentRefund as bP, type MembershipPaymentRefund as bQ, type PaymentRefunded as bR, type PaymentRefundFailed as bS, type RefundedAsStoreCredit as bT, type PaymentPending as bU, type PaymentPendingPaymentDetailsOneOf as bV, type RegularPayment as bW, type RegularPaymentPaymentMethodDetailsOneOf as bX, type CreditCardDetails as bY, type PaymentCanceled as bZ, type PaymentCanceledPaymentDetailsOneOf as b_, type TaxSummary as ba, type OrderTaxInfo as bb, type OrderTaxBreakdown as bc, type AppliedDiscount as bd, type AppliedDiscountDiscountSourceOneOf as be, type Coupon as bf, type MerchantDiscount as bg, type MerchantDiscountMerchantDiscountReasonOneOf as bh, type DiscountRule as bi, type DiscountRuleName as bj, type LineItemDiscount as bk, type Activity as bl, type ActivityContentOneOf as bm, type CustomActivity as bn, type MerchantComment as bo, type OrderRefunded as bp, type OrderCreatedFromExchange as bq, type NewExchangeOrderCreated as br, type LineItemExchangeData as bs, type DraftOrderChangesApplied as bt, type OrderChange as bu, type OrderChangeValueOneOf as bv, type LineItemChanges as bw, type LineItemQuantityChange as bx, type LineItemPriceChange as by, type ManagedLineItem as bz, type PreparePaymentCollectionApplicationErrors as c, type OrderTransactions as c$, type PaymentDeclinedPaymentDetailsOneOf as c0, type ReceiptCreated as c1, type ReceiptCreatedReceiptInfoOneOf as c2, type WixReceipt as c3, type ExternalReceipt as c4, type ReceiptSent as c5, type ReceiptSentReceiptInfoOneOf as c6, type ChargebackCreated as c7, type ChargebackReversed as c8, type CreatedBy as c9, type BulkOrderResult as cA, type ItemMetadata as cB, type ApplicationError as cC, type BulkActionMetadata as cD, type GetRefundabilityStatusRequest as cE, type GetRefundabilityStatusResponse as cF, type Refundability as cG, type RefundabilityAdditionalRefundabilityInfoOneOf as cH, type CreatePaymentGatewayOrderRequest as cI, type ChargedBy as cJ, type CreatePaymentGatewayOrderResponse as cK, type ChargeMembershipsRequest as cL, type MembershipChargeItem as cM, type MembershipName as cN, type ServiceProperties as cO, type ChargeMembershipsResponse as cP, type TriggerRefundRequest as cQ, type PaymentRefund as cR, type RefundDetails as cS, type RefundItem as cT, type LineItemRefund as cU, type AdditionalFeeRefund as cV, type ShippingRefund as cW, type RefundSideEffects as cX, type RestockInfo as cY, type RestockItem as cZ, type TriggerRefundResponse as c_, type CreatedByStringOneOf as ca, type ChannelInfo as cb, type CustomField as cc, type BalanceSummary as cd, type Balance as ce, type AdditionalFee as cf, type FulfillmentStatusesAggregate as cg, type Tags as ch, type TagList as ci, type Location as cj, type OrderApproved as ck, type OrdersExperiments as cl, type OrderRejectedEventOrderRejected as cm, type OrderItemsRestocked as cn, type V1RestockItem as co, type PreparePaymentCollectionRequest as cp, type RedirectUrls as cq, type DelayedCaptureSettings as cr, type Duration as cs, type GetPaymentCollectabilityStatusRequest as ct, type RecordManuallyCollectedPaymentRequest as cu, type RecordManuallyCollectedPaymentResponse as cv, type MarkOrderAsPaidRequest as cw, type MarkOrderAsPaidResponse as cx, type BulkMarkOrdersAsPaidRequest as cy, type BulkMarkOrdersAsPaidResponse as cz, type VoidAuthorizedPaymentsApplicationErrors as d, type GetOrderResponse as d$, type Payment as d0, type PaymentPaymentDetailsOneOf as d1, type PaymentReceiptInfoOneOf as d2, type RegularPaymentDetails as d3, type RegularPaymentDetailsPaymentMethodDetailsOneOf as d4, type CreditCardPaymentMethodDetails as d5, type AuthorizationDetails as d6, type AuthorizationCapture as d7, type AuthorizationActionFailureDetails as d8, type AuthorizationVoid as d9, type EntityDeletedEvent as dA, type ActionEvent as dB, type Empty as dC, type MessageEnvelope as dD, type IdentificationData as dE, type IdentificationDataIdOneOf as dF, type UpdateInternalDocumentsEvent as dG, type UpdateInternalDocumentsEventOperationOneOf as dH, type InternalDocument as dI, type InternalDocumentUpdateOperation as dJ, type DeleteByIdsOperation as dK, type DeleteByFilterOperation as dL, type InternalDocumentUpdateByFilterOperation as dM, type InternalUpdateExistingOperation as dN, type VersionedDocumentUpdateOperation as dO, type VersionedDeleteByIdsOperation as dP, type VersionedDocumentId as dQ, type TriggerReindexRequest as dR, type TriggerReindexResponse as dS, type BatchOfTriggerReindexOrderRequest as dT, type TriggerReindexOrderRequest as dU, type DiffmatokyPayload as dV, type ErrorInformation as dW, type ContinueSideEffectsFlowInLegacyData as dX, type SnapshotMessage as dY, type IndexingMessage as dZ, type GetOrderRequest as d_, type V1ScheduledAction as da, type Chargeback as db, type GiftCardPaymentDetails as dc, type MembershipPaymentDetails as dd, type WixReceiptInfo as de, type ExternalReceiptInfo as df, type Refund as dg, type RefundTransaction as dh, type RefundStatusInfo as di, type AggregatedRefundSummary as dj, type RefundItemsBreakdown as dk, type LineItemRefundSummary as dl, type CalculateRefundRequest as dm, type CalculateRefundItemRequest as dn, type CalculateRefundResponse as dp, type CalculateRefundItemResponse as dq, type VoidAuthorizedPaymentsRequest as dr, type CaptureAuthorizedPaymentsRequest as ds, type ChargeSavedPaymentMethodRequest as dt, type ChargeSavedPaymentMethodResponse as du, type DomainEvent as dv, type DomainEventBodyOneOf as dw, type EntityCreatedEvent as dx, type RestoreInfo as dy, type EntityUpdatedEvent as dz, type PaymentCapture as e, type UpdateBillingContactDetailsRequest as e$, type InternalQueryOrdersRequest as e0, type PlatformQuery as e1, type PlatformQueryPagingMethodOneOf as e2, type Sorting as e3, type PlatformPaging as e4, type CursorPaging as e5, type InternalQueryOrdersResponse as e6, type PlatformPagingMetadata as e7, type Cursors as e8, type QueryOrderRequest as e9, type DraftOrderCommitSettings as eA, type InventoryUpdateDetails as eB, type CommitDeltasResponse as eC, type OrderDeltasCommitted as eD, type CommittedDiffs as eE, type CommittedDiffsShippingUpdateInfoOneOf as eF, type LineItemDelta as eG, type LineItemDeltaDeltaOneOf as eH, type ArchiveOrderRequest as eI, type ArchiveOrderResponse as eJ, type BulkArchiveOrdersRequest as eK, type BulkArchiveOrdersResponse as eL, type BulkArchiveOrdersByFilterRequest as eM, type BulkArchiveOrdersByFilterResponse as eN, type UnArchiveOrderRequest as eO, type UnArchiveOrderResponse as eP, type BulkUnArchiveOrdersRequest as eQ, type BulkUnArchiveOrdersResponse as eR, type BulkUnArchiveOrdersByFilterRequest as eS, type BulkUnArchiveOrdersByFilterResponse as eT, type UpdateBuyerInfoRequest as eU, type BuyerInfoUpdate as eV, type UpdateBuyerInfoResponse as eW, type UpdateBuyerEmailRequest as eX, type UpdateBuyerEmailResponse as eY, type UpdateOrderShippingAddressRequest as eZ, type UpdateOrderShippingAddressResponse as e_, type QueryOrderResponse as ea, type SearchOrdersRequest as eb, type CursorSearch as ec, type CursorSearchPagingMethodOneOf as ed, type CursorPagingMetadata as ee, type CreateOrderRequest as ef, type OrderCreationSettings as eg, type OrderCreateNotifications as eh, type CreateOrderResponse as ei, type UpdateOrderRequest as ej, type UpdateOrderResponse as ek, type BulkUpdateOrdersRequest as el, type CommitDeltasRequest as em, type DraftOrderDiffs as en, type DraftOrderDiffsShippingUpdateInfoOneOf as eo, type DraftOrderDiffsBuyerUpdateInfoOneOf as ep, type DraftOrderDiffsBillingUpdateInfoOneOf as eq, type DraftOrderDiffsRecipientUpdateInfoOneOf as er, type V1LineItemDelta as es, type V1LineItemDeltaDeltaOneOf as et, type OrderLineItemChangedDetails as eu, type ItemChangedDetails as ev, type AppliedDiscountDelta as ew, type AppliedDiscountDeltaDeltaOneOf as ex, type AdditionalFeeDelta as ey, type AdditionalFeeDeltaDeltaOneOf as ez, type CaptureAuthorizedPaymentsApplicationErrors as f, type BulkSetBusinessLocationResult as f$, type UpdateBillingContactDetailsResponse as f0, type UpdateOrderLineItemRequest as f1, type UpdateOrderLineItemResponse as f2, type UpdateOrderLineItemsRequest as f3, type MaskedOrderLineItem as f4, type UpdateOrderLineItemsResponse as f5, type AddInternalActivityRequest as f6, type InternalActivity as f7, type InternalActivityContentOneOf as f8, type OrderPlaced as f9, type UpdateActivityResponse as fA, type DeleteActivityRequest as fB, type DeleteActivityResponse as fC, type UpdateLineItemsDescriptionLinesRequest as fD, type LineItemUpdate as fE, type UpdateLineItemsDescriptionLinesResponse as fF, type MarkOrderAsSeenByHumanRequest as fG, type MarkOrderAsSeenByHumanResponse as fH, type CancelOrderRequest as fI, type OrderCanceledEventOrderCanceled as fJ, type UpdateOrderStatusRequest as fK, type UpdateOrderStatusResponse as fL, type MarkAsFulfilledRequest as fM, type MarkAsFulfilledResponse as fN, type FulfillmentStatusUpdated as fO, type BulkMarkAsFulfilledRequest as fP, type BulkMarkAsFulfilledResponse as fQ, type BulkMarkAsFulfilledByFilterRequest as fR, type BulkMarkAsFulfilledByFilterResponse as fS, type MarkAsUnfulfilledRequest as fT, type MarkAsUnfulfilledResponse as fU, type BulkMarkAsUnfulfilledRequest as fV, type BulkMarkAsUnfulfilledResponse as fW, type BulkMarkAsUnfulfilledByFilterRequest as fX, type BulkMarkAsUnfulfilledByFilterResponse as fY, type BulkSetBusinessLocationRequest as fZ, type BulkSetBusinessLocationResponse as f_, type OrderPaid as fa, type OrderFulfilled as fb, type OrderNotFulfilled as fc, type OrderCanceled as fd, type DownloadLinkSent as fe, type TrackingNumberAdded as ff, type TrackingNumberEdited as fg, type TrackingLinkAdded as fh, type ShippingConfirmationEmailSent as fi, type InvoiceAdded as fj, type InvoiceSent as fk, type FulfillerEmailSent as fl, type ShippingAddressEdited as fm, type EmailEdited as fn, type PickupReadyEmailSent as fo, type OrderPartiallyPaid as fp, type OrderPending as fq, type OrderRejected as fr, type AddInternalActivityResponse as fs, type AddActivityRequest as ft, type PublicActivity as fu, type PublicActivityContentOneOf as fv, type AddActivityResponse as fw, type AddActivitiesRequest as fx, type AddActivitiesResponse as fy, type UpdateActivityRequest as fz, type GetOrderApplicationErrors as g, type OrderSearchSpec as g$, type V1MarkOrderAsPaidRequest as g0, type V1MarkOrderAsPaidResponse as g1, type PaymentStatusUpdated as g2, type V1BulkMarkOrdersAsPaidRequest as g3, type V1BulkMarkOrdersAsPaidResponse as g4, type V1CreatePaymentGatewayOrderRequest as g5, type V1CreatePaymentGatewayOrderResponse as g6, type GetShipmentsRequest as g7, type GetShipmentsResponse as g8, type AggregateOrdersRequest as g9, type InvoiceDates as gA, type LineItems as gB, type LineItem as gC, type BigDecimalWrapper as gD, type LineItemTax as gE, type Source as gF, type LineItemMetaData as gG, type Locale as gH, type TotalPrice as gI, type ItemizedFee as gJ, type Discount as gK, type DiscountOneDiscountTypeOneOf as gL, type CalculatedTaxes as gM, type CalculatedTax as gN, type Payments as gO, type InvoicesPayment as gP, type MetaData as gQ, type InvoiceDynamicPriceTotals as gR, type CustomFieldValue as gS, type Value as gT, type Deposit as gU, type TriggerSideEffectsFromLegacyData as gV, type BaseEventMetadata as gW, type EventMetadata as gX, type PaymentCollectionCreatePaymentGatewayOrderOptions as gY, type ChargeMembershipsOptions as gZ, type TriggerRefundOptions as g_, type AggregateOrdersResponse as ga, type DecrementItemsQuantityRequest as gb, type DecrementData as gc, type DecrementItemsQuantityResponse as gd, type BulkUpdateOrderTagsRequest as ge, type BulkUpdateOrderTagsResult as gf, type Task as gg, type TaskKey as gh, type TaskAction as gi, type TaskActionActionOneOf as gj, type Complete as gk, type Cancel as gl, type Reschedule as gm, type InvoiceSentEvent as gn, type IdAndVersion as go, type InvoiceFields as gp, type Customer as gq, type Email as gr, type QuotesAddress as gs, type AddressDescription as gt, type Phone as gu, type Company as gv, type CommonAddress as gw, type CommonAddressStreetOneOf as gx, type Subdivision as gy, type StandardDetails as gz, type OrderSearch as h, onOrderPaymentStatusUpdated as h$, type CommitDeltasOptions as h0, type UpdateOrderLineItemIdentifiers as h1, type UpdateOrderLineItem as h2, type UpdateActivityIdentifiers as h3, type DeleteActivityIdentifiers as h4, type AggregateOrdersOptions as h5, type DescriptionLineTypeWithLiterals as h6, type ItemTypeItemTypeWithLiterals as h7, type PaymentOptionTypeWithLiterals as h8, type JurisdictionTypeWithLiterals as h9, type ActionTypeWithLiterals as hA, type ChargebackStatusWithLiterals as hB, type MembershipPaymentStatusWithLiterals as hC, type RefundStatusWithLiterals as hD, type WebhookIdentityTypeWithLiterals as hE, type VersioningModeWithLiterals as hF, type SortOrderWithLiterals as hG, type OrderApprovalStrategyWithLiterals as hH, type DeltaPaymentOptionTypeWithLiterals as hI, type InventoryActionWithLiterals as hJ, type PlacementWithLiterals as hK, type SubdivisionTypeWithLiterals as hL, type SourceTypeWithLiterals as hM, type CustomFieldGroupWithLiterals as hN, type ValueTypeWithLiterals as hO, type DepositTypeWithLiterals as hP, type InvoiceStatusWithLiterals as hQ, type RecordManuallyCollectedPaymentApplicationErrors as hR, type PaymentCollectionMarkOrderAsPaidApplicationErrors as hS, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as hT, type TriggerRefundApplicationErrors as hU, type CommitDeltasApplicationErrors as hV, type UpdateOrderStatusApplicationErrors as hW, onOrderApproved as hX, onOrderUpdated as hY, onOrderCanceled as hZ, onOrderCreated as h_, type SubscriptionFrequencyWithLiterals as ha, type AdjustmentTypeWithLiterals as hb, type TaxableAddressTypeWithLiterals as hc, type PaymentStatusWithLiterals as hd, type FulfillmentStatusWithLiterals as he, type WeightUnitWithLiterals as hf, type VatTypeWithLiterals as hg, type PickupMethodWithLiterals as hh, type OrderStatusWithLiterals as hi, type DiscountTypeWithLiterals as hj, type DiscountReasonWithLiterals as hk, type LineItemQuantityChangeTypeWithLiterals as hl, type ActivityTypeWithLiterals as hm, type AttributionSourceWithLiterals as hn, type ChannelTypeWithLiterals as ho, type ScheduledActionWithLiterals as hp, type DurationUnitWithLiterals as hq, type PaymentCollectabilityStatusWithLiterals as hr, type RefundableStatusWithLiterals as hs, type NonRefundableReasonWithLiterals as ht, type ManuallyRefundableReasonWithLiterals as hu, type RestockTypeWithLiterals as hv, type TransactionStatusWithLiterals as hw, type AuthorizationCaptureStatusWithLiterals as hx, type AuthorizationVoidStatusWithLiterals as hy, type ReasonWithLiterals as hz, type CreateOrderOptions as i, preparePaymentCollection as i0, getPaymentCollectabilityStatus as i1, voidAuthorizedPayments as i2, captureAuthorizedPayments as i3, getOrder as i4, type CommonSearchWithEntityContext as i5, createOrder as i6, updateOrder as i7, bulkUpdateOrders as i8, cancelOrder as i9, bulkUpdateOrderTags as ia, type CreateOrderApplicationErrors as j, type UpdateOrderApplicationErrors as k, type BulkUpdateOrdersResponse as l, type CancelOrderOptions as m, type CancelOrderResponse as n, type CancelOrderApplicationErrors as o, type BulkUpdateOrderTagsOptions as p, type BulkUpdateOrderTagsResponse as q, type OrderApprovedEnvelope as r, type OrderUpdatedEnvelope as s, type OrderCanceledEnvelope as t, type OrderCreatedEnvelope as u, type OrderPaymentStatusUpdatedEnvelope as v, PaymentOptionType as w, SubscriptionFrequency as x, PaymentStatus as y, VatType as z };