@wix/auto_sdk_ecom_orders 1.0.87 → 1.0.88
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{ecom-v1-order-orders.universal-Bcw6NjJM.d.ts → ecom-v1-order-orders.universal-CBJ5qQrX.d.ts} +311 -25
- package/build/cjs/index.d.ts +6 -6
- package/build/cjs/index.js +15 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +15 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +714 -8
- package/build/es/{ecom-v1-order-orders.universal-Bcw6NjJM.d.mts → ecom-v1-order-orders.universal-CBJ5qQrX.d.mts} +311 -25
- package/build/es/index.d.mts +6 -6
- package/build/es/index.mjs +15 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +15 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +714 -8
- package/build/internal/cjs/{ecom-v1-order-orders.universal-DJbQYSET.d.ts → ecom-v1-order-orders.universal-BIDprMe0.d.ts} +228 -175
- package/build/internal/cjs/index.d.ts +13 -13
- package/build/internal/cjs/index.js +15 -0
- 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 +15 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +714 -8
- package/build/internal/es/{ecom-v1-order-orders.universal-DJbQYSET.d.mts → ecom-v1-order-orders.universal-BIDprMe0.d.mts} +228 -175
- package/build/internal/es/index.d.mts +13 -13
- package/build/internal/es/index.mjs +15 -0
- 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 +15 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +714 -8
- package/package.json +2 -2
package/build/es/meta.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { dg as PreparePaymentCollectionRequest$1, b as PreparePaymentCollectionResponse$1, dk as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, dl as RecordManuallyCollectedPaymentRequest$1, dm as RecordManuallyCollectedPaymentResponse$1, dn as MarkOrderAsPaidRequest$1, dp as MarkOrderAsPaidResponse$1, dq as BulkMarkOrdersAsPaidRequest$1, dr as BulkMarkOrdersAsPaidResponse$1, dw as GetRefundabilityStatusRequest$1, dx as GetRefundabilityStatusResponse$1, dA as CreatePaymentGatewayOrderRequest$1, dC as CreatePaymentGatewayOrderResponse$1, dD as ChargeMembershipsRequest$1, dH as ChargeMembershipsResponse$1, dI as TriggerRefundRequest$1, dN as TriggerRefundResponse$1, ed as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, ee as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, eB as GetOrderRequest$1, eC as GetOrderResponse$1, eO as SearchOrdersRequest$1, S as SearchOrdersResponse$1, eS as CreateOrderRequest$1, eV as CreateOrderResponse$1, eW as UpdateOrderRequest$1, eX as UpdateOrderResponse$1, eY as BulkUpdateOrdersRequest$1, l as BulkUpdateOrdersResponse$1, eZ as CommitDeltasRequest$1, fd as CommitDeltasResponse$1, fE as UpdateOrderLineItemRequest$1, fF as UpdateOrderLineItemResponse$1, g4 as AddActivityRequest$1, g7 as AddActivityResponse$1, ga as UpdateActivityRequest$1, gb as UpdateActivityResponse$1, gc as DeleteActivityRequest$1, gd as DeleteActivityResponse$1, gj as CancelOrderRequest$1, n as CancelOrderResponse$1, gl as UpdateOrderStatusRequest$1, gm as UpdateOrderStatusResponse$1, gM as AggregateOrdersRequest$1, gN as AggregateOrdersResponse$1, gR as BulkUpdateOrderTagsRequest$1, q as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-
|
|
1
|
+
import { dg as PreparePaymentCollectionRequest$1, b as PreparePaymentCollectionResponse$1, dk as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, dl as RecordManuallyCollectedPaymentRequest$1, dm as RecordManuallyCollectedPaymentResponse$1, dn as MarkOrderAsPaidRequest$1, dp as MarkOrderAsPaidResponse$1, dq as BulkMarkOrdersAsPaidRequest$1, dr as BulkMarkOrdersAsPaidResponse$1, dw as GetRefundabilityStatusRequest$1, dx as GetRefundabilityStatusResponse$1, dA as CreatePaymentGatewayOrderRequest$1, dC as CreatePaymentGatewayOrderResponse$1, dD as ChargeMembershipsRequest$1, dH as ChargeMembershipsResponse$1, dI as TriggerRefundRequest$1, dN as TriggerRefundResponse$1, ed as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, ee as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, eB as GetOrderRequest$1, eC as GetOrderResponse$1, eO as SearchOrdersRequest$1, S as SearchOrdersResponse$1, eS as CreateOrderRequest$1, eV as CreateOrderResponse$1, eW as UpdateOrderRequest$1, eX as UpdateOrderResponse$1, eY as BulkUpdateOrdersRequest$1, l as BulkUpdateOrdersResponse$1, eZ as CommitDeltasRequest$1, fd as CommitDeltasResponse$1, fE as UpdateOrderLineItemRequest$1, fF as UpdateOrderLineItemResponse$1, g4 as AddActivityRequest$1, g7 as AddActivityResponse$1, ga as UpdateActivityRequest$1, gb as UpdateActivityResponse$1, gc as DeleteActivityRequest$1, gd as DeleteActivityResponse$1, gj as CancelOrderRequest$1, n as CancelOrderResponse$1, gl as UpdateOrderStatusRequest$1, gm as UpdateOrderStatusResponse$1, gM as AggregateOrdersRequest$1, gN as AggregateOrdersResponse$1, gR as BulkUpdateOrderTagsRequest$1, q as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-CBJ5qQrX.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Order {
|
|
@@ -1395,6 +1395,53 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1395
1395
|
merchantComment?: MerchantComment;
|
|
1396
1396
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1397
1397
|
orderRefunded?: OrderRefunded;
|
|
1398
|
+
/** Details of changes made by the Draft Orders API. */
|
|
1399
|
+
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
1400
|
+
/** Details of the payment method saved for order */
|
|
1401
|
+
savedPaymentMethod?: SavedPaymentMethod;
|
|
1402
|
+
/** Details of an authorized payment created. */
|
|
1403
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
1404
|
+
/** Details of an authorized payment captured. */
|
|
1405
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
1406
|
+
/** Details of an authorized payment voided. */
|
|
1407
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
1408
|
+
/**
|
|
1409
|
+
* Details of an initiated refund process.
|
|
1410
|
+
*
|
|
1411
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1412
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1413
|
+
*/
|
|
1414
|
+
refundInitiated?: RefundInitiated;
|
|
1415
|
+
/**
|
|
1416
|
+
* Details of a refunded payment.
|
|
1417
|
+
*
|
|
1418
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1419
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1420
|
+
*/
|
|
1421
|
+
paymentRefunded?: PaymentRefunded;
|
|
1422
|
+
/**
|
|
1423
|
+
* Details of a failed payment refund.
|
|
1424
|
+
*
|
|
1425
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1426
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1427
|
+
*/
|
|
1428
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1429
|
+
/** Details of refund to store credit. */
|
|
1430
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1431
|
+
/** Details of a pending payment. */
|
|
1432
|
+
paymentPending?: PaymentPending;
|
|
1433
|
+
/** Details of a canceled payment. */
|
|
1434
|
+
paymentCanceled?: PaymentCanceled;
|
|
1435
|
+
/** Details of a declined payment. */
|
|
1436
|
+
paymentDeclined?: PaymentDeclined;
|
|
1437
|
+
/** Receipt was added for associated payment. */
|
|
1438
|
+
receiptCreated?: ReceiptCreated;
|
|
1439
|
+
/** Receipt sent to customer. */
|
|
1440
|
+
receiptSent?: ReceiptSent;
|
|
1441
|
+
/** Order received a chargeback for one of its' payments. */
|
|
1442
|
+
chargebackCreated?: ChargebackCreated;
|
|
1443
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
1444
|
+
chargebackReversed?: ChargebackReversed;
|
|
1398
1445
|
/**
|
|
1399
1446
|
* Activity ID.
|
|
1400
1447
|
* @format GUID
|
|
@@ -1423,6 +1470,53 @@ interface ActivityContentOneOf {
|
|
|
1423
1470
|
merchantComment?: MerchantComment;
|
|
1424
1471
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1425
1472
|
orderRefunded?: OrderRefunded;
|
|
1473
|
+
/** Details of changes made by the Draft Orders API. */
|
|
1474
|
+
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
1475
|
+
/** Details of the payment method saved for order */
|
|
1476
|
+
savedPaymentMethod?: SavedPaymentMethod;
|
|
1477
|
+
/** Details of an authorized payment created. */
|
|
1478
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
1479
|
+
/** Details of an authorized payment captured. */
|
|
1480
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
1481
|
+
/** Details of an authorized payment voided. */
|
|
1482
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
1483
|
+
/**
|
|
1484
|
+
* Details of an initiated refund process.
|
|
1485
|
+
*
|
|
1486
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1487
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1488
|
+
*/
|
|
1489
|
+
refundInitiated?: RefundInitiated;
|
|
1490
|
+
/**
|
|
1491
|
+
* Details of a refunded payment.
|
|
1492
|
+
*
|
|
1493
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1494
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1495
|
+
*/
|
|
1496
|
+
paymentRefunded?: PaymentRefunded;
|
|
1497
|
+
/**
|
|
1498
|
+
* Details of a failed payment refund.
|
|
1499
|
+
*
|
|
1500
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
1501
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
1502
|
+
*/
|
|
1503
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1504
|
+
/** Details of refund to store credit. */
|
|
1505
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1506
|
+
/** Details of a pending payment. */
|
|
1507
|
+
paymentPending?: PaymentPending;
|
|
1508
|
+
/** Details of a canceled payment. */
|
|
1509
|
+
paymentCanceled?: PaymentCanceled;
|
|
1510
|
+
/** Details of a declined payment. */
|
|
1511
|
+
paymentDeclined?: PaymentDeclined;
|
|
1512
|
+
/** Receipt was added for associated payment. */
|
|
1513
|
+
receiptCreated?: ReceiptCreated;
|
|
1514
|
+
/** Receipt sent to customer. */
|
|
1515
|
+
receiptSent?: ReceiptSent;
|
|
1516
|
+
/** Order received a chargeback for one of its' payments. */
|
|
1517
|
+
chargebackCreated?: ChargebackCreated;
|
|
1518
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
1519
|
+
chargebackReversed?: ChargebackReversed;
|
|
1426
1520
|
}
|
|
1427
1521
|
interface CustomActivity {
|
|
1428
1522
|
/**
|
|
@@ -1458,45 +1552,642 @@ interface OrderRefunded {
|
|
|
1458
1552
|
*/
|
|
1459
1553
|
reason?: string;
|
|
1460
1554
|
}
|
|
1555
|
+
interface DraftOrderChangesApplied {
|
|
1556
|
+
/** Draft order id. */
|
|
1557
|
+
draftOrderId?: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* Reason for edit, given by user (optional).
|
|
1560
|
+
* @maxLength 200
|
|
1561
|
+
*/
|
|
1562
|
+
reason?: string | null;
|
|
1563
|
+
/** Changes applied to order. */
|
|
1564
|
+
changes?: OrderChange[];
|
|
1565
|
+
}
|
|
1566
|
+
interface OrderChange extends OrderChangeValueOneOf {
|
|
1567
|
+
lineItemChanged?: LineItemChanges;
|
|
1568
|
+
lineItemAdded?: ManagedLineItem;
|
|
1569
|
+
lineItemRemoved?: ManagedLineItem;
|
|
1570
|
+
discountAdded?: ManagedDiscount;
|
|
1571
|
+
discountRemoved?: ManagedDiscount;
|
|
1572
|
+
additionalFeeAdded?: ManagedAdditionalFee;
|
|
1573
|
+
additionalFeeRemoved?: ManagedAdditionalFee;
|
|
1574
|
+
totalPriceChanged?: TotalPriceChange;
|
|
1575
|
+
shippingInformationChanged?: ShippingInformationChange;
|
|
1576
|
+
}
|
|
1577
|
+
/** @oneof */
|
|
1578
|
+
interface OrderChangeValueOneOf {
|
|
1579
|
+
lineItemChanged?: LineItemChanges;
|
|
1580
|
+
lineItemAdded?: ManagedLineItem;
|
|
1581
|
+
lineItemRemoved?: ManagedLineItem;
|
|
1582
|
+
discountAdded?: ManagedDiscount;
|
|
1583
|
+
discountRemoved?: ManagedDiscount;
|
|
1584
|
+
additionalFeeAdded?: ManagedAdditionalFee;
|
|
1585
|
+
additionalFeeRemoved?: ManagedAdditionalFee;
|
|
1586
|
+
totalPriceChanged?: TotalPriceChange;
|
|
1587
|
+
shippingInformationChanged?: ShippingInformationChange;
|
|
1588
|
+
}
|
|
1589
|
+
interface LineItemChanges {
|
|
1590
|
+
/**
|
|
1591
|
+
* Line item ID.
|
|
1592
|
+
* @format GUID
|
|
1593
|
+
*/
|
|
1594
|
+
id?: string;
|
|
1595
|
+
/** Item name. */
|
|
1596
|
+
name?: ProductName;
|
|
1597
|
+
/** Item quantity change. */
|
|
1598
|
+
quantity?: LineItemQuantityChange;
|
|
1599
|
+
/** Item price change. */
|
|
1600
|
+
price?: LineItemPriceChange;
|
|
1601
|
+
}
|
|
1602
|
+
interface LineItemQuantityChange {
|
|
1603
|
+
/**
|
|
1604
|
+
* Item quantity before update.
|
|
1605
|
+
* @max 1000000
|
|
1606
|
+
*/
|
|
1607
|
+
originalQuantity?: number;
|
|
1608
|
+
/**
|
|
1609
|
+
* Item quantity after update.
|
|
1610
|
+
* @max 1000000
|
|
1611
|
+
*/
|
|
1612
|
+
newQuantity?: number;
|
|
1613
|
+
/**
|
|
1614
|
+
* Difference between original and new quantity. Absolute value.
|
|
1615
|
+
* @min 1
|
|
1616
|
+
* @max 1000000
|
|
1617
|
+
*/
|
|
1618
|
+
diff?: number;
|
|
1619
|
+
/** Type of quantity change: increase or decrease. */
|
|
1620
|
+
deltaType?: LineItemQuantityChangeTypeWithLiterals;
|
|
1621
|
+
}
|
|
1622
|
+
declare enum LineItemQuantityChangeType {
|
|
1623
|
+
/** Quantity increased. */
|
|
1624
|
+
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
1625
|
+
/** Quantity decreased. */
|
|
1626
|
+
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
1627
|
+
}
|
|
1628
|
+
/** @enumType */
|
|
1629
|
+
type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
|
|
1630
|
+
interface LineItemPriceChange {
|
|
1631
|
+
/** Item price before update. */
|
|
1632
|
+
originalPrice?: Price;
|
|
1633
|
+
/** Item price after update. */
|
|
1634
|
+
newPrice?: Price;
|
|
1635
|
+
}
|
|
1636
|
+
interface ManagedLineItem {
|
|
1637
|
+
/**
|
|
1638
|
+
* Line item ID.
|
|
1639
|
+
* @format GUID
|
|
1640
|
+
*/
|
|
1641
|
+
id?: string;
|
|
1642
|
+
/** Item name. */
|
|
1643
|
+
name?: ProductName;
|
|
1644
|
+
/**
|
|
1645
|
+
* Added or removed item quantity.
|
|
1646
|
+
* @min 1
|
|
1647
|
+
* @max 1000000
|
|
1648
|
+
*/
|
|
1649
|
+
quantity?: number;
|
|
1650
|
+
}
|
|
1651
|
+
interface ManagedDiscount {
|
|
1652
|
+
/**
|
|
1653
|
+
* Discount id.
|
|
1654
|
+
* @format GUID
|
|
1655
|
+
*/
|
|
1656
|
+
id?: string;
|
|
1657
|
+
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
1658
|
+
name?: TranslatedValue;
|
|
1659
|
+
/** Line items discount applies to. */
|
|
1660
|
+
affectedLineItems?: LineItemAmount[];
|
|
1661
|
+
/** Discount amount. */
|
|
1662
|
+
totalAmount?: Price;
|
|
1663
|
+
}
|
|
1664
|
+
interface TranslatedValue {
|
|
1665
|
+
/**
|
|
1666
|
+
* Value in site default language.
|
|
1667
|
+
* @minLength 1
|
|
1668
|
+
*/
|
|
1669
|
+
original?: string;
|
|
1670
|
+
/**
|
|
1671
|
+
* Translated value.
|
|
1672
|
+
* @minLength 1
|
|
1673
|
+
*/
|
|
1674
|
+
translated?: string | null;
|
|
1675
|
+
}
|
|
1676
|
+
interface LineItemAmount {
|
|
1677
|
+
/**
|
|
1678
|
+
* Order line item id
|
|
1679
|
+
* @format GUID
|
|
1680
|
+
*/
|
|
1681
|
+
id?: string;
|
|
1682
|
+
/** Item name. */
|
|
1683
|
+
name?: ProductName;
|
|
1684
|
+
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
1685
|
+
amount?: Price;
|
|
1686
|
+
}
|
|
1687
|
+
interface ManagedAdditionalFee {
|
|
1688
|
+
/**
|
|
1689
|
+
* Additional fee id.
|
|
1690
|
+
* @format GUID
|
|
1691
|
+
*/
|
|
1692
|
+
id?: string;
|
|
1693
|
+
/** Additional fee name. */
|
|
1694
|
+
name?: TranslatedValue;
|
|
1695
|
+
/** Line items additional fee applies to. */
|
|
1696
|
+
affectedLineItems?: LineItemAmount[];
|
|
1697
|
+
/** Additional fee amount. */
|
|
1698
|
+
totalAmount?: Price;
|
|
1699
|
+
}
|
|
1700
|
+
interface TotalPriceChange {
|
|
1701
|
+
/** Order’s total price after discounts and tax. Before update */
|
|
1702
|
+
originalTotal?: Price;
|
|
1703
|
+
/** Order’s total price after discounts and tax. After update */
|
|
1704
|
+
newTotal?: Price;
|
|
1705
|
+
}
|
|
1706
|
+
interface ShippingInformationChange {
|
|
1707
|
+
/** Order’s Shipping Information. Before update */
|
|
1708
|
+
originalShippingInfo?: ShippingInformation;
|
|
1709
|
+
/** Order’s Shipping Information. After update */
|
|
1710
|
+
newShippingInfo?: ShippingInformation;
|
|
1711
|
+
}
|
|
1712
|
+
interface ShippingInformation {
|
|
1713
|
+
/** Order’s shipping price. */
|
|
1714
|
+
total?: Price;
|
|
1715
|
+
/**
|
|
1716
|
+
* Order’s shipping title.
|
|
1717
|
+
* @maxLength 250
|
|
1718
|
+
*/
|
|
1719
|
+
shippingTitle?: string;
|
|
1720
|
+
}
|
|
1721
|
+
/** Payment method is saved for order */
|
|
1722
|
+
interface SavedPaymentMethod {
|
|
1723
|
+
/**
|
|
1724
|
+
* Payment method name
|
|
1725
|
+
* @minLength 1
|
|
1726
|
+
* @maxLength 100
|
|
1727
|
+
*/
|
|
1728
|
+
name?: string;
|
|
1729
|
+
/**
|
|
1730
|
+
* Payment method description
|
|
1731
|
+
* @minLength 1
|
|
1732
|
+
* @maxLength 100
|
|
1733
|
+
*/
|
|
1734
|
+
description?: string | null;
|
|
1735
|
+
}
|
|
1736
|
+
interface AuthorizedPaymentCreated {
|
|
1737
|
+
/**
|
|
1738
|
+
* Payment ID of payment associated with this activity
|
|
1739
|
+
* @format GUID
|
|
1740
|
+
*/
|
|
1741
|
+
paymentId?: string;
|
|
1742
|
+
/** Payment amount */
|
|
1743
|
+
amount?: Price;
|
|
1744
|
+
/**
|
|
1745
|
+
* The last 4 digits of the card number.
|
|
1746
|
+
* @maxLength 4
|
|
1747
|
+
*/
|
|
1748
|
+
lastFourDigits?: string | null;
|
|
1749
|
+
/**
|
|
1750
|
+
* Card issuer's brand.
|
|
1751
|
+
* @maxLength 100
|
|
1752
|
+
*/
|
|
1753
|
+
brand?: string | null;
|
|
1754
|
+
}
|
|
1755
|
+
interface AuthorizedPaymentCaptured {
|
|
1756
|
+
/**
|
|
1757
|
+
* Payment ID of payment associated with this activity
|
|
1758
|
+
* @format GUID
|
|
1759
|
+
*/
|
|
1760
|
+
paymentId?: string;
|
|
1761
|
+
/** Payment amount */
|
|
1762
|
+
amount?: Price;
|
|
1763
|
+
/**
|
|
1764
|
+
* The last 4 digits of the card number.
|
|
1765
|
+
* @maxLength 4
|
|
1766
|
+
*/
|
|
1767
|
+
lastFourDigits?: string | null;
|
|
1768
|
+
/**
|
|
1769
|
+
* Card issuer's brand.
|
|
1770
|
+
* @maxLength 100
|
|
1771
|
+
*/
|
|
1772
|
+
brand?: string | null;
|
|
1773
|
+
}
|
|
1774
|
+
interface AuthorizedPaymentVoided {
|
|
1775
|
+
/**
|
|
1776
|
+
* Payment ID of payment associated with this activity
|
|
1777
|
+
* @format GUID
|
|
1778
|
+
*/
|
|
1779
|
+
paymentId?: string;
|
|
1780
|
+
/** Payment amount */
|
|
1781
|
+
amount?: Price;
|
|
1782
|
+
/**
|
|
1783
|
+
* The last 4 digits of the card number.
|
|
1784
|
+
* @maxLength 4
|
|
1785
|
+
*/
|
|
1786
|
+
lastFourDigits?: string | null;
|
|
1787
|
+
/**
|
|
1788
|
+
* Card issuer's brand.
|
|
1789
|
+
* @maxLength 100
|
|
1790
|
+
*/
|
|
1791
|
+
brand?: string | null;
|
|
1792
|
+
}
|
|
1793
|
+
interface RefundInitiated {
|
|
1794
|
+
/**
|
|
1795
|
+
* Refund ID.
|
|
1796
|
+
* @format GUID
|
|
1797
|
+
*/
|
|
1798
|
+
refundId?: string;
|
|
1799
|
+
/** Refund amount. */
|
|
1800
|
+
amount?: Price;
|
|
1801
|
+
/**
|
|
1802
|
+
* Details about the payments being refunded.
|
|
1803
|
+
* @minSize 1
|
|
1804
|
+
* @maxSize 50
|
|
1805
|
+
*/
|
|
1806
|
+
payments?: RefundedPayment[];
|
|
1807
|
+
/**
|
|
1808
|
+
* Reason for refund.
|
|
1809
|
+
* @maxLength 200
|
|
1810
|
+
*/
|
|
1811
|
+
reason?: string | null;
|
|
1812
|
+
}
|
|
1813
|
+
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
1814
|
+
/** Regular payment refund. */
|
|
1815
|
+
regular?: RegularPaymentRefund;
|
|
1816
|
+
/** Gift card payment refund. */
|
|
1817
|
+
giftCard?: GiftCardPaymentRefund;
|
|
1818
|
+
/** Membership payment refund. */
|
|
1819
|
+
membership?: MembershipPaymentRefund;
|
|
1820
|
+
/**
|
|
1821
|
+
* Payment ID.
|
|
1822
|
+
* @format GUID
|
|
1823
|
+
*/
|
|
1824
|
+
paymentId?: string;
|
|
1825
|
+
/** Whether refund was made externally and manually on the payment provider's side. */
|
|
1826
|
+
externalRefund?: boolean;
|
|
1827
|
+
}
|
|
1828
|
+
/** @oneof */
|
|
1829
|
+
interface RefundedPaymentKindOneOf {
|
|
1830
|
+
/** Regular payment refund. */
|
|
1831
|
+
regular?: RegularPaymentRefund;
|
|
1832
|
+
/** Gift card payment refund. */
|
|
1833
|
+
giftCard?: GiftCardPaymentRefund;
|
|
1834
|
+
/** Membership payment refund. */
|
|
1835
|
+
membership?: MembershipPaymentRefund;
|
|
1836
|
+
}
|
|
1837
|
+
interface RegularPaymentRefund {
|
|
1838
|
+
/** Refund amount */
|
|
1839
|
+
amount?: Price;
|
|
1840
|
+
/**
|
|
1841
|
+
* The last 4 digits of the card number.
|
|
1842
|
+
* @maxLength 4
|
|
1843
|
+
*/
|
|
1844
|
+
lastFourDigits?: string | null;
|
|
1845
|
+
/**
|
|
1846
|
+
* Card issuer's brand.
|
|
1847
|
+
* @maxLength 100
|
|
1848
|
+
*/
|
|
1849
|
+
brand?: string | null;
|
|
1850
|
+
}
|
|
1851
|
+
interface GiftCardPaymentRefund {
|
|
1852
|
+
/**
|
|
1853
|
+
* Gift card payment ID
|
|
1854
|
+
* @minLength 1
|
|
1855
|
+
* @maxLength 100
|
|
1856
|
+
*/
|
|
1857
|
+
giftCardPaymentId?: string | null;
|
|
1858
|
+
/** Refund amount */
|
|
1859
|
+
amount?: Price;
|
|
1860
|
+
}
|
|
1861
|
+
interface MembershipPaymentRefund {
|
|
1862
|
+
/**
|
|
1863
|
+
* Membership ID
|
|
1864
|
+
* @minLength 1
|
|
1865
|
+
* @maxLength 100
|
|
1866
|
+
*/
|
|
1867
|
+
membershipId?: string | null;
|
|
1868
|
+
}
|
|
1869
|
+
interface PaymentRefunded {
|
|
1870
|
+
/**
|
|
1871
|
+
* Refund ID.
|
|
1872
|
+
* @format GUID
|
|
1873
|
+
*/
|
|
1874
|
+
refundId?: string;
|
|
1875
|
+
/** Details about the refunded payment. */
|
|
1876
|
+
payment?: RefundedPayment;
|
|
1877
|
+
}
|
|
1878
|
+
interface PaymentRefundFailed {
|
|
1879
|
+
/**
|
|
1880
|
+
* Refund ID.
|
|
1881
|
+
* @format GUID
|
|
1882
|
+
*/
|
|
1883
|
+
refundId?: string;
|
|
1884
|
+
/** Details about the failed payment refund. */
|
|
1885
|
+
payment?: RefundedPayment;
|
|
1886
|
+
}
|
|
1887
|
+
interface RefundedAsStoreCredit {
|
|
1888
|
+
/** Refund amount */
|
|
1889
|
+
amount?: Price;
|
|
1890
|
+
/**
|
|
1891
|
+
* Reason for refund
|
|
1892
|
+
* @maxLength 100
|
|
1893
|
+
*/
|
|
1894
|
+
reason?: string | null;
|
|
1895
|
+
}
|
|
1896
|
+
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
1897
|
+
/** Regular payment. */
|
|
1898
|
+
regular?: RegularPayment;
|
|
1899
|
+
/**
|
|
1900
|
+
* Payment ID of payment associated with this activity
|
|
1901
|
+
* @format GUID
|
|
1902
|
+
*/
|
|
1903
|
+
paymentId?: string;
|
|
1904
|
+
}
|
|
1905
|
+
/** @oneof */
|
|
1906
|
+
interface PaymentPendingPaymentDetailsOneOf {
|
|
1907
|
+
/** Regular payment. */
|
|
1908
|
+
regular?: RegularPayment;
|
|
1909
|
+
}
|
|
1910
|
+
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
1911
|
+
/** Whether regular card used */
|
|
1912
|
+
creditCardDetails?: CreditCardDetails;
|
|
1913
|
+
/** Payment amount */
|
|
1914
|
+
amount?: Price;
|
|
1915
|
+
}
|
|
1916
|
+
/** @oneof */
|
|
1917
|
+
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
1918
|
+
/** Whether regular card used */
|
|
1919
|
+
creditCardDetails?: CreditCardDetails;
|
|
1920
|
+
}
|
|
1921
|
+
interface CreditCardDetails {
|
|
1922
|
+
/**
|
|
1923
|
+
* The last 4 digits of the card number.
|
|
1924
|
+
* @maxLength 4
|
|
1925
|
+
*/
|
|
1926
|
+
lastFourDigits?: string | null;
|
|
1927
|
+
/**
|
|
1928
|
+
* Card issuer's brand.
|
|
1929
|
+
* @maxLength 100
|
|
1930
|
+
*/
|
|
1931
|
+
brand?: string | null;
|
|
1932
|
+
}
|
|
1933
|
+
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
1934
|
+
/** Regular payment. */
|
|
1935
|
+
regular?: RegularPayment;
|
|
1936
|
+
/**
|
|
1937
|
+
* Payment ID of payment associated with this activity
|
|
1938
|
+
* @format GUID
|
|
1939
|
+
*/
|
|
1940
|
+
paymentId?: string;
|
|
1941
|
+
}
|
|
1942
|
+
/** @oneof */
|
|
1943
|
+
interface PaymentCanceledPaymentDetailsOneOf {
|
|
1944
|
+
/** Regular payment. */
|
|
1945
|
+
regular?: RegularPayment;
|
|
1946
|
+
}
|
|
1947
|
+
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
1948
|
+
/** Regular payment. */
|
|
1949
|
+
regular?: RegularPayment;
|
|
1950
|
+
/**
|
|
1951
|
+
* Payment ID of payment associated with this activity
|
|
1952
|
+
* @format GUID
|
|
1953
|
+
*/
|
|
1954
|
+
paymentId?: string;
|
|
1955
|
+
}
|
|
1956
|
+
/** @oneof */
|
|
1957
|
+
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
1958
|
+
/** Regular payment. */
|
|
1959
|
+
regular?: RegularPayment;
|
|
1960
|
+
}
|
|
1961
|
+
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
1962
|
+
/** Receipt created by Wix */
|
|
1963
|
+
wixReceipt?: WixReceipt;
|
|
1964
|
+
/** Receipt created by an external system. */
|
|
1965
|
+
externalReceipt?: ExternalReceipt;
|
|
1966
|
+
/**
|
|
1967
|
+
* Payment ID of payment associated with this activity
|
|
1968
|
+
* @format GUID
|
|
1969
|
+
*/
|
|
1970
|
+
paymentId?: string;
|
|
1971
|
+
}
|
|
1972
|
+
/** @oneof */
|
|
1973
|
+
interface ReceiptCreatedReceiptInfoOneOf {
|
|
1974
|
+
/** Receipt created by Wix */
|
|
1975
|
+
wixReceipt?: WixReceipt;
|
|
1976
|
+
/** Receipt created by an external system. */
|
|
1977
|
+
externalReceipt?: ExternalReceipt;
|
|
1978
|
+
}
|
|
1979
|
+
interface WixReceipt {
|
|
1980
|
+
/**
|
|
1981
|
+
* Receipt ID
|
|
1982
|
+
* @format GUID
|
|
1983
|
+
*/
|
|
1984
|
+
receiptId?: string;
|
|
1985
|
+
/**
|
|
1986
|
+
* Display number of receipt
|
|
1987
|
+
* @minLength 1
|
|
1988
|
+
* @maxLength 40
|
|
1989
|
+
*/
|
|
1990
|
+
displayNumber?: string | null;
|
|
1991
|
+
}
|
|
1992
|
+
interface ExternalReceipt {
|
|
1993
|
+
/**
|
|
1994
|
+
* Receipt ID
|
|
1995
|
+
* @maxLength 100
|
|
1996
|
+
*/
|
|
1997
|
+
receiptId?: string | null;
|
|
1998
|
+
/**
|
|
1999
|
+
* Display number of receipt
|
|
2000
|
+
* @minLength 1
|
|
2001
|
+
* @maxLength 40
|
|
2002
|
+
*/
|
|
2003
|
+
displayNumber?: string | null;
|
|
2004
|
+
}
|
|
2005
|
+
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
2006
|
+
/** Receipt created by Wix */
|
|
2007
|
+
wixReceipt?: WixReceipt;
|
|
2008
|
+
/** Receipt created by an external system. */
|
|
2009
|
+
externalReceipt?: ExternalReceipt;
|
|
2010
|
+
/**
|
|
2011
|
+
* Payment ID of payment associated with this activity
|
|
2012
|
+
* @format GUID
|
|
2013
|
+
*/
|
|
2014
|
+
paymentId?: string;
|
|
2015
|
+
}
|
|
2016
|
+
/** @oneof */
|
|
2017
|
+
interface ReceiptSentReceiptInfoOneOf {
|
|
2018
|
+
/** Receipt created by Wix */
|
|
2019
|
+
wixReceipt?: WixReceipt;
|
|
2020
|
+
/** Receipt created by an external system. */
|
|
2021
|
+
externalReceipt?: ExternalReceipt;
|
|
2022
|
+
}
|
|
2023
|
+
interface ChargebackCreated {
|
|
2024
|
+
/**
|
|
2025
|
+
* ID of the payment that received a chargeback.
|
|
2026
|
+
* @format GUID
|
|
2027
|
+
*/
|
|
2028
|
+
paymentId?: string;
|
|
2029
|
+
/**
|
|
2030
|
+
* Chargeback ID.
|
|
2031
|
+
* @format GUID
|
|
2032
|
+
*/
|
|
2033
|
+
chargebackId?: string;
|
|
2034
|
+
/** Chargeback amount. */
|
|
2035
|
+
amount?: Price;
|
|
2036
|
+
/** Payment details. */
|
|
2037
|
+
paymentDetails?: RegularPayment;
|
|
2038
|
+
}
|
|
2039
|
+
interface ChargebackReversed {
|
|
2040
|
+
/**
|
|
2041
|
+
* ID of the payment involved with the chargeback.
|
|
2042
|
+
* @format GUID
|
|
2043
|
+
*/
|
|
2044
|
+
paymentId?: string;
|
|
2045
|
+
/**
|
|
2046
|
+
* Chargeback ID.
|
|
2047
|
+
* @format GUID
|
|
2048
|
+
*/
|
|
2049
|
+
chargebackId?: string;
|
|
2050
|
+
/** Chargeback amount. */
|
|
2051
|
+
amount?: Price;
|
|
2052
|
+
/** Chargeback reversal amount. */
|
|
2053
|
+
reversalAmount?: Price;
|
|
2054
|
+
/** Payment details. */
|
|
2055
|
+
paymentDetails?: RegularPayment;
|
|
2056
|
+
}
|
|
1461
2057
|
declare enum ActivityType {
|
|
2058
|
+
/** Order was refunded, either partially or fully. */
|
|
1462
2059
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
2060
|
+
/** New order was created and placed. */
|
|
1463
2061
|
ORDER_PLACED = "ORDER_PLACED",
|
|
2062
|
+
/** Order payment was completed and confirmed. */
|
|
1464
2063
|
ORDER_PAID = "ORDER_PAID",
|
|
2064
|
+
/** Order items were marked as fulfilled (shipped or ready for pickup). */
|
|
1465
2065
|
ORDER_FULFILLED = "ORDER_FULFILLED",
|
|
2066
|
+
/** Order fulfillment status was changed to not fulfilled. */
|
|
1466
2067
|
ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
|
|
2068
|
+
/** Order was canceled by merchant or customer. */
|
|
1467
2069
|
ORDER_CANCELED = "ORDER_CANCELED",
|
|
2070
|
+
/** Download link was sent for digital items in the order. */
|
|
1468
2071
|
DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
|
|
2072
|
+
/** Shipping tracking number was added to the order. */
|
|
1469
2073
|
TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
|
|
2074
|
+
/** Existing shipping tracking number was modified. */
|
|
1470
2075
|
TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
|
|
2076
|
+
/** Tracking link for shipment was added to the order. */
|
|
1471
2077
|
TRACKING_LINK_ADDED = "TRACKING_LINK_ADDED",
|
|
2078
|
+
/** Email confirming shipment was sent to the customer. */
|
|
1472
2079
|
SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
|
|
2080
|
+
/** Invoice document was added to the order. */
|
|
1473
2081
|
INVOICE_ADDED = "INVOICE_ADDED",
|
|
2082
|
+
/** Invoice was removed from the order. */
|
|
1474
2083
|
INVOICE_REMOVED = "INVOICE_REMOVED",
|
|
2084
|
+
/** Invoice was sent to the customer via email. */
|
|
1475
2085
|
INVOICE_SENT = "INVOICE_SENT",
|
|
2086
|
+
/** Notification email was sent to the order fulfiller. */
|
|
1476
2087
|
FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
|
|
2088
|
+
/** Order's shipping address was modified. */
|
|
1477
2089
|
SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
|
|
2090
|
+
/** Order's contact email address was changed. */
|
|
1478
2091
|
EMAIL_EDITED = "EMAIL_EDITED",
|
|
2092
|
+
/** Email notification for pickup readiness was sent. */
|
|
1479
2093
|
PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
|
|
2094
|
+
/** Custom activity created by a third-party application. */
|
|
1480
2095
|
CUSTOM_ACTIVITY = "CUSTOM_ACTIVITY",
|
|
2096
|
+
/** Comment added to the order by a merchant. */
|
|
1481
2097
|
MERCHANT_COMMENT = "MERCHANT_COMMENT",
|
|
2098
|
+
/** Order was created as a result of an exchange. */
|
|
1482
2099
|
ORDER_CREATED_FROM_EXCHANGE = "ORDER_CREATED_FROM_EXCHANGE",
|
|
2100
|
+
/** New exchange order was created from this order. */
|
|
1483
2101
|
NEW_EXCHANGE_ORDER_CREATED = "NEW_EXCHANGE_ORDER_CREATED",
|
|
2102
|
+
/** Partial payment was received for the order. */
|
|
1484
2103
|
ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID",
|
|
2104
|
+
/** Changes were applied to a draft order. */
|
|
1485
2105
|
DRAFT_ORDER_CHANGES_APPLIED = "DRAFT_ORDER_CHANGES_APPLIED",
|
|
2106
|
+
/** Payment method was saved for future use. */
|
|
1486
2107
|
SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
|
|
1487
|
-
/**
|
|
2108
|
+
/**
|
|
2109
|
+
* Payment was authorized but not yet captured.
|
|
2110
|
+
* @documentationMaturity preview
|
|
2111
|
+
*/
|
|
2112
|
+
AUTHORIZED_PAYMENT_CREATED = "AUTHORIZED_PAYMENT_CREATED",
|
|
2113
|
+
/**
|
|
2114
|
+
* Previously authorized payment was captured.
|
|
2115
|
+
* @documentationMaturity preview
|
|
2116
|
+
*/
|
|
2117
|
+
AUTHORIZED_PAYMENT_CAPTURED = "AUTHORIZED_PAYMENT_CAPTURED",
|
|
2118
|
+
/**
|
|
2119
|
+
* Previously authorized payment was voided.
|
|
2120
|
+
* @documentationMaturity preview
|
|
2121
|
+
*/
|
|
2122
|
+
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED",
|
|
2123
|
+
/**
|
|
2124
|
+
* Refund process was initiated.
|
|
2125
|
+
* @documentationMaturity preview
|
|
2126
|
+
*/
|
|
2127
|
+
REFUND_INITIATED = "REFUND_INITIATED",
|
|
2128
|
+
/**
|
|
2129
|
+
* Payment was successfully refunded.
|
|
2130
|
+
* @documentationMaturity preview
|
|
2131
|
+
*/
|
|
2132
|
+
PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
|
|
2133
|
+
/**
|
|
2134
|
+
* Attempt to refund payment failed.
|
|
2135
|
+
* @documentationMaturity preview
|
|
2136
|
+
*/
|
|
2137
|
+
PAYMENT_REFUND_FAILED = "PAYMENT_REFUND_FAILED",
|
|
2138
|
+
/**
|
|
2139
|
+
* Refund was issued as store credit.
|
|
2140
|
+
* @documentationMaturity preview
|
|
2141
|
+
*/
|
|
2142
|
+
REFUNDED_AS_STORE_CREDIT = "REFUNDED_AS_STORE_CREDIT",
|
|
2143
|
+
/**
|
|
2144
|
+
* Payment is awaiting processing or confirmation.
|
|
2145
|
+
* @documentationMaturity preview
|
|
2146
|
+
*/
|
|
1488
2147
|
PAYMENT_PENDING = "PAYMENT_PENDING",
|
|
1489
|
-
/**
|
|
2148
|
+
/**
|
|
2149
|
+
* Payment was canceled before completion.
|
|
2150
|
+
* @documentationMaturity preview
|
|
2151
|
+
*/
|
|
1490
2152
|
PAYMENT_CANCELED = "PAYMENT_CANCELED",
|
|
1491
|
-
/**
|
|
2153
|
+
/**
|
|
2154
|
+
* Payment was declined by payment provider.
|
|
2155
|
+
* @documentationMaturity preview
|
|
2156
|
+
*/
|
|
1492
2157
|
PAYMENT_DECLINED = "PAYMENT_DECLINED",
|
|
1493
|
-
/**
|
|
2158
|
+
/**
|
|
2159
|
+
* Order is awaiting approval or processing.
|
|
2160
|
+
* @documentationMaturity preview
|
|
2161
|
+
*/
|
|
1494
2162
|
ORDER_PENDING = "ORDER_PENDING",
|
|
1495
|
-
/**
|
|
1496
|
-
|
|
2163
|
+
/**
|
|
2164
|
+
* Order was rejected by merchant.
|
|
2165
|
+
* @documentationMaturity preview
|
|
2166
|
+
*/
|
|
2167
|
+
ORDER_REJECTED = "ORDER_REJECTED",
|
|
2168
|
+
/**
|
|
2169
|
+
* Receipt was generated for a payment.
|
|
2170
|
+
* @documentationMaturity preview
|
|
2171
|
+
*/
|
|
2172
|
+
RECEIPT_CREATED = "RECEIPT_CREATED",
|
|
2173
|
+
/**
|
|
2174
|
+
* Receipt was sent to the customer.
|
|
2175
|
+
* @documentationMaturity preview
|
|
2176
|
+
*/
|
|
2177
|
+
RECEIPT_SENT = "RECEIPT_SENT",
|
|
2178
|
+
/**
|
|
2179
|
+
* Chargeback was created for one of the order's payments.
|
|
2180
|
+
* @documentationMaturity preview
|
|
2181
|
+
*/
|
|
2182
|
+
CHARGEBACK_CREATED = "CHARGEBACK_CREATED",
|
|
2183
|
+
/**
|
|
2184
|
+
* Chargeback was resolved in merchant's favor.
|
|
2185
|
+
* @documentationMaturity preview
|
|
2186
|
+
*/
|
|
2187
|
+
CHARGEBACK_REVERSED = "CHARGEBACK_REVERSED"
|
|
1497
2188
|
}
|
|
1498
2189
|
/** @enumType */
|
|
1499
|
-
type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
|
|
2190
|
+
type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'AUTHORIZED_PAYMENT_CREATED' | 'AUTHORIZED_PAYMENT_CAPTURED' | 'AUTHORIZED_PAYMENT_VOIDED' | 'REFUND_INITIATED' | 'PAYMENT_REFUNDED' | 'PAYMENT_REFUND_FAILED' | 'REFUNDED_AS_STORE_CREDIT' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED' | 'RECEIPT_CREATED' | 'RECEIPT_SENT' | 'CHARGEBACK_CREATED' | 'CHARGEBACK_REVERSED';
|
|
1500
2191
|
declare enum AttributionSource {
|
|
1501
2192
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1502
2193
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
@@ -1641,11 +2332,26 @@ interface BalanceSummary {
|
|
|
1641
2332
|
* @readonly
|
|
1642
2333
|
*/
|
|
1643
2334
|
authorized?: Price;
|
|
2335
|
+
/**
|
|
2336
|
+
* Sum of all pending refund transactions.
|
|
2337
|
+
* @readonly
|
|
2338
|
+
*/
|
|
2339
|
+
pendingRefund?: Price;
|
|
1644
2340
|
/**
|
|
1645
2341
|
* Sum of all pending transactions.
|
|
1646
2342
|
* @readonly
|
|
1647
2343
|
*/
|
|
1648
2344
|
pending?: Price;
|
|
2345
|
+
/**
|
|
2346
|
+
* Sum of all transaction chargebacks.
|
|
2347
|
+
* @readonly
|
|
2348
|
+
*/
|
|
2349
|
+
chargeback?: Price;
|
|
2350
|
+
/**
|
|
2351
|
+
* Sum of all chargeback reversals.
|
|
2352
|
+
* @readonly
|
|
2353
|
+
*/
|
|
2354
|
+
chargebackReversal?: Price;
|
|
1649
2355
|
}
|
|
1650
2356
|
/**
|
|
1651
2357
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|