@wix/auto_sdk_ecom_orders 1.0.67 → 1.0.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/cjs/ecom-v1-order-orders.universal-Dt_KjUcw.d.ts → cjs/ecom-v1-order-orders.universal-Br3Nippn.d.ts} +351 -3211
- package/build/cjs/index.d.ts +11 -59
- package/build/cjs/index.js +310 -1377
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +113 -1127
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +43 -953
- package/build/cjs/meta.js +3 -647
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/es/ecom-v1-order-orders.universal-Dt_KjUcw.d.mts → es/ecom-v1-order-orders.universal-Br3Nippn.d.mts} +351 -3211
- package/build/es/index.d.mts +11 -59
- package/build/es/index.mjs +308 -1344
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +112 -1094
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +43 -953
- package/build/es/meta.mjs +2 -635
- package/build/es/meta.mjs.map +1 -1
- package/build/{cjs/ecom-v1-order-orders.universal-D9sENjnN.d.ts → internal/cjs/ecom-v1-order-orders.universal-BAE6DVkA.d.ts} +857 -2526
- package/build/internal/cjs/index.d.ts +11 -165
- package/build/internal/cjs/index.js +310 -1377
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +113 -1127
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +43 -953
- package/build/internal/cjs/meta.js +3 -647
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/ecom-v1-order-orders.universal-D9sENjnN.d.mts → internal/es/ecom-v1-order-orders.universal-BAE6DVkA.d.mts} +857 -2526
- package/build/internal/es/index.d.mts +11 -165
- package/build/internal/es/index.mjs +308 -1344
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +112 -1094
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +43 -953
- package/build/internal/es/meta.mjs +2 -635
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -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,10 +2350,21 @@ interface Location {
|
|
|
2557
2350
|
*/
|
|
2558
2351
|
name?: string;
|
|
2559
2352
|
}
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
|
|
2353
|
+
interface DiffmatokyPayload {
|
|
2354
|
+
left?: string;
|
|
2355
|
+
right?: string;
|
|
2356
|
+
compareChannel?: string;
|
|
2357
|
+
entityId?: string;
|
|
2358
|
+
errorInformation?: ErrorInformation;
|
|
2359
|
+
tags?: string[];
|
|
2360
|
+
}
|
|
2361
|
+
interface ErrorInformation {
|
|
2362
|
+
stackTrace?: string;
|
|
2363
|
+
}
|
|
2364
|
+
interface ContinueSideEffectsFlowInLegacyData {
|
|
2365
|
+
storeId?: string;
|
|
2366
|
+
orderId?: string;
|
|
2367
|
+
ordersExperiments?: OrdersExperiments;
|
|
2564
2368
|
}
|
|
2565
2369
|
interface OrdersExperiments {
|
|
2566
2370
|
epCommitTax?: boolean;
|
|
@@ -2569,6 +2373,20 @@ interface OrdersExperiments {
|
|
|
2569
2373
|
producedByEpBridge?: boolean;
|
|
2570
2374
|
enableRewrittenSideEffects?: boolean;
|
|
2571
2375
|
}
|
|
2376
|
+
interface SnapshotMessage {
|
|
2377
|
+
_id?: string;
|
|
2378
|
+
opType?: number;
|
|
2379
|
+
}
|
|
2380
|
+
interface IndexingMessage {
|
|
2381
|
+
_id?: string;
|
|
2382
|
+
opType?: number;
|
|
2383
|
+
requiredVersions?: string[];
|
|
2384
|
+
}
|
|
2385
|
+
/** Triggered when the order status changes to approved */
|
|
2386
|
+
interface OrderApproved {
|
|
2387
|
+
/** The order that was updated */
|
|
2388
|
+
order?: Order;
|
|
2389
|
+
}
|
|
2572
2390
|
interface OrderRejectedEventOrderRejected {
|
|
2573
2391
|
/** The order that was rejected */
|
|
2574
2392
|
order?: Order;
|
|
@@ -2578,9 +2396,9 @@ interface OrderItemsRestocked {
|
|
|
2578
2396
|
/** The order which items were restocked */
|
|
2579
2397
|
order?: Order;
|
|
2580
2398
|
/** Restocked items and quantities */
|
|
2581
|
-
restockItems?:
|
|
2399
|
+
restockItems?: RestockItem[];
|
|
2582
2400
|
}
|
|
2583
|
-
interface
|
|
2401
|
+
interface RestockItem {
|
|
2584
2402
|
/**
|
|
2585
2403
|
* ID of the line item being restocked.
|
|
2586
2404
|
* @format GUID
|
|
@@ -2593,2350 +2411,106 @@ interface V1RestockItem {
|
|
|
2593
2411
|
*/
|
|
2594
2412
|
quantity?: number;
|
|
2595
2413
|
}
|
|
2596
|
-
interface
|
|
2414
|
+
interface GetOrderRequest {
|
|
2597
2415
|
/**
|
|
2598
|
-
*
|
|
2416
|
+
* ID of the order to retrieve.
|
|
2599
2417
|
* @minLength 1
|
|
2600
2418
|
* @maxLength 100
|
|
2601
2419
|
*/
|
|
2602
|
-
|
|
2603
|
-
/** Amount to collect */
|
|
2604
|
-
amount: Price;
|
|
2605
|
-
/**
|
|
2606
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
2607
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
2608
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
2609
|
-
*/
|
|
2610
|
-
paymentGatewayOrderId?: string | null;
|
|
2611
|
-
/**
|
|
2612
|
-
* Whether to delay capture of the payment.
|
|
2613
|
-
* Default: false
|
|
2614
|
-
* @deprecated Whether to delay capture of the payment.
|
|
2615
|
-
* Default: false
|
|
2616
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
2617
|
-
* @targetRemovalDate 2024-09-30
|
|
2618
|
-
*/
|
|
2619
|
-
delayedCapture?: boolean;
|
|
2620
|
-
/**
|
|
2621
|
-
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
2622
|
-
* Default: `true`
|
|
2623
|
-
* @internal
|
|
2624
|
-
*/
|
|
2625
|
-
merchantInitiated?: boolean | null;
|
|
2626
|
-
/**
|
|
2627
|
-
* Redirect urls which are used to return buyer to third party system.
|
|
2628
|
-
* @internal
|
|
2629
|
-
*/
|
|
2630
|
-
redirectUrls?: RedirectUrls;
|
|
2631
|
-
/** Delayed capture payment settings */
|
|
2632
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
2420
|
+
_id: string;
|
|
2633
2421
|
}
|
|
2634
|
-
interface
|
|
2635
|
-
/**
|
|
2636
|
-
|
|
2637
|
-
* @format WEB_URL
|
|
2638
|
-
*/
|
|
2639
|
-
successUrl?: string | null;
|
|
2640
|
-
/**
|
|
2641
|
-
* URL to redirect buyer in case of buyer canceled the transaction
|
|
2642
|
-
* @format WEB_URL
|
|
2643
|
-
*/
|
|
2644
|
-
cancelUrl?: string | null;
|
|
2645
|
-
/**
|
|
2646
|
-
* URL to redirect buyer in case of failed/rejected transaction
|
|
2647
|
-
* @format WEB_URL
|
|
2648
|
-
*/
|
|
2649
|
-
errorUrl?: string | null;
|
|
2650
|
-
/**
|
|
2651
|
-
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
2652
|
-
* @format WEB_URL
|
|
2653
|
-
*/
|
|
2654
|
-
pendingUrl?: string | null;
|
|
2422
|
+
interface GetOrderResponse {
|
|
2423
|
+
/** The requested order. */
|
|
2424
|
+
order?: Order;
|
|
2655
2425
|
}
|
|
2656
|
-
interface
|
|
2657
|
-
/**
|
|
2658
|
-
|
|
2659
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2660
|
-
delayDuration?: Duration;
|
|
2426
|
+
interface InternalQueryOrdersRequest {
|
|
2427
|
+
/** Query options. */
|
|
2428
|
+
query?: PlatformQuery;
|
|
2661
2429
|
}
|
|
2662
|
-
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
|
|
2666
|
-
|
|
2667
|
-
|
|
2430
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2431
|
+
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
2432
|
+
paging?: PlatformPaging;
|
|
2433
|
+
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
2434
|
+
cursorPaging?: CursorPaging;
|
|
2435
|
+
/** Filter object. */
|
|
2436
|
+
filter?: Record<string, any> | null;
|
|
2437
|
+
/** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
|
|
2438
|
+
sort?: Sorting[];
|
|
2668
2439
|
}
|
|
2669
|
-
/** @
|
|
2670
|
-
|
|
2671
|
-
|
|
2440
|
+
/** @oneof */
|
|
2441
|
+
interface PlatformQueryPagingMethodOneOf {
|
|
2442
|
+
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
2443
|
+
paging?: PlatformPaging;
|
|
2444
|
+
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
2445
|
+
cursorPaging?: CursorPaging;
|
|
2446
|
+
}
|
|
2447
|
+
interface Sorting {
|
|
2672
2448
|
/**
|
|
2673
|
-
*
|
|
2674
|
-
* @
|
|
2449
|
+
* Name of the field to sort by.
|
|
2450
|
+
* @maxLength 512
|
|
2675
2451
|
*/
|
|
2676
|
-
|
|
2677
|
-
/**
|
|
2678
|
-
|
|
2452
|
+
fieldName?: string;
|
|
2453
|
+
/** Sort order. */
|
|
2454
|
+
order?: SortOrderWithLiterals;
|
|
2679
2455
|
}
|
|
2680
|
-
declare enum
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
|
-
HOURS = "HOURS",
|
|
2684
|
-
DAYS = "DAYS"
|
|
2456
|
+
declare enum SortOrder {
|
|
2457
|
+
ASC = "ASC",
|
|
2458
|
+
DESC = "DESC"
|
|
2685
2459
|
}
|
|
2686
2460
|
/** @enumType */
|
|
2687
|
-
type
|
|
2688
|
-
interface
|
|
2689
|
-
/** Payment gateway order id which is associated with given payment */
|
|
2690
|
-
paymentGatewayOrderId?: string;
|
|
2691
|
-
}
|
|
2692
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
2461
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2462
|
+
interface PlatformPaging {
|
|
2693
2463
|
/**
|
|
2694
|
-
*
|
|
2695
|
-
* @
|
|
2696
|
-
* @maxLength 100
|
|
2464
|
+
* Number of items to load.
|
|
2465
|
+
* @max 100
|
|
2697
2466
|
*/
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
|
|
2701
|
-
/** Payment collectability status */
|
|
2702
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
2703
|
-
/** Collectable order amount */
|
|
2704
|
-
amount?: Price;
|
|
2705
|
-
}
|
|
2706
|
-
declare enum PaymentCollectabilityStatus {
|
|
2707
|
-
UNKNOWN = "UNKNOWN",
|
|
2708
|
-
COLLECTABLE = "COLLECTABLE",
|
|
2709
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
2710
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
2711
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
2712
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
2713
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
2714
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2467
|
+
limit?: number | null;
|
|
2468
|
+
/** Number of items to skip in the current sort order. */
|
|
2469
|
+
offset?: number | null;
|
|
2715
2470
|
}
|
|
2716
|
-
|
|
2717
|
-
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';
|
|
2718
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
2471
|
+
interface CursorPaging {
|
|
2719
2472
|
/**
|
|
2720
|
-
*
|
|
2721
|
-
* @
|
|
2722
|
-
* @maxLength 100
|
|
2473
|
+
* Maximum number of items to return in the results.
|
|
2474
|
+
* @max 100
|
|
2723
2475
|
*/
|
|
2724
|
-
|
|
2725
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
2726
|
-
amount: Price;
|
|
2727
|
-
}
|
|
2728
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
2729
|
-
}
|
|
2730
|
-
interface MarkOrderAsPaidRequest {
|
|
2476
|
+
limit?: number | null;
|
|
2731
2477
|
/**
|
|
2732
|
-
*
|
|
2733
|
-
*
|
|
2734
|
-
*
|
|
2478
|
+
* Pointer to the next or previous page in the list of results.
|
|
2479
|
+
*
|
|
2480
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2481
|
+
* Not relevant for the first request.
|
|
2482
|
+
* @maxLength 16000
|
|
2735
2483
|
*/
|
|
2736
|
-
|
|
2484
|
+
cursor?: string | null;
|
|
2737
2485
|
}
|
|
2738
|
-
interface
|
|
2739
|
-
/**
|
|
2740
|
-
|
|
2486
|
+
interface InternalQueryOrdersResponse {
|
|
2487
|
+
/** List of orders. */
|
|
2488
|
+
orders?: Order[];
|
|
2489
|
+
/** Details on the paged set of results returned. */
|
|
2490
|
+
metadata?: PlatformPagingMetadata;
|
|
2741
2491
|
}
|
|
2742
|
-
interface
|
|
2492
|
+
interface PlatformPagingMetadata {
|
|
2493
|
+
/** The number of items returned in this response. */
|
|
2494
|
+
count?: number | null;
|
|
2495
|
+
/** The offset which was requested. Returned if offset paging was used. */
|
|
2496
|
+
offset?: number | null;
|
|
2497
|
+
/** The total number of items that match the query. Returned if offset paging was used. */
|
|
2498
|
+
total?: number | null;
|
|
2499
|
+
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
2500
|
+
cursors?: Cursors;
|
|
2501
|
+
}
|
|
2502
|
+
interface Cursors {
|
|
2743
2503
|
/**
|
|
2744
|
-
*
|
|
2745
|
-
* @
|
|
2746
|
-
* @maxSize 100
|
|
2747
|
-
* @minLength 1
|
|
2748
|
-
* @maxLength 100
|
|
2504
|
+
* Cursor string pointing to the next page in the list of results.
|
|
2505
|
+
* @maxLength 16000
|
|
2749
2506
|
*/
|
|
2750
|
-
|
|
2751
|
-
}
|
|
2752
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
2507
|
+
next?: string | null;
|
|
2753
2508
|
/**
|
|
2754
|
-
*
|
|
2755
|
-
*
|
|
2756
|
-
*/
|
|
2757
|
-
results?: BulkOrderResult[];
|
|
2758
|
-
/** Bulk action metadata. */
|
|
2759
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2760
|
-
}
|
|
2761
|
-
interface BulkOrderResult {
|
|
2762
|
-
/** Item metadata. */
|
|
2763
|
-
itemMetadata?: ItemMetadata;
|
|
2764
|
-
/**
|
|
2765
|
-
* Updated order.
|
|
2766
|
-
*
|
|
2767
|
-
* Returned when `returnFullEntity = true`.
|
|
2768
|
-
*/
|
|
2769
|
-
item?: Order;
|
|
2770
|
-
}
|
|
2771
|
-
interface ItemMetadata {
|
|
2772
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2773
|
-
_id?: string | null;
|
|
2774
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2775
|
-
originalIndex?: number;
|
|
2776
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2777
|
-
success?: boolean;
|
|
2778
|
-
/** Details about the error in case of failure. */
|
|
2779
|
-
error?: ApplicationError;
|
|
2780
|
-
}
|
|
2781
|
-
interface ApplicationError {
|
|
2782
|
-
/** Error code. */
|
|
2783
|
-
code?: string;
|
|
2784
|
-
/** Description of the error. */
|
|
2785
|
-
description?: string;
|
|
2786
|
-
/** Data related to the error. */
|
|
2787
|
-
data?: Record<string, any> | null;
|
|
2788
|
-
}
|
|
2789
|
-
interface BulkActionMetadata {
|
|
2790
|
-
/** Number of items that were successfully processed. */
|
|
2791
|
-
totalSuccesses?: number;
|
|
2792
|
-
/** Number of items that couldn't be processed. */
|
|
2793
|
-
totalFailures?: number;
|
|
2794
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2795
|
-
undetailedFailures?: number;
|
|
2796
|
-
}
|
|
2797
|
-
interface GetRefundabilityStatusRequest {
|
|
2798
|
-
/**
|
|
2799
|
-
* Order ID.
|
|
2800
|
-
* @minLength 1
|
|
2801
|
-
* @maxLength 100
|
|
2802
|
-
*/
|
|
2803
|
-
ecomOrderId: string;
|
|
2804
|
-
}
|
|
2805
|
-
interface GetRefundabilityStatusResponse {
|
|
2806
|
-
/**
|
|
2807
|
-
* Refundability details.
|
|
2808
|
-
* @maxSize 300
|
|
2809
|
-
*/
|
|
2810
|
-
refundabilities?: Refundability[];
|
|
2811
|
-
/**
|
|
2812
|
-
* Whether the order supports refunding per item.
|
|
2813
|
-
* @deprecated
|
|
2814
|
-
*/
|
|
2815
|
-
refundablePerItem?: boolean;
|
|
2816
|
-
}
|
|
2817
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2818
|
-
/** Reason why payment is not refundable. */
|
|
2819
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2820
|
-
/** Reason why payment is only refundable manually. */
|
|
2821
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2822
|
-
/** Payment ID. */
|
|
2823
|
-
paymentId?: string;
|
|
2824
|
-
/** Payment refundability status. */
|
|
2825
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
2826
|
-
/** Link to payment provider dashboard. */
|
|
2827
|
-
providerLink?: string | null;
|
|
2828
|
-
}
|
|
2829
|
-
/** @oneof */
|
|
2830
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2831
|
-
/** Reason why payment is not refundable. */
|
|
2832
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2833
|
-
/** Reason why payment is only refundable manually. */
|
|
2834
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2835
|
-
}
|
|
2836
|
-
declare enum RefundableStatus {
|
|
2837
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2838
|
-
MANUAL = "MANUAL",
|
|
2839
|
-
REFUNDABLE = "REFUNDABLE"
|
|
2840
|
-
}
|
|
2841
|
-
/** @enumType */
|
|
2842
|
-
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
2843
|
-
declare enum NonRefundableReason {
|
|
2844
|
-
NONE = "NONE",
|
|
2845
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
2846
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
2847
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
2848
|
-
NOT_PAID = "NOT_PAID",
|
|
2849
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
2850
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
2851
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
2852
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
2853
|
-
FORBIDDEN = "FORBIDDEN",
|
|
2854
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
2855
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
2856
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
2857
|
-
}
|
|
2858
|
-
/** @enumType */
|
|
2859
|
-
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';
|
|
2860
|
-
declare enum ManuallyRefundableReason {
|
|
2861
|
-
EXPIRED = "EXPIRED",
|
|
2862
|
-
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
2863
|
-
OFFLINE = "OFFLINE",
|
|
2864
|
-
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2865
|
-
}
|
|
2866
|
-
/** @enumType */
|
|
2867
|
-
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
2868
|
-
interface CreatePaymentGatewayOrderRequest {
|
|
2869
|
-
/**
|
|
2870
|
-
* Ecom order ID.
|
|
2871
|
-
* @minLength 1
|
|
2872
|
-
* @maxLength 100
|
|
2873
|
-
*/
|
|
2874
|
-
ecomOrderId: string;
|
|
2875
|
-
/** Information about the user who initiated the payment. */
|
|
2876
|
-
chargedBy?: ChargedBy;
|
|
2877
|
-
}
|
|
2878
|
-
interface ChargedBy {
|
|
2879
|
-
/**
|
|
2880
|
-
* ID - id of the user who initiated the payment
|
|
2881
|
-
* @format GUID
|
|
2882
|
-
*/
|
|
2883
|
-
_id?: string;
|
|
2884
|
-
/**
|
|
2885
|
-
* Full name - name of the user who initiated the payment
|
|
2886
|
-
* @minLength 1
|
|
2887
|
-
* @maxLength 200
|
|
2888
|
-
*/
|
|
2889
|
-
fullName?: string | null;
|
|
2890
|
-
}
|
|
2891
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
2892
|
-
/** ID of the order created in the payment gateway */
|
|
2893
|
-
paymentGatewayOrderId?: string;
|
|
2894
|
-
}
|
|
2895
|
-
interface ChargeMembershipsRequest {
|
|
2896
|
-
/**
|
|
2897
|
-
* Order ID.
|
|
2898
|
-
* @minLength 1
|
|
2899
|
-
* @maxLength 100
|
|
2900
|
-
*/
|
|
2901
|
-
ecomOrderId: string;
|
|
2902
|
-
/**
|
|
2903
|
-
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
2904
|
-
* but a user which is using the membership on behalf of the a member
|
|
2905
|
-
* @format GUID
|
|
2906
|
-
*/
|
|
2907
|
-
memberId: string;
|
|
2908
|
-
/**
|
|
2909
|
-
* List of items to be paid by memberships
|
|
2910
|
-
* @minSize 1
|
|
2911
|
-
* @maxSize 300
|
|
2912
|
-
*/
|
|
2913
|
-
membershipCharges?: MembershipChargeItem[];
|
|
2914
|
-
}
|
|
2915
|
-
interface MembershipChargeItem {
|
|
2916
|
-
/**
|
|
2917
|
-
* The id of used membership
|
|
2918
|
-
* @minLength 1
|
|
2919
|
-
* @maxLength 100
|
|
2920
|
-
*/
|
|
2921
|
-
membershipId?: string;
|
|
2922
|
-
/**
|
|
2923
|
-
* ID of the application providing this payment option
|
|
2924
|
-
* @format GUID
|
|
2925
|
-
*/
|
|
2926
|
-
appId?: string;
|
|
2927
|
-
/** The name of used membership */
|
|
2928
|
-
membershipName?: MembershipName;
|
|
2929
|
-
/** Additional data about this membership */
|
|
2930
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
2931
|
-
/** Catalog and item reference info. */
|
|
2932
|
-
catalogReference?: CatalogReference;
|
|
2933
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
2934
|
-
serviceProperties?: ServiceProperties;
|
|
2935
|
-
/**
|
|
2936
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
2937
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
2938
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
2939
|
-
* @minLength 1
|
|
2940
|
-
* @maxLength 36
|
|
2941
|
-
*/
|
|
2942
|
-
rootCatalogItemId?: string | null;
|
|
2943
|
-
/**
|
|
2944
|
-
* line item id of Checkout/Order line item
|
|
2945
|
-
* @minLength 1
|
|
2946
|
-
* @maxLength 100
|
|
2947
|
-
*/
|
|
2948
|
-
lineItemId?: string;
|
|
2949
|
-
}
|
|
2950
|
-
interface MembershipName {
|
|
2951
|
-
/**
|
|
2952
|
-
* Membership name.
|
|
2953
|
-
* @maxLength 100
|
|
2954
|
-
*/
|
|
2955
|
-
original?: string;
|
|
2956
|
-
/**
|
|
2957
|
-
* Translated membership name. Defaults to `original` when not provided.
|
|
2958
|
-
* @maxLength 100
|
|
2959
|
-
*/
|
|
2960
|
-
translated?: string | null;
|
|
2961
|
-
}
|
|
2962
|
-
interface ServiceProperties {
|
|
2963
|
-
/**
|
|
2964
|
-
* 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.
|
|
2965
|
-
* For example, the start time of a class.
|
|
2966
|
-
*/
|
|
2967
|
-
scheduledDate?: Date | null;
|
|
2968
|
-
/**
|
|
2969
|
-
* 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.
|
|
2970
|
-
* @min 1
|
|
2971
|
-
* @max 10000
|
|
2972
|
-
*/
|
|
2973
|
-
numberOfParticipants?: number | null;
|
|
2974
|
-
}
|
|
2975
|
-
interface ChargeMembershipsResponse {
|
|
2976
|
-
}
|
|
2977
|
-
interface TriggerRefundRequest {
|
|
2978
|
-
/**
|
|
2979
|
-
* The order this refund related to
|
|
2980
|
-
* @minLength 1
|
|
2981
|
-
* @maxLength 100
|
|
2982
|
-
*/
|
|
2983
|
-
ecomOrderId: string;
|
|
2984
|
-
/**
|
|
2985
|
-
* Refund operations information
|
|
2986
|
-
* @minSize 1
|
|
2987
|
-
* @maxSize 1
|
|
2988
|
-
*/
|
|
2989
|
-
payments: PaymentRefund[];
|
|
2990
|
-
/** Business model of a refund */
|
|
2991
|
-
details?: RefundDetails;
|
|
2992
|
-
/** Side effect details related to refund */
|
|
2993
|
-
sideEffects?: RefundSideEffects;
|
|
2994
|
-
}
|
|
2995
|
-
interface PaymentRefund {
|
|
2996
|
-
/**
|
|
2997
|
-
* Specific payment within the order to refund
|
|
2998
|
-
* @format GUID
|
|
2999
|
-
*/
|
|
3000
|
-
paymentId?: string;
|
|
3001
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
3002
|
-
amount?: Price;
|
|
3003
|
-
/**
|
|
3004
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
3005
|
-
* 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.
|
|
3006
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
3007
|
-
*/
|
|
3008
|
-
externalRefund?: boolean;
|
|
3009
|
-
}
|
|
3010
|
-
/** Business model of a refund request */
|
|
3011
|
-
interface RefundDetails {
|
|
3012
|
-
/**
|
|
3013
|
-
* Order line item IDs and quantities that were refunded.
|
|
3014
|
-
* @maxSize 300
|
|
3015
|
-
*/
|
|
3016
|
-
items?: RefundItem[];
|
|
3017
|
-
/** Whether the shipping fee was also refunded. */
|
|
3018
|
-
shippingIncluded?: boolean;
|
|
3019
|
-
/**
|
|
3020
|
-
* Reason for the refund, provided by customer (optional).
|
|
3021
|
-
* @maxLength 200
|
|
3022
|
-
*/
|
|
3023
|
-
reason?: string | null;
|
|
3024
|
-
/**
|
|
3025
|
-
* Line items that were refunded.
|
|
3026
|
-
* @maxSize 300
|
|
3027
|
-
*/
|
|
3028
|
-
lineItems?: LineItemRefund[];
|
|
3029
|
-
/**
|
|
3030
|
-
* Additional fees that were refunded.
|
|
3031
|
-
* @maxSize 100
|
|
3032
|
-
*/
|
|
3033
|
-
additionalFees?: AdditionalFeeRefund[];
|
|
3034
|
-
/** Shipping amount that was refunded. */
|
|
3035
|
-
shipping?: ShippingRefund;
|
|
3036
|
-
}
|
|
3037
|
-
interface RefundItem {
|
|
3038
|
-
/**
|
|
3039
|
-
* Line item ID the refunded line item.
|
|
3040
|
-
* @format GUID
|
|
3041
|
-
*/
|
|
3042
|
-
lineItemId?: string;
|
|
3043
|
-
/**
|
|
3044
|
-
* Line item quantity refunded.
|
|
3045
|
-
* @min 1
|
|
3046
|
-
* @max 100000
|
|
3047
|
-
*/
|
|
3048
|
-
quantity?: number;
|
|
3049
|
-
}
|
|
3050
|
-
interface LineItemRefund {
|
|
3051
|
-
/**
|
|
3052
|
-
* Line item ID.
|
|
3053
|
-
* @format GUID
|
|
3054
|
-
* @immutable
|
|
3055
|
-
*/
|
|
3056
|
-
lineItemId?: string;
|
|
3057
|
-
/**
|
|
3058
|
-
* Refund quantity.
|
|
3059
|
-
* @min 1
|
|
3060
|
-
* @max 100000
|
|
3061
|
-
* @immutable
|
|
3062
|
-
*/
|
|
3063
|
-
quantity?: number;
|
|
3064
|
-
}
|
|
3065
|
-
interface AdditionalFeeRefund {
|
|
3066
|
-
/**
|
|
3067
|
-
* Additional fee ID.
|
|
3068
|
-
* @format GUID
|
|
3069
|
-
* @immutable
|
|
3070
|
-
*/
|
|
3071
|
-
additionalFeeId?: string;
|
|
3072
|
-
/**
|
|
3073
|
-
* Refund amount.
|
|
3074
|
-
* @immutable
|
|
3075
|
-
*/
|
|
3076
|
-
amount?: Price;
|
|
3077
|
-
}
|
|
3078
|
-
interface ShippingRefund {
|
|
3079
|
-
/**
|
|
3080
|
-
* Refund amount.
|
|
3081
|
-
* @immutable
|
|
3082
|
-
*/
|
|
3083
|
-
amount?: Price;
|
|
3084
|
-
}
|
|
3085
|
-
interface RefundSideEffects {
|
|
3086
|
-
/** Inventory restock details as part of this refund. */
|
|
3087
|
-
restockInfo?: RestockInfo;
|
|
3088
|
-
/** Whether to send a refund confirmation email to the customer. */
|
|
3089
|
-
sendOrderRefundedEmail?: boolean;
|
|
3090
|
-
/**
|
|
3091
|
-
* Custom message added to the refund confirmation email.
|
|
3092
|
-
* @minLength 1
|
|
3093
|
-
* @maxLength 1000
|
|
3094
|
-
*/
|
|
3095
|
-
customMessage?: string | null;
|
|
3096
|
-
}
|
|
3097
|
-
interface RestockInfo {
|
|
3098
|
-
/** Restock type. */
|
|
3099
|
-
type?: RestockTypeWithLiterals;
|
|
3100
|
-
/**
|
|
3101
|
-
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
3102
|
-
* @maxSize 300
|
|
3103
|
-
*/
|
|
3104
|
-
items?: RestockItem[];
|
|
3105
|
-
}
|
|
3106
|
-
declare enum RestockType {
|
|
3107
|
-
NO_ITEMS = "NO_ITEMS",
|
|
3108
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
3109
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
3110
|
-
}
|
|
3111
|
-
/** @enumType */
|
|
3112
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
3113
|
-
interface RestockItem {
|
|
3114
|
-
/**
|
|
3115
|
-
* ID of the line item being restocked.
|
|
3116
|
-
* @format GUID
|
|
3117
|
-
*/
|
|
3118
|
-
lineItemId?: string;
|
|
3119
|
-
/**
|
|
3120
|
-
* Line item quantity being restocked.
|
|
3121
|
-
* @min 1
|
|
3122
|
-
* @max 100000
|
|
3123
|
-
*/
|
|
3124
|
-
quantity?: number;
|
|
3125
|
-
}
|
|
3126
|
-
interface TriggerRefundResponse {
|
|
3127
|
-
/** All order's transactions after the refunds were added */
|
|
3128
|
-
orderTransactions?: OrderTransactions;
|
|
3129
|
-
/** Created refund ID */
|
|
3130
|
-
refundId?: string | null;
|
|
3131
|
-
/** Payment ID's that the refund execution had failed for */
|
|
3132
|
-
failedPaymentIds?: ItemMetadata[];
|
|
3133
|
-
}
|
|
3134
|
-
interface OrderTransactions {
|
|
3135
|
-
/**
|
|
3136
|
-
* Order ID.
|
|
3137
|
-
* @format GUID
|
|
3138
|
-
*/
|
|
3139
|
-
orderId?: string;
|
|
3140
|
-
/**
|
|
3141
|
-
* Record of payments made to the merchant.
|
|
3142
|
-
* @maxSize 100
|
|
3143
|
-
*/
|
|
3144
|
-
payments?: Payment[];
|
|
3145
|
-
/**
|
|
3146
|
-
* Record of refunds made to the buyer.
|
|
3147
|
-
* @maxSize 300
|
|
3148
|
-
*/
|
|
3149
|
-
refunds?: Refund[];
|
|
3150
|
-
}
|
|
3151
|
-
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
3152
|
-
/** Regular payment details. */
|
|
3153
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
3154
|
-
/** Gift card payment details. */
|
|
3155
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
3156
|
-
/**
|
|
3157
|
-
* Receipt created by Wix
|
|
3158
|
-
* @internal
|
|
3159
|
-
*/
|
|
3160
|
-
wixReceipt?: WixReceiptInfo;
|
|
3161
|
-
/**
|
|
3162
|
-
* Receipt created by an external system.
|
|
3163
|
-
* @internal
|
|
3164
|
-
*/
|
|
3165
|
-
externalReceipt?: ExternalReceiptInfo;
|
|
3166
|
-
/**
|
|
3167
|
-
* Payment ID.
|
|
3168
|
-
* @format GUID
|
|
3169
|
-
* @readonly
|
|
3170
|
-
*/
|
|
3171
|
-
_id?: string | null;
|
|
3172
|
-
/** 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. */
|
|
3173
|
-
_createdDate?: Date | null;
|
|
3174
|
-
/**
|
|
3175
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
3176
|
-
* @readonly
|
|
3177
|
-
*/
|
|
3178
|
-
_updatedDate?: Date | null;
|
|
3179
|
-
/** Payment amount. */
|
|
3180
|
-
amount?: Price;
|
|
3181
|
-
/**
|
|
3182
|
-
* Whether refunds for this payment are disabled.
|
|
3183
|
-
* + `true`: This payment is not refundable.
|
|
3184
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
3185
|
-
*/
|
|
3186
|
-
refundDisabled?: boolean;
|
|
3187
|
-
/**
|
|
3188
|
-
* Whether receipt generation for this payment are allowed.
|
|
3189
|
-
* + `true`: This payment supports receipt generation.
|
|
3190
|
-
* + `false`: This payment not supports receipt generation, or receipt already generated
|
|
3191
|
-
* @internal
|
|
3192
|
-
* @readonly
|
|
3193
|
-
*/
|
|
3194
|
-
supportReceiptGeneration?: boolean;
|
|
3195
|
-
}
|
|
3196
|
-
/** @oneof */
|
|
3197
|
-
interface PaymentPaymentDetailsOneOf {
|
|
3198
|
-
/** Regular payment details. */
|
|
3199
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
3200
|
-
/** Gift card payment details. */
|
|
3201
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
3202
|
-
}
|
|
3203
|
-
/** @oneof */
|
|
3204
|
-
interface PaymentReceiptInfoOneOf {
|
|
3205
|
-
/**
|
|
3206
|
-
* Receipt created by Wix
|
|
3207
|
-
* @internal
|
|
3208
|
-
*/
|
|
3209
|
-
wixReceipt?: WixReceiptInfo;
|
|
3210
|
-
/**
|
|
3211
|
-
* Receipt created by an external system.
|
|
3212
|
-
* @internal
|
|
3213
|
-
*/
|
|
3214
|
-
externalReceipt?: ExternalReceiptInfo;
|
|
3215
|
-
}
|
|
3216
|
-
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3217
|
-
/** Whether regular card used */
|
|
3218
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3219
|
-
/**
|
|
3220
|
-
* Wix Payments order ID.
|
|
3221
|
-
* @maxLength 100
|
|
3222
|
-
*/
|
|
3223
|
-
paymentOrderId?: string | null;
|
|
3224
|
-
/**
|
|
3225
|
-
* Payment gateway's transaction ID.
|
|
3226
|
-
* This field is only returned when the value of `offline_payment` is `false`.
|
|
3227
|
-
* @maxLength 100
|
|
3228
|
-
*/
|
|
3229
|
-
gatewayTransactionId?: string | null;
|
|
3230
|
-
/**
|
|
3231
|
-
* Payment method. Non-exhaustive list of supported values:
|
|
3232
|
-
* + `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`
|
|
3233
|
-
* @maxLength 100
|
|
3234
|
-
*/
|
|
3235
|
-
paymentMethod?: string | null;
|
|
3236
|
-
/**
|
|
3237
|
-
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
3238
|
-
* @maxLength 100
|
|
3239
|
-
*/
|
|
3240
|
-
providerTransactionId?: string | null;
|
|
3241
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
3242
|
-
offlinePayment?: boolean;
|
|
3243
|
-
/** Payment status. */
|
|
3244
|
-
status?: TransactionStatusWithLiterals;
|
|
3245
|
-
/**
|
|
3246
|
-
* Whether there is a payment agreement that allows for future charges.
|
|
3247
|
-
* @immutable
|
|
3248
|
-
*/
|
|
3249
|
-
savedPaymentMethod?: boolean;
|
|
3250
|
-
/** Authorization details. */
|
|
3251
|
-
authorizationDetails?: AuthorizationDetails;
|
|
3252
|
-
/**
|
|
3253
|
-
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
3254
|
-
* @internal
|
|
3255
|
-
* @maxLength 300
|
|
3256
|
-
*/
|
|
3257
|
-
paymentProvider?: string | null;
|
|
3258
|
-
}
|
|
3259
|
-
/** @oneof */
|
|
3260
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
3261
|
-
/** Whether regular card used */
|
|
3262
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
3263
|
-
}
|
|
3264
|
-
declare enum TransactionStatus {
|
|
3265
|
-
UNDEFINED = "UNDEFINED",
|
|
3266
|
-
APPROVED = "APPROVED",
|
|
3267
|
-
PENDING = "PENDING",
|
|
3268
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
3269
|
-
CANCELED = "CANCELED",
|
|
3270
|
-
DECLINED = "DECLINED",
|
|
3271
|
-
REFUNDED = "REFUNDED",
|
|
3272
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
3273
|
-
AUTHORIZED = "AUTHORIZED",
|
|
3274
|
-
VOIDED = "VOIDED"
|
|
3275
|
-
}
|
|
3276
|
-
/** @enumType */
|
|
3277
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
3278
|
-
interface CreditCardPaymentMethodDetails {
|
|
3279
|
-
/**
|
|
3280
|
-
* The last 4 digits of the card number.
|
|
3281
|
-
* @maxLength 4
|
|
3282
|
-
*/
|
|
3283
|
-
lastFourDigits?: string | null;
|
|
3284
|
-
/**
|
|
3285
|
-
* Card issuer's brand.
|
|
3286
|
-
* @maxLength 100
|
|
3287
|
-
*/
|
|
3288
|
-
brand?: string | null;
|
|
3289
|
-
}
|
|
3290
|
-
interface AuthorizationDetails {
|
|
3291
|
-
/**
|
|
3292
|
-
* Whether the authorized payment is of a delayed capture.
|
|
3293
|
-
* @readonly
|
|
3294
|
-
*/
|
|
3295
|
-
delayedCapture?: boolean;
|
|
3296
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3297
|
-
authorizedDate?: Date | null;
|
|
3298
|
-
/**
|
|
3299
|
-
* List of captures associated with payment
|
|
3300
|
-
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
3301
|
-
* @maxSize 1
|
|
3302
|
-
*/
|
|
3303
|
-
captures?: AuthorizationCapture[];
|
|
3304
|
-
/** Void associated with payment */
|
|
3305
|
-
void?: AuthorizationVoid;
|
|
3306
|
-
/** Scheduled action for this transaction */
|
|
3307
|
-
scheduledAction?: V1ScheduledAction;
|
|
3308
|
-
}
|
|
3309
|
-
interface AuthorizationCapture {
|
|
3310
|
-
/**
|
|
3311
|
-
* Capture ID.
|
|
3312
|
-
* @format GUID
|
|
3313
|
-
* @readonly
|
|
3314
|
-
*/
|
|
3315
|
-
_id?: string | null;
|
|
3316
|
-
/** Status of this capture action */
|
|
3317
|
-
status?: AuthorizationCaptureStatusWithLiterals;
|
|
3318
|
-
/**
|
|
3319
|
-
* Amount of this capture
|
|
3320
|
-
* @immutable
|
|
3321
|
-
*/
|
|
3322
|
-
amount?: Price;
|
|
3323
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3324
|
-
_createdDate?: Date | null;
|
|
3325
|
-
/** In case of status is FAILED may contain failure details */
|
|
3326
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
3327
|
-
}
|
|
3328
|
-
declare enum AuthorizationCaptureStatus {
|
|
3329
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3330
|
-
/** Capture operation still in progress. */
|
|
3331
|
-
PENDING = "PENDING",
|
|
3332
|
-
/** Capture operation succeeded. */
|
|
3333
|
-
SUCCEEDED = "SUCCEEDED",
|
|
3334
|
-
/** Capture operation failed. */
|
|
3335
|
-
FAILED = "FAILED"
|
|
3336
|
-
}
|
|
3337
|
-
/** @enumType */
|
|
3338
|
-
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3339
|
-
interface AuthorizationActionFailureDetails {
|
|
3340
|
-
/** @maxLength 100 */
|
|
3341
|
-
failureCode?: string;
|
|
3342
|
-
}
|
|
3343
|
-
interface AuthorizationVoid {
|
|
3344
|
-
/** Status of this void action */
|
|
3345
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
3346
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3347
|
-
voidedDate?: Date | null;
|
|
3348
|
-
/** In case of status is FAILED may contain failure details */
|
|
3349
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
3350
|
-
/** Reason of void action */
|
|
3351
|
-
reason?: ReasonWithLiterals;
|
|
3352
|
-
}
|
|
3353
|
-
declare enum AuthorizationVoidStatus {
|
|
3354
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3355
|
-
/** Void operation still in progress. */
|
|
3356
|
-
PENDING = "PENDING",
|
|
3357
|
-
/** Void operation succeeded. */
|
|
3358
|
-
SUCCEEDED = "SUCCEEDED",
|
|
3359
|
-
/** Void operation failed. */
|
|
3360
|
-
FAILED = "FAILED"
|
|
3361
|
-
}
|
|
3362
|
-
/** @enumType */
|
|
3363
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3364
|
-
/** Reason the authorization was voided. */
|
|
3365
|
-
declare enum Reason {
|
|
3366
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
3367
|
-
/** Authorization was voided by user. */
|
|
3368
|
-
MANUAL = "MANUAL",
|
|
3369
|
-
/** Authorization passed execution date. */
|
|
3370
|
-
SCHEDULED = "SCHEDULED"
|
|
3371
|
-
}
|
|
3372
|
-
/** @enumType */
|
|
3373
|
-
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
3374
|
-
interface V1ScheduledAction {
|
|
3375
|
-
/** Type of the action. */
|
|
3376
|
-
actionType?: ActionTypeWithLiterals;
|
|
3377
|
-
/** The date and time of the action. */
|
|
3378
|
-
executionDate?: Date | null;
|
|
3379
|
-
}
|
|
3380
|
-
declare enum ActionType {
|
|
3381
|
-
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
3382
|
-
VOID = "VOID",
|
|
3383
|
-
CAPTURE = "CAPTURE"
|
|
3384
|
-
}
|
|
3385
|
-
/** @enumType */
|
|
3386
|
-
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3387
|
-
interface Chargeback {
|
|
3388
|
-
/**
|
|
3389
|
-
* Chargeback ID.
|
|
3390
|
-
* @format GUID
|
|
3391
|
-
* @readonly
|
|
3392
|
-
* @immutable
|
|
3393
|
-
*/
|
|
3394
|
-
_id?: string;
|
|
3395
|
-
/**
|
|
3396
|
-
* 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.
|
|
3397
|
-
* @readonly
|
|
3398
|
-
* @immutable
|
|
3399
|
-
*/
|
|
3400
|
-
_createdDate?: Date | null;
|
|
3401
|
-
/**
|
|
3402
|
-
* 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.
|
|
3403
|
-
* @readonly
|
|
3404
|
-
*/
|
|
3405
|
-
_updatedDate?: Date | null;
|
|
3406
|
-
/**
|
|
3407
|
-
* Amount.
|
|
3408
|
-
* @readonly
|
|
3409
|
-
* @immutable
|
|
3410
|
-
*/
|
|
3411
|
-
amount?: Price;
|
|
3412
|
-
/**
|
|
3413
|
-
* Reversal amount. Present only when status is REVERSED.
|
|
3414
|
-
* @readonly
|
|
3415
|
-
*/
|
|
3416
|
-
reversalAmount?: Price;
|
|
3417
|
-
/**
|
|
3418
|
-
* Status.
|
|
3419
|
-
*
|
|
3420
|
-
* Default: `"APPROVED"`.
|
|
3421
|
-
*/
|
|
3422
|
-
status?: ChargebackStatusWithLiterals;
|
|
3423
|
-
/**
|
|
3424
|
-
* External chargeback ID.
|
|
3425
|
-
* @format GUID
|
|
3426
|
-
* @readonly
|
|
3427
|
-
* @immutable
|
|
3428
|
-
*/
|
|
3429
|
-
externalId?: string | null;
|
|
3430
|
-
}
|
|
3431
|
-
declare enum ChargebackStatus {
|
|
3432
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
3433
|
-
/** Chargeback was approved. */
|
|
3434
|
-
APPROVED = "APPROVED",
|
|
3435
|
-
/** Chargeback was reversed. */
|
|
3436
|
-
REVERSED = "REVERSED"
|
|
3437
|
-
}
|
|
3438
|
-
/** @enumType */
|
|
3439
|
-
type ChargebackStatusWithLiterals = ChargebackStatus | 'UNSPECIFIED' | 'APPROVED' | 'REVERSED';
|
|
3440
|
-
interface GiftCardPaymentDetails {
|
|
3441
|
-
/**
|
|
3442
|
-
* Gift card payment ID.
|
|
3443
|
-
* @minLength 1
|
|
3444
|
-
* @maxLength 100
|
|
3445
|
-
*/
|
|
3446
|
-
giftCardPaymentId?: string;
|
|
3447
|
-
/**
|
|
3448
|
-
* ID of the app that created the gift card.
|
|
3449
|
-
* @format GUID
|
|
3450
|
-
*/
|
|
3451
|
-
appId?: string;
|
|
3452
|
-
/**
|
|
3453
|
-
* Whether the gift card is voided.
|
|
3454
|
-
* @readonly
|
|
3455
|
-
*/
|
|
3456
|
-
voided?: boolean;
|
|
3457
|
-
/**
|
|
3458
|
-
* Gift card obfuscated code.
|
|
3459
|
-
* @internal
|
|
3460
|
-
* @maxLength 30
|
|
3461
|
-
* @immutable
|
|
3462
|
-
*/
|
|
3463
|
-
obfuscatedCode?: string | null;
|
|
3464
|
-
}
|
|
3465
|
-
interface MembershipPaymentDetails {
|
|
3466
|
-
/**
|
|
3467
|
-
* Membership ID.
|
|
3468
|
-
* @minLength 1
|
|
3469
|
-
* @maxLength 100
|
|
3470
|
-
*/
|
|
3471
|
-
membershipId?: string;
|
|
3472
|
-
/**
|
|
3473
|
-
* ID of the line item this membership applies to.
|
|
3474
|
-
* @minLength 1
|
|
3475
|
-
* @maxLength 100
|
|
3476
|
-
*/
|
|
3477
|
-
lineItemId?: string;
|
|
3478
|
-
/** Payment status. */
|
|
3479
|
-
status?: MembershipPaymentStatusWithLiterals;
|
|
3480
|
-
/** Membership name. */
|
|
3481
|
-
name?: MembershipName;
|
|
3482
|
-
/**
|
|
3483
|
-
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
3484
|
-
* @minLength 1
|
|
3485
|
-
* @maxLength 100
|
|
3486
|
-
*/
|
|
3487
|
-
externalTransactionId?: string | null;
|
|
3488
|
-
/**
|
|
3489
|
-
* Whether the membership is voided.
|
|
3490
|
-
* @readonly
|
|
3491
|
-
*/
|
|
3492
|
-
voided?: boolean;
|
|
3493
|
-
/**
|
|
3494
|
-
* ID of the application providing this payment option.
|
|
3495
|
-
* @format GUID
|
|
3496
|
-
*/
|
|
3497
|
-
providerAppId?: string;
|
|
3498
|
-
}
|
|
3499
|
-
declare enum MembershipPaymentStatus {
|
|
3500
|
-
/** Payment was charged. */
|
|
3501
|
-
CHARGED = "CHARGED",
|
|
3502
|
-
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3503
|
-
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3504
|
-
}
|
|
3505
|
-
/** @enumType */
|
|
3506
|
-
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
3507
|
-
interface WixReceiptInfo {
|
|
3508
|
-
/**
|
|
3509
|
-
* Receipt ID
|
|
3510
|
-
* @format GUID
|
|
3511
|
-
*/
|
|
3512
|
-
receiptId?: string;
|
|
3513
|
-
/**
|
|
3514
|
-
* Display number of receipt
|
|
3515
|
-
* @minLength 1
|
|
3516
|
-
* @maxLength 40
|
|
3517
|
-
*/
|
|
3518
|
-
displayNumber?: string | null;
|
|
3519
|
-
}
|
|
3520
|
-
interface ExternalReceiptInfo {
|
|
3521
|
-
/**
|
|
3522
|
-
* External receipt ID
|
|
3523
|
-
* @maxLength 100
|
|
3524
|
-
*/
|
|
3525
|
-
receiptId?: string | null;
|
|
3526
|
-
/**
|
|
3527
|
-
* ID of the app providing the receipt
|
|
3528
|
-
* @format GUID
|
|
3529
|
-
*/
|
|
3530
|
-
appId?: string | null;
|
|
3531
|
-
/**
|
|
3532
|
-
* Display number of receipt
|
|
3533
|
-
* @minLength 1
|
|
3534
|
-
* @maxLength 40
|
|
3535
|
-
*/
|
|
3536
|
-
displayNumber?: string | null;
|
|
3537
|
-
}
|
|
3538
|
-
interface Refund {
|
|
3539
|
-
/**
|
|
3540
|
-
* Refund ID.
|
|
3541
|
-
* @format GUID
|
|
3542
|
-
* @readonly
|
|
3543
|
-
*/
|
|
3544
|
-
_id?: string;
|
|
3545
|
-
/**
|
|
3546
|
-
* List of transactions.
|
|
3547
|
-
* @maxSize 50
|
|
3548
|
-
*/
|
|
3549
|
-
transactions?: RefundTransaction[];
|
|
3550
|
-
/** Refund business details. */
|
|
3551
|
-
details?: RefundDetails;
|
|
3552
|
-
/**
|
|
3553
|
-
* 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.
|
|
3554
|
-
* @readonly
|
|
3555
|
-
* @immutable
|
|
3556
|
-
*/
|
|
3557
|
-
_createdDate?: Date | null;
|
|
3558
|
-
/**
|
|
3559
|
-
* Aggregated refund summary.
|
|
3560
|
-
* @readonly
|
|
3561
|
-
*/
|
|
3562
|
-
summary?: AggregatedRefundSummary;
|
|
3563
|
-
/**
|
|
3564
|
-
* ID of the app that initiated this refund.
|
|
3565
|
-
* @format GUID
|
|
3566
|
-
* @readonly
|
|
3567
|
-
* @immutable
|
|
3568
|
-
*/
|
|
3569
|
-
requestingServiceAppId?: string | null;
|
|
3570
|
-
}
|
|
3571
|
-
interface RefundTransaction {
|
|
3572
|
-
/**
|
|
3573
|
-
* ID of the payment associated with this refund.
|
|
3574
|
-
* @format GUID
|
|
3575
|
-
* @immutable
|
|
3576
|
-
*/
|
|
3577
|
-
paymentId?: string;
|
|
3578
|
-
/**
|
|
3579
|
-
* Refund amount.
|
|
3580
|
-
* @immutable
|
|
3581
|
-
*/
|
|
3582
|
-
amount?: Price;
|
|
3583
|
-
/** Refund status. */
|
|
3584
|
-
refundStatus?: RefundStatusWithLiterals;
|
|
3585
|
-
/** Optional details of current refund status. */
|
|
3586
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
3587
|
-
/**
|
|
3588
|
-
* Payment gateway's refund ID.
|
|
3589
|
-
* This field is only returned when the value of `external_refund` is `false`.
|
|
3590
|
-
* @format GUID
|
|
3591
|
-
*/
|
|
3592
|
-
gatewayRefundId?: string | null;
|
|
3593
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
3594
|
-
providerRefundId?: string | null;
|
|
3595
|
-
/**
|
|
3596
|
-
* Whether refund was made externally and manually on the payment provider's side.
|
|
3597
|
-
* @immutable
|
|
3598
|
-
*/
|
|
3599
|
-
externalRefund?: boolean;
|
|
3600
|
-
}
|
|
3601
|
-
/** Refund transaction status. */
|
|
3602
|
-
declare enum RefundStatus {
|
|
3603
|
-
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
3604
|
-
PENDING = "PENDING",
|
|
3605
|
-
/** Refund transaction succeeded. */
|
|
3606
|
-
SUCCEEDED = "SUCCEEDED",
|
|
3607
|
-
/** Refund transaction failed. */
|
|
3608
|
-
FAILED = "FAILED",
|
|
3609
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
3610
|
-
SCHEDULED = "SCHEDULED",
|
|
3611
|
-
/** Refund was initiated on payment provider side. */
|
|
3612
|
-
STARTED = "STARTED"
|
|
3613
|
-
}
|
|
3614
|
-
/** @enumType */
|
|
3615
|
-
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
3616
|
-
interface RefundStatusInfo {
|
|
3617
|
-
/**
|
|
3618
|
-
* Reason code for the refund's current status.
|
|
3619
|
-
*
|
|
3620
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
3621
|
-
* @minLength 1
|
|
3622
|
-
* @maxLength 10
|
|
3623
|
-
*/
|
|
3624
|
-
paymentGatewayReasonCode?: string | null;
|
|
3625
|
-
/**
|
|
3626
|
-
* Free text explanation of current refund status.
|
|
3627
|
-
* @minLength 1
|
|
3628
|
-
* @maxLength 1000
|
|
3629
|
-
*/
|
|
3630
|
-
description?: string | null;
|
|
3631
|
-
}
|
|
3632
|
-
interface AggregatedRefundSummary {
|
|
3633
|
-
/** Total amount requested for refund. */
|
|
3634
|
-
requestedRefund?: Price;
|
|
3635
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
3636
|
-
pendingRefund?: Price;
|
|
3637
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
3638
|
-
refunded?: Price;
|
|
3639
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
3640
|
-
failedRefundAmount?: Price;
|
|
3641
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
3642
|
-
pending?: boolean;
|
|
3643
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
3644
|
-
breakdown?: RefundItemsBreakdown;
|
|
3645
|
-
}
|
|
3646
|
-
interface RefundItemsBreakdown {
|
|
3647
|
-
/**
|
|
3648
|
-
* Refunded line items and the amount refunded for each.
|
|
3649
|
-
* @maxSize 300
|
|
3650
|
-
*/
|
|
3651
|
-
lineItems?: LineItemRefundSummary[];
|
|
3652
|
-
}
|
|
3653
|
-
interface LineItemRefundSummary {
|
|
3654
|
-
/**
|
|
3655
|
-
* ID of the refunded line item.
|
|
3656
|
-
* @format GUID
|
|
3657
|
-
*/
|
|
3658
|
-
lineItemId?: string;
|
|
3659
|
-
/** Total refunded amount for the line item. */
|
|
3660
|
-
totalRefundedAmount?: Price;
|
|
3661
|
-
}
|
|
3662
|
-
interface CalculateRefundRequest {
|
|
3663
|
-
/**
|
|
3664
|
-
* Order ID
|
|
3665
|
-
* @minLength 1
|
|
3666
|
-
* @maxLength 100
|
|
3667
|
-
*/
|
|
3668
|
-
ecomOrderId?: string;
|
|
3669
|
-
/**
|
|
3670
|
-
* Refunded line items and quantity
|
|
3671
|
-
* @maxSize 300
|
|
3672
|
-
*/
|
|
3673
|
-
refundItems?: CalculateRefundItemRequest[];
|
|
3674
|
-
/** Should include shipping in refund calculation */
|
|
3675
|
-
refundShipping?: boolean;
|
|
3676
|
-
}
|
|
3677
|
-
interface CalculateRefundItemRequest {
|
|
3678
|
-
/**
|
|
3679
|
-
* ID of the line item being refunded
|
|
3680
|
-
* @format GUID
|
|
3681
|
-
*/
|
|
3682
|
-
_id?: string;
|
|
3683
|
-
/**
|
|
3684
|
-
* How much of that line item is being refunded
|
|
3685
|
-
* @min 1
|
|
3686
|
-
* @max 100000
|
|
3687
|
-
*/
|
|
3688
|
-
quantity?: number;
|
|
3689
|
-
}
|
|
3690
|
-
interface CalculateRefundResponse {
|
|
3691
|
-
/** Total refundable amount */
|
|
3692
|
-
total?: Price;
|
|
3693
|
-
/** Tax cost of the order */
|
|
3694
|
-
tax?: Price;
|
|
3695
|
-
/** Discount given for this order */
|
|
3696
|
-
discount?: Price;
|
|
3697
|
-
/** Total cost of the order (without tax) */
|
|
3698
|
-
subtotal?: Price;
|
|
3699
|
-
/** Total shipping cost for order */
|
|
3700
|
-
shipping?: Price;
|
|
3701
|
-
/** Previous refund given on that order */
|
|
3702
|
-
previouslyRefundedAmount?: Price;
|
|
3703
|
-
/**
|
|
3704
|
-
* The refundable items of that order
|
|
3705
|
-
* @maxSize 300
|
|
3706
|
-
*/
|
|
3707
|
-
items?: CalculateRefundItemResponse[];
|
|
3708
|
-
}
|
|
3709
|
-
interface CalculateRefundItemResponse {
|
|
3710
|
-
/**
|
|
3711
|
-
* Line item ID
|
|
3712
|
-
* @format GUID
|
|
3713
|
-
*/
|
|
3714
|
-
_id?: string;
|
|
3715
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
3716
|
-
price?: Price;
|
|
3717
|
-
}
|
|
3718
|
-
interface VoidAuthorizedPaymentsRequest {
|
|
3719
|
-
/**
|
|
3720
|
-
* Wix eCommerce order ID
|
|
3721
|
-
* @minLength 1
|
|
3722
|
-
* @maxLength 100
|
|
3723
|
-
*/
|
|
3724
|
-
ecomOrderId: string;
|
|
3725
|
-
/**
|
|
3726
|
-
* Payment IDs
|
|
3727
|
-
* @minSize 1
|
|
3728
|
-
* @maxSize 100
|
|
3729
|
-
* @format GUID
|
|
3730
|
-
*/
|
|
3731
|
-
paymentIds: string[];
|
|
3732
|
-
}
|
|
3733
|
-
interface VoidAuthorizedPaymentsResponse {
|
|
3734
|
-
/** All order's transactions after the void was triggered */
|
|
3735
|
-
orderTransactions?: OrderTransactions;
|
|
3736
|
-
}
|
|
3737
|
-
interface CaptureAuthorizedPaymentsRequest {
|
|
3738
|
-
/**
|
|
3739
|
-
* Wix eCommerce order ID
|
|
3740
|
-
* @minLength 1
|
|
3741
|
-
* @maxLength 100
|
|
3742
|
-
*/
|
|
3743
|
-
ecomOrderId: string;
|
|
3744
|
-
/**
|
|
3745
|
-
* Capture payments information
|
|
3746
|
-
* @minSize 1
|
|
3747
|
-
* @maxSize 100
|
|
3748
|
-
*/
|
|
3749
|
-
payments: PaymentCapture[];
|
|
3750
|
-
}
|
|
3751
|
-
interface PaymentCapture {
|
|
3752
|
-
/**
|
|
3753
|
-
* Payment ID
|
|
3754
|
-
* @format GUID
|
|
3755
|
-
*/
|
|
3756
|
-
paymentId?: string | null;
|
|
3757
|
-
/**
|
|
3758
|
-
* Capture amount.
|
|
3759
|
-
* If not provided - full authorized amount will be captured.
|
|
3760
|
-
*/
|
|
3761
|
-
amount?: Price;
|
|
3762
|
-
}
|
|
3763
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
3764
|
-
/** All order's transactions after the capture was triggered */
|
|
3765
|
-
orderTransactions?: OrderTransactions;
|
|
3766
|
-
}
|
|
3767
|
-
interface ChargeSavedPaymentMethodRequest {
|
|
3768
|
-
/**
|
|
3769
|
-
* Ecom Order ID.
|
|
3770
|
-
* @minLength 1
|
|
3771
|
-
* @maxLength 100
|
|
3772
|
-
*/
|
|
3773
|
-
ecomOrderId?: string;
|
|
3774
|
-
/** Amount to be charged */
|
|
3775
|
-
amount?: Price;
|
|
3776
|
-
}
|
|
3777
|
-
interface ChargeSavedPaymentMethodResponse {
|
|
3778
|
-
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
3779
|
-
paymentGatewayOrderId?: string;
|
|
3780
|
-
}
|
|
3781
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3782
|
-
createdEvent?: EntityCreatedEvent;
|
|
3783
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3784
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3785
|
-
actionEvent?: ActionEvent;
|
|
3786
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3787
|
-
_id?: string;
|
|
3788
|
-
/**
|
|
3789
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3790
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3791
|
-
*/
|
|
3792
|
-
entityFqdn?: string;
|
|
3793
|
-
/**
|
|
3794
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3795
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3796
|
-
*/
|
|
3797
|
-
slug?: string;
|
|
3798
|
-
/** ID of the entity associated with the event. */
|
|
3799
|
-
entityId?: string;
|
|
3800
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3801
|
-
eventTime?: Date | null;
|
|
3802
|
-
/**
|
|
3803
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
3804
|
-
* (for example, GDPR).
|
|
3805
|
-
*/
|
|
3806
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3807
|
-
/** If present, indicates the action that triggered the event. */
|
|
3808
|
-
originatedFrom?: string | null;
|
|
3809
|
-
/**
|
|
3810
|
-
* 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.
|
|
3811
|
-
* 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.
|
|
3812
|
-
*/
|
|
3813
|
-
entityEventSequence?: string | null;
|
|
3814
|
-
}
|
|
3815
|
-
/** @oneof */
|
|
3816
|
-
interface DomainEventBodyOneOf {
|
|
3817
|
-
createdEvent?: EntityCreatedEvent;
|
|
3818
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3819
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3820
|
-
actionEvent?: ActionEvent;
|
|
3821
|
-
}
|
|
3822
|
-
interface EntityCreatedEvent {
|
|
3823
|
-
entity?: string;
|
|
3824
|
-
}
|
|
3825
|
-
interface RestoreInfo {
|
|
3826
|
-
deletedDate?: Date | null;
|
|
3827
|
-
}
|
|
3828
|
-
interface EntityUpdatedEvent {
|
|
3829
|
-
/**
|
|
3830
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3831
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3832
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3833
|
-
*/
|
|
3834
|
-
currentEntity?: string;
|
|
3835
|
-
}
|
|
3836
|
-
interface EntityDeletedEvent {
|
|
3837
|
-
/** Entity that was deleted. */
|
|
3838
|
-
deletedEntity?: string | null;
|
|
3839
|
-
}
|
|
3840
|
-
interface ActionEvent {
|
|
3841
|
-
body?: string;
|
|
3842
|
-
}
|
|
3843
|
-
interface Empty {
|
|
3844
|
-
}
|
|
3845
|
-
interface MessageEnvelope {
|
|
3846
|
-
/**
|
|
3847
|
-
* App instance ID.
|
|
3848
|
-
* @format GUID
|
|
3849
|
-
*/
|
|
3850
|
-
instanceId?: string | null;
|
|
3851
|
-
/**
|
|
3852
|
-
* Event type.
|
|
3853
|
-
* @maxLength 150
|
|
3854
|
-
*/
|
|
3855
|
-
eventType?: string;
|
|
3856
|
-
/** The identification type and identity data. */
|
|
3857
|
-
identity?: IdentificationData;
|
|
3858
|
-
/** Stringify payload. */
|
|
3859
|
-
data?: string;
|
|
3860
|
-
}
|
|
3861
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3862
|
-
/**
|
|
3863
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3864
|
-
* @format GUID
|
|
3865
|
-
*/
|
|
3866
|
-
anonymousVisitorId?: string;
|
|
3867
|
-
/**
|
|
3868
|
-
* ID of a site visitor that has logged in to the site.
|
|
3869
|
-
* @format GUID
|
|
3870
|
-
*/
|
|
3871
|
-
memberId?: string;
|
|
3872
|
-
/**
|
|
3873
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3874
|
-
* @format GUID
|
|
3875
|
-
*/
|
|
3876
|
-
wixUserId?: string;
|
|
3877
|
-
/**
|
|
3878
|
-
* ID of an app.
|
|
3879
|
-
* @format GUID
|
|
3880
|
-
*/
|
|
3881
|
-
appId?: string;
|
|
3882
|
-
/** @readonly */
|
|
3883
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3884
|
-
}
|
|
3885
|
-
/** @oneof */
|
|
3886
|
-
interface IdentificationDataIdOneOf {
|
|
3887
|
-
/**
|
|
3888
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3889
|
-
* @format GUID
|
|
3890
|
-
*/
|
|
3891
|
-
anonymousVisitorId?: string;
|
|
3892
|
-
/**
|
|
3893
|
-
* ID of a site visitor that has logged in to the site.
|
|
3894
|
-
* @format GUID
|
|
3895
|
-
*/
|
|
3896
|
-
memberId?: string;
|
|
3897
|
-
/**
|
|
3898
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3899
|
-
* @format GUID
|
|
3900
|
-
*/
|
|
3901
|
-
wixUserId?: string;
|
|
3902
|
-
/**
|
|
3903
|
-
* ID of an app.
|
|
3904
|
-
* @format GUID
|
|
3905
|
-
*/
|
|
3906
|
-
appId?: string;
|
|
3907
|
-
}
|
|
3908
|
-
declare enum WebhookIdentityType {
|
|
3909
|
-
UNKNOWN = "UNKNOWN",
|
|
3910
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3911
|
-
MEMBER = "MEMBER",
|
|
3912
|
-
WIX_USER = "WIX_USER",
|
|
3913
|
-
APP = "APP"
|
|
3914
|
-
}
|
|
3915
|
-
/** @enumType */
|
|
3916
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3917
|
-
declare enum TextDetection {
|
|
3918
|
-
/** No detection was made */
|
|
3919
|
-
UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
|
|
3920
|
-
/** The image contains text */
|
|
3921
|
-
CONTAINS_TEXT = "CONTAINS_TEXT",
|
|
3922
|
-
/** The image does not contain text */
|
|
3923
|
-
NO_TEXT = "NO_TEXT"
|
|
3924
|
-
}
|
|
3925
|
-
/** @enumType */
|
|
3926
|
-
type TextDetectionWithLiterals = TextDetection | 'UNKNOWN_TEXT_DETECTION' | 'CONTAINS_TEXT' | 'NO_TEXT';
|
|
3927
|
-
declare enum AnimationDetection {
|
|
3928
|
-
/** No detection was made */
|
|
3929
|
-
UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
|
|
3930
|
-
/** The image contains animation */
|
|
3931
|
-
CONTAINS_ANIMATION = "CONTAINS_ANIMATION",
|
|
3932
|
-
/** The image does not contain animation */
|
|
3933
|
-
NO_ANIMATION = "NO_ANIMATION"
|
|
3934
|
-
}
|
|
3935
|
-
/** @enumType */
|
|
3936
|
-
type AnimationDetectionWithLiterals = AnimationDetection | 'UNKNOWN_ANIMATION_DETECTION' | 'CONTAINS_ANIMATION' | 'NO_ANIMATION';
|
|
3937
|
-
interface ImageContent {
|
|
3938
|
-
/** Text detection */
|
|
3939
|
-
text?: TextDetectionWithLiterals;
|
|
3940
|
-
/** Animation detection */
|
|
3941
|
-
animation?: AnimationDetectionWithLiterals;
|
|
3942
|
-
}
|
|
3943
|
-
interface SendBuyerConfirmationEmailRequest {
|
|
3944
|
-
/** @format GUID */
|
|
3945
|
-
orderId?: string;
|
|
3946
|
-
}
|
|
3947
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
3948
|
-
}
|
|
3949
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3950
|
-
/**
|
|
3951
|
-
* @minLength 1
|
|
3952
|
-
* @maxLength 100
|
|
3953
|
-
*/
|
|
3954
|
-
orderId?: string;
|
|
3955
|
-
}
|
|
3956
|
-
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
3957
|
-
}
|
|
3958
|
-
interface SendBuyerPickupConfirmationEmailRequest {
|
|
3959
|
-
/**
|
|
3960
|
-
* @minLength 1
|
|
3961
|
-
* @maxLength 100
|
|
3962
|
-
*/
|
|
3963
|
-
orderId?: string;
|
|
3964
|
-
}
|
|
3965
|
-
interface SendBuyerPickupConfirmationEmailResponse {
|
|
3966
|
-
}
|
|
3967
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3968
|
-
/**
|
|
3969
|
-
* IDs of orders to send pickup emails for.
|
|
3970
|
-
* @minSize 1
|
|
3971
|
-
* @maxSize 300
|
|
3972
|
-
*/
|
|
3973
|
-
orderIds?: string[];
|
|
3974
|
-
}
|
|
3975
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3976
|
-
}
|
|
3977
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
3978
|
-
/**
|
|
3979
|
-
* @minLength 1
|
|
3980
|
-
* @maxLength 100
|
|
3981
|
-
*/
|
|
3982
|
-
orderId?: string;
|
|
3983
|
-
}
|
|
3984
|
-
interface SendBuyerShippingConfirmationEmailResponse {
|
|
3985
|
-
}
|
|
3986
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3987
|
-
/**
|
|
3988
|
-
* IDs of orders to send pickup emails for.
|
|
3989
|
-
* @minSize 1
|
|
3990
|
-
* @maxSize 300
|
|
3991
|
-
*/
|
|
3992
|
-
orderIds?: string[];
|
|
3993
|
-
}
|
|
3994
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3995
|
-
}
|
|
3996
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
3997
|
-
/**
|
|
3998
|
-
* @minLength 1
|
|
3999
|
-
* @maxLength 100
|
|
4000
|
-
*/
|
|
4001
|
-
orderId?: string;
|
|
4002
|
-
}
|
|
4003
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
4004
|
-
}
|
|
4005
|
-
interface SendCancelRefundEmailRequest {
|
|
4006
|
-
/**
|
|
4007
|
-
* The ID of order that is canceled/refunded
|
|
4008
|
-
* @minLength 1
|
|
4009
|
-
* @maxLength 100
|
|
4010
|
-
*/
|
|
4011
|
-
orderId?: string;
|
|
4012
|
-
/**
|
|
4013
|
-
* Personal note added to the email (optional)
|
|
4014
|
-
* @minLength 1
|
|
4015
|
-
* @maxLength 1000
|
|
4016
|
-
*/
|
|
4017
|
-
customMessage?: string | null;
|
|
4018
|
-
/** Refund amount */
|
|
4019
|
-
refundAmount?: Price;
|
|
4020
|
-
/**
|
|
4021
|
-
* Refund ID. (Optional)
|
|
4022
|
-
* @format GUID
|
|
4023
|
-
*/
|
|
4024
|
-
refundId?: string | null;
|
|
4025
|
-
}
|
|
4026
|
-
interface SendCancelRefundEmailResponse {
|
|
4027
|
-
}
|
|
4028
|
-
interface SendRefundEmailRequest {
|
|
4029
|
-
/**
|
|
4030
|
-
* The ID of order that is refunded
|
|
4031
|
-
* @format GUID
|
|
4032
|
-
*/
|
|
4033
|
-
orderId?: string;
|
|
4034
|
-
/**
|
|
4035
|
-
* Refund ID
|
|
4036
|
-
* @format GUID
|
|
4037
|
-
*/
|
|
4038
|
-
refundId?: string;
|
|
4039
|
-
/**
|
|
4040
|
-
* Personal note added to the email (optional)
|
|
4041
|
-
* @minLength 1
|
|
4042
|
-
* @maxLength 1000
|
|
4043
|
-
*/
|
|
4044
|
-
customMessage?: string | null;
|
|
4045
|
-
}
|
|
4046
|
-
interface SendRefundEmailResponse {
|
|
4047
|
-
}
|
|
4048
|
-
interface SendMerchantOrderReceivedPushRequest {
|
|
4049
|
-
/**
|
|
4050
|
-
* @minLength 1
|
|
4051
|
-
* @maxLength 100
|
|
4052
|
-
*/
|
|
4053
|
-
orderId?: string;
|
|
4054
|
-
}
|
|
4055
|
-
interface SendMerchantOrderReceivedPushResponse {
|
|
4056
|
-
}
|
|
4057
|
-
interface PreviewEmailByTypeRequest {
|
|
4058
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
4059
|
-
}
|
|
4060
|
-
declare enum PreviewEmailType {
|
|
4061
|
-
ORDER_PLACED = "ORDER_PLACED",
|
|
4062
|
-
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
4063
|
-
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
4064
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
4065
|
-
}
|
|
4066
|
-
/** @enumType */
|
|
4067
|
-
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
4068
|
-
interface PreviewEmailByTypeResponse {
|
|
4069
|
-
emailPreview?: string;
|
|
4070
|
-
}
|
|
4071
|
-
interface PreviewRefundEmailRequest {
|
|
4072
|
-
/**
|
|
4073
|
-
* @minLength 1
|
|
4074
|
-
* @maxLength 100
|
|
4075
|
-
*/
|
|
4076
|
-
orderId?: string;
|
|
4077
|
-
/** Refund amount */
|
|
4078
|
-
refundAmount?: Price;
|
|
4079
|
-
/** Refund business details */
|
|
4080
|
-
details?: RefundDetails;
|
|
4081
|
-
/**
|
|
4082
|
-
* Personal note added to the email (optional)
|
|
4083
|
-
* @minLength 1
|
|
4084
|
-
* @maxLength 1000
|
|
4085
|
-
*/
|
|
4086
|
-
customMessage?: string | null;
|
|
4087
|
-
/**
|
|
4088
|
-
* Refund ID. (Optional)
|
|
4089
|
-
* @format GUID
|
|
4090
|
-
*/
|
|
4091
|
-
refundId?: string | null;
|
|
4092
|
-
}
|
|
4093
|
-
interface PreviewRefundEmailResponse {
|
|
4094
|
-
emailPreview?: string;
|
|
4095
|
-
}
|
|
4096
|
-
interface PreviewCancelEmailRequest {
|
|
4097
|
-
/**
|
|
4098
|
-
* @minLength 1
|
|
4099
|
-
* @maxLength 100
|
|
4100
|
-
*/
|
|
4101
|
-
orderId?: string;
|
|
4102
|
-
/**
|
|
4103
|
-
* Personal note added to the email (optional)
|
|
4104
|
-
* @minLength 1
|
|
4105
|
-
* @maxLength 1000
|
|
4106
|
-
*/
|
|
4107
|
-
customMessage?: string | null;
|
|
4108
|
-
}
|
|
4109
|
-
interface PreviewCancelEmailResponse {
|
|
4110
|
-
emailPreview?: string;
|
|
4111
|
-
}
|
|
4112
|
-
interface PreviewCancelRefundEmailRequest {
|
|
4113
|
-
/**
|
|
4114
|
-
* @minLength 1
|
|
4115
|
-
* @maxLength 100
|
|
4116
|
-
*/
|
|
4117
|
-
orderId?: string;
|
|
4118
|
-
/**
|
|
4119
|
-
* Personal note added to the email (optional)
|
|
4120
|
-
* @minLength 1
|
|
4121
|
-
* @maxLength 1000
|
|
4122
|
-
*/
|
|
4123
|
-
customMessage?: string | null;
|
|
4124
|
-
/** Refund amount */
|
|
4125
|
-
refundAmount?: Price;
|
|
4126
|
-
/**
|
|
4127
|
-
* Refund ID. (Optional)
|
|
4128
|
-
* @format GUID
|
|
4129
|
-
*/
|
|
4130
|
-
refundId?: string | null;
|
|
4131
|
-
}
|
|
4132
|
-
interface PreviewCancelRefundEmailResponse {
|
|
4133
|
-
emailPreview?: string;
|
|
4134
|
-
}
|
|
4135
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
4136
|
-
}
|
|
4137
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
4138
|
-
emailPreview?: string;
|
|
4139
|
-
}
|
|
4140
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
4141
|
-
}
|
|
4142
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
4143
|
-
emailPreview?: string;
|
|
4144
|
-
}
|
|
4145
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
4146
|
-
}
|
|
4147
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
4148
|
-
emailPreview?: string;
|
|
4149
|
-
}
|
|
4150
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
4151
|
-
}
|
|
4152
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
4153
|
-
emailPreview?: string;
|
|
4154
|
-
}
|
|
4155
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
4156
|
-
}
|
|
4157
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
4158
|
-
emailPreview?: string;
|
|
4159
|
-
}
|
|
4160
|
-
interface TriggerReindexOrderRequest {
|
|
4161
|
-
/** @format GUID */
|
|
4162
|
-
metasiteId?: string;
|
|
4163
|
-
/**
|
|
4164
|
-
* @minLength 1
|
|
4165
|
-
* @maxLength 100
|
|
4166
|
-
*/
|
|
4167
|
-
orderId?: string;
|
|
4168
|
-
}
|
|
4169
|
-
interface SnapshotMessage {
|
|
4170
|
-
_id?: string;
|
|
4171
|
-
opType?: number;
|
|
4172
|
-
}
|
|
4173
|
-
/** Triggered when the payment status of an order is updated */
|
|
4174
|
-
interface PaymentStatusUpdated {
|
|
4175
|
-
/** The order that was updated */
|
|
4176
|
-
order?: Order;
|
|
4177
|
-
/** The previous status (before the update) */
|
|
4178
|
-
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
4179
|
-
}
|
|
4180
|
-
interface GetMetasiteDataRequest {
|
|
4181
|
-
/**
|
|
4182
|
-
* meta site Id for data to retrieve
|
|
4183
|
-
* @format GUID
|
|
4184
|
-
*/
|
|
4185
|
-
metasiteId?: string;
|
|
4186
|
-
}
|
|
4187
|
-
interface GetMetasiteDataResponse {
|
|
4188
|
-
/** meta site data */
|
|
4189
|
-
metasite?: MetaSite;
|
|
4190
|
-
/** is metasite added to new SDL population via population manager */
|
|
4191
|
-
isInNewPopulation?: boolean;
|
|
4192
|
-
/** metasite url */
|
|
4193
|
-
metasiteUrl?: string;
|
|
4194
|
-
/** owner data */
|
|
4195
|
-
userDataResponse?: UserDataResponse;
|
|
4196
|
-
}
|
|
4197
|
-
/**
|
|
4198
|
-
* Represents Meta Site.
|
|
4199
|
-
*
|
|
4200
|
-
* Meta Site is a legacy concept, it aggregates data from several domains. Generally, it contains and manages
|
|
4201
|
-
* relations between different entities related to the site (or, as a new concept, to the container).
|
|
4202
|
-
*
|
|
4203
|
-
* We prefer to pronounce it as 2 separate words, therefore we use terms "meta site" or "metaSite" or "meta_site" in code.
|
|
4204
|
-
*/
|
|
4205
|
-
interface MetaSite {
|
|
4206
|
-
/**
|
|
4207
|
-
* Identifier of meta site.
|
|
4208
|
-
* @format GUID
|
|
4209
|
-
* @readonly
|
|
4210
|
-
*/
|
|
4211
|
-
metaSiteId?: string;
|
|
4212
|
-
/**
|
|
4213
|
-
* Internal version of meta site. Monotonically increasing number.
|
|
4214
|
-
*
|
|
4215
|
-
* If passed within update request, it will be used for optimistic locking. In this case,
|
|
4216
|
-
* StaleStateException will be thrown if current version doesn't match.
|
|
4217
|
-
*
|
|
4218
|
-
* In old MetaSiteDTO -- revision.
|
|
4219
|
-
* @readonly
|
|
4220
|
-
*/
|
|
4221
|
-
version?: string;
|
|
4222
|
-
/**
|
|
4223
|
-
* Identifier of account that owns this meta site.
|
|
4224
|
-
* @readonly
|
|
4225
|
-
*/
|
|
4226
|
-
ownerId?: string;
|
|
4227
|
-
/**
|
|
4228
|
-
* Date and time when meta site was created.
|
|
4229
|
-
* @readonly
|
|
4230
|
-
*/
|
|
4231
|
-
dateCreated?: Date | null;
|
|
4232
|
-
/**
|
|
4233
|
-
* Date and time when meta site was updated for the last time.
|
|
4234
|
-
* @readonly
|
|
4235
|
-
*/
|
|
4236
|
-
dateUpdated?: Date | null;
|
|
4237
|
-
/**
|
|
4238
|
-
* All "applications" of this meta site.
|
|
4239
|
-
*
|
|
4240
|
-
* In old MetaSiteDTO -- embeddedServices.
|
|
4241
|
-
*/
|
|
4242
|
-
apps?: App[];
|
|
4243
|
-
/** Namespace of meta site. */
|
|
4244
|
-
namespace?: NamespaceWithLiterals;
|
|
4245
|
-
/**
|
|
4246
|
-
* Indicates whether https should be used for viewing a site.
|
|
4247
|
-
*
|
|
4248
|
-
* In old MetaSiteDTO -- flags.UseHttps.
|
|
4249
|
-
*/
|
|
4250
|
-
useHttps?: boolean;
|
|
4251
|
-
defaultSeoData?: SeoData;
|
|
4252
|
-
/**
|
|
4253
|
-
* Information about HTML application.
|
|
4254
|
-
*
|
|
4255
|
-
* In old MetaSiteDTO -- appplications.find(_.applicationType == HtmlWeb).
|
|
4256
|
-
*/
|
|
4257
|
-
htmlApp?: HtmlApplication;
|
|
4258
|
-
/**
|
|
4259
|
-
* @maxSize 10000
|
|
4260
|
-
* @deprecated
|
|
4261
|
-
*/
|
|
4262
|
-
externalUriMappings?: ExternalUriMapping[];
|
|
4263
|
-
/** Indicates whether meta site was published. If true - site should be accessible for viewing. */
|
|
4264
|
-
published?: boolean;
|
|
4265
|
-
/**
|
|
4266
|
-
* The name of meta site.
|
|
4267
|
-
*
|
|
4268
|
-
* Matches this regular expression: [a-z0-9_\-]{4,20} (but for some legacy sites might be shorted/longer).
|
|
4269
|
-
*/
|
|
4270
|
-
name?: string;
|
|
4271
|
-
/**
|
|
4272
|
-
* Indicates whether this site is managed by ADI editor
|
|
4273
|
-
*
|
|
4274
|
-
* Values:
|
|
4275
|
-
* None - not managed.
|
|
4276
|
-
* Some(false) - site was created via ADI editor, but later on user switched to regular editor.
|
|
4277
|
-
* Some(true) - site was created and still is managed by ADI editor.
|
|
4278
|
-
*
|
|
4279
|
-
* In old MetaSiteDTO: embeddedService[embeddedServiceType=Onboarding].attributes.isInUse.
|
|
4280
|
-
*/
|
|
4281
|
-
adi?: boolean | null;
|
|
4282
|
-
/**
|
|
4283
|
-
* Indicates whether this meta site is template.
|
|
4284
|
-
*
|
|
4285
|
-
* In old MetaSiteDTO: documentType == Template.
|
|
4286
|
-
* @readonly
|
|
4287
|
-
*/
|
|
4288
|
-
template?: boolean | null;
|
|
4289
|
-
/**
|
|
4290
|
-
* Identifier of a template (meta site) from which this site was created.
|
|
4291
|
-
*
|
|
4292
|
-
* If it's empty it either means that site wasn't created from a template OR it's very old, so we didn't store
|
|
4293
|
-
* it back then.
|
|
4294
|
-
*
|
|
4295
|
-
* For example, if "site" was created from "template", then "template"'s id will be in origin_template_id.
|
|
4296
|
-
* When "site" is cloned, clone will also have "template"'s id in origin_instance_id.
|
|
4297
|
-
* @format GUID
|
|
4298
|
-
* @readonly
|
|
4299
|
-
*/
|
|
4300
|
-
originTemplateId?: string | null;
|
|
4301
|
-
/**
|
|
4302
|
-
* Indicates meta site blocked from publishing and added additional filtering in listing API (MSS). READ_ONLY.
|
|
4303
|
-
* @readonly
|
|
4304
|
-
*/
|
|
4305
|
-
blocked?: boolean;
|
|
4306
|
-
/**
|
|
4307
|
-
* If true - default meta site routing (connected domains, free url, ML) is not used for this meta site.
|
|
4308
|
-
*
|
|
4309
|
-
* Meaning, that if `example.org` is connected to this meta site, `router-server` will return 404 for `example.org`
|
|
4310
|
-
* anyway.
|
|
4311
|
-
*
|
|
4312
|
-
* This flag is set for some sites that have custom mapping in Routes API / wix-pages-bo.
|
|
4313
|
-
*/
|
|
4314
|
-
dontUseDefaultRouting?: boolean;
|
|
4315
|
-
/**
|
|
4316
|
-
* Indicates the site is used as critical asset and as such is protected. You would be only able to provision applications to this meta site. READ_ONLY.
|
|
4317
|
-
* @readonly
|
|
4318
|
-
*/
|
|
4319
|
-
criticalAsset?: boolean;
|
|
4320
|
-
/**
|
|
4321
|
-
* Date and time when the account that owns this meta site was created.
|
|
4322
|
-
* @readonly
|
|
4323
|
-
*/
|
|
4324
|
-
accountCreatedDate?: Date | null;
|
|
4325
|
-
}
|
|
4326
|
-
interface App {
|
|
4327
|
-
/**
|
|
4328
|
-
* Identifier of application type (application definition id).
|
|
4329
|
-
*
|
|
4330
|
-
* Can be both UUID and non-UUID, for example: SiteMembers, Onboarding, CloudSiteExtension etc.
|
|
4331
|
-
* @maxLength 36
|
|
4332
|
-
*/
|
|
4333
|
-
appDefId?: string;
|
|
4334
|
-
/**
|
|
4335
|
-
* Identifier of the instance (concrete application, installed on a site).
|
|
4336
|
-
*
|
|
4337
|
-
* Mostly UUID, but for some specific legacy cases might be something else.
|
|
4338
|
-
* @maxLength 36
|
|
4339
|
-
*/
|
|
4340
|
-
instanceId?: string;
|
|
4341
|
-
/**
|
|
4342
|
-
* State of this app (see docs for state).
|
|
4343
|
-
* @readonly
|
|
4344
|
-
*/
|
|
4345
|
-
state?: StateWithLiterals;
|
|
4346
|
-
/**
|
|
4347
|
-
* Identifier of the originating application. For example, if this app was part of a template,
|
|
4348
|
-
* then an app will get instance_id of that app as origin instance id.
|
|
4349
|
-
*
|
|
4350
|
-
* If application was provisioned not from some template, it should be empty.
|
|
4351
|
-
*
|
|
4352
|
-
* Note, it could be == to instance_id (for old sites).
|
|
4353
|
-
* @maxLength 36
|
|
4354
|
-
*/
|
|
4355
|
-
originInstanceId?: string;
|
|
4356
|
-
}
|
|
4357
|
-
/**
|
|
4358
|
-
* Represents the actual state of the application on site. Do not confuse with the State in the old MetaSiteDTO,
|
|
4359
|
-
* which has less values and doesn't have 1-to-1 correspondence with this one (this one is exact and correct!)
|
|
4360
|
-
*/
|
|
4361
|
-
declare enum State {
|
|
4362
|
-
UNKNOWN = "UNKNOWN",
|
|
4363
|
-
/** App is installed on a site. */
|
|
4364
|
-
ENABLED = "ENABLED",
|
|
4365
|
-
/** App is removed from a site (but we preserve it just in case). */
|
|
4366
|
-
DISABLED = "DISABLED",
|
|
4367
|
-
/** App is in "demo" mode, meaning that it's in read-only mode (it's in a template OR not installed yet). */
|
|
4368
|
-
TEMPLATE = "TEMPLATE",
|
|
4369
|
-
/** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
|
|
4370
|
-
PENDING = "PENDING"
|
|
4371
|
-
}
|
|
4372
|
-
/** @enumType */
|
|
4373
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'TEMPLATE' | 'PENDING';
|
|
4374
|
-
declare enum Namespace {
|
|
4375
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4376
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4377
|
-
WIX = "WIX",
|
|
4378
|
-
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4379
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
4380
|
-
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4381
|
-
ALBUMS = "ALBUMS",
|
|
4382
|
-
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4383
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4384
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4385
|
-
HOTELS = "HOTELS",
|
|
4386
|
-
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4387
|
-
CLUBS = "CLUBS",
|
|
4388
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4389
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4390
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4391
|
-
DEV_SITE = "DEV_SITE",
|
|
4392
|
-
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4393
|
-
LOGOS = "LOGOS",
|
|
4394
|
-
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4395
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4396
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4397
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4398
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4399
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4400
|
-
/**
|
|
4401
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
4402
|
-
*
|
|
4403
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
4404
|
-
*/
|
|
4405
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
4406
|
-
/**
|
|
4407
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
4408
|
-
* Will be accessible from Site List and will not have a website app.
|
|
4409
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4410
|
-
*/
|
|
4411
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
4412
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
4413
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
4414
|
-
/** It is to be used in the Business First efforts. */
|
|
4415
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4416
|
-
/** Bookings business flow with no site. */
|
|
4417
|
-
ANYWHERE = "ANYWHERE",
|
|
4418
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
4419
|
-
HEADLESS = "HEADLESS",
|
|
4420
|
-
/**
|
|
4421
|
-
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
4422
|
-
* The site will be used for account level CSM feature for enterprise
|
|
4423
|
-
*/
|
|
4424
|
-
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
4425
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
4426
|
-
RISE = "RISE",
|
|
4427
|
-
/**
|
|
4428
|
-
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
4429
|
-
* There's a blank site behind the scene but it's blank).
|
|
4430
|
-
* The Mobile company will be the owner of this namespace.
|
|
4431
|
-
*/
|
|
4432
|
-
BRANDED_FIRST = "BRANDED_FIRST",
|
|
4433
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
4434
|
-
NOWNIA = "NOWNIA",
|
|
4435
|
-
/**
|
|
4436
|
-
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
4437
|
-
* The Partners company owns this namespace.
|
|
4438
|
-
*/
|
|
4439
|
-
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
4440
|
-
/** Codux Headless Sites */
|
|
4441
|
-
CODUX = "CODUX",
|
|
4442
|
-
/** Bobb - AI Design Creator. */
|
|
4443
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4444
|
-
/**
|
|
4445
|
-
* Shared Blog Site is a unique single site across Enterprise account,
|
|
4446
|
-
* This site will hold all Blog posts related to the Marketing product.
|
|
4447
|
-
*/
|
|
4448
|
-
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
4449
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4450
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
4451
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4452
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
4453
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4454
|
-
MIMIR = "MIMIR"
|
|
4455
|
-
}
|
|
4456
|
-
/** @enumType */
|
|
4457
|
-
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
4458
|
-
interface SeoData {
|
|
4459
|
-
/**
|
|
4460
|
-
* A title.
|
|
4461
|
-
* @maxLength 255
|
|
4462
|
-
*/
|
|
4463
|
-
title?: string | null;
|
|
4464
|
-
/** Indicates whether the site should be indexable by bots. */
|
|
4465
|
-
indexable?: boolean;
|
|
4466
|
-
/** TDB. */
|
|
4467
|
-
suppressTrackingCookies?: boolean;
|
|
4468
|
-
/**
|
|
4469
|
-
* TDB.
|
|
4470
|
-
* @maxLength 300
|
|
4471
|
-
*/
|
|
4472
|
-
ogImage?: string | null;
|
|
4473
|
-
/**
|
|
4474
|
-
* A list of meta tags.
|
|
4475
|
-
* @maxSize 100
|
|
4476
|
-
*/
|
|
4477
|
-
metaTags?: MetaTag[];
|
|
4478
|
-
/**
|
|
4479
|
-
* A canonical URL for a site.
|
|
4480
|
-
* @maxLength 4000
|
|
4481
|
-
*/
|
|
4482
|
-
canonicalUrl?: string | null;
|
|
4483
|
-
}
|
|
4484
|
-
interface MetaTag {
|
|
4485
|
-
/**
|
|
4486
|
-
* A name.
|
|
4487
|
-
* @maxLength 50
|
|
4488
|
-
*/
|
|
4489
|
-
name?: string;
|
|
4490
|
-
/**
|
|
4491
|
-
* A value.
|
|
4492
|
-
* @maxLength 500
|
|
4493
|
-
*/
|
|
4494
|
-
value?: string;
|
|
4495
|
-
/** Indicates whether should be rendered as property. */
|
|
4496
|
-
property?: boolean;
|
|
4497
|
-
}
|
|
4498
|
-
/** Represents an HTML application (HTML site). */
|
|
4499
|
-
interface HtmlApplication {
|
|
4500
|
-
/** Legacy, don't use it if you can. */
|
|
4501
|
-
intId?: number;
|
|
4502
|
-
/** Identifier of the instance. */
|
|
4503
|
-
instanceId?: string;
|
|
4504
|
-
seoData?: SeoData;
|
|
4505
|
-
/** Language of this site. */
|
|
4506
|
-
languageCode?: string;
|
|
4507
|
-
/** File name for thumbnail. */
|
|
4508
|
-
thumbnail?: string | null;
|
|
4509
|
-
/** Indicates whether this site is managed by EditorX. */
|
|
4510
|
-
editorX?: boolean;
|
|
4511
|
-
/** Indicates whether this site is managed by Wix Studio. */
|
|
4512
|
-
studio?: boolean;
|
|
4513
|
-
/** Indicates that site is managed by Odeditor */
|
|
4514
|
-
odeditor?: boolean;
|
|
4515
|
-
/** Indicates that site is managed by Picasso */
|
|
4516
|
-
picasso?: boolean;
|
|
4517
|
-
}
|
|
4518
|
-
interface ExternalUriMapping {
|
|
4519
|
-
/**
|
|
4520
|
-
* Deprecated.
|
|
4521
|
-
* @maxLength 255
|
|
4522
|
-
*/
|
|
4523
|
-
fromExternalUri?: string;
|
|
4524
|
-
/**
|
|
4525
|
-
* Deprecated.
|
|
4526
|
-
* @maxLength 255
|
|
4527
|
-
*/
|
|
4528
|
-
toWixUri?: string;
|
|
4529
|
-
/**
|
|
4530
|
-
* Deprecated.
|
|
4531
|
-
* @maxLength 255
|
|
4532
|
-
*/
|
|
4533
|
-
oldToWixUri?: string | null;
|
|
4534
|
-
/** Deprecated. */
|
|
4535
|
-
requireDomain?: boolean | null;
|
|
4536
|
-
}
|
|
4537
|
-
interface UserDataResponse {
|
|
4538
|
-
userEmail?: string;
|
|
4539
|
-
/** owner name */
|
|
4540
|
-
userName?: string;
|
|
4541
|
-
/** owner status */
|
|
4542
|
-
userStatus?: string;
|
|
4543
|
-
/** owner language */
|
|
4544
|
-
userLanguage?: string;
|
|
4545
|
-
}
|
|
4546
|
-
interface QueryOrdersForMetasiteRequest {
|
|
4547
|
-
/**
|
|
4548
|
-
* meta site Id for EP orders to retrieve
|
|
4549
|
-
* @format GUID
|
|
4550
|
-
*/
|
|
4551
|
-
metasiteId?: string;
|
|
4552
|
-
/** paginated internal orders query request */
|
|
4553
|
-
internalQueryOrdersRequest?: InternalQueryOrdersRequest;
|
|
4554
|
-
}
|
|
4555
|
-
interface InternalQueryOrdersRequest {
|
|
4556
|
-
/** Query options. */
|
|
4557
|
-
query?: PlatformQuery;
|
|
4558
|
-
}
|
|
4559
|
-
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
4560
|
-
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4561
|
-
paging?: PlatformPaging;
|
|
4562
|
-
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
4563
|
-
cursorPaging?: CursorPaging;
|
|
4564
|
-
/** Filter object. */
|
|
4565
|
-
filter?: Record<string, any> | null;
|
|
4566
|
-
/** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
|
|
4567
|
-
sort?: Sorting[];
|
|
4568
|
-
}
|
|
4569
|
-
/** @oneof */
|
|
4570
|
-
interface PlatformQueryPagingMethodOneOf {
|
|
4571
|
-
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4572
|
-
paging?: PlatformPaging;
|
|
4573
|
-
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
4574
|
-
cursorPaging?: CursorPaging;
|
|
4575
|
-
}
|
|
4576
|
-
interface Sorting {
|
|
4577
|
-
/**
|
|
4578
|
-
* Name of the field to sort by.
|
|
4579
|
-
* @maxLength 512
|
|
4580
|
-
*/
|
|
4581
|
-
fieldName?: string;
|
|
4582
|
-
/** Sort order. */
|
|
4583
|
-
order?: SortOrderWithLiterals;
|
|
4584
|
-
}
|
|
4585
|
-
declare enum SortOrder {
|
|
4586
|
-
ASC = "ASC",
|
|
4587
|
-
DESC = "DESC"
|
|
4588
|
-
}
|
|
4589
|
-
/** @enumType */
|
|
4590
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
4591
|
-
interface PlatformPaging {
|
|
4592
|
-
/**
|
|
4593
|
-
* Number of items to load.
|
|
4594
|
-
* @max 100
|
|
4595
|
-
*/
|
|
4596
|
-
limit?: number | null;
|
|
4597
|
-
/** Number of items to skip in the current sort order. */
|
|
4598
|
-
offset?: number | null;
|
|
4599
|
-
}
|
|
4600
|
-
interface CursorPaging {
|
|
4601
|
-
/**
|
|
4602
|
-
* Maximum number of items to return in the results.
|
|
4603
|
-
* @max 100
|
|
4604
|
-
*/
|
|
4605
|
-
limit?: number | null;
|
|
4606
|
-
/**
|
|
4607
|
-
* Pointer to the next or previous page in the list of results.
|
|
4608
|
-
*
|
|
4609
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
4610
|
-
* Not relevant for the first request.
|
|
4611
|
-
* @maxLength 16000
|
|
4612
|
-
*/
|
|
4613
|
-
cursor?: string | null;
|
|
4614
|
-
}
|
|
4615
|
-
interface QueryOrdersForMetasiteResponse {
|
|
4616
|
-
/** found exisitng orders according to pagination and query provided. */
|
|
4617
|
-
orders?: Order[];
|
|
4618
|
-
/** Details on the paged set of results returned. */
|
|
4619
|
-
pagingMetadata?: PlatformPagingMetadata;
|
|
4620
|
-
}
|
|
4621
|
-
interface PlatformPagingMetadata {
|
|
4622
|
-
/** The number of items returned in this response. */
|
|
4623
|
-
count?: number | null;
|
|
4624
|
-
/** The offset which was requested. Returned if offset paging was used. */
|
|
4625
|
-
offset?: number | null;
|
|
4626
|
-
/** The total number of items that match the query. Returned if offset paging was used. */
|
|
4627
|
-
total?: number | null;
|
|
4628
|
-
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
4629
|
-
cursors?: Cursors;
|
|
4630
|
-
}
|
|
4631
|
-
interface Cursors {
|
|
4632
|
-
/**
|
|
4633
|
-
* Cursor string pointing to the next page in the list of results.
|
|
4634
|
-
* @maxLength 16000
|
|
4635
|
-
*/
|
|
4636
|
-
next?: string | null;
|
|
4637
|
-
/**
|
|
4638
|
-
* Cursor pointing to the previous page in the list of results.
|
|
4639
|
-
* @maxLength 16000
|
|
2509
|
+
* Cursor pointing to the previous page in the list of results.
|
|
2510
|
+
* @maxLength 16000
|
|
4640
2511
|
*/
|
|
4641
2512
|
prev?: string | null;
|
|
4642
2513
|
}
|
|
4643
|
-
interface GetOrderForMetasiteRequest {
|
|
4644
|
-
/**
|
|
4645
|
-
* meta site Id for EP order to retrieve
|
|
4646
|
-
* @format GUID
|
|
4647
|
-
*/
|
|
4648
|
-
metasiteId?: string;
|
|
4649
|
-
/**
|
|
4650
|
-
* Order Id for EP order to retrieve
|
|
4651
|
-
* @minLength 1
|
|
4652
|
-
* @maxLength 100
|
|
4653
|
-
*/
|
|
4654
|
-
orderId?: string;
|
|
4655
|
-
}
|
|
4656
|
-
interface GetOrderForMetasiteResponse {
|
|
4657
|
-
/** Existing EP order */
|
|
4658
|
-
order?: Order;
|
|
4659
|
-
}
|
|
4660
|
-
interface ListOrderTransactionsForMetasiteRequest {
|
|
4661
|
-
/**
|
|
4662
|
-
* meta site Id for EP order transactions to retrieve
|
|
4663
|
-
* @format GUID
|
|
4664
|
-
*/
|
|
4665
|
-
metasiteId?: string;
|
|
4666
|
-
/**
|
|
4667
|
-
* Order Id for EP order transactions to retrieve
|
|
4668
|
-
* @format GUID
|
|
4669
|
-
*/
|
|
4670
|
-
orderId?: string;
|
|
4671
|
-
}
|
|
4672
|
-
interface ListOrderTransactionsForMetasiteResponse {
|
|
4673
|
-
/** Order ID and its associated transactions. */
|
|
4674
|
-
orderTransactions?: OrderTransactions;
|
|
4675
|
-
}
|
|
4676
|
-
interface UpsertRefundRequest {
|
|
4677
|
-
/**
|
|
4678
|
-
* Meta site ID.
|
|
4679
|
-
* @format GUID
|
|
4680
|
-
*/
|
|
4681
|
-
metasiteId?: string;
|
|
4682
|
-
/**
|
|
4683
|
-
* Order ID associated with refund.
|
|
4684
|
-
* @format GUID
|
|
4685
|
-
*/
|
|
4686
|
-
orderId?: string;
|
|
4687
|
-
/** Refund to upsert. */
|
|
4688
|
-
refund?: Refund;
|
|
4689
|
-
}
|
|
4690
|
-
interface UpsertRefundResponse {
|
|
4691
|
-
/** Updated order transactions. */
|
|
4692
|
-
orderTransactions?: OrderTransactions;
|
|
4693
|
-
}
|
|
4694
|
-
interface GetOrderOutOfBoxRequest {
|
|
4695
|
-
/**
|
|
4696
|
-
* Order Id for EP order to retrieve
|
|
4697
|
-
* @minLength 1
|
|
4698
|
-
* @maxLength 100
|
|
4699
|
-
*/
|
|
4700
|
-
_id?: string;
|
|
4701
|
-
}
|
|
4702
|
-
interface GetOrderOutOfBoxResponse {
|
|
4703
|
-
/**
|
|
4704
|
-
* Order id if found
|
|
4705
|
-
* @minLength 1
|
|
4706
|
-
* @maxLength 100
|
|
4707
|
-
*/
|
|
4708
|
-
orderId?: string;
|
|
4709
|
-
}
|
|
4710
|
-
interface GetOrderAgcRequest {
|
|
4711
|
-
/**
|
|
4712
|
-
* Order Id for EP order to retrieve
|
|
4713
|
-
* @minLength 1
|
|
4714
|
-
* @maxLength 100
|
|
4715
|
-
*/
|
|
4716
|
-
_id?: string;
|
|
4717
|
-
}
|
|
4718
|
-
interface GetOrderAgcResponse {
|
|
4719
|
-
/**
|
|
4720
|
-
* Order id if found
|
|
4721
|
-
* @minLength 1
|
|
4722
|
-
* @maxLength 100
|
|
4723
|
-
*/
|
|
4724
|
-
orderId?: string;
|
|
4725
|
-
}
|
|
4726
|
-
interface GetOrderWithFilterByLocationRequest {
|
|
4727
|
-
/**
|
|
4728
|
-
* Order Id for EP order to retrieve
|
|
4729
|
-
* @minLength 1
|
|
4730
|
-
* @maxLength 100
|
|
4731
|
-
*/
|
|
4732
|
-
_id?: string;
|
|
4733
|
-
}
|
|
4734
|
-
interface GetOrderWithFilterByLocationResponse {
|
|
4735
|
-
/**
|
|
4736
|
-
* Order id if found
|
|
4737
|
-
* @minLength 1
|
|
4738
|
-
* @maxLength 100
|
|
4739
|
-
*/
|
|
4740
|
-
orderId?: string;
|
|
4741
|
-
}
|
|
4742
|
-
interface V1UpdateOrderRequest {
|
|
4743
|
-
/** Order to be updated. */
|
|
4744
|
-
order?: Order;
|
|
4745
|
-
}
|
|
4746
|
-
interface V1UpdateOrderResponse {
|
|
4747
|
-
/** Updated order. */
|
|
4748
|
-
order?: Order;
|
|
4749
|
-
}
|
|
4750
|
-
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
4751
|
-
/** insert/update documents */
|
|
4752
|
-
update?: InternalDocumentUpdateOperation;
|
|
4753
|
-
/** delete by document ids */
|
|
4754
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
4755
|
-
/** delete documents matching filter */
|
|
4756
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
4757
|
-
/** update internal documents matching filter */
|
|
4758
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
4759
|
-
/** update only existing documents */
|
|
4760
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
4761
|
-
/** insert/update documents with versioning */
|
|
4762
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
4763
|
-
/** delete by document ids with versioning */
|
|
4764
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
4765
|
-
/**
|
|
4766
|
-
* type of the documents
|
|
4767
|
-
* @minLength 2
|
|
4768
|
-
*/
|
|
4769
|
-
documentType?: string;
|
|
4770
|
-
/**
|
|
4771
|
-
* language of the documents (mandatory)
|
|
4772
|
-
* @minLength 2
|
|
4773
|
-
*/
|
|
4774
|
-
language?: string | null;
|
|
4775
|
-
/**
|
|
4776
|
-
* one or more search documents
|
|
4777
|
-
* @deprecated
|
|
4778
|
-
*/
|
|
4779
|
-
addDocuments?: InternalDocument[];
|
|
4780
|
-
/**
|
|
4781
|
-
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
4782
|
-
* @deprecated
|
|
4783
|
-
*/
|
|
4784
|
-
removeDocumentIds?: string[];
|
|
4785
|
-
/** id to pass to processing notification */
|
|
4786
|
-
correlationId?: string | null;
|
|
4787
|
-
/** when event was created / issued */
|
|
4788
|
-
issuedAt?: Date | null;
|
|
4789
|
-
}
|
|
4790
|
-
/** @oneof */
|
|
4791
|
-
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
4792
|
-
/** insert/update documents */
|
|
4793
|
-
update?: InternalDocumentUpdateOperation;
|
|
4794
|
-
/** delete by document ids */
|
|
4795
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
4796
|
-
/** delete documents matching filter */
|
|
4797
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
4798
|
-
/** update internal documents matching filter */
|
|
4799
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
4800
|
-
/** update only existing documents */
|
|
4801
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
4802
|
-
/** insert/update documents with versioning */
|
|
4803
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
4804
|
-
/** delete by document ids with versioning */
|
|
4805
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
4806
|
-
}
|
|
4807
|
-
interface InternalDocument {
|
|
4808
|
-
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
4809
|
-
document?: Record<string, any> | null;
|
|
4810
|
-
}
|
|
4811
|
-
interface InternalDocumentUpdateOperation {
|
|
4812
|
-
/** documents to index or update */
|
|
4813
|
-
documents?: InternalDocument[];
|
|
4814
|
-
}
|
|
4815
|
-
interface DeleteByIdsOperation {
|
|
4816
|
-
/** ids of the documents to delete */
|
|
4817
|
-
documentIds?: string[];
|
|
4818
|
-
/**
|
|
4819
|
-
* tenant id for custom tenancy strategy
|
|
4820
|
-
* @minLength 2
|
|
4821
|
-
* @maxLength 300
|
|
4822
|
-
*/
|
|
4823
|
-
tenantId?: string | null;
|
|
4824
|
-
}
|
|
4825
|
-
interface DeleteByFilterOperation {
|
|
4826
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
4827
|
-
filter?: Record<string, any> | null;
|
|
4828
|
-
/**
|
|
4829
|
-
* tenant id for custom tenancy strategy
|
|
4830
|
-
* @minLength 2
|
|
4831
|
-
* @maxLength 300
|
|
4832
|
-
*/
|
|
4833
|
-
tenantId?: string | null;
|
|
4834
|
-
}
|
|
4835
|
-
interface InternalDocumentUpdateByFilterOperation {
|
|
4836
|
-
/** documents matching this filter will be updated */
|
|
4837
|
-
filter?: Record<string, any> | null;
|
|
4838
|
-
/** partial document to apply */
|
|
4839
|
-
document?: InternalDocument;
|
|
4840
|
-
/**
|
|
4841
|
-
* tenant id for custom tenancy strategy
|
|
4842
|
-
* @minLength 2
|
|
4843
|
-
* @maxLength 300
|
|
4844
|
-
*/
|
|
4845
|
-
tenantId?: string | null;
|
|
4846
|
-
}
|
|
4847
|
-
interface InternalUpdateExistingOperation {
|
|
4848
|
-
/** documents to update */
|
|
4849
|
-
documents?: InternalDocument[];
|
|
4850
|
-
}
|
|
4851
|
-
interface VersionedDocumentUpdateOperation {
|
|
4852
|
-
/** documents to create or overwrite */
|
|
4853
|
-
documents?: InternalDocument[];
|
|
4854
|
-
/** versioning mode to use instead of default */
|
|
4855
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
4856
|
-
}
|
|
4857
|
-
declare enum VersioningMode {
|
|
4858
|
-
/** use default versioning mode agreed with search team */
|
|
4859
|
-
DEFAULT = "DEFAULT",
|
|
4860
|
-
/** execute only if version is greater than existing */
|
|
4861
|
-
GREATER_THAN = "GREATER_THAN",
|
|
4862
|
-
/** execute only if version is greater or equal to existing */
|
|
4863
|
-
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
4864
|
-
}
|
|
4865
|
-
/** @enumType */
|
|
4866
|
-
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
4867
|
-
interface VersionedDeleteByIdsOperation {
|
|
4868
|
-
/** ids with version of the documents to delete */
|
|
4869
|
-
documentIds?: VersionedDocumentId[];
|
|
4870
|
-
/**
|
|
4871
|
-
* tenant id for custom tenancy strategy
|
|
4872
|
-
* @minLength 2
|
|
4873
|
-
* @maxLength 300
|
|
4874
|
-
*/
|
|
4875
|
-
tenantId?: string | null;
|
|
4876
|
-
}
|
|
4877
|
-
interface VersionedDocumentId {
|
|
4878
|
-
/** document id */
|
|
4879
|
-
documentId?: string;
|
|
4880
|
-
/** document version */
|
|
4881
|
-
version?: string;
|
|
4882
|
-
/** versioning mode to use instead of default */
|
|
4883
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
4884
|
-
}
|
|
4885
|
-
interface TriggerReindexRequest {
|
|
4886
|
-
/** @format GUID */
|
|
4887
|
-
metasiteId?: string;
|
|
4888
|
-
/**
|
|
4889
|
-
* @minLength 1
|
|
4890
|
-
* @maxLength 100
|
|
4891
|
-
* @maxSize 100
|
|
4892
|
-
*/
|
|
4893
|
-
orderIds?: string[];
|
|
4894
|
-
}
|
|
4895
|
-
interface TriggerReindexResponse {
|
|
4896
|
-
}
|
|
4897
|
-
interface BatchOfTriggerReindexOrderRequest {
|
|
4898
|
-
/** @maxSize 25 */
|
|
4899
|
-
requests?: TriggerReindexOrderRequest[];
|
|
4900
|
-
}
|
|
4901
|
-
interface DiffmatokyPayload {
|
|
4902
|
-
left?: string;
|
|
4903
|
-
right?: string;
|
|
4904
|
-
compareChannel?: string;
|
|
4905
|
-
entityId?: string;
|
|
4906
|
-
errorInformation?: ErrorInformation;
|
|
4907
|
-
tags?: string[];
|
|
4908
|
-
}
|
|
4909
|
-
interface ErrorInformation {
|
|
4910
|
-
stackTrace?: string;
|
|
4911
|
-
}
|
|
4912
|
-
interface ContinueSideEffectsFlowInLegacyData {
|
|
4913
|
-
storeId?: string;
|
|
4914
|
-
orderId?: string;
|
|
4915
|
-
ordersExperiments?: OrdersExperiments;
|
|
4916
|
-
}
|
|
4917
|
-
interface IndexingMessage {
|
|
4918
|
-
_id?: string;
|
|
4919
|
-
opType?: number;
|
|
4920
|
-
requiredVersions?: string[];
|
|
4921
|
-
}
|
|
4922
|
-
interface GetOrderRequest {
|
|
4923
|
-
/**
|
|
4924
|
-
* ID of the order to retrieve.
|
|
4925
|
-
* @minLength 1
|
|
4926
|
-
* @maxLength 100
|
|
4927
|
-
*/
|
|
4928
|
-
_id: string;
|
|
4929
|
-
}
|
|
4930
|
-
interface GetOrderResponse {
|
|
4931
|
-
/** The requested order. */
|
|
4932
|
-
order?: Order;
|
|
4933
|
-
}
|
|
4934
|
-
interface InternalQueryOrdersResponse {
|
|
4935
|
-
/** List of orders. */
|
|
4936
|
-
orders?: Order[];
|
|
4937
|
-
/** Details on the paged set of results returned. */
|
|
4938
|
-
metadata?: PlatformPagingMetadata;
|
|
4939
|
-
}
|
|
4940
2514
|
interface QueryOrderRequest {
|
|
4941
2515
|
/** Query options. */
|
|
4942
2516
|
query?: PlatformQuery;
|
|
@@ -5079,6 +2653,42 @@ interface BulkUpdateOrdersResponse {
|
|
|
5079
2653
|
/** Bulk action metadata. */
|
|
5080
2654
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5081
2655
|
}
|
|
2656
|
+
interface BulkOrderResult {
|
|
2657
|
+
/** Item metadata. */
|
|
2658
|
+
itemMetadata?: ItemMetadata;
|
|
2659
|
+
/**
|
|
2660
|
+
* Updated order.
|
|
2661
|
+
*
|
|
2662
|
+
* Returned when `returnFullEntity = true`.
|
|
2663
|
+
*/
|
|
2664
|
+
item?: Order;
|
|
2665
|
+
}
|
|
2666
|
+
interface ItemMetadata {
|
|
2667
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2668
|
+
_id?: string | null;
|
|
2669
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2670
|
+
originalIndex?: number;
|
|
2671
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2672
|
+
success?: boolean;
|
|
2673
|
+
/** Details about the error in case of failure. */
|
|
2674
|
+
error?: ApplicationError;
|
|
2675
|
+
}
|
|
2676
|
+
interface ApplicationError {
|
|
2677
|
+
/** Error code. */
|
|
2678
|
+
code?: string;
|
|
2679
|
+
/** Description of the error. */
|
|
2680
|
+
description?: string;
|
|
2681
|
+
/** Data related to the error. */
|
|
2682
|
+
data?: Record<string, any> | null;
|
|
2683
|
+
}
|
|
2684
|
+
interface BulkActionMetadata {
|
|
2685
|
+
/** Number of items that were successfully processed. */
|
|
2686
|
+
totalSuccesses?: number;
|
|
2687
|
+
/** Number of items that couldn't be processed. */
|
|
2688
|
+
totalFailures?: number;
|
|
2689
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2690
|
+
undetailedFailures?: number;
|
|
2691
|
+
}
|
|
5082
2692
|
interface CommitDeltasRequest {
|
|
5083
2693
|
/** Order id to be updated */
|
|
5084
2694
|
_id: string;
|
|
@@ -5103,36 +2713,6 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
|
|
|
5103
2713
|
changedShippingInfo?: V1ShippingInformation;
|
|
5104
2714
|
/** Remove existing shipping info. */
|
|
5105
2715
|
shippingInfoRemoved?: boolean;
|
|
5106
|
-
/**
|
|
5107
|
-
* Buyer info and selected buyer option details.
|
|
5108
|
-
* @internal
|
|
5109
|
-
*/
|
|
5110
|
-
changedBuyerInfo?: BuyerInfo;
|
|
5111
|
-
/**
|
|
5112
|
-
* Remove existing buyer info.
|
|
5113
|
-
* @internal
|
|
5114
|
-
*/
|
|
5115
|
-
buyerInfoRemoved?: boolean;
|
|
5116
|
-
/**
|
|
5117
|
-
* Updated billing info.
|
|
5118
|
-
* @internal
|
|
5119
|
-
*/
|
|
5120
|
-
changedBillingInfo?: AddressWithContact;
|
|
5121
|
-
/**
|
|
5122
|
-
* Remove existing billing info.
|
|
5123
|
-
* @internal
|
|
5124
|
-
*/
|
|
5125
|
-
billingInfoRemoved?: boolean;
|
|
5126
|
-
/**
|
|
5127
|
-
* Updated recipient info.
|
|
5128
|
-
* @internal
|
|
5129
|
-
*/
|
|
5130
|
-
changedRecipientInfo?: AddressWithContact;
|
|
5131
|
-
/**
|
|
5132
|
-
* Remove existing recipient info.
|
|
5133
|
-
* @internal
|
|
5134
|
-
*/
|
|
5135
|
-
recipientInfoRemoved?: boolean;
|
|
5136
2716
|
/**
|
|
5137
2717
|
* Added/updated/removed order line items.
|
|
5138
2718
|
* @maxSize 300
|
|
@@ -5174,42 +2754,12 @@ interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
|
5174
2754
|
}
|
|
5175
2755
|
/** @oneof */
|
|
5176
2756
|
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
5177
|
-
/**
|
|
5178
|
-
* Buyer info and selected buyer option details.
|
|
5179
|
-
* @internal
|
|
5180
|
-
*/
|
|
5181
|
-
changedBuyerInfo?: BuyerInfo;
|
|
5182
|
-
/**
|
|
5183
|
-
* Remove existing buyer info.
|
|
5184
|
-
* @internal
|
|
5185
|
-
*/
|
|
5186
|
-
buyerInfoRemoved?: boolean;
|
|
5187
2757
|
}
|
|
5188
2758
|
/** @oneof */
|
|
5189
2759
|
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
5190
|
-
/**
|
|
5191
|
-
* Updated billing info.
|
|
5192
|
-
* @internal
|
|
5193
|
-
*/
|
|
5194
|
-
changedBillingInfo?: AddressWithContact;
|
|
5195
|
-
/**
|
|
5196
|
-
* Remove existing billing info.
|
|
5197
|
-
* @internal
|
|
5198
|
-
*/
|
|
5199
|
-
billingInfoRemoved?: boolean;
|
|
5200
2760
|
}
|
|
5201
2761
|
/** @oneof */
|
|
5202
2762
|
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
5203
|
-
/**
|
|
5204
|
-
* Updated recipient info.
|
|
5205
|
-
* @internal
|
|
5206
|
-
*/
|
|
5207
|
-
changedRecipientInfo?: AddressWithContact;
|
|
5208
|
-
/**
|
|
5209
|
-
* Remove existing recipient info.
|
|
5210
|
-
* @internal
|
|
5211
|
-
*/
|
|
5212
|
-
recipientInfoRemoved?: boolean;
|
|
5213
2763
|
}
|
|
5214
2764
|
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
5215
2765
|
/** The line item was added. */
|
|
@@ -5309,21 +2859,8 @@ interface OrderLineItemChangedDetails {
|
|
|
5309
2859
|
* @maxSize 5
|
|
5310
2860
|
*/
|
|
5311
2861
|
locations?: LocationAndQuantity[];
|
|
5312
|
-
/**
|
|
5313
|
-
* ID of the app managing the inventory.
|
|
5314
|
-
* @internal
|
|
5315
|
-
* @format GUID
|
|
5316
|
-
*/
|
|
5317
|
-
inventoryAppId?: string | null;
|
|
5318
2862
|
/** Subscription info. */
|
|
5319
2863
|
subscriptionInfo?: SubscriptionInfo;
|
|
5320
|
-
/**
|
|
5321
|
-
* Modifier groups that were added to the item.
|
|
5322
|
-
* @internal
|
|
5323
|
-
* @readonly
|
|
5324
|
-
* @maxSize 10
|
|
5325
|
-
*/
|
|
5326
|
-
modifierGroups?: ModifierGroup[];
|
|
5327
2864
|
}
|
|
5328
2865
|
/** Type of selected payment option for catalog item */
|
|
5329
2866
|
declare enum DeltaPaymentOptionType {
|
|
@@ -5710,35 +3247,6 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5710
3247
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5711
3248
|
/** Payment method is saved for order */
|
|
5712
3249
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5713
|
-
/**
|
|
5714
|
-
* Details of an initiated refund process.
|
|
5715
|
-
*
|
|
5716
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5717
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5718
|
-
* @internal
|
|
5719
|
-
*/
|
|
5720
|
-
refundInitiated?: RefundInitiated;
|
|
5721
|
-
/**
|
|
5722
|
-
* Details of a refunded payment.
|
|
5723
|
-
*
|
|
5724
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5725
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5726
|
-
* @internal
|
|
5727
|
-
*/
|
|
5728
|
-
paymentRefunded?: PaymentRefunded;
|
|
5729
|
-
/**
|
|
5730
|
-
* Details of a failed payment refund.
|
|
5731
|
-
*
|
|
5732
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5733
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5734
|
-
* @internal
|
|
5735
|
-
*/
|
|
5736
|
-
paymentRefundFailed?: PaymentRefundFailed;
|
|
5737
|
-
/**
|
|
5738
|
-
* Details of refund to store credit.
|
|
5739
|
-
* @internal
|
|
5740
|
-
*/
|
|
5741
|
-
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5742
3250
|
/** Details of a pending payment */
|
|
5743
3251
|
paymentPending?: PaymentPending;
|
|
5744
3252
|
/** Details of a canceled payment */
|
|
@@ -5749,26 +3257,6 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5749
3257
|
orderPending?: OrderPending;
|
|
5750
3258
|
/** Order rejected */
|
|
5751
3259
|
orderRejected?: OrderRejected;
|
|
5752
|
-
/**
|
|
5753
|
-
* Receipt was added for associated payment
|
|
5754
|
-
* @internal
|
|
5755
|
-
*/
|
|
5756
|
-
receiptCreated?: ReceiptCreated;
|
|
5757
|
-
/**
|
|
5758
|
-
* Receipt sent to customer
|
|
5759
|
-
* @internal
|
|
5760
|
-
*/
|
|
5761
|
-
receiptSent?: ReceiptSent;
|
|
5762
|
-
/**
|
|
5763
|
-
* Chargeback created for one of the order's payments.
|
|
5764
|
-
* @internal
|
|
5765
|
-
*/
|
|
5766
|
-
chargebackCreated?: ChargebackCreated;
|
|
5767
|
-
/**
|
|
5768
|
-
* Chargeback reversed for one of the order's payments.
|
|
5769
|
-
* @internal
|
|
5770
|
-
*/
|
|
5771
|
-
chargebackReversed?: ChargebackReversed;
|
|
5772
3260
|
/**
|
|
5773
3261
|
* Internal activity ID.
|
|
5774
3262
|
* @format GUID
|
|
@@ -5833,35 +3321,6 @@ interface InternalActivityContentOneOf {
|
|
|
5833
3321
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5834
3322
|
/** Payment method is saved for order */
|
|
5835
3323
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5836
|
-
/**
|
|
5837
|
-
* Details of an initiated refund process.
|
|
5838
|
-
*
|
|
5839
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5840
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5841
|
-
* @internal
|
|
5842
|
-
*/
|
|
5843
|
-
refundInitiated?: RefundInitiated;
|
|
5844
|
-
/**
|
|
5845
|
-
* Details of a refunded payment.
|
|
5846
|
-
*
|
|
5847
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5848
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5849
|
-
* @internal
|
|
5850
|
-
*/
|
|
5851
|
-
paymentRefunded?: PaymentRefunded;
|
|
5852
|
-
/**
|
|
5853
|
-
* Details of a failed payment refund.
|
|
5854
|
-
*
|
|
5855
|
-
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5856
|
-
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5857
|
-
* @internal
|
|
5858
|
-
*/
|
|
5859
|
-
paymentRefundFailed?: PaymentRefundFailed;
|
|
5860
|
-
/**
|
|
5861
|
-
* Details of refund to store credit.
|
|
5862
|
-
* @internal
|
|
5863
|
-
*/
|
|
5864
|
-
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5865
3324
|
/** Details of a pending payment */
|
|
5866
3325
|
paymentPending?: PaymentPending;
|
|
5867
3326
|
/** Details of a canceled payment */
|
|
@@ -5872,26 +3331,6 @@ interface InternalActivityContentOneOf {
|
|
|
5872
3331
|
orderPending?: OrderPending;
|
|
5873
3332
|
/** Order rejected */
|
|
5874
3333
|
orderRejected?: OrderRejected;
|
|
5875
|
-
/**
|
|
5876
|
-
* Receipt was added for associated payment
|
|
5877
|
-
* @internal
|
|
5878
|
-
*/
|
|
5879
|
-
receiptCreated?: ReceiptCreated;
|
|
5880
|
-
/**
|
|
5881
|
-
* Receipt sent to customer
|
|
5882
|
-
* @internal
|
|
5883
|
-
*/
|
|
5884
|
-
receiptSent?: ReceiptSent;
|
|
5885
|
-
/**
|
|
5886
|
-
* Chargeback created for one of the order's payments.
|
|
5887
|
-
* @internal
|
|
5888
|
-
*/
|
|
5889
|
-
chargebackCreated?: ChargebackCreated;
|
|
5890
|
-
/**
|
|
5891
|
-
* Chargeback reversed for one of the order's payments.
|
|
5892
|
-
* @internal
|
|
5893
|
-
*/
|
|
5894
|
-
chargebackReversed?: ChargebackReversed;
|
|
5895
3334
|
}
|
|
5896
3335
|
/** Order placed */
|
|
5897
3336
|
interface OrderPlaced {
|
|
@@ -6252,7 +3691,7 @@ interface BulkSetBusinessLocationResponse {
|
|
|
6252
3691
|
interface BulkSetBusinessLocationResult {
|
|
6253
3692
|
itemMetadata?: ItemMetadata;
|
|
6254
3693
|
}
|
|
6255
|
-
interface
|
|
3694
|
+
interface MarkOrderAsPaidRequest {
|
|
6256
3695
|
/**
|
|
6257
3696
|
* Order ID.
|
|
6258
3697
|
* @minLength 1
|
|
@@ -6260,11 +3699,18 @@ interface V1MarkOrderAsPaidRequest {
|
|
|
6260
3699
|
*/
|
|
6261
3700
|
_id?: string;
|
|
6262
3701
|
}
|
|
6263
|
-
interface
|
|
3702
|
+
interface MarkOrderAsPaidResponse {
|
|
6264
3703
|
/** Updated order. */
|
|
6265
3704
|
order?: Order;
|
|
6266
3705
|
}
|
|
6267
|
-
|
|
3706
|
+
/** Triggered when the payment status of an order is updated */
|
|
3707
|
+
interface PaymentStatusUpdated {
|
|
3708
|
+
/** The order that was updated */
|
|
3709
|
+
order?: Order;
|
|
3710
|
+
/** The previous status (before the update) */
|
|
3711
|
+
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
3712
|
+
}
|
|
3713
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
6268
3714
|
/**
|
|
6269
3715
|
* IDs of orders to mark as paid.
|
|
6270
3716
|
* @minSize 1
|
|
@@ -6274,7 +3720,7 @@ interface V1BulkMarkOrdersAsPaidRequest {
|
|
|
6274
3720
|
*/
|
|
6275
3721
|
ids?: string[];
|
|
6276
3722
|
}
|
|
6277
|
-
interface
|
|
3723
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
6278
3724
|
/**
|
|
6279
3725
|
* Items updated by the bulk action.
|
|
6280
3726
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -6283,7 +3729,7 @@ interface V1BulkMarkOrdersAsPaidResponse {
|
|
|
6283
3729
|
/** Bulk action metadata. */
|
|
6284
3730
|
bulkActionMetadata?: BulkActionMetadata;
|
|
6285
3731
|
}
|
|
6286
|
-
interface
|
|
3732
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
6287
3733
|
/**
|
|
6288
3734
|
* eCom Order ID
|
|
6289
3735
|
* @minLength 1
|
|
@@ -6291,7 +3737,7 @@ interface V1CreatePaymentGatewayOrderRequest {
|
|
|
6291
3737
|
*/
|
|
6292
3738
|
ecomOrderId?: string;
|
|
6293
3739
|
}
|
|
6294
|
-
interface
|
|
3740
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
6295
3741
|
/** ID of the order created in the payment gateway */
|
|
6296
3742
|
paymentGatewayOrderId?: string;
|
|
6297
3743
|
}
|
|
@@ -6381,6 +3827,70 @@ interface BulkUpdateOrderTagsResponse {
|
|
|
6381
3827
|
interface BulkUpdateOrderTagsResult {
|
|
6382
3828
|
itemMetadata?: ItemMetadata;
|
|
6383
3829
|
}
|
|
3830
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3831
|
+
createdEvent?: EntityCreatedEvent;
|
|
3832
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3833
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3834
|
+
actionEvent?: ActionEvent;
|
|
3835
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3836
|
+
_id?: string;
|
|
3837
|
+
/**
|
|
3838
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3839
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3840
|
+
*/
|
|
3841
|
+
entityFqdn?: string;
|
|
3842
|
+
/**
|
|
3843
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3844
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3845
|
+
*/
|
|
3846
|
+
slug?: string;
|
|
3847
|
+
/** ID of the entity associated with the event. */
|
|
3848
|
+
entityId?: string;
|
|
3849
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3850
|
+
eventTime?: Date | null;
|
|
3851
|
+
/**
|
|
3852
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3853
|
+
* (for example, GDPR).
|
|
3854
|
+
*/
|
|
3855
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3856
|
+
/** If present, indicates the action that triggered the event. */
|
|
3857
|
+
originatedFrom?: string | null;
|
|
3858
|
+
/**
|
|
3859
|
+
* 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.
|
|
3860
|
+
* 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.
|
|
3861
|
+
*/
|
|
3862
|
+
entityEventSequence?: string | null;
|
|
3863
|
+
}
|
|
3864
|
+
/** @oneof */
|
|
3865
|
+
interface DomainEventBodyOneOf {
|
|
3866
|
+
createdEvent?: EntityCreatedEvent;
|
|
3867
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3868
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3869
|
+
actionEvent?: ActionEvent;
|
|
3870
|
+
}
|
|
3871
|
+
interface EntityCreatedEvent {
|
|
3872
|
+
entity?: string;
|
|
3873
|
+
}
|
|
3874
|
+
interface RestoreInfo {
|
|
3875
|
+
deletedDate?: Date | null;
|
|
3876
|
+
}
|
|
3877
|
+
interface EntityUpdatedEvent {
|
|
3878
|
+
/**
|
|
3879
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3880
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3881
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3882
|
+
*/
|
|
3883
|
+
currentEntity?: string;
|
|
3884
|
+
}
|
|
3885
|
+
interface EntityDeletedEvent {
|
|
3886
|
+
/** Entity that was deleted. */
|
|
3887
|
+
deletedEntity?: string | null;
|
|
3888
|
+
}
|
|
3889
|
+
interface ActionEvent {
|
|
3890
|
+
body?: string;
|
|
3891
|
+
}
|
|
3892
|
+
interface Empty {
|
|
3893
|
+
}
|
|
6384
3894
|
interface Task {
|
|
6385
3895
|
key?: TaskKey;
|
|
6386
3896
|
executeAt?: Date | null;
|
|
@@ -6699,9 +4209,9 @@ interface CalculatedTax {
|
|
|
6699
4209
|
code?: string | null;
|
|
6700
4210
|
}
|
|
6701
4211
|
interface Payments {
|
|
6702
|
-
payments?:
|
|
4212
|
+
payments?: Payment[];
|
|
6703
4213
|
}
|
|
6704
|
-
interface
|
|
4214
|
+
interface Payment {
|
|
6705
4215
|
/** document */
|
|
6706
4216
|
_id?: string;
|
|
6707
4217
|
type?: string;
|
|
@@ -6824,137 +4334,90 @@ declare enum InvoiceStatus {
|
|
|
6824
4334
|
Processing = "Processing",
|
|
6825
4335
|
Paid = "Paid",
|
|
6826
4336
|
Overdue = "Overdue",
|
|
6827
|
-
Void = "Void",
|
|
6828
|
-
Deleted = "Deleted",
|
|
6829
|
-
PartiallyPaid = "PartiallyPaid",
|
|
6830
|
-
PartialAndOverdue = "PartialAndOverdue"
|
|
6831
|
-
}
|
|
6832
|
-
/** @enumType */
|
|
6833
|
-
type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
|
|
6834
|
-
interface TriggerSideEffectsFromLegacyData {
|
|
6835
|
-
storeId?: string;
|
|
6836
|
-
orderId?: string;
|
|
6837
|
-
ordersExperiments?: OrdersExperiments;
|
|
6838
|
-
}
|
|
6839
|
-
|
|
6840
|
-
|
|
6841
|
-
|
|
6842
|
-
|
|
6843
|
-
|
|
6844
|
-
|
|
6845
|
-
|
|
6846
|
-
|
|
6847
|
-
|
|
6848
|
-
|
|
6849
|
-
|
|
6850
|
-
data
|
|
6851
|
-
|
|
6852
|
-
|
|
6853
|
-
|
|
6854
|
-
|
|
6855
|
-
|
|
6856
|
-
|
|
6857
|
-
|
|
6858
|
-
|
|
6859
|
-
|
|
6860
|
-
|
|
6861
|
-
|
|
6862
|
-
|
|
6863
|
-
|
|
6864
|
-
|
|
6865
|
-
|
|
6866
|
-
|
|
6867
|
-
|
|
6868
|
-
|
|
6869
|
-
|
|
6870
|
-
|
|
6871
|
-
|
|
6872
|
-
|
|
6873
|
-
|
|
6874
|
-
|
|
6875
|
-
|
|
6876
|
-
|
|
6877
|
-
|
|
6878
|
-
|
|
6879
|
-
|
|
6880
|
-
|
|
6881
|
-
|
|
6882
|
-
|
|
6883
|
-
|
|
6884
|
-
|
|
6885
|
-
|
|
6886
|
-
|
|
6887
|
-
|
|
6888
|
-
|
|
6889
|
-
|
|
6890
|
-
|
|
6891
|
-
|
|
6892
|
-
|
|
6893
|
-
|
|
6894
|
-
|
|
6895
|
-
|
|
6896
|
-
|
|
6897
|
-
|
|
6898
|
-
|
|
6899
|
-
|
|
6900
|
-
|
|
6901
|
-
|
|
6902
|
-
|
|
6903
|
-
|
|
6904
|
-
|
|
6905
|
-
|
|
6906
|
-
|
|
6907
|
-
|
|
6908
|
-
}
|
|
6909
|
-
|
|
6910
|
-
|
|
6911
|
-
data?: Record<string, any>;
|
|
6912
|
-
} | {
|
|
6913
|
-
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6914
|
-
description?: string;
|
|
6915
|
-
data?: Record<string, any>;
|
|
6916
|
-
} | {
|
|
6917
|
-
code?: 'PAYMENT_NOT_FOUND';
|
|
6918
|
-
description?: string;
|
|
6919
|
-
data?: Record<string, any>;
|
|
6920
|
-
} | {
|
|
6921
|
-
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6922
|
-
description?: string;
|
|
6923
|
-
data?: Record<string, any>;
|
|
6924
|
-
};
|
|
6925
|
-
type CaptureAuthorizedPaymentsApplicationErrors = {
|
|
6926
|
-
code?: 'INVALID_AMOUNT';
|
|
6927
|
-
description?: string;
|
|
6928
|
-
data?: Record<string, any>;
|
|
6929
|
-
} | {
|
|
6930
|
-
code?: 'NOT_REGULAR_ONLINE_PAYMENT';
|
|
6931
|
-
description?: string;
|
|
6932
|
-
data?: Record<string, any>;
|
|
6933
|
-
} | {
|
|
6934
|
-
code?: 'PAYMENT_ALREADY_VOIDED';
|
|
6935
|
-
description?: string;
|
|
6936
|
-
data?: Record<string, any>;
|
|
6937
|
-
} | {
|
|
6938
|
-
code?: 'PAYMENT_ALREADY_CAPTURED';
|
|
6939
|
-
description?: string;
|
|
6940
|
-
data?: Record<string, any>;
|
|
6941
|
-
} | {
|
|
6942
|
-
code?: 'PAYMENT_NOT_AUTHORIZED';
|
|
6943
|
-
description?: string;
|
|
6944
|
-
data?: Record<string, any>;
|
|
6945
|
-
} | {
|
|
6946
|
-
code?: 'PAYMENT_NOT_FOUND';
|
|
6947
|
-
description?: string;
|
|
6948
|
-
data?: Record<string, any>;
|
|
6949
|
-
} | {
|
|
6950
|
-
code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
|
|
6951
|
-
description?: string;
|
|
6952
|
-
data?: Record<string, any>;
|
|
6953
|
-
} | {
|
|
6954
|
-
code?: 'PAYMENT_HAS_PENDING_CAPTURE';
|
|
6955
|
-
description?: string;
|
|
6956
|
-
data?: Record<string, any>;
|
|
6957
|
-
};
|
|
4337
|
+
Void = "Void",
|
|
4338
|
+
Deleted = "Deleted",
|
|
4339
|
+
PartiallyPaid = "PartiallyPaid",
|
|
4340
|
+
PartialAndOverdue = "PartialAndOverdue"
|
|
4341
|
+
}
|
|
4342
|
+
/** @enumType */
|
|
4343
|
+
type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
|
|
4344
|
+
interface TriggerSideEffectsFromLegacyData {
|
|
4345
|
+
storeId?: string;
|
|
4346
|
+
orderId?: string;
|
|
4347
|
+
ordersExperiments?: OrdersExperiments;
|
|
4348
|
+
}
|
|
4349
|
+
interface MessageEnvelope {
|
|
4350
|
+
/**
|
|
4351
|
+
* App instance ID.
|
|
4352
|
+
* @format GUID
|
|
4353
|
+
*/
|
|
4354
|
+
instanceId?: string | null;
|
|
4355
|
+
/**
|
|
4356
|
+
* Event type.
|
|
4357
|
+
* @maxLength 150
|
|
4358
|
+
*/
|
|
4359
|
+
eventType?: string;
|
|
4360
|
+
/** The identification type and identity data. */
|
|
4361
|
+
identity?: IdentificationData;
|
|
4362
|
+
/** Stringify payload. */
|
|
4363
|
+
data?: string;
|
|
4364
|
+
}
|
|
4365
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4366
|
+
/**
|
|
4367
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4368
|
+
* @format GUID
|
|
4369
|
+
*/
|
|
4370
|
+
anonymousVisitorId?: string;
|
|
4371
|
+
/**
|
|
4372
|
+
* ID of a site visitor that has logged in to the site.
|
|
4373
|
+
* @format GUID
|
|
4374
|
+
*/
|
|
4375
|
+
memberId?: string;
|
|
4376
|
+
/**
|
|
4377
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4378
|
+
* @format GUID
|
|
4379
|
+
*/
|
|
4380
|
+
wixUserId?: string;
|
|
4381
|
+
/**
|
|
4382
|
+
* ID of an app.
|
|
4383
|
+
* @format GUID
|
|
4384
|
+
*/
|
|
4385
|
+
appId?: string;
|
|
4386
|
+
/** @readonly */
|
|
4387
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4388
|
+
}
|
|
4389
|
+
/** @oneof */
|
|
4390
|
+
interface IdentificationDataIdOneOf {
|
|
4391
|
+
/**
|
|
4392
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4393
|
+
* @format GUID
|
|
4394
|
+
*/
|
|
4395
|
+
anonymousVisitorId?: string;
|
|
4396
|
+
/**
|
|
4397
|
+
* ID of a site visitor that has logged in to the site.
|
|
4398
|
+
* @format GUID
|
|
4399
|
+
*/
|
|
4400
|
+
memberId?: string;
|
|
4401
|
+
/**
|
|
4402
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4403
|
+
* @format GUID
|
|
4404
|
+
*/
|
|
4405
|
+
wixUserId?: string;
|
|
4406
|
+
/**
|
|
4407
|
+
* ID of an app.
|
|
4408
|
+
* @format GUID
|
|
4409
|
+
*/
|
|
4410
|
+
appId?: string;
|
|
4411
|
+
}
|
|
4412
|
+
declare enum WebhookIdentityType {
|
|
4413
|
+
UNKNOWN = "UNKNOWN",
|
|
4414
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
4415
|
+
MEMBER = "MEMBER",
|
|
4416
|
+
WIX_USER = "WIX_USER",
|
|
4417
|
+
APP = "APP"
|
|
4418
|
+
}
|
|
4419
|
+
/** @enumType */
|
|
4420
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
6958
4421
|
type GetOrderApplicationErrors = {
|
|
6959
4422
|
code?: 'ORDER_NOT_FOUND';
|
|
6960
4423
|
description?: string;
|
|
@@ -7075,11 +4538,14 @@ interface OrderApprovedEnvelope {
|
|
|
7075
4538
|
* @slug approved
|
|
7076
4539
|
*/
|
|
7077
4540
|
declare function onOrderApproved(handler: (event: OrderApprovedEnvelope) => void | Promise<void>): void;
|
|
7078
|
-
interface
|
|
7079
|
-
|
|
4541
|
+
interface OrderCanceledEnvelope {
|
|
4542
|
+
data: OrderCanceledEventOrderCanceled;
|
|
7080
4543
|
metadata: EventMetadata;
|
|
7081
4544
|
}
|
|
7082
|
-
/**
|
|
4545
|
+
/**
|
|
4546
|
+
* Triggered when an order is canceled.
|
|
4547
|
+
* Learn more about [eCommerce webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
4548
|
+
* @permissionScope Manage Stores - all permissions
|
|
7083
4549
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7084
4550
|
* @permissionScope Manage Stores
|
|
7085
4551
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
@@ -7097,17 +4563,18 @@ interface OrderUpdatedEnvelope {
|
|
|
7097
4563
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7098
4564
|
* @permissionId ECOM.READ_ORDERS
|
|
7099
4565
|
* @webhook
|
|
7100
|
-
* @eventType wix.ecom.v1.
|
|
7101
|
-
* @
|
|
4566
|
+
* @eventType wix.ecom.v1.order_canceled
|
|
4567
|
+
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
4568
|
+
* @slug canceled
|
|
7102
4569
|
*/
|
|
7103
|
-
declare function
|
|
7104
|
-
interface
|
|
7105
|
-
|
|
4570
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
4571
|
+
interface OrderCreatedEnvelope {
|
|
4572
|
+
entity: Order;
|
|
7106
4573
|
metadata: EventMetadata;
|
|
7107
4574
|
}
|
|
7108
4575
|
/**
|
|
7109
|
-
* Triggered when an order is
|
|
7110
|
-
* Learn more about [
|
|
4576
|
+
* Triggered when an order is created.
|
|
4577
|
+
* Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
7111
4578
|
* @permissionScope Manage Stores - all permissions
|
|
7112
4579
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7113
4580
|
* @permissionScope Manage Stores
|
|
@@ -7126,18 +4593,17 @@ interface OrderCanceledEnvelope {
|
|
|
7126
4593
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7127
4594
|
* @permissionId ECOM.READ_ORDERS
|
|
7128
4595
|
* @webhook
|
|
7129
|
-
* @eventType wix.ecom.v1.
|
|
4596
|
+
* @eventType wix.ecom.v1.order_created
|
|
7130
4597
|
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
7131
|
-
* @slug
|
|
4598
|
+
* @slug created
|
|
7132
4599
|
*/
|
|
7133
|
-
declare function
|
|
7134
|
-
interface
|
|
7135
|
-
|
|
4600
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
4601
|
+
interface OrderPaymentStatusUpdatedEnvelope {
|
|
4602
|
+
data: PaymentStatusUpdated;
|
|
7136
4603
|
metadata: EventMetadata;
|
|
7137
4604
|
}
|
|
7138
4605
|
/**
|
|
7139
|
-
* Triggered when an order is
|
|
7140
|
-
* Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
4606
|
+
* Triggered when an order's payment status is updated.
|
|
7141
4607
|
* @permissionScope Manage Stores - all permissions
|
|
7142
4608
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7143
4609
|
* @permissionScope Manage Stores
|
|
@@ -7156,231 +4622,38 @@ interface OrderCreatedEnvelope {
|
|
|
7156
4622
|
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7157
4623
|
* @permissionId ECOM.READ_ORDERS
|
|
7158
4624
|
* @webhook
|
|
7159
|
-
* @eventType wix.ecom.v1.
|
|
4625
|
+
* @eventType wix.ecom.v1.order_payment_status_updated
|
|
7160
4626
|
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
7161
|
-
* @slug
|
|
7162
|
-
*/
|
|
7163
|
-
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
7164
|
-
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`;
|
|
7165
|
-
/**
|
|
7166
|
-
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
7167
|
-
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
7168
|
-
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
7169
|
-
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
7170
|
-
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
7171
|
-
* @param ecomOrderId - Ecom order ID.
|
|
7172
|
-
* @param amount - Amount to collect
|
|
7173
|
-
* @public
|
|
7174
|
-
* @documentationMaturity preview
|
|
7175
|
-
* @requiredField amount
|
|
7176
|
-
* @requiredField ecomOrderId
|
|
7177
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
7178
|
-
* @applicableIdentity APP
|
|
7179
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
7180
|
-
*/
|
|
7181
|
-
declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
|
|
7182
|
-
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
|
|
7183
|
-
}>;
|
|
7184
|
-
interface PreparePaymentCollectionOptions {
|
|
7185
|
-
/**
|
|
7186
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
7187
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
7188
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
7189
|
-
*/
|
|
7190
|
-
paymentGatewayOrderId?: string | null;
|
|
7191
|
-
/**
|
|
7192
|
-
* Whether to delay capture of the payment.
|
|
7193
|
-
* Default: false
|
|
7194
|
-
* @deprecated Whether to delay capture of the payment.
|
|
7195
|
-
* Default: false
|
|
7196
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
7197
|
-
* @targetRemovalDate 2024-09-30
|
|
7198
|
-
*/
|
|
7199
|
-
delayedCapture?: boolean;
|
|
7200
|
-
/** Delayed capture payment settings */
|
|
7201
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
7202
|
-
}
|
|
7203
|
-
/**
|
|
7204
|
-
* Provides payment collectability status for given order. If payment collection is possible
|
|
7205
|
-
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
7206
|
-
* reason why payment collection is not possible.
|
|
7207
|
-
* @param ecomOrderId - Ecom order ID.
|
|
7208
|
-
* @public
|
|
7209
|
-
* @documentationMaturity preview
|
|
7210
|
-
* @requiredField ecomOrderId
|
|
7211
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
7212
|
-
* @applicableIdentity APP
|
|
7213
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
7214
|
-
*/
|
|
7215
|
-
declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
7216
|
-
/**
|
|
7217
|
-
* Records and approves new manual payment with provided custom amount on given order.
|
|
7218
|
-
* Existing pending payments are ignored.
|
|
7219
|
-
* Custom amount is expected to be less or equal remaining amount to be paid on order (affected by approved payments, refunds and gift card payments)
|
|
7220
|
-
* @param orderId - Order ID.
|
|
7221
|
-
* @param amount - Amount to be recorded as approved manual payment for given order
|
|
7222
|
-
* @internal
|
|
7223
|
-
* @documentationMaturity preview
|
|
7224
|
-
* @requiredField amount
|
|
7225
|
-
* @requiredField orderId
|
|
7226
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
7227
|
-
* @applicableIdentity APP
|
|
7228
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.RecordManuallyCollectedPayment
|
|
7229
|
-
*/
|
|
7230
|
-
declare function recordManuallyCollectedPayment(orderId: string, amount: Price): Promise<void & {
|
|
7231
|
-
__applicationErrorsType?: RecordManuallyCollectedPaymentApplicationErrors;
|
|
7232
|
-
}>;
|
|
7233
|
-
/**
|
|
7234
|
-
* Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
7235
|
-
* In case the order already has an offline payment transaction associated with it
|
|
7236
|
-
* (usually when manual payment method is chosen at checkout) - This transaction will become approved.
|
|
7237
|
-
* In case the order has no payment transactions associated with it
|
|
7238
|
-
* (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction
|
|
7239
|
-
* will be created and approved.
|
|
7240
|
-
* @param ecomOrderId - Ecom order ID.
|
|
7241
|
-
* @internal
|
|
7242
|
-
* @documentationMaturity preview
|
|
7243
|
-
* @requiredField ecomOrderId
|
|
7244
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
7245
|
-
* @applicableIdentity APP
|
|
7246
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.MarkOrderAsPaid
|
|
7247
|
-
*/
|
|
7248
|
-
declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise<NonNullablePaths<MarkOrderAsPaidResponse, {
|
|
7249
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7250
|
-
}[OrderNonNullablePaths]> & {
|
|
7251
|
-
__applicationErrorsType?: PaymentCollectionMarkOrderAsPaidApplicationErrors;
|
|
7252
|
-
}>;
|
|
7253
|
-
/**
|
|
7254
|
-
* Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
7255
|
-
* @param ecomOrderIds - IDs of orders to mark as paid.
|
|
7256
|
-
* @internal
|
|
7257
|
-
* @documentationMaturity preview
|
|
7258
|
-
* @requiredField ecomOrderIds
|
|
7259
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
7260
|
-
* @applicableIdentity APP
|
|
7261
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.BulkMarkOrdersAsPaid
|
|
7262
|
-
*/
|
|
7263
|
-
declare function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds: string[]): Promise<NonNullablePaths<BulkMarkOrdersAsPaidResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
7264
|
-
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
7265
|
-
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
7266
|
-
/**
|
|
7267
|
-
* Checks whether this order can be refunded.
|
|
7268
|
-
* @param ecomOrderId - Order ID.
|
|
7269
|
-
* @internal
|
|
7270
|
-
* @documentationMaturity preview
|
|
7271
|
-
* @requiredField ecomOrderId
|
|
7272
|
-
* @permissionId ECOM.READ_TRANSACTIONS
|
|
7273
|
-
* @applicableIdentity APP
|
|
7274
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetRefundabilityStatus
|
|
7275
|
-
*/
|
|
7276
|
-
declare function getRefundabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetRefundabilityStatusResponse, `refundabilities` | `refundabilities.${number}.nonRefundableReason` | `refundabilities.${number}.manuallyRefundableReason` | `refundabilities.${number}.paymentId` | `refundabilities.${number}.refundabilityStatus` | `refundablePerItem`>>;
|
|
7277
|
-
/**
|
|
7278
|
-
* Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:
|
|
7279
|
-
* 1. An explicit amount provided in the request, or;
|
|
7280
|
-
* 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.
|
|
7281
|
-
* As a result, an ID of the created payment gateway order would be returned.
|
|
7282
|
-
* You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).
|
|
7283
|
-
* @param ecomOrderId - Ecom order ID.
|
|
7284
|
-
* @internal
|
|
7285
|
-
* @documentationMaturity preview
|
|
7286
|
-
* @requiredField ecomOrderId
|
|
7287
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
7288
|
-
* @applicableIdentity APP
|
|
7289
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CreatePaymentGatewayOrder
|
|
7290
|
-
*/
|
|
7291
|
-
declare function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions): Promise<NonNullablePaths<CreatePaymentGatewayOrderResponse, `paymentGatewayOrderId`> & {
|
|
7292
|
-
__applicationErrorsType?: PaymentCollectionCreatePaymentGatewayOrderApplicationErrors;
|
|
7293
|
-
}>;
|
|
7294
|
-
interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
7295
|
-
/** Information about the user who initiated the payment. */
|
|
7296
|
-
chargedBy?: ChargedBy;
|
|
7297
|
-
}
|
|
7298
|
-
/** @param ecomOrderId - Order ID.
|
|
7299
|
-
* @param memberId - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
7300
|
-
* but a user which is using the membership on behalf of the a member
|
|
7301
|
-
* @internal
|
|
7302
|
-
* @documentationMaturity preview
|
|
7303
|
-
* @requiredField ecomOrderId
|
|
7304
|
-
* @requiredField memberId
|
|
7305
|
-
* @requiredField options.membershipCharges.appId
|
|
7306
|
-
* @requiredField options.membershipCharges.catalogReference
|
|
7307
|
-
* @requiredField options.membershipCharges.catalogReference.appId
|
|
7308
|
-
* @requiredField options.membershipCharges.catalogReference.catalogItemId
|
|
7309
|
-
* @requiredField options.membershipCharges.membershipId
|
|
7310
|
-
* @requiredField options.membershipCharges.membershipName
|
|
7311
|
-
* @requiredField options.membershipCharges.membershipName.original
|
|
7312
|
-
* @requiredField options.membershipCharges.rootCatalogItemId
|
|
7313
|
-
* @permissionId ECOM.MODIFY_TRANSACTIONS
|
|
7314
|
-
* @applicableIdentity APP
|
|
7315
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.ChargeMemberships
|
|
7316
|
-
*/
|
|
7317
|
-
declare function chargeMemberships(ecomOrderId: string, memberId: string, options?: NonNullablePaths<ChargeMembershipsOptions, `membershipCharges.${number}.appId` | `membershipCharges.${number}.catalogReference` | `membershipCharges.${number}.catalogReference.appId` | `membershipCharges.${number}.catalogReference.catalogItemId` | `membershipCharges.${number}.membershipId` | `membershipCharges.${number}.membershipName` | `membershipCharges.${number}.membershipName.original` | `membershipCharges.${number}.rootCatalogItemId`>): Promise<void>;
|
|
7318
|
-
interface ChargeMembershipsOptions {
|
|
7319
|
-
/**
|
|
7320
|
-
* List of items to be paid by memberships
|
|
7321
|
-
* @minSize 1
|
|
7322
|
-
* @maxSize 300
|
|
7323
|
-
*/
|
|
7324
|
-
membershipCharges?: MembershipChargeItem[];
|
|
7325
|
-
}
|
|
7326
|
-
/**
|
|
7327
|
-
* Calls corresponding payment providers and creates refund transactions for requested payments.
|
|
7328
|
-
* Updates order transactions based on refund results.
|
|
7329
|
-
* For requested payments with `TriggerRefundRequest.payments.external_refund = true` will not call payment providers and
|
|
7330
|
-
* will only update order transactions.
|
|
7331
|
-
* @param ecomOrderId - The order this refund related to
|
|
7332
|
-
* @param payments - Refund operations information
|
|
7333
|
-
* @internal
|
|
7334
|
-
* @documentationMaturity preview
|
|
7335
|
-
* @requiredField ecomOrderId
|
|
7336
|
-
* @requiredField payments
|
|
7337
|
-
* @requiredField payments.paymentId
|
|
7338
|
-
* @permissionId ECOM.MODIFY_TRANSACTIONS
|
|
7339
|
-
* @applicableIdentity APP
|
|
7340
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.TriggerRefund
|
|
4627
|
+
* @slug payment_status_updated
|
|
7341
4628
|
*/
|
|
7342
|
-
declare function
|
|
7343
|
-
|
|
7344
|
-
|
|
7345
|
-
|
|
7346
|
-
/** Business model of a refund */
|
|
7347
|
-
details?: RefundDetails;
|
|
7348
|
-
/** Side effect details related to refund */
|
|
7349
|
-
sideEffects?: RefundSideEffects;
|
|
4629
|
+
declare function onOrderPaymentStatusUpdated(handler: (event: OrderPaymentStatusUpdatedEnvelope) => void | Promise<void>): void;
|
|
4630
|
+
interface OrderUpdatedEnvelope {
|
|
4631
|
+
entity: Order;
|
|
4632
|
+
metadata: EventMetadata;
|
|
7350
4633
|
}
|
|
7351
|
-
/**
|
|
7352
|
-
*
|
|
7353
|
-
*
|
|
7354
|
-
* @
|
|
7355
|
-
* @
|
|
7356
|
-
* @
|
|
7357
|
-
* @
|
|
7358
|
-
* @
|
|
7359
|
-
* @
|
|
7360
|
-
* @
|
|
7361
|
-
* @
|
|
7362
|
-
* @
|
|
7363
|
-
|
|
7364
|
-
|
|
7365
|
-
|
|
7366
|
-
|
|
7367
|
-
|
|
7368
|
-
*
|
|
7369
|
-
*
|
|
7370
|
-
* @
|
|
7371
|
-
* @param payments - Capture payments information
|
|
7372
|
-
* @public
|
|
7373
|
-
* @documentationMaturity preview
|
|
7374
|
-
* @requiredField ecomOrderId
|
|
7375
|
-
* @requiredField payments
|
|
7376
|
-
* @requiredField payments.paymentId
|
|
7377
|
-
* @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
|
|
7378
|
-
* @applicableIdentity APP
|
|
7379
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
4634
|
+
/** @permissionScope Manage Stores - all permissions
|
|
4635
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4636
|
+
* @permissionScope Manage Stores
|
|
4637
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4638
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
4639
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
4640
|
+
* @permissionScope Read Orders
|
|
4641
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
4642
|
+
* @permissionScope Read Stores - all read permissions
|
|
4643
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
4644
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4645
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4646
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4647
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4648
|
+
* @permissionScope Manage Orders
|
|
4649
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4650
|
+
* @permissionId ECOM.READ_ORDERS
|
|
4651
|
+
* @webhook
|
|
4652
|
+
* @eventType wix.ecom.v1.order_updated
|
|
4653
|
+
* @slug updated
|
|
7380
4654
|
*/
|
|
7381
|
-
declare function
|
|
7382
|
-
|
|
7383
|
-
}>;
|
|
4655
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
4656
|
+
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`;
|
|
7384
4657
|
/**
|
|
7385
4658
|
* Retrieves an order.
|
|
7386
4659
|
*
|
|
@@ -7816,23 +5089,6 @@ interface BulkUpdateOrdersOptions {
|
|
|
7816
5089
|
*/
|
|
7817
5090
|
returnEntity?: boolean;
|
|
7818
5091
|
}
|
|
7819
|
-
/** @param _id - Order id to be updated
|
|
7820
|
-
* @internal
|
|
7821
|
-
* @documentationMaturity preview
|
|
7822
|
-
* @requiredField _id
|
|
7823
|
-
* @requiredField options.changes
|
|
7824
|
-
* @requiredField options.changes.priceSummary.subtotal
|
|
7825
|
-
* @requiredField options.changes.priceSummary.total
|
|
7826
|
-
* @permissionId ECOM.ORDERS_DELTAS_COMMIT
|
|
7827
|
-
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
7828
|
-
* @applicableIdentity APP
|
|
7829
|
-
* @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
|
|
7830
|
-
*/
|
|
7831
|
-
declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
|
|
7832
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7833
|
-
}[OrderNonNullablePaths]> & {
|
|
7834
|
-
__applicationErrorsType?: CommitDeltasApplicationErrors;
|
|
7835
|
-
}>;
|
|
7836
5092
|
interface CommitDeltasOptions {
|
|
7837
5093
|
/**
|
|
7838
5094
|
* Draft order Id representing this change.
|
|
@@ -7850,21 +5106,6 @@ interface CommitDeltasOptions {
|
|
|
7850
5106
|
*/
|
|
7851
5107
|
reason?: string | null;
|
|
7852
5108
|
}
|
|
7853
|
-
/** @internal
|
|
7854
|
-
* @documentationMaturity preview
|
|
7855
|
-
* @requiredField identifiers
|
|
7856
|
-
* @requiredField identifiers._id
|
|
7857
|
-
* @requiredField identifiers.lineItemId
|
|
7858
|
-
* @requiredField lineItem
|
|
7859
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
7860
|
-
* @applicableIdentity APP
|
|
7861
|
-
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
|
|
7862
|
-
* @deprecated
|
|
7863
|
-
* @targetRemovalDate 2024-02-15
|
|
7864
|
-
*/
|
|
7865
|
-
declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
|
|
7866
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7867
|
-
}[OrderNonNullablePaths]>>;
|
|
7868
5109
|
interface UpdateOrderLineItemIdentifiers {
|
|
7869
5110
|
/**
|
|
7870
5111
|
* Order ID
|
|
@@ -7988,61 +5229,13 @@ interface UpdateOrderLineItem {
|
|
|
7988
5229
|
locations?: LocationAndQuantity[];
|
|
7989
5230
|
/** Address used for tax calculation. */
|
|
7990
5231
|
taxableAddress?: TaxableAddress;
|
|
7991
|
-
/**
|
|
7992
|
-
* ID of the app managing the inventory.
|
|
7993
|
-
* @internal
|
|
7994
|
-
* @format GUID
|
|
7995
|
-
*/
|
|
7996
|
-
inventoryAppId?: string | null;
|
|
7997
5232
|
/**
|
|
7998
5233
|
* Custom extended fields for the line item object.
|
|
7999
5234
|
*
|
|
8000
5235
|
* [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.
|
|
8001
5236
|
*/
|
|
8002
5237
|
extendedFields?: ExtendedFields;
|
|
8003
|
-
/**
|
|
8004
|
-
* Modifier groups that were added to the item.
|
|
8005
|
-
* @internal
|
|
8006
|
-
* @readonly
|
|
8007
|
-
* @maxSize 10
|
|
8008
|
-
*/
|
|
8009
|
-
modifierGroups?: ModifierGroup[];
|
|
8010
5238
|
}
|
|
8011
|
-
/**
|
|
8012
|
-
* Adds a merchant comment to an order.
|
|
8013
|
-
* > **Note:** Activities with type CustomActivity not supported
|
|
8014
|
-
* @param _id - Order ID.
|
|
8015
|
-
* @param activity - Activity info.
|
|
8016
|
-
* @internal
|
|
8017
|
-
* @documentationMaturity preview
|
|
8018
|
-
* @requiredField _id
|
|
8019
|
-
* @requiredField activity
|
|
8020
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
8021
|
-
* @applicableIdentity APP
|
|
8022
|
-
* @fqn com.wix.ecom.orders.v1.Orders.AddActivity
|
|
8023
|
-
* @deprecated
|
|
8024
|
-
* @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
|
|
8025
|
-
* @targetRemovalDate 2024-11-01
|
|
8026
|
-
*/
|
|
8027
|
-
declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
|
|
8028
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
8029
|
-
}[OrderNonNullablePaths] | `activityId`>>;
|
|
8030
|
-
/**
|
|
8031
|
-
* Updates an order's activity.
|
|
8032
|
-
* @param activity - Activity info.
|
|
8033
|
-
* @internal
|
|
8034
|
-
* @documentationMaturity preview
|
|
8035
|
-
* @requiredField activity
|
|
8036
|
-
* @requiredField identifiers
|
|
8037
|
-
* @requiredField identifiers._id
|
|
8038
|
-
* @requiredField identifiers.activityId
|
|
8039
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
8040
|
-
* @applicableIdentity APP
|
|
8041
|
-
* @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
|
|
8042
|
-
*/
|
|
8043
|
-
declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
|
|
8044
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
8045
|
-
}[OrderNonNullablePaths]>>;
|
|
8046
5239
|
interface UpdateActivityIdentifiers {
|
|
8047
5240
|
/**
|
|
8048
5241
|
* Order ID.
|
|
@@ -8056,22 +5249,6 @@ interface UpdateActivityIdentifiers {
|
|
|
8056
5249
|
*/
|
|
8057
5250
|
activityId: string;
|
|
8058
5251
|
}
|
|
8059
|
-
/**
|
|
8060
|
-
* Delete's an order's activity.
|
|
8061
|
-
*
|
|
8062
|
-
* Only custom activities and merchant comments can be deleted.
|
|
8063
|
-
* @internal
|
|
8064
|
-
* @documentationMaturity preview
|
|
8065
|
-
* @requiredField identifiers
|
|
8066
|
-
* @requiredField identifiers._id
|
|
8067
|
-
* @requiredField identifiers.activityId
|
|
8068
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
8069
|
-
* @applicableIdentity APP
|
|
8070
|
-
* @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
|
|
8071
|
-
*/
|
|
8072
|
-
declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
|
|
8073
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
8074
|
-
}[OrderNonNullablePaths]>>;
|
|
8075
5252
|
interface DeleteActivityIdentifiers {
|
|
8076
5253
|
/**
|
|
8077
5254
|
* Order ID.
|
|
@@ -8114,43 +5291,6 @@ interface CancelOrderOptions {
|
|
|
8114
5291
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
8115
5292
|
restockAllItems?: boolean;
|
|
8116
5293
|
}
|
|
8117
|
-
/**
|
|
8118
|
-
* Updates order status.
|
|
8119
|
-
*
|
|
8120
|
-
* >CANCELED and REJECTED are final statuses. Update from either of those will fail.
|
|
8121
|
-
* >Updates into INITIALIZED are not supported.
|
|
8122
|
-
*
|
|
8123
|
-
* Approving order:
|
|
8124
|
-
* APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
|
|
8125
|
-
*
|
|
8126
|
-
* Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
|
|
8127
|
-
* will cause an error.
|
|
8128
|
-
*
|
|
8129
|
-
* Setting PENDING status:
|
|
8130
|
-
* Only orders in INITIALIZED status can be updated into PENDING.
|
|
8131
|
-
* @param orderId - Order ID.
|
|
8132
|
-
* @param status - New order status.
|
|
8133
|
-
* @internal
|
|
8134
|
-
* @documentationMaturity preview
|
|
8135
|
-
* @requiredField orderId
|
|
8136
|
-
* @requiredField status
|
|
8137
|
-
* @permissionId ECOM.ORDER_UPDATE_STATUS
|
|
8138
|
-
* @applicableIdentity APP
|
|
8139
|
-
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
8140
|
-
*/
|
|
8141
|
-
declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
8142
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
8143
|
-
}[OrderNonNullablePaths]> & {
|
|
8144
|
-
__applicationErrorsType?: UpdateOrderStatusApplicationErrors;
|
|
8145
|
-
}>;
|
|
8146
|
-
/** @internal
|
|
8147
|
-
* @documentationMaturity preview
|
|
8148
|
-
* @requiredField options.aggregation
|
|
8149
|
-
* @permissionId ECOM.READ_ORDERS
|
|
8150
|
-
* @applicableIdentity APP
|
|
8151
|
-
* @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
|
|
8152
|
-
*/
|
|
8153
|
-
declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
|
|
8154
5294
|
interface AggregateOrdersOptions {
|
|
8155
5295
|
/** Filter applied to original data */
|
|
8156
5296
|
filter?: Record<string, any> | null;
|
|
@@ -8187,4 +5327,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
8187
5327
|
unassignTags?: Tags;
|
|
8188
5328
|
}
|
|
8189
5329
|
|
|
8190
|
-
export { type AggregateOrdersResponse as $, type UpdateOrderLineItemIdentifiers as A, type BulkMarkOrdersAsPaidResponse as B, type CreatePaymentGatewayOrderResponse as C, type UpdateOrderLineItem as D, type UpdateOrderLineItemResponse as E, type PublicActivity as F, type GetPaymentCollectabilityStatusResponse as G, type AddActivityResponse as H, type UpdateActivityIdentifiers as I, type UpdateActivityResponse as J, type DeleteActivityIdentifiers as K, type DeleteActivityResponse as L, type MarkOrderAsPaidResponse as M, type CancelOrderOptions as N, type Order as O, type Price as P, type CancelOrderResponse as Q, type RecordManuallyCollectedPaymentApplicationErrors as R, type SearchOrdersResponse as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type CancelOrderApplicationErrors as W, type OrderStatusWithLiterals as X, type UpdateOrderStatusResponse as Y, type UpdateOrderStatusApplicationErrors as Z, type AggregateOrdersOptions as _, type PreparePaymentCollectionOptions as a, type DescriptionLineDescriptionLineValueOneOf as a$, type BulkUpdateOrderTagsOptions as a0, type BulkUpdateOrderTagsResponse as a1, type OrderApprovedEnvelope as a2, type OrderUpdatedEnvelope as a3, type OrderCanceledEnvelope as a4, type OrderCreatedEnvelope as a5, DescriptionLineType as a6, ItemTypeItemType as a7, PaymentOptionType as a8, JurisdictionType as a9, ActionType as aA, ChargebackStatus as aB, MembershipPaymentStatus as aC, RefundStatus as aD, WebhookIdentityType as aE, TextDetection as aF, AnimationDetection as aG, PreviewEmailType as aH, State as aI, Namespace as aJ, SortOrder as aK, VersioningMode as aL, OrderApprovalStrategy as aM, DeltaPaymentOptionType as aN, InventoryAction as aO, Placement as aP, SubdivisionType as aQ, SourceType as aR, CustomFieldGroup as aS, ValueType as aT, DepositType as aU, InvoiceStatus as aV, type OrderLineItem as aW, type ProductName as aX, type CatalogReference as aY, type DescriptionLine as aZ, type DescriptionLineValueOneOf as a_, SubscriptionFrequency as aa, AdjustmentType as ab, TaxableAddressType as ac, PaymentStatus as ad, FulfillmentStatus as ae, WeightUnit as af, VatType as ag, PickupMethod as ah, OrderStatus as ai, DiscountType as aj, DiscountReason as ak, LineItemQuantityChangeType as al, ActivityType as am, AttributionSource as an, ChannelType as ao, ScheduledAction as ap, DurationUnit as aq, PaymentCollectabilityStatus as ar, RefundableStatus as as, NonRefundableReason as at, ManuallyRefundableReason as au, RestockType as av, TransactionStatus as aw, AuthorizationCaptureStatus as ax, AuthorizationVoidStatus as ay, Reason as az, type PreparePaymentCollectionResponse as b, type DraftOrderChangesApplied as b$, type DescriptionLineName as b0, type PlainTextValue as b1, type Color as b2, type FocalPoint as b3, type PhysicalProperties as b4, type ItemType as b5, type ItemTypeItemTypeDataOneOf as b6, type ItemTaxFullDetails as b7, type LineItemTaxInfo as b8, type LineItemTaxBreakdown as b9, type V1ShippingInformation as bA, type DeliveryLogistics as bB, type DeliveryLogisticsAddressOneOf as bC, type PickupDetails as bD, type PickupAddress as bE, type DeliveryTimeSlot as bF, type ShippingPrice as bG, type ShippingRegion as bH, type TaxSummary as bI, type OrderTaxInfo as bJ, type OrderTaxBreakdown as bK, type AppliedDiscount as bL, type AppliedDiscountDiscountSourceOneOf as bM, type Coupon as bN, type MerchantDiscount as bO, type MerchantDiscountMerchantDiscountReasonOneOf as bP, type DiscountRule as bQ, type DiscountRuleName as bR, type LineItemDiscount as bS, type Activity as bT, type ActivityContentOneOf as bU, type CustomActivity as bV, type MerchantComment as bW, type OrderRefunded as bX, type OrderCreatedFromExchange as bY, type NewExchangeOrderCreated as bZ, type LineItemExchangeData as b_, type DigitalFile as ba, type SubscriptionInfo as bb, type SubscriptionTitle as bc, type SubscriptionDescription as bd, type SubscriptionSettings as be, type FreeTrialPeriod as bf, type BillingAdjustment as bg, type BillingAdjustmentPriceSummary as bh, type PriceDescription as bi, type LocationAndQuantity as bj, type TaxableAddress as bk, type TaxableAddressTaxableAddressDataOneOf as bl, type ExtendedFields as bm, type ModifierGroup as bn, type TranslatableString as bo, type ItemModifier as bp, type BuyerInfo as bq, type BuyerInfoIdOneOf as br, type CurrencyConversionDetails as bs, type PriceSummary as bt, type AddressWithContact as bu, type Address as bv, type StreetAddress as bw, type AddressLocation as bx, type FullAddressContactDetails as by, type VatId as bz, type PreparePaymentCollectionApplicationErrors as c, type GetPaymentCollectabilityStatusRequest as c$, type OrderChange as c0, type OrderChangeValueOneOf as c1, type LineItemChanges as c2, type LineItemQuantityChange as c3, type LineItemPriceChange as c4, type ManagedLineItem as c5, type ManagedDiscount as c6, type TranslatedValue as c7, type LineItemAmount as c8, type ManagedAdditionalFee as c9, type ReceiptCreatedReceiptInfoOneOf as cA, type WixReceipt as cB, type ExternalReceipt as cC, type ReceiptSent as cD, type ReceiptSentReceiptInfoOneOf as cE, type ChargebackCreated as cF, type ChargebackReversed as cG, type CreatedBy as cH, type CreatedByStringOneOf as cI, type ChannelInfo as cJ, type CustomField as cK, type BalanceSummary as cL, type Balance as cM, type AdditionalFee as cN, type FulfillmentStatusesAggregate as cO, type Tags as cP, type TagList as cQ, type Location as cR, type OrderApproved as cS, type OrdersExperiments as cT, type OrderRejectedEventOrderRejected as cU, type OrderItemsRestocked as cV, type V1RestockItem as cW, type PreparePaymentCollectionRequest as cX, type RedirectUrls as cY, type DelayedCaptureSettings as cZ, type Duration as c_, type TotalPriceChange as ca, type ShippingInformationChange as cb, type ShippingInformation as cc, type SavedPaymentMethod as cd, type AuthorizedPaymentCreated as ce, type AuthorizedPaymentCaptured as cf, type AuthorizedPaymentVoided as cg, type RefundInitiated as ch, type RefundedPayment as ci, type RefundedPaymentKindOneOf as cj, type RegularPaymentRefund as ck, type GiftCardPaymentRefund as cl, type MembershipPaymentRefund as cm, type PaymentRefunded as cn, type PaymentRefundFailed as co, type RefundedAsStoreCredit as cp, type PaymentPending as cq, type PaymentPendingPaymentDetailsOneOf as cr, type RegularPayment as cs, type RegularPaymentPaymentMethodDetailsOneOf as ct, type CreditCardDetails as cu, type PaymentCanceled as cv, type PaymentCanceledPaymentDetailsOneOf as cw, type PaymentDeclined as cx, type PaymentDeclinedPaymentDetailsOneOf as cy, type ReceiptCreated as cz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as d, type EntityUpdatedEvent as d$, type RecordManuallyCollectedPaymentRequest as d0, type RecordManuallyCollectedPaymentResponse as d1, type MarkOrderAsPaidRequest as d2, type BulkMarkOrdersAsPaidRequest as d3, type BulkOrderResult as d4, type ItemMetadata as d5, type ApplicationError as d6, type BulkActionMetadata as d7, type GetRefundabilityStatusRequest as d8, type Refundability as d9, type AuthorizationCapture as dA, type AuthorizationActionFailureDetails as dB, type AuthorizationVoid as dC, type V1ScheduledAction as dD, type Chargeback as dE, type GiftCardPaymentDetails as dF, type MembershipPaymentDetails as dG, type WixReceiptInfo as dH, type ExternalReceiptInfo as dI, type Refund as dJ, type RefundTransaction as dK, type RefundStatusInfo as dL, type AggregatedRefundSummary as dM, type RefundItemsBreakdown as dN, type LineItemRefundSummary as dO, type CalculateRefundRequest as dP, type CalculateRefundItemRequest as dQ, type CalculateRefundResponse as dR, type CalculateRefundItemResponse as dS, type VoidAuthorizedPaymentsRequest as dT, type CaptureAuthorizedPaymentsRequest as dU, type ChargeSavedPaymentMethodRequest as dV, type ChargeSavedPaymentMethodResponse as dW, type DomainEvent as dX, type DomainEventBodyOneOf as dY, type EntityCreatedEvent as dZ, type RestoreInfo as d_, type RefundabilityAdditionalRefundabilityInfoOneOf as da, type CreatePaymentGatewayOrderRequest as db, type ChargedBy as dc, type ChargeMembershipsRequest as dd, type MembershipChargeItem as de, type MembershipName as df, type ServiceProperties as dg, type ChargeMembershipsResponse as dh, type TriggerRefundRequest as di, type RefundDetails as dj, type RefundItem as dk, type LineItemRefund as dl, type AdditionalFeeRefund as dm, type ShippingRefund as dn, type RefundSideEffects as dp, type RestockInfo as dq, type RestockItem as dr, type OrderTransactions as ds, type Payment as dt, type PaymentPaymentDetailsOneOf as du, type PaymentReceiptInfoOneOf as dv, type RegularPaymentDetails as dw, type RegularPaymentDetailsPaymentMethodDetailsOneOf as dx, type CreditCardPaymentMethodDetails as dy, type AuthorizationDetails as dz, type GetRefundabilityStatusResponse as e, type CursorPaging as e$, type EntityDeletedEvent as e0, type ActionEvent as e1, type Empty as e2, type MessageEnvelope as e3, type IdentificationData as e4, type IdentificationDataIdOneOf as e5, type ImageContent as e6, type SendBuyerConfirmationEmailRequest as e7, type SendBuyerConfirmationEmailResponse as e8, type SendBuyerPaymentsReceivedEmailRequest as e9, type PreviewBuyerPaymentsReceivedEmailResponse as eA, type PreviewBuyerConfirmationEmailRequest as eB, type PreviewBuyerConfirmationEmailResponse as eC, type PreviewBuyerPickupConfirmationEmailRequest as eD, type PreviewBuyerPickupConfirmationEmailResponse as eE, type PreviewShippingConfirmationEmailRequest as eF, type PreviewShippingConfirmationEmailResponse as eG, type PreviewResendDownloadLinksEmailRequest as eH, type PreviewResendDownloadLinksEmailResponse as eI, type TriggerReindexOrderRequest as eJ, type SnapshotMessage as eK, type PaymentStatusUpdated as eL, type GetMetasiteDataRequest as eM, type GetMetasiteDataResponse as eN, type MetaSite as eO, type App as eP, type SeoData as eQ, type MetaTag as eR, type HtmlApplication as eS, type ExternalUriMapping as eT, type UserDataResponse as eU, type QueryOrdersForMetasiteRequest as eV, type InternalQueryOrdersRequest as eW, type PlatformQuery as eX, type PlatformQueryPagingMethodOneOf as eY, type Sorting as eZ, type PlatformPaging as e_, type SendBuyerPaymentsReceivedEmailResponse as ea, type SendBuyerPickupConfirmationEmailRequest as eb, type SendBuyerPickupConfirmationEmailResponse as ec, type BulkSendBuyerPickupConfirmationEmailsRequest as ed, type BulkSendBuyerPickupConfirmationEmailsResponse as ee, type SendBuyerShippingConfirmationEmailRequest as ef, type SendBuyerShippingConfirmationEmailResponse as eg, type BulkSendBuyerShippingConfirmationEmailsRequest as eh, type BulkSendBuyerShippingConfirmationEmailsResponse as ei, type SendMerchantOrderReceivedNotificationRequest as ej, type SendMerchantOrderReceivedNotificationResponse as ek, type SendCancelRefundEmailRequest as el, type SendCancelRefundEmailResponse as em, type SendRefundEmailRequest as en, type SendRefundEmailResponse as eo, type SendMerchantOrderReceivedPushRequest as ep, type SendMerchantOrderReceivedPushResponse as eq, type PreviewEmailByTypeRequest as er, type PreviewEmailByTypeResponse as es, type PreviewRefundEmailRequest as et, type PreviewRefundEmailResponse as eu, type PreviewCancelEmailRequest as ev, type PreviewCancelEmailResponse as ew, type PreviewCancelRefundEmailRequest as ex, type PreviewCancelRefundEmailResponse as ey, type PreviewBuyerPaymentsReceivedEmailRequest as ez, type PaymentCollectionCreatePaymentGatewayOrderOptions as f, type AdditionalFeeDelta as f$, type QueryOrdersForMetasiteResponse as f0, type PlatformPagingMetadata as f1, type Cursors as f2, type GetOrderForMetasiteRequest as f3, type GetOrderForMetasiteResponse as f4, type ListOrderTransactionsForMetasiteRequest as f5, type ListOrderTransactionsForMetasiteResponse as f6, type UpsertRefundRequest as f7, type UpsertRefundResponse as f8, type GetOrderOutOfBoxRequest as f9, type GetOrderResponse as fA, type InternalQueryOrdersResponse as fB, type QueryOrderRequest as fC, type QueryOrderResponse as fD, type SearchOrdersRequest as fE, type CursorSearch as fF, type CursorSearchPagingMethodOneOf as fG, type CursorPagingMetadata as fH, type CreateOrderRequest as fI, type OrderCreationSettings as fJ, type OrderCreateNotifications as fK, type CreateOrderResponse as fL, type UpdateOrderRequest as fM, type UpdateOrderResponse as fN, type BulkUpdateOrdersRequest as fO, type CommitDeltasRequest as fP, type DraftOrderDiffs as fQ, type DraftOrderDiffsShippingUpdateInfoOneOf as fR, type DraftOrderDiffsBuyerUpdateInfoOneOf as fS, type DraftOrderDiffsBillingUpdateInfoOneOf as fT, type DraftOrderDiffsRecipientUpdateInfoOneOf as fU, type V1LineItemDelta as fV, type V1LineItemDeltaDeltaOneOf as fW, type OrderLineItemChangedDetails as fX, type ItemChangedDetails as fY, type AppliedDiscountDelta as fZ, type AppliedDiscountDeltaDeltaOneOf as f_, type GetOrderOutOfBoxResponse as fa, type GetOrderAgcRequest as fb, type GetOrderAgcResponse as fc, type GetOrderWithFilterByLocationRequest as fd, type GetOrderWithFilterByLocationResponse as fe, type V1UpdateOrderRequest as ff, type V1UpdateOrderResponse as fg, type UpdateInternalDocumentsEvent as fh, type UpdateInternalDocumentsEventOperationOneOf as fi, type InternalDocument as fj, type InternalDocumentUpdateOperation as fk, type DeleteByIdsOperation as fl, type DeleteByFilterOperation as fm, type InternalDocumentUpdateByFilterOperation as fn, type InternalUpdateExistingOperation as fo, type VersionedDocumentUpdateOperation as fp, type VersionedDeleteByIdsOperation as fq, type VersionedDocumentId as fr, type TriggerReindexRequest as fs, type TriggerReindexResponse as ft, type BatchOfTriggerReindexOrderRequest as fu, type DiffmatokyPayload as fv, type ErrorInformation as fw, type ContinueSideEffectsFlowInLegacyData as fx, type IndexingMessage as fy, type GetOrderRequest as fz, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as g, type LineItemUpdate as g$, type AdditionalFeeDeltaDeltaOneOf as g0, type DraftOrderCommitSettings as g1, type InventoryUpdateDetails as g2, type OrderDeltasCommitted as g3, type CommittedDiffs as g4, type CommittedDiffsShippingUpdateInfoOneOf as g5, type LineItemDelta as g6, type LineItemDeltaDeltaOneOf as g7, type ArchiveOrderRequest as g8, type ArchiveOrderResponse as g9, type OrderPlaced as gA, type OrderPaid as gB, type OrderFulfilled as gC, type OrderNotFulfilled as gD, type OrderCanceled as gE, type DownloadLinkSent as gF, type TrackingNumberAdded as gG, type TrackingNumberEdited as gH, type TrackingLinkAdded as gI, type ShippingConfirmationEmailSent as gJ, type InvoiceAdded as gK, type InvoiceSent as gL, type FulfillerEmailSent as gM, type ShippingAddressEdited as gN, type EmailEdited as gO, type PickupReadyEmailSent as gP, type OrderPartiallyPaid as gQ, type OrderPending as gR, type OrderRejected as gS, type AddInternalActivityResponse as gT, type AddActivityRequest as gU, type PublicActivityContentOneOf as gV, type AddActivitiesRequest as gW, type AddActivitiesResponse as gX, type UpdateActivityRequest as gY, type DeleteActivityRequest as gZ, type UpdateLineItemsDescriptionLinesRequest as g_, type BulkArchiveOrdersRequest as ga, type BulkArchiveOrdersResponse as gb, type BulkArchiveOrdersByFilterRequest as gc, type BulkArchiveOrdersByFilterResponse as gd, type UnArchiveOrderRequest as ge, type UnArchiveOrderResponse as gf, type BulkUnArchiveOrdersRequest as gg, type BulkUnArchiveOrdersResponse as gh, type BulkUnArchiveOrdersByFilterRequest as gi, type BulkUnArchiveOrdersByFilterResponse as gj, type UpdateBuyerInfoRequest as gk, type BuyerInfoUpdate as gl, type UpdateBuyerInfoResponse as gm, type UpdateBuyerEmailRequest as gn, type UpdateBuyerEmailResponse as go, type UpdateOrderShippingAddressRequest as gp, type UpdateOrderShippingAddressResponse as gq, type UpdateBillingContactDetailsRequest as gr, type UpdateBillingContactDetailsResponse as gs, type UpdateOrderLineItemRequest as gt, type UpdateOrderLineItemsRequest as gu, type MaskedOrderLineItem as gv, type UpdateOrderLineItemsResponse as gw, type AddInternalActivityRequest as gx, type InternalActivity as gy, type InternalActivityContentOneOf as gz, type ChargeMembershipsOptions as h, type Locale as h$, type UpdateLineItemsDescriptionLinesResponse as h0, type MarkOrderAsSeenByHumanRequest as h1, type MarkOrderAsSeenByHumanResponse as h2, type CancelOrderRequest as h3, type OrderCanceledEventOrderCanceled as h4, type UpdateOrderStatusRequest as h5, type MarkAsFulfilledRequest as h6, type MarkAsFulfilledResponse as h7, type FulfillmentStatusUpdated as h8, type BulkMarkAsFulfilledRequest as h9, type Task as hA, type TaskKey as hB, type TaskAction as hC, type TaskActionActionOneOf as hD, type Complete as hE, type Cancel as hF, type Reschedule as hG, type InvoiceSentEvent as hH, type IdAndVersion as hI, type InvoiceFields as hJ, type Customer as hK, type Email as hL, type QuotesAddress as hM, type AddressDescription as hN, type Phone as hO, type Company as hP, type CommonAddress as hQ, type CommonAddressStreetOneOf as hR, type Subdivision as hS, type StandardDetails as hT, type InvoiceDates as hU, type LineItems as hV, type LineItem as hW, type BigDecimalWrapper as hX, type LineItemTax as hY, type Source as hZ, type LineItemMetaData as h_, type BulkMarkAsFulfilledResponse as ha, type BulkMarkAsFulfilledByFilterRequest as hb, type BulkMarkAsFulfilledByFilterResponse as hc, type MarkAsUnfulfilledRequest as hd, type MarkAsUnfulfilledResponse as he, type BulkMarkAsUnfulfilledRequest as hf, type BulkMarkAsUnfulfilledResponse as hg, type BulkMarkAsUnfulfilledByFilterRequest as hh, type BulkMarkAsUnfulfilledByFilterResponse as hi, type BulkSetBusinessLocationRequest as hj, type BulkSetBusinessLocationResponse as hk, type BulkSetBusinessLocationResult as hl, type V1MarkOrderAsPaidRequest as hm, type V1MarkOrderAsPaidResponse as hn, type V1BulkMarkOrdersAsPaidRequest as ho, type V1BulkMarkOrdersAsPaidResponse as hp, type V1CreatePaymentGatewayOrderRequest as hq, type V1CreatePaymentGatewayOrderResponse as hr, type GetShipmentsRequest as hs, type GetShipmentsResponse as ht, type AggregateOrdersRequest as hu, type DecrementItemsQuantityRequest as hv, type DecrementData as hw, type DecrementItemsQuantityResponse as hx, type BulkUpdateOrderTagsRequest as hy, type BulkUpdateOrderTagsResult as hz, type PaymentRefund as i, type PlacementWithLiterals as i$, type TotalPrice as i0, type ItemizedFee as i1, type Discount as i2, type DiscountOneDiscountTypeOneOf as i3, type CalculatedTaxes as i4, type CalculatedTax as i5, type Payments as i6, type InvoicesPayment as i7, type MetaData as i8, type InvoiceDynamicPriceTotals as i9, type ChannelTypeWithLiterals as iA, type ScheduledActionWithLiterals as iB, type DurationUnitWithLiterals as iC, type PaymentCollectabilityStatusWithLiterals as iD, type RefundableStatusWithLiterals as iE, type NonRefundableReasonWithLiterals as iF, type ManuallyRefundableReasonWithLiterals as iG, type RestockTypeWithLiterals as iH, type TransactionStatusWithLiterals as iI, type AuthorizationCaptureStatusWithLiterals as iJ, type AuthorizationVoidStatusWithLiterals as iK, type ReasonWithLiterals as iL, type ActionTypeWithLiterals as iM, type ChargebackStatusWithLiterals as iN, type MembershipPaymentStatusWithLiterals as iO, type RefundStatusWithLiterals as iP, type WebhookIdentityTypeWithLiterals as iQ, type TextDetectionWithLiterals as iR, type AnimationDetectionWithLiterals as iS, type PreviewEmailTypeWithLiterals as iT, type StateWithLiterals as iU, type NamespaceWithLiterals as iV, type SortOrderWithLiterals as iW, type VersioningModeWithLiterals as iX, type OrderApprovalStrategyWithLiterals as iY, type DeltaPaymentOptionTypeWithLiterals as iZ, type InventoryActionWithLiterals as i_, type CustomFieldValue as ia, type Value as ib, type Deposit as ic, type TriggerSideEffectsFromLegacyData as id, type BaseEventMetadata as ie, type EventMetadata as ig, type OrderSearchSpec as ih, type DescriptionLineTypeWithLiterals as ii, type ItemTypeItemTypeWithLiterals as ij, type PaymentOptionTypeWithLiterals as ik, type JurisdictionTypeWithLiterals as il, type SubscriptionFrequencyWithLiterals as im, type AdjustmentTypeWithLiterals as io, type TaxableAddressTypeWithLiterals as ip, type PaymentStatusWithLiterals as iq, type FulfillmentStatusWithLiterals as ir, type WeightUnitWithLiterals as is, type VatTypeWithLiterals as it, type PickupMethodWithLiterals as iu, type DiscountTypeWithLiterals as iv, type DiscountReasonWithLiterals as iw, type LineItemQuantityChangeTypeWithLiterals as ix, type ActivityTypeWithLiterals as iy, type AttributionSourceWithLiterals as iz, type TriggerRefundResponse as j, type SubdivisionTypeWithLiterals as j0, type SourceTypeWithLiterals as j1, type CustomFieldGroupWithLiterals as j2, type ValueTypeWithLiterals as j3, type DepositTypeWithLiterals as j4, type InvoiceStatusWithLiterals as j5, onOrderApproved as j6, onOrderUpdated as j7, onOrderCanceled as j8, onOrderCreated as j9, preparePaymentCollection as ja, getPaymentCollectabilityStatus as jb, recordManuallyCollectedPayment as jc, paymentCollectionMarkOrderAsPaid as jd, paymentCollectionBulkMarkOrdersAsPaid as je, getRefundabilityStatus as jf, paymentCollectionCreatePaymentGatewayOrder as jg, chargeMemberships as jh, triggerRefund as ji, voidAuthorizedPayments as jj, captureAuthorizedPayments as jk, getOrder as jl, type CommonSearchWithEntityContext as jm, createOrder as jn, updateOrder as jo, bulkUpdateOrders as jp, commitDeltas as jq, updateOrderLineItem as jr, addActivity as js, updateActivity as jt, deleteActivity as ju, cancelOrder as jv, updateOrderStatus as jw, aggregateOrders as jx, bulkUpdateOrderTags as jy, type TriggerRefundApplicationErrors as k, type VoidAuthorizedPaymentsApplicationErrors as l, type PaymentCapture as m, type CaptureAuthorizedPaymentsResponse as n, type CaptureAuthorizedPaymentsApplicationErrors as o, type GetOrderApplicationErrors as p, type OrderSearch as q, type CreateOrderOptions as r, type CreateOrderApplicationErrors as s, type UpdateOrderApplicationErrors as t, type MaskedOrder as u, type BulkUpdateOrdersOptions as v, type BulkUpdateOrdersResponse as w, type CommitDeltasOptions as x, type CommitDeltasResponse as y, type CommitDeltasApplicationErrors as z };
|
|
5330
|
+
export { type ProductName as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CreateOrderOptions as C, DescriptionLineType as D, InventoryAction as E, FulfillmentStatus as F, type GetOrderApplicationErrors as G, Placement as H, ItemTypeItemType as I, JurisdictionType as J, SubdivisionType as K, LineItemQuantityChangeType as L, type MaskedOrder as M, SourceType as N, type Order as O, PaymentOptionType as P, CustomFieldGroup as Q, ValueType as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, VatType as V, WeightUnit as W, DepositType as X, InvoiceStatus as Y, WebhookIdentityType as Z, type OrderLineItem as _, type OrderSearch as a, type MerchantComment as a$, type CatalogReference as a0, type Price as a1, type DescriptionLine as a2, type DescriptionLineValueOneOf as a3, type DescriptionLineDescriptionLineValueOneOf as a4, type DescriptionLineName as a5, type PlainTextValue as a6, type Color as a7, type FocalPoint as a8, type PhysicalProperties as a9, type Address as aA, type StreetAddress as aB, type AddressLocation as aC, type FullAddressContactDetails as aD, type VatId as aE, type V1ShippingInformation as aF, type DeliveryLogistics as aG, type DeliveryLogisticsAddressOneOf as aH, type PickupDetails as aI, type PickupAddress as aJ, type DeliveryTimeSlot as aK, type ShippingPrice as aL, type ShippingRegion as aM, type TaxSummary as aN, type OrderTaxInfo as aO, type OrderTaxBreakdown as aP, type AppliedDiscount as aQ, type AppliedDiscountDiscountSourceOneOf as aR, type Coupon as aS, type MerchantDiscount as aT, type MerchantDiscountMerchantDiscountReasonOneOf as aU, type DiscountRule as aV, type DiscountRuleName as aW, type LineItemDiscount as aX, type Activity as aY, type ActivityContentOneOf as aZ, type CustomActivity as a_, type ItemType as aa, type ItemTypeItemTypeDataOneOf as ab, type ItemTaxFullDetails as ac, type LineItemTaxInfo as ad, type LineItemTaxBreakdown as ae, type DigitalFile as af, type SubscriptionInfo as ag, type SubscriptionTitle as ah, type SubscriptionDescription as ai, type SubscriptionSettings as aj, type FreeTrialPeriod as ak, type BillingAdjustment as al, type BillingAdjustmentPriceSummary as am, type PriceDescription as an, type LocationAndQuantity as ao, type TaxableAddress as ap, type TaxableAddressTaxableAddressDataOneOf as aq, type ExtendedFields as ar, type ModifierGroup as as, type TranslatableString as at, type ItemModifier as au, type BuyerInfo as av, type BuyerInfoIdOneOf as aw, type CurrencyConversionDetails as ax, type PriceSummary as ay, type AddressWithContact as az, type CreateOrderApplicationErrors as b, type SnapshotMessage as b$, type OrderRefunded as b0, type OrderCreatedFromExchange as b1, type NewExchangeOrderCreated as b2, type LineItemExchangeData as b3, type DraftOrderChangesApplied as b4, type OrderChange as b5, type OrderChangeValueOneOf as b6, type LineItemChanges as b7, type LineItemQuantityChange as b8, type LineItemPriceChange as b9, type PaymentCanceled as bA, type PaymentCanceledPaymentDetailsOneOf as bB, type PaymentDeclined as bC, type PaymentDeclinedPaymentDetailsOneOf as bD, type ReceiptCreated as bE, type ReceiptCreatedReceiptInfoOneOf as bF, type WixReceipt as bG, type ExternalReceipt as bH, type ReceiptSent as bI, type ReceiptSentReceiptInfoOneOf as bJ, type ChargebackCreated as bK, type ChargebackReversed as bL, type CreatedBy as bM, type CreatedByStringOneOf as bN, type ChannelInfo as bO, type CustomField as bP, type BalanceSummary as bQ, type Balance as bR, type AdditionalFee as bS, type FulfillmentStatusesAggregate as bT, type Tags as bU, type TagList as bV, type Location as bW, type DiffmatokyPayload as bX, type ErrorInformation as bY, type ContinueSideEffectsFlowInLegacyData as bZ, type OrdersExperiments as b_, type ManagedLineItem as ba, type ManagedDiscount as bb, type TranslatedValue as bc, type LineItemAmount as bd, type ManagedAdditionalFee as be, type TotalPriceChange as bf, type ShippingInformationChange as bg, type ShippingInformation as bh, type SavedPaymentMethod as bi, type AuthorizedPaymentCreated as bj, type AuthorizedPaymentCaptured as bk, type AuthorizedPaymentVoided as bl, type RefundInitiated as bm, type RefundedPayment as bn, type RefundedPaymentKindOneOf as bo, type RegularPaymentRefund as bp, type GiftCardPaymentRefund as bq, type MembershipPaymentRefund as br, type PaymentRefunded as bs, type PaymentRefundFailed as bt, type RefundedAsStoreCredit as bu, type PaymentPending as bv, type PaymentPendingPaymentDetailsOneOf as bw, type RegularPayment as bx, type RegularPaymentPaymentMethodDetailsOneOf as by, type CreditCardDetails as bz, type UpdateOrderApplicationErrors as c, type BulkUnArchiveOrdersRequest as c$, type IndexingMessage as c0, type OrderApproved as c1, type OrderRejectedEventOrderRejected as c2, type OrderItemsRestocked as c3, type RestockItem as c4, type GetOrderRequest as c5, type GetOrderResponse as c6, type InternalQueryOrdersRequest as c7, type PlatformQuery as c8, type PlatformQueryPagingMethodOneOf as c9, type DraftOrderDiffsBuyerUpdateInfoOneOf as cA, type DraftOrderDiffsBillingUpdateInfoOneOf as cB, type DraftOrderDiffsRecipientUpdateInfoOneOf as cC, type V1LineItemDelta as cD, type V1LineItemDeltaDeltaOneOf as cE, type OrderLineItemChangedDetails as cF, type ItemChangedDetails as cG, type AppliedDiscountDelta as cH, type AppliedDiscountDeltaDeltaOneOf as cI, type AdditionalFeeDelta as cJ, type AdditionalFeeDeltaDeltaOneOf as cK, type DraftOrderCommitSettings as cL, type InventoryUpdateDetails as cM, type CommitDeltasResponse as cN, type OrderDeltasCommitted as cO, type CommittedDiffs as cP, type CommittedDiffsShippingUpdateInfoOneOf as cQ, type LineItemDelta as cR, type LineItemDeltaDeltaOneOf as cS, type ArchiveOrderRequest as cT, type ArchiveOrderResponse as cU, type BulkArchiveOrdersRequest as cV, type BulkArchiveOrdersResponse as cW, type BulkArchiveOrdersByFilterRequest as cX, type BulkArchiveOrdersByFilterResponse as cY, type UnArchiveOrderRequest as cZ, type UnArchiveOrderResponse as c_, type Sorting as ca, type PlatformPaging as cb, type CursorPaging as cc, type InternalQueryOrdersResponse as cd, type PlatformPagingMetadata as ce, type Cursors as cf, type QueryOrderRequest as cg, type QueryOrderResponse as ch, type SearchOrdersRequest as ci, type CursorSearch as cj, type CursorSearchPagingMethodOneOf as ck, type CursorPagingMetadata as cl, type CreateOrderRequest as cm, type OrderCreationSettings as cn, type OrderCreateNotifications as co, type CreateOrderResponse as cp, type UpdateOrderRequest as cq, type UpdateOrderResponse as cr, type BulkUpdateOrdersRequest as cs, type BulkOrderResult as ct, type ItemMetadata as cu, type ApplicationError as cv, type BulkActionMetadata as cw, type CommitDeltasRequest as cx, type DraftOrderDiffs as cy, type DraftOrderDiffsShippingUpdateInfoOneOf as cz, type BulkUpdateOrdersResponse as d, type BulkMarkAsFulfilledRequest as d$, type BulkUnArchiveOrdersResponse as d0, type BulkUnArchiveOrdersByFilterRequest as d1, type BulkUnArchiveOrdersByFilterResponse as d2, type UpdateBuyerInfoRequest as d3, type BuyerInfoUpdate as d4, type UpdateBuyerInfoResponse as d5, type UpdateBuyerEmailRequest as d6, type UpdateBuyerEmailResponse as d7, type UpdateOrderShippingAddressRequest as d8, type UpdateOrderShippingAddressResponse as d9, type PickupReadyEmailSent as dA, type OrderPartiallyPaid as dB, type OrderPending as dC, type OrderRejected as dD, type AddInternalActivityResponse as dE, type AddActivityRequest as dF, type PublicActivity as dG, type PublicActivityContentOneOf as dH, type AddActivityResponse as dI, type AddActivitiesRequest as dJ, type AddActivitiesResponse as dK, type UpdateActivityRequest as dL, type UpdateActivityResponse as dM, type DeleteActivityRequest as dN, type DeleteActivityResponse as dO, type UpdateLineItemsDescriptionLinesRequest as dP, type LineItemUpdate as dQ, type UpdateLineItemsDescriptionLinesResponse as dR, type MarkOrderAsSeenByHumanRequest as dS, type MarkOrderAsSeenByHumanResponse as dT, type CancelOrderRequest as dU, type OrderCanceledEventOrderCanceled as dV, type UpdateOrderStatusRequest as dW, type UpdateOrderStatusResponse as dX, type MarkAsFulfilledRequest as dY, type MarkAsFulfilledResponse as dZ, type FulfillmentStatusUpdated as d_, type UpdateBillingContactDetailsRequest as da, type UpdateBillingContactDetailsResponse as db, type UpdateOrderLineItemRequest as dc, type UpdateOrderLineItemResponse as dd, type UpdateOrderLineItemsRequest as de, type MaskedOrderLineItem as df, type UpdateOrderLineItemsResponse as dg, type AddInternalActivityRequest as dh, type InternalActivity as di, type InternalActivityContentOneOf as dj, type OrderPlaced as dk, type OrderPaid as dl, type OrderFulfilled as dm, type OrderNotFulfilled as dn, type OrderCanceled as dp, type DownloadLinkSent as dq, type TrackingNumberAdded as dr, type TrackingNumberEdited as ds, type TrackingLinkAdded as dt, type ShippingConfirmationEmailSent as du, type InvoiceAdded as dv, type InvoiceSent as dw, type FulfillerEmailSent as dx, type ShippingAddressEdited as dy, type EmailEdited as dz, type CancelOrderOptions as e, type Locale as e$, type BulkMarkAsFulfilledResponse as e0, type BulkMarkAsFulfilledByFilterRequest as e1, type BulkMarkAsFulfilledByFilterResponse as e2, type MarkAsUnfulfilledRequest as e3, type MarkAsUnfulfilledResponse as e4, type BulkMarkAsUnfulfilledRequest as e5, type BulkMarkAsUnfulfilledResponse as e6, type BulkMarkAsUnfulfilledByFilterRequest as e7, type BulkMarkAsUnfulfilledByFilterResponse as e8, type BulkSetBusinessLocationRequest as e9, type Task as eA, type TaskKey as eB, type TaskAction as eC, type TaskActionActionOneOf as eD, type Complete as eE, type Cancel as eF, type Reschedule as eG, type InvoiceSentEvent as eH, type IdAndVersion as eI, type InvoiceFields as eJ, type Customer as eK, type Email as eL, type QuotesAddress as eM, type AddressDescription as eN, type Phone as eO, type Company as eP, type CommonAddress as eQ, type CommonAddressStreetOneOf as eR, type Subdivision as eS, type StandardDetails as eT, type InvoiceDates as eU, type LineItems as eV, type LineItem as eW, type BigDecimalWrapper as eX, type LineItemTax as eY, type Source as eZ, type LineItemMetaData as e_, type BulkSetBusinessLocationResponse as ea, type BulkSetBusinessLocationResult as eb, type MarkOrderAsPaidRequest as ec, type MarkOrderAsPaidResponse as ed, type PaymentStatusUpdated as ee, type BulkMarkOrdersAsPaidRequest as ef, type BulkMarkOrdersAsPaidResponse as eg, type CreatePaymentGatewayOrderRequest as eh, type CreatePaymentGatewayOrderResponse as ei, type GetShipmentsRequest as ej, type GetShipmentsResponse as ek, type AggregateOrdersRequest as el, type AggregateOrdersResponse as em, type DecrementItemsQuantityRequest as en, type DecrementData as eo, type DecrementItemsQuantityResponse as ep, type BulkUpdateOrderTagsRequest as eq, type BulkUpdateOrderTagsResult as er, type DomainEvent as es, type DomainEventBodyOneOf as et, type EntityCreatedEvent as eu, type RestoreInfo as ev, type EntityUpdatedEvent as ew, type EntityDeletedEvent as ex, type ActionEvent as ey, type Empty as ez, type CancelOrderResponse as f, onOrderUpdated as f$, type TotalPrice as f0, type ItemizedFee as f1, type Discount as f2, type DiscountOneDiscountTypeOneOf as f3, type CalculatedTaxes as f4, type CalculatedTax as f5, type Payments as f6, type Payment as f7, type MetaData as f8, type InvoiceDynamicPriceTotals as f9, type VatTypeWithLiterals as fA, type PickupMethodWithLiterals as fB, type OrderStatusWithLiterals as fC, type DiscountTypeWithLiterals as fD, type DiscountReasonWithLiterals as fE, type LineItemQuantityChangeTypeWithLiterals as fF, type ActivityTypeWithLiterals as fG, type AttributionSourceWithLiterals as fH, type ChannelTypeWithLiterals as fI, type SortOrderWithLiterals as fJ, type OrderApprovalStrategyWithLiterals as fK, type DeltaPaymentOptionTypeWithLiterals as fL, type InventoryActionWithLiterals as fM, type PlacementWithLiterals as fN, type SubdivisionTypeWithLiterals as fO, type SourceTypeWithLiterals as fP, type CustomFieldGroupWithLiterals as fQ, type ValueTypeWithLiterals as fR, type DepositTypeWithLiterals as fS, type InvoiceStatusWithLiterals as fT, type WebhookIdentityTypeWithLiterals as fU, type CommitDeltasApplicationErrors as fV, type UpdateOrderStatusApplicationErrors as fW, onOrderApproved as fX, onOrderCanceled as fY, onOrderCreated as fZ, onOrderPaymentStatusUpdated as f_, type CustomFieldValue as fa, type Value as fb, type Deposit as fc, type TriggerSideEffectsFromLegacyData as fd, type MessageEnvelope as fe, type IdentificationData as ff, type IdentificationDataIdOneOf as fg, type BaseEventMetadata as fh, type EventMetadata as fi, type OrderSearchSpec as fj, type CommitDeltasOptions as fk, type UpdateOrderLineItemIdentifiers as fl, type UpdateOrderLineItem as fm, type UpdateActivityIdentifiers as fn, type DeleteActivityIdentifiers as fo, type AggregateOrdersOptions as fp, type DescriptionLineTypeWithLiterals as fq, type ItemTypeItemTypeWithLiterals as fr, type PaymentOptionTypeWithLiterals as fs, type JurisdictionTypeWithLiterals as ft, type SubscriptionFrequencyWithLiterals as fu, type AdjustmentTypeWithLiterals as fv, type TaxableAddressTypeWithLiterals as fw, type PaymentStatusWithLiterals as fx, type FulfillmentStatusWithLiterals as fy, type WeightUnitWithLiterals as fz, type CancelOrderApplicationErrors as g, getOrder as g0, type CommonSearchWithEntityContext as g1, createOrder as g2, updateOrder as g3, bulkUpdateOrders as g4, cancelOrder as g5, bulkUpdateOrderTags as g6, type BulkUpdateOrderTagsOptions as h, type BulkUpdateOrderTagsResponse as i, type OrderApprovedEnvelope as j, type OrderCanceledEnvelope as k, type OrderCreatedEnvelope as l, type OrderPaymentStatusUpdatedEnvelope as m, type OrderUpdatedEnvelope as n, SubscriptionFrequency as o, PaymentStatus as p, PickupMethod as q, OrderStatus as r, DiscountType as s, DiscountReason as t, ActivityType as u, AttributionSource as v, ChannelType as w, SortOrder as x, OrderApprovalStrategy as y, DeltaPaymentOptionType as z };
|