@wix/auto_sdk_ecom_orders 1.0.70 → 1.0.71
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-KCtJReRk.d.ts → cjs/ecom-v1-order-orders.universal-B51dgVhk.d.ts} +223 -2226
- package/build/cjs/index.d.ts +3 -56
- package/build/cjs/index.js +311 -1338
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +112 -1039
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +38 -1006
- package/build/cjs/meta.js +2 -637
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/es/ecom-v1-order-orders.universal-KCtJReRk.d.mts → es/ecom-v1-order-orders.universal-B51dgVhk.d.mts} +223 -2226
- package/build/es/index.d.mts +3 -56
- package/build/es/index.mjs +310 -1311
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +111 -1012
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +38 -1006
- package/build/es/meta.mjs +1 -625
- package/build/es/meta.mjs.map +1 -1
- package/build/{cjs/ecom-v1-order-orders.universal-C73TYoI7.d.ts → internal/cjs/ecom-v1-order-orders.universal-BuGgtT93.d.ts} +725 -1537
- package/build/internal/cjs/index.d.ts +3 -162
- package/build/internal/cjs/index.js +311 -1338
- 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 +112 -1039
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +38 -1006
- package/build/internal/cjs/meta.js +2 -637
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/ecom-v1-order-orders.universal-C73TYoI7.d.mts → internal/es/ecom-v1-order-orders.universal-BuGgtT93.d.mts} +725 -1537
- package/build/internal/es/index.d.mts +3 -162
- package/build/internal/es/index.mjs +310 -1311
- 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 +111 -1012
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +38 -1006
- package/build/internal/es/meta.mjs +1 -625
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/es/meta.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { cw as GetOrderRequest$1, cx as GetOrderResponse$1, cJ as SearchOrdersRequest$1, S as SearchOrdersResponse$1, cN as CreateOrderRequest$1, cQ as CreateOrderResponse$1, cR as UpdateOrderRequest$1, cS as UpdateOrderResponse$1, cT as BulkUpdateOrdersRequest$1, d as BulkUpdateOrdersResponse$1, cY as CommitDeltasRequest$1, dc as CommitDeltasResponse$1, dE as UpdateOrderLineItemRequest$1, dF as UpdateOrderLineItemResponse$1, e4 as AddActivityRequest$1, e7 as AddActivityResponse$1, ea as UpdateActivityRequest$1, eb as UpdateActivityResponse$1, ec as DeleteActivityRequest$1, ed as DeleteActivityResponse$1, ej as CancelOrderRequest$1, f as CancelOrderResponse$1, el as UpdateOrderStatusRequest$1, em as UpdateOrderStatusResponse$1, eM as AggregateOrdersRequest$1, eN as AggregateOrdersResponse$1, eR as BulkUpdateOrderTagsRequest$1, i as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-B51dgVhk.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Order {
|
|
@@ -1692,979 +1692,6 @@ interface Location {
|
|
|
1692
1692
|
*/
|
|
1693
1693
|
name?: string;
|
|
1694
1694
|
}
|
|
1695
|
-
interface PreparePaymentCollectionRequest {
|
|
1696
|
-
/**
|
|
1697
|
-
* Ecom order ID.
|
|
1698
|
-
* @minLength 1
|
|
1699
|
-
* @maxLength 100
|
|
1700
|
-
*/
|
|
1701
|
-
ecomOrderId: string;
|
|
1702
|
-
/** Amount to collect */
|
|
1703
|
-
amount: Price;
|
|
1704
|
-
/**
|
|
1705
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
1706
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
1707
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
1708
|
-
*/
|
|
1709
|
-
paymentGatewayOrderId?: string | null;
|
|
1710
|
-
/**
|
|
1711
|
-
* Whether to delay capture of the payment.
|
|
1712
|
-
* Default: false
|
|
1713
|
-
* @deprecated Whether to delay capture of the payment.
|
|
1714
|
-
* Default: false
|
|
1715
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
1716
|
-
* @targetRemovalDate 2024-09-30
|
|
1717
|
-
*/
|
|
1718
|
-
delayedCapture?: boolean;
|
|
1719
|
-
/** Delayed capture payment settings */
|
|
1720
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
1721
|
-
}
|
|
1722
|
-
interface DelayedCaptureSettings {
|
|
1723
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
1724
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
1725
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
1726
|
-
delayDuration?: Duration;
|
|
1727
|
-
}
|
|
1728
|
-
declare enum ScheduledAction {
|
|
1729
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
1730
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
1731
|
-
VOID = "VOID",
|
|
1732
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
1733
|
-
CAPTURE = "CAPTURE"
|
|
1734
|
-
}
|
|
1735
|
-
/** @enumType */
|
|
1736
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
|
|
1737
|
-
interface Duration {
|
|
1738
|
-
/**
|
|
1739
|
-
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
1740
|
-
* @min 1
|
|
1741
|
-
*/
|
|
1742
|
-
count?: number;
|
|
1743
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
1744
|
-
unit?: DurationUnitWithLiterals;
|
|
1745
|
-
}
|
|
1746
|
-
declare enum DurationUnit {
|
|
1747
|
-
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
1748
|
-
MINUTES = "MINUTES",
|
|
1749
|
-
HOURS = "HOURS",
|
|
1750
|
-
DAYS = "DAYS"
|
|
1751
|
-
}
|
|
1752
|
-
/** @enumType */
|
|
1753
|
-
type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
1754
|
-
interface PreparePaymentCollectionResponse {
|
|
1755
|
-
/** Payment gateway order id which is associated with given payment */
|
|
1756
|
-
paymentGatewayOrderId?: string;
|
|
1757
|
-
}
|
|
1758
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
1759
|
-
/**
|
|
1760
|
-
* Ecom order ID.
|
|
1761
|
-
* @minLength 1
|
|
1762
|
-
* @maxLength 100
|
|
1763
|
-
*/
|
|
1764
|
-
ecomOrderId: string;
|
|
1765
|
-
}
|
|
1766
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
1767
|
-
/** Payment collectability status */
|
|
1768
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
1769
|
-
/** Collectable order amount */
|
|
1770
|
-
amount?: Price;
|
|
1771
|
-
}
|
|
1772
|
-
declare enum PaymentCollectabilityStatus {
|
|
1773
|
-
UNKNOWN = "UNKNOWN",
|
|
1774
|
-
COLLECTABLE = "COLLECTABLE",
|
|
1775
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
1776
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
1777
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
1778
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
1779
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
1780
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
1781
|
-
}
|
|
1782
|
-
/** @enumType */
|
|
1783
|
-
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';
|
|
1784
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
1785
|
-
/**
|
|
1786
|
-
* Order ID.
|
|
1787
|
-
* @minLength 1
|
|
1788
|
-
* @maxLength 100
|
|
1789
|
-
*/
|
|
1790
|
-
orderId: string;
|
|
1791
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
1792
|
-
amount: Price;
|
|
1793
|
-
}
|
|
1794
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
1795
|
-
}
|
|
1796
|
-
interface MarkOrderAsPaidRequest {
|
|
1797
|
-
/**
|
|
1798
|
-
* Ecom order ID.
|
|
1799
|
-
* @minLength 1
|
|
1800
|
-
* @maxLength 100
|
|
1801
|
-
*/
|
|
1802
|
-
ecomOrderId: string;
|
|
1803
|
-
}
|
|
1804
|
-
interface MarkOrderAsPaidResponse {
|
|
1805
|
-
/** Updated order. */
|
|
1806
|
-
order?: Order;
|
|
1807
|
-
}
|
|
1808
|
-
interface BulkMarkOrdersAsPaidRequest {
|
|
1809
|
-
/**
|
|
1810
|
-
* IDs of orders to mark as paid.
|
|
1811
|
-
* @minSize 1
|
|
1812
|
-
* @maxSize 100
|
|
1813
|
-
* @minLength 1
|
|
1814
|
-
* @maxLength 100
|
|
1815
|
-
*/
|
|
1816
|
-
ecomOrderIds: string[];
|
|
1817
|
-
}
|
|
1818
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
1819
|
-
/**
|
|
1820
|
-
* Items updated by the bulk action.
|
|
1821
|
-
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
1822
|
-
*/
|
|
1823
|
-
results?: BulkOrderResult[];
|
|
1824
|
-
/** Bulk action metadata. */
|
|
1825
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1826
|
-
}
|
|
1827
|
-
interface BulkOrderResult {
|
|
1828
|
-
/** Item metadata. */
|
|
1829
|
-
itemMetadata?: ItemMetadata;
|
|
1830
|
-
/**
|
|
1831
|
-
* Updated order.
|
|
1832
|
-
*
|
|
1833
|
-
* Returned when `returnFullEntity = true`.
|
|
1834
|
-
*/
|
|
1835
|
-
item?: Order;
|
|
1836
|
-
}
|
|
1837
|
-
interface ItemMetadata {
|
|
1838
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1839
|
-
id?: string | null;
|
|
1840
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1841
|
-
originalIndex?: number;
|
|
1842
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1843
|
-
success?: boolean;
|
|
1844
|
-
/** Details about the error in case of failure. */
|
|
1845
|
-
error?: ApplicationError;
|
|
1846
|
-
}
|
|
1847
|
-
interface ApplicationError {
|
|
1848
|
-
/** Error code. */
|
|
1849
|
-
code?: string;
|
|
1850
|
-
/** Description of the error. */
|
|
1851
|
-
description?: string;
|
|
1852
|
-
/** Data related to the error. */
|
|
1853
|
-
data?: Record<string, any> | null;
|
|
1854
|
-
}
|
|
1855
|
-
interface BulkActionMetadata {
|
|
1856
|
-
/** Number of items that were successfully processed. */
|
|
1857
|
-
totalSuccesses?: number;
|
|
1858
|
-
/** Number of items that couldn't be processed. */
|
|
1859
|
-
totalFailures?: number;
|
|
1860
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1861
|
-
undetailedFailures?: number;
|
|
1862
|
-
}
|
|
1863
|
-
interface GetRefundabilityStatusRequest {
|
|
1864
|
-
/**
|
|
1865
|
-
* Order ID.
|
|
1866
|
-
* @minLength 1
|
|
1867
|
-
* @maxLength 100
|
|
1868
|
-
*/
|
|
1869
|
-
ecomOrderId: string;
|
|
1870
|
-
}
|
|
1871
|
-
interface GetRefundabilityStatusResponse {
|
|
1872
|
-
/**
|
|
1873
|
-
* Refundability details.
|
|
1874
|
-
* @maxSize 300
|
|
1875
|
-
*/
|
|
1876
|
-
refundabilities?: Refundability[];
|
|
1877
|
-
/**
|
|
1878
|
-
* Whether the order supports refunding per item.
|
|
1879
|
-
* @deprecated
|
|
1880
|
-
*/
|
|
1881
|
-
refundablePerItem?: boolean;
|
|
1882
|
-
}
|
|
1883
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
1884
|
-
/** Reason why payment is not refundable. */
|
|
1885
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
1886
|
-
/** Reason why payment is only refundable manually. */
|
|
1887
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
1888
|
-
/** Payment ID. */
|
|
1889
|
-
paymentId?: string;
|
|
1890
|
-
/** Payment refundability status. */
|
|
1891
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
1892
|
-
/** Link to payment provider dashboard. */
|
|
1893
|
-
providerLink?: string | null;
|
|
1894
|
-
}
|
|
1895
|
-
/** @oneof */
|
|
1896
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
1897
|
-
/** Reason why payment is not refundable. */
|
|
1898
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
1899
|
-
/** Reason why payment is only refundable manually. */
|
|
1900
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
1901
|
-
}
|
|
1902
|
-
declare enum RefundableStatus {
|
|
1903
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
1904
|
-
MANUAL = "MANUAL",
|
|
1905
|
-
REFUNDABLE = "REFUNDABLE"
|
|
1906
|
-
}
|
|
1907
|
-
/** @enumType */
|
|
1908
|
-
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
1909
|
-
declare enum NonRefundableReason {
|
|
1910
|
-
NONE = "NONE",
|
|
1911
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
1912
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
1913
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
1914
|
-
NOT_PAID = "NOT_PAID",
|
|
1915
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
1916
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
1917
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
1918
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
1919
|
-
FORBIDDEN = "FORBIDDEN",
|
|
1920
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
1921
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
1922
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
1923
|
-
}
|
|
1924
|
-
/** @enumType */
|
|
1925
|
-
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';
|
|
1926
|
-
declare enum ManuallyRefundableReason {
|
|
1927
|
-
EXPIRED = "EXPIRED",
|
|
1928
|
-
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
1929
|
-
OFFLINE = "OFFLINE",
|
|
1930
|
-
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
1931
|
-
}
|
|
1932
|
-
/** @enumType */
|
|
1933
|
-
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
1934
|
-
interface CreatePaymentGatewayOrderRequest {
|
|
1935
|
-
/**
|
|
1936
|
-
* Ecom order ID.
|
|
1937
|
-
* @minLength 1
|
|
1938
|
-
* @maxLength 100
|
|
1939
|
-
*/
|
|
1940
|
-
ecomOrderId: string;
|
|
1941
|
-
/** Information about the user who initiated the payment. */
|
|
1942
|
-
chargedBy?: ChargedBy;
|
|
1943
|
-
}
|
|
1944
|
-
interface ChargedBy {
|
|
1945
|
-
/**
|
|
1946
|
-
* ID - id of the user who initiated the payment
|
|
1947
|
-
* @format GUID
|
|
1948
|
-
*/
|
|
1949
|
-
id?: string;
|
|
1950
|
-
/**
|
|
1951
|
-
* Full name - name of the user who initiated the payment
|
|
1952
|
-
* @minLength 1
|
|
1953
|
-
* @maxLength 200
|
|
1954
|
-
*/
|
|
1955
|
-
fullName?: string | null;
|
|
1956
|
-
}
|
|
1957
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
1958
|
-
/** ID of the order created in the payment gateway */
|
|
1959
|
-
paymentGatewayOrderId?: string;
|
|
1960
|
-
}
|
|
1961
|
-
interface ChargeMembershipsRequest {
|
|
1962
|
-
/**
|
|
1963
|
-
* Order ID.
|
|
1964
|
-
* @minLength 1
|
|
1965
|
-
* @maxLength 100
|
|
1966
|
-
*/
|
|
1967
|
-
ecomOrderId: string;
|
|
1968
|
-
/**
|
|
1969
|
-
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
1970
|
-
* but a user which is using the membership on behalf of the a member
|
|
1971
|
-
* @format GUID
|
|
1972
|
-
*/
|
|
1973
|
-
memberId: string;
|
|
1974
|
-
/**
|
|
1975
|
-
* List of items to be paid by memberships
|
|
1976
|
-
* @minSize 1
|
|
1977
|
-
* @maxSize 300
|
|
1978
|
-
*/
|
|
1979
|
-
membershipCharges?: MembershipChargeItem[];
|
|
1980
|
-
}
|
|
1981
|
-
interface MembershipChargeItem {
|
|
1982
|
-
/**
|
|
1983
|
-
* The id of used membership
|
|
1984
|
-
* @minLength 1
|
|
1985
|
-
* @maxLength 100
|
|
1986
|
-
*/
|
|
1987
|
-
membershipId?: string;
|
|
1988
|
-
/**
|
|
1989
|
-
* ID of the application providing this payment option
|
|
1990
|
-
* @format GUID
|
|
1991
|
-
*/
|
|
1992
|
-
appId?: string;
|
|
1993
|
-
/** The name of used membership */
|
|
1994
|
-
membershipName?: MembershipName;
|
|
1995
|
-
/** Additional data about this membership */
|
|
1996
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
1997
|
-
/** Catalog and item reference info. */
|
|
1998
|
-
catalogReference?: CatalogReference;
|
|
1999
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
2000
|
-
serviceProperties?: ServiceProperties;
|
|
2001
|
-
/**
|
|
2002
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
2003
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
2004
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
2005
|
-
* @minLength 1
|
|
2006
|
-
* @maxLength 36
|
|
2007
|
-
*/
|
|
2008
|
-
rootCatalogItemId?: string | null;
|
|
2009
|
-
/**
|
|
2010
|
-
* line item id of Checkout/Order line item
|
|
2011
|
-
* @minLength 1
|
|
2012
|
-
* @maxLength 100
|
|
2013
|
-
*/
|
|
2014
|
-
lineItemId?: string;
|
|
2015
|
-
}
|
|
2016
|
-
interface MembershipName {
|
|
2017
|
-
/**
|
|
2018
|
-
* Membership name.
|
|
2019
|
-
* @maxLength 100
|
|
2020
|
-
*/
|
|
2021
|
-
original?: string;
|
|
2022
|
-
/**
|
|
2023
|
-
* Translated membership name. Defaults to `original` when not provided.
|
|
2024
|
-
* @maxLength 100
|
|
2025
|
-
*/
|
|
2026
|
-
translated?: string | null;
|
|
2027
|
-
}
|
|
2028
|
-
interface ServiceProperties {
|
|
2029
|
-
/**
|
|
2030
|
-
* 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.
|
|
2031
|
-
* For example, the start time of a class.
|
|
2032
|
-
*/
|
|
2033
|
-
scheduledDate?: Date | null;
|
|
2034
|
-
/**
|
|
2035
|
-
* 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.
|
|
2036
|
-
* @min 1
|
|
2037
|
-
* @max 10000
|
|
2038
|
-
*/
|
|
2039
|
-
numberOfParticipants?: number | null;
|
|
2040
|
-
}
|
|
2041
|
-
interface ChargeMembershipsResponse {
|
|
2042
|
-
}
|
|
2043
|
-
interface TriggerRefundRequest {
|
|
2044
|
-
/**
|
|
2045
|
-
* The order this refund related to
|
|
2046
|
-
* @minLength 1
|
|
2047
|
-
* @maxLength 100
|
|
2048
|
-
*/
|
|
2049
|
-
ecomOrderId: string;
|
|
2050
|
-
/**
|
|
2051
|
-
* Refund operations information
|
|
2052
|
-
* @minSize 1
|
|
2053
|
-
* @maxSize 1
|
|
2054
|
-
*/
|
|
2055
|
-
payments: PaymentRefund[];
|
|
2056
|
-
/** Business model of a refund */
|
|
2057
|
-
details?: RefundDetails;
|
|
2058
|
-
/** Side effect details related to refund */
|
|
2059
|
-
sideEffects?: RefundSideEffects;
|
|
2060
|
-
}
|
|
2061
|
-
interface PaymentRefund {
|
|
2062
|
-
/**
|
|
2063
|
-
* Specific payment within the order to refund
|
|
2064
|
-
* @format GUID
|
|
2065
|
-
*/
|
|
2066
|
-
paymentId?: string;
|
|
2067
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
2068
|
-
amount?: Price;
|
|
2069
|
-
/**
|
|
2070
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
2071
|
-
* 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.
|
|
2072
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
2073
|
-
*/
|
|
2074
|
-
externalRefund?: boolean;
|
|
2075
|
-
}
|
|
2076
|
-
/** Business model of a refund request */
|
|
2077
|
-
interface RefundDetails {
|
|
2078
|
-
/**
|
|
2079
|
-
* Order line item IDs and quantities that were refunded.
|
|
2080
|
-
* @maxSize 300
|
|
2081
|
-
*/
|
|
2082
|
-
items?: RefundItem[];
|
|
2083
|
-
/** Whether the shipping fee was also refunded. */
|
|
2084
|
-
shippingIncluded?: boolean;
|
|
2085
|
-
/**
|
|
2086
|
-
* Reason for the refund, provided by customer (optional).
|
|
2087
|
-
* @maxLength 200
|
|
2088
|
-
*/
|
|
2089
|
-
reason?: string | null;
|
|
2090
|
-
/**
|
|
2091
|
-
* Line items that were refunded.
|
|
2092
|
-
* @maxSize 300
|
|
2093
|
-
*/
|
|
2094
|
-
lineItems?: LineItemRefund[];
|
|
2095
|
-
/**
|
|
2096
|
-
* Additional fees that were refunded.
|
|
2097
|
-
* @maxSize 100
|
|
2098
|
-
*/
|
|
2099
|
-
additionalFees?: AdditionalFeeRefund[];
|
|
2100
|
-
/** Shipping amount that was refunded. */
|
|
2101
|
-
shipping?: ShippingRefund;
|
|
2102
|
-
}
|
|
2103
|
-
interface RefundItem {
|
|
2104
|
-
/**
|
|
2105
|
-
* Line item ID the refunded line item.
|
|
2106
|
-
* @format GUID
|
|
2107
|
-
*/
|
|
2108
|
-
lineItemId?: string;
|
|
2109
|
-
/**
|
|
2110
|
-
* Line item quantity refunded.
|
|
2111
|
-
* @min 1
|
|
2112
|
-
* @max 100000
|
|
2113
|
-
*/
|
|
2114
|
-
quantity?: number;
|
|
2115
|
-
}
|
|
2116
|
-
interface LineItemRefund {
|
|
2117
|
-
/**
|
|
2118
|
-
* Line item ID.
|
|
2119
|
-
* @format GUID
|
|
2120
|
-
* @immutable
|
|
2121
|
-
*/
|
|
2122
|
-
lineItemId?: string;
|
|
2123
|
-
/**
|
|
2124
|
-
* Refund quantity.
|
|
2125
|
-
* @min 1
|
|
2126
|
-
* @max 100000
|
|
2127
|
-
* @immutable
|
|
2128
|
-
*/
|
|
2129
|
-
quantity?: number;
|
|
2130
|
-
}
|
|
2131
|
-
interface AdditionalFeeRefund {
|
|
2132
|
-
/**
|
|
2133
|
-
* Additional fee ID.
|
|
2134
|
-
* @format GUID
|
|
2135
|
-
* @immutable
|
|
2136
|
-
*/
|
|
2137
|
-
additionalFeeId?: string;
|
|
2138
|
-
/**
|
|
2139
|
-
* Refund amount.
|
|
2140
|
-
* @immutable
|
|
2141
|
-
*/
|
|
2142
|
-
amount?: Price;
|
|
2143
|
-
}
|
|
2144
|
-
interface ShippingRefund {
|
|
2145
|
-
/**
|
|
2146
|
-
* Refund amount.
|
|
2147
|
-
* @immutable
|
|
2148
|
-
*/
|
|
2149
|
-
amount?: Price;
|
|
2150
|
-
}
|
|
2151
|
-
interface RefundSideEffects {
|
|
2152
|
-
/** Inventory restock details as part of this refund. */
|
|
2153
|
-
restockInfo?: RestockInfo;
|
|
2154
|
-
/** Whether to send a refund confirmation email to the customer. */
|
|
2155
|
-
sendOrderRefundedEmail?: boolean;
|
|
2156
|
-
/**
|
|
2157
|
-
* Custom message added to the refund confirmation email.
|
|
2158
|
-
* @minLength 1
|
|
2159
|
-
* @maxLength 1000
|
|
2160
|
-
*/
|
|
2161
|
-
customMessage?: string | null;
|
|
2162
|
-
}
|
|
2163
|
-
interface RestockInfo {
|
|
2164
|
-
/** Restock type. */
|
|
2165
|
-
type?: RestockTypeWithLiterals;
|
|
2166
|
-
/**
|
|
2167
|
-
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
2168
|
-
* @maxSize 300
|
|
2169
|
-
*/
|
|
2170
|
-
items?: RestockItem[];
|
|
2171
|
-
}
|
|
2172
|
-
declare enum RestockType {
|
|
2173
|
-
NO_ITEMS = "NO_ITEMS",
|
|
2174
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
2175
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
2176
|
-
}
|
|
2177
|
-
/** @enumType */
|
|
2178
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
2179
|
-
interface RestockItem {
|
|
2180
|
-
/**
|
|
2181
|
-
* ID of the line item being restocked.
|
|
2182
|
-
* @format GUID
|
|
2183
|
-
*/
|
|
2184
|
-
lineItemId?: string;
|
|
2185
|
-
/**
|
|
2186
|
-
* Line item quantity being restocked.
|
|
2187
|
-
* @min 1
|
|
2188
|
-
* @max 100000
|
|
2189
|
-
*/
|
|
2190
|
-
quantity?: number;
|
|
2191
|
-
}
|
|
2192
|
-
interface TriggerRefundResponse {
|
|
2193
|
-
/** All order's transactions after the refunds were added */
|
|
2194
|
-
orderTransactions?: OrderTransactions;
|
|
2195
|
-
/** Created refund ID */
|
|
2196
|
-
refundId?: string | null;
|
|
2197
|
-
/** Payment ID's that the refund execution had failed for */
|
|
2198
|
-
failedPaymentIds?: ItemMetadata[];
|
|
2199
|
-
}
|
|
2200
|
-
interface OrderTransactions {
|
|
2201
|
-
/**
|
|
2202
|
-
* Order ID.
|
|
2203
|
-
* @format GUID
|
|
2204
|
-
*/
|
|
2205
|
-
orderId?: string;
|
|
2206
|
-
/**
|
|
2207
|
-
* Record of payments made to the merchant.
|
|
2208
|
-
* @maxSize 100
|
|
2209
|
-
*/
|
|
2210
|
-
payments?: Payment[];
|
|
2211
|
-
/**
|
|
2212
|
-
* Record of refunds made to the buyer.
|
|
2213
|
-
* @maxSize 300
|
|
2214
|
-
*/
|
|
2215
|
-
refunds?: Refund[];
|
|
2216
|
-
}
|
|
2217
|
-
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
2218
|
-
/** Regular payment details. */
|
|
2219
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
2220
|
-
/** Gift card payment details. */
|
|
2221
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2222
|
-
/**
|
|
2223
|
-
* Payment ID.
|
|
2224
|
-
* @format GUID
|
|
2225
|
-
* @readonly
|
|
2226
|
-
*/
|
|
2227
|
-
id?: string | null;
|
|
2228
|
-
/** 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. */
|
|
2229
|
-
createdDate?: Date | null;
|
|
2230
|
-
/**
|
|
2231
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2232
|
-
* @readonly
|
|
2233
|
-
*/
|
|
2234
|
-
updatedDate?: Date | null;
|
|
2235
|
-
/** Payment amount. */
|
|
2236
|
-
amount?: Price;
|
|
2237
|
-
/**
|
|
2238
|
-
* Whether refunds for this payment are disabled.
|
|
2239
|
-
* + `true`: This payment is not refundable.
|
|
2240
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
2241
|
-
*/
|
|
2242
|
-
refundDisabled?: boolean;
|
|
2243
|
-
}
|
|
2244
|
-
/** @oneof */
|
|
2245
|
-
interface PaymentPaymentDetailsOneOf {
|
|
2246
|
-
/** Regular payment details. */
|
|
2247
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
2248
|
-
/** Gift card payment details. */
|
|
2249
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2250
|
-
}
|
|
2251
|
-
/** @oneof */
|
|
2252
|
-
interface PaymentReceiptInfoOneOf {
|
|
2253
|
-
}
|
|
2254
|
-
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2255
|
-
/** Whether regular card used */
|
|
2256
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2257
|
-
/**
|
|
2258
|
-
* Wix Payments order ID.
|
|
2259
|
-
* @maxLength 100
|
|
2260
|
-
*/
|
|
2261
|
-
paymentOrderId?: string | null;
|
|
2262
|
-
/**
|
|
2263
|
-
* Payment gateway's transaction ID.
|
|
2264
|
-
* This field is only returned when the value of `offline_payment` is `false`.
|
|
2265
|
-
* @maxLength 100
|
|
2266
|
-
*/
|
|
2267
|
-
gatewayTransactionId?: string | null;
|
|
2268
|
-
/**
|
|
2269
|
-
* Payment method. Non-exhaustive list of supported values:
|
|
2270
|
-
* + `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`
|
|
2271
|
-
* @maxLength 100
|
|
2272
|
-
*/
|
|
2273
|
-
paymentMethod?: string | null;
|
|
2274
|
-
/**
|
|
2275
|
-
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
2276
|
-
* @maxLength 100
|
|
2277
|
-
*/
|
|
2278
|
-
providerTransactionId?: string | null;
|
|
2279
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
2280
|
-
offlinePayment?: boolean;
|
|
2281
|
-
/** Payment status. */
|
|
2282
|
-
status?: TransactionStatusWithLiterals;
|
|
2283
|
-
/**
|
|
2284
|
-
* Whether there is a payment agreement that allows for future charges.
|
|
2285
|
-
* @immutable
|
|
2286
|
-
*/
|
|
2287
|
-
savedPaymentMethod?: boolean;
|
|
2288
|
-
/** Authorization details. */
|
|
2289
|
-
authorizationDetails?: AuthorizationDetails;
|
|
2290
|
-
/**
|
|
2291
|
-
* Record of chargebacks made by the buyer.
|
|
2292
|
-
* @maxSize 6
|
|
2293
|
-
*/
|
|
2294
|
-
chargebacks?: Chargeback[];
|
|
2295
|
-
}
|
|
2296
|
-
/** @oneof */
|
|
2297
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2298
|
-
/** Whether regular card used */
|
|
2299
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2300
|
-
}
|
|
2301
|
-
declare enum TransactionStatus {
|
|
2302
|
-
UNDEFINED = "UNDEFINED",
|
|
2303
|
-
APPROVED = "APPROVED",
|
|
2304
|
-
PENDING = "PENDING",
|
|
2305
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
2306
|
-
CANCELED = "CANCELED",
|
|
2307
|
-
DECLINED = "DECLINED",
|
|
2308
|
-
REFUNDED = "REFUNDED",
|
|
2309
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
2310
|
-
AUTHORIZED = "AUTHORIZED",
|
|
2311
|
-
VOIDED = "VOIDED"
|
|
2312
|
-
}
|
|
2313
|
-
/** @enumType */
|
|
2314
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
2315
|
-
interface CreditCardPaymentMethodDetails {
|
|
2316
|
-
/**
|
|
2317
|
-
* The last 4 digits of the card number.
|
|
2318
|
-
* @maxLength 4
|
|
2319
|
-
*/
|
|
2320
|
-
lastFourDigits?: string | null;
|
|
2321
|
-
/**
|
|
2322
|
-
* Card issuer's brand.
|
|
2323
|
-
* @maxLength 100
|
|
2324
|
-
*/
|
|
2325
|
-
brand?: string | null;
|
|
2326
|
-
}
|
|
2327
|
-
interface AuthorizationDetails {
|
|
2328
|
-
/**
|
|
2329
|
-
* Whether the authorized payment is of a delayed capture.
|
|
2330
|
-
* @readonly
|
|
2331
|
-
*/
|
|
2332
|
-
delayedCapture?: boolean;
|
|
2333
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
2334
|
-
authorizedDate?: Date | null;
|
|
2335
|
-
/**
|
|
2336
|
-
* List of captures associated with payment
|
|
2337
|
-
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
2338
|
-
* @maxSize 1
|
|
2339
|
-
*/
|
|
2340
|
-
captures?: AuthorizationCapture[];
|
|
2341
|
-
/** Void associated with payment */
|
|
2342
|
-
void?: AuthorizationVoid;
|
|
2343
|
-
/** Scheduled action for this transaction */
|
|
2344
|
-
scheduledAction?: V1ScheduledAction;
|
|
2345
|
-
}
|
|
2346
|
-
interface AuthorizationCapture {
|
|
2347
|
-
/**
|
|
2348
|
-
* Capture ID.
|
|
2349
|
-
* @format GUID
|
|
2350
|
-
* @readonly
|
|
2351
|
-
*/
|
|
2352
|
-
id?: string | null;
|
|
2353
|
-
/** Status of this capture action */
|
|
2354
|
-
status?: AuthorizationCaptureStatusWithLiterals;
|
|
2355
|
-
/**
|
|
2356
|
-
* Amount of this capture
|
|
2357
|
-
* @immutable
|
|
2358
|
-
*/
|
|
2359
|
-
amount?: Price;
|
|
2360
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
2361
|
-
createdDate?: Date | null;
|
|
2362
|
-
/** In case of status is FAILED may contain failure details */
|
|
2363
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
2364
|
-
}
|
|
2365
|
-
declare enum AuthorizationCaptureStatus {
|
|
2366
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2367
|
-
/** Capture operation still in progress. */
|
|
2368
|
-
PENDING = "PENDING",
|
|
2369
|
-
/** Capture operation succeeded. */
|
|
2370
|
-
SUCCEEDED = "SUCCEEDED",
|
|
2371
|
-
/** Capture operation failed. */
|
|
2372
|
-
FAILED = "FAILED"
|
|
2373
|
-
}
|
|
2374
|
-
/** @enumType */
|
|
2375
|
-
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
2376
|
-
interface AuthorizationActionFailureDetails {
|
|
2377
|
-
/** @maxLength 100 */
|
|
2378
|
-
failureCode?: string;
|
|
2379
|
-
}
|
|
2380
|
-
interface AuthorizationVoid {
|
|
2381
|
-
/** Status of this void action */
|
|
2382
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
2383
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
2384
|
-
voidedDate?: Date | null;
|
|
2385
|
-
/** In case of status is FAILED may contain failure details */
|
|
2386
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
2387
|
-
/** Reason of void action */
|
|
2388
|
-
reason?: ReasonWithLiterals;
|
|
2389
|
-
}
|
|
2390
|
-
declare enum AuthorizationVoidStatus {
|
|
2391
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2392
|
-
/** Void operation still in progress. */
|
|
2393
|
-
PENDING = "PENDING",
|
|
2394
|
-
/** Void operation succeeded. */
|
|
2395
|
-
SUCCEEDED = "SUCCEEDED",
|
|
2396
|
-
/** Void operation failed. */
|
|
2397
|
-
FAILED = "FAILED"
|
|
2398
|
-
}
|
|
2399
|
-
/** @enumType */
|
|
2400
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
2401
|
-
/** Reason the authorization was voided. */
|
|
2402
|
-
declare enum Reason {
|
|
2403
|
-
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
2404
|
-
/** Authorization was voided by user. */
|
|
2405
|
-
MANUAL = "MANUAL",
|
|
2406
|
-
/** Authorization passed execution date. */
|
|
2407
|
-
SCHEDULED = "SCHEDULED"
|
|
2408
|
-
}
|
|
2409
|
-
/** @enumType */
|
|
2410
|
-
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
2411
|
-
interface V1ScheduledAction {
|
|
2412
|
-
/** Type of the action. */
|
|
2413
|
-
actionType?: ActionTypeWithLiterals;
|
|
2414
|
-
/** The date and time of the action. */
|
|
2415
|
-
executionDate?: Date | null;
|
|
2416
|
-
}
|
|
2417
|
-
declare enum ActionType {
|
|
2418
|
-
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
2419
|
-
VOID = "VOID",
|
|
2420
|
-
CAPTURE = "CAPTURE"
|
|
2421
|
-
}
|
|
2422
|
-
/** @enumType */
|
|
2423
|
-
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
2424
|
-
interface Chargeback {
|
|
2425
|
-
/**
|
|
2426
|
-
* Chargeback ID.
|
|
2427
|
-
* @format GUID
|
|
2428
|
-
* @readonly
|
|
2429
|
-
* @immutable
|
|
2430
|
-
*/
|
|
2431
|
-
id?: string;
|
|
2432
|
-
/**
|
|
2433
|
-
* 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.
|
|
2434
|
-
* @readonly
|
|
2435
|
-
* @immutable
|
|
2436
|
-
*/
|
|
2437
|
-
createdDate?: Date | null;
|
|
2438
|
-
/**
|
|
2439
|
-
* 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.
|
|
2440
|
-
* @readonly
|
|
2441
|
-
*/
|
|
2442
|
-
updatedDate?: Date | null;
|
|
2443
|
-
/**
|
|
2444
|
-
* Amount.
|
|
2445
|
-
* @readonly
|
|
2446
|
-
* @immutable
|
|
2447
|
-
*/
|
|
2448
|
-
amount?: Price;
|
|
2449
|
-
/**
|
|
2450
|
-
* Reversal amount. Present only when status is REVERSED.
|
|
2451
|
-
* @readonly
|
|
2452
|
-
*/
|
|
2453
|
-
reversalAmount?: Price;
|
|
2454
|
-
/**
|
|
2455
|
-
* Status.
|
|
2456
|
-
*
|
|
2457
|
-
* Default: `"APPROVED"`.
|
|
2458
|
-
*/
|
|
2459
|
-
status?: ChargebackStatusWithLiterals;
|
|
2460
|
-
/**
|
|
2461
|
-
* External chargeback ID.
|
|
2462
|
-
* @format GUID
|
|
2463
|
-
* @readonly
|
|
2464
|
-
* @immutable
|
|
2465
|
-
*/
|
|
2466
|
-
externalId?: string | null;
|
|
2467
|
-
}
|
|
2468
|
-
declare enum ChargebackStatus {
|
|
2469
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
2470
|
-
/** Chargeback was approved. */
|
|
2471
|
-
APPROVED = "APPROVED",
|
|
2472
|
-
/** Chargeback was reversed. */
|
|
2473
|
-
REVERSED = "REVERSED"
|
|
2474
|
-
}
|
|
2475
|
-
/** @enumType */
|
|
2476
|
-
type ChargebackStatusWithLiterals = ChargebackStatus | 'UNSPECIFIED' | 'APPROVED' | 'REVERSED';
|
|
2477
|
-
interface GiftCardPaymentDetails {
|
|
2478
|
-
/**
|
|
2479
|
-
* Gift card payment ID.
|
|
2480
|
-
* @minLength 1
|
|
2481
|
-
* @maxLength 100
|
|
2482
|
-
*/
|
|
2483
|
-
giftCardPaymentId?: string;
|
|
2484
|
-
/**
|
|
2485
|
-
* ID of the app that created the gift card.
|
|
2486
|
-
* @format GUID
|
|
2487
|
-
*/
|
|
2488
|
-
appId?: string;
|
|
2489
|
-
/**
|
|
2490
|
-
* Whether the gift card is voided.
|
|
2491
|
-
* @readonly
|
|
2492
|
-
*/
|
|
2493
|
-
voided?: boolean;
|
|
2494
|
-
}
|
|
2495
|
-
interface Refund {
|
|
2496
|
-
/**
|
|
2497
|
-
* Refund ID.
|
|
2498
|
-
* @format GUID
|
|
2499
|
-
* @readonly
|
|
2500
|
-
*/
|
|
2501
|
-
id?: string;
|
|
2502
|
-
/**
|
|
2503
|
-
* List of transactions.
|
|
2504
|
-
* @maxSize 50
|
|
2505
|
-
*/
|
|
2506
|
-
transactions?: RefundTransaction[];
|
|
2507
|
-
/** Refund business details. */
|
|
2508
|
-
details?: RefundDetails;
|
|
2509
|
-
/**
|
|
2510
|
-
* 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.
|
|
2511
|
-
* @readonly
|
|
2512
|
-
* @immutable
|
|
2513
|
-
*/
|
|
2514
|
-
createdDate?: Date | null;
|
|
2515
|
-
/**
|
|
2516
|
-
* Aggregated refund summary.
|
|
2517
|
-
* @readonly
|
|
2518
|
-
*/
|
|
2519
|
-
summary?: AggregatedRefundSummary;
|
|
2520
|
-
/**
|
|
2521
|
-
* ID of the app that initiated this refund.
|
|
2522
|
-
* @format GUID
|
|
2523
|
-
* @readonly
|
|
2524
|
-
* @immutable
|
|
2525
|
-
*/
|
|
2526
|
-
requestingServiceAppId?: string | null;
|
|
2527
|
-
}
|
|
2528
|
-
interface RefundTransaction {
|
|
2529
|
-
/**
|
|
2530
|
-
* ID of the payment associated with this refund.
|
|
2531
|
-
* @format GUID
|
|
2532
|
-
* @immutable
|
|
2533
|
-
*/
|
|
2534
|
-
paymentId?: string;
|
|
2535
|
-
/**
|
|
2536
|
-
* Refund amount.
|
|
2537
|
-
* @immutable
|
|
2538
|
-
*/
|
|
2539
|
-
amount?: Price;
|
|
2540
|
-
/** Refund status. */
|
|
2541
|
-
refundStatus?: RefundStatusWithLiterals;
|
|
2542
|
-
/** Optional details of current refund status. */
|
|
2543
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
2544
|
-
/**
|
|
2545
|
-
* Payment gateway's refund ID.
|
|
2546
|
-
* This field is only returned when the value of `external_refund` is `false`.
|
|
2547
|
-
* @format GUID
|
|
2548
|
-
*/
|
|
2549
|
-
gatewayRefundId?: string | null;
|
|
2550
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
2551
|
-
providerRefundId?: string | null;
|
|
2552
|
-
/**
|
|
2553
|
-
* Whether refund was made externally and manually on the payment provider's side.
|
|
2554
|
-
* @immutable
|
|
2555
|
-
*/
|
|
2556
|
-
externalRefund?: boolean;
|
|
2557
|
-
}
|
|
2558
|
-
/** Refund transaction status. */
|
|
2559
|
-
declare enum RefundStatus {
|
|
2560
|
-
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
2561
|
-
PENDING = "PENDING",
|
|
2562
|
-
/** Refund transaction succeeded. */
|
|
2563
|
-
SUCCEEDED = "SUCCEEDED",
|
|
2564
|
-
/** Refund transaction failed. */
|
|
2565
|
-
FAILED = "FAILED",
|
|
2566
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
2567
|
-
SCHEDULED = "SCHEDULED",
|
|
2568
|
-
/** Refund was initiated on payment provider side. */
|
|
2569
|
-
STARTED = "STARTED"
|
|
2570
|
-
}
|
|
2571
|
-
/** @enumType */
|
|
2572
|
-
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
2573
|
-
interface RefundStatusInfo {
|
|
2574
|
-
/**
|
|
2575
|
-
* Reason code for the refund's current status.
|
|
2576
|
-
*
|
|
2577
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
2578
|
-
* @minLength 1
|
|
2579
|
-
* @maxLength 10
|
|
2580
|
-
*/
|
|
2581
|
-
paymentGatewayReasonCode?: string | null;
|
|
2582
|
-
/**
|
|
2583
|
-
* Free text explanation of current refund status.
|
|
2584
|
-
* @minLength 1
|
|
2585
|
-
* @maxLength 1000
|
|
2586
|
-
*/
|
|
2587
|
-
description?: string | null;
|
|
2588
|
-
}
|
|
2589
|
-
interface AggregatedRefundSummary {
|
|
2590
|
-
/** Total amount requested for refund. */
|
|
2591
|
-
requestedRefund?: Price;
|
|
2592
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
2593
|
-
pendingRefund?: Price;
|
|
2594
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
2595
|
-
refunded?: Price;
|
|
2596
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
2597
|
-
failedRefundAmount?: Price;
|
|
2598
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
2599
|
-
pending?: boolean;
|
|
2600
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
2601
|
-
breakdown?: RefundItemsBreakdown;
|
|
2602
|
-
}
|
|
2603
|
-
interface RefundItemsBreakdown {
|
|
2604
|
-
/**
|
|
2605
|
-
* Refunded line items and the amount refunded for each.
|
|
2606
|
-
* @maxSize 300
|
|
2607
|
-
*/
|
|
2608
|
-
lineItems?: LineItemRefundSummary[];
|
|
2609
|
-
}
|
|
2610
|
-
interface LineItemRefundSummary {
|
|
2611
|
-
/**
|
|
2612
|
-
* ID of the refunded line item.
|
|
2613
|
-
* @format GUID
|
|
2614
|
-
*/
|
|
2615
|
-
lineItemId?: string;
|
|
2616
|
-
/** Total refunded amount for the line item. */
|
|
2617
|
-
totalRefundedAmount?: Price;
|
|
2618
|
-
}
|
|
2619
|
-
interface VoidAuthorizedPaymentsRequest {
|
|
2620
|
-
/**
|
|
2621
|
-
* Wix eCommerce order ID
|
|
2622
|
-
* @minLength 1
|
|
2623
|
-
* @maxLength 100
|
|
2624
|
-
*/
|
|
2625
|
-
ecomOrderId: string;
|
|
2626
|
-
/**
|
|
2627
|
-
* Payment IDs
|
|
2628
|
-
* @minSize 1
|
|
2629
|
-
* @maxSize 100
|
|
2630
|
-
* @format GUID
|
|
2631
|
-
*/
|
|
2632
|
-
paymentIds: string[];
|
|
2633
|
-
}
|
|
2634
|
-
interface VoidAuthorizedPaymentsResponse {
|
|
2635
|
-
/** All order's transactions after the void was triggered */
|
|
2636
|
-
orderTransactions?: OrderTransactions;
|
|
2637
|
-
}
|
|
2638
|
-
interface CaptureAuthorizedPaymentsRequest {
|
|
2639
|
-
/**
|
|
2640
|
-
* Wix eCommerce order ID
|
|
2641
|
-
* @minLength 1
|
|
2642
|
-
* @maxLength 100
|
|
2643
|
-
*/
|
|
2644
|
-
ecomOrderId: string;
|
|
2645
|
-
/**
|
|
2646
|
-
* Capture payments information
|
|
2647
|
-
* @minSize 1
|
|
2648
|
-
* @maxSize 100
|
|
2649
|
-
*/
|
|
2650
|
-
payments: PaymentCapture[];
|
|
2651
|
-
}
|
|
2652
|
-
interface PaymentCapture {
|
|
2653
|
-
/**
|
|
2654
|
-
* Payment ID
|
|
2655
|
-
* @format GUID
|
|
2656
|
-
*/
|
|
2657
|
-
paymentId?: string | null;
|
|
2658
|
-
/**
|
|
2659
|
-
* Capture amount.
|
|
2660
|
-
* If not provided - full authorized amount will be captured.
|
|
2661
|
-
*/
|
|
2662
|
-
amount?: Price;
|
|
2663
|
-
}
|
|
2664
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
2665
|
-
/** All order's transactions after the capture was triggered */
|
|
2666
|
-
orderTransactions?: OrderTransactions;
|
|
2667
|
-
}
|
|
2668
1695
|
interface GetOrderRequest {
|
|
2669
1696
|
/**
|
|
2670
1697
|
* ID of the order to retrieve.
|
|
@@ -2851,6 +1878,42 @@ interface BulkUpdateOrdersResponse {
|
|
|
2851
1878
|
/** Bulk action metadata. */
|
|
2852
1879
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2853
1880
|
}
|
|
1881
|
+
interface BulkOrderResult {
|
|
1882
|
+
/** Item metadata. */
|
|
1883
|
+
itemMetadata?: ItemMetadata;
|
|
1884
|
+
/**
|
|
1885
|
+
* Updated order.
|
|
1886
|
+
*
|
|
1887
|
+
* Returned when `returnFullEntity = true`.
|
|
1888
|
+
*/
|
|
1889
|
+
item?: Order;
|
|
1890
|
+
}
|
|
1891
|
+
interface ItemMetadata {
|
|
1892
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1893
|
+
id?: string | null;
|
|
1894
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1895
|
+
originalIndex?: number;
|
|
1896
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1897
|
+
success?: boolean;
|
|
1898
|
+
/** Details about the error in case of failure. */
|
|
1899
|
+
error?: ApplicationError;
|
|
1900
|
+
}
|
|
1901
|
+
interface ApplicationError {
|
|
1902
|
+
/** Error code. */
|
|
1903
|
+
code?: string;
|
|
1904
|
+
/** Description of the error. */
|
|
1905
|
+
description?: string;
|
|
1906
|
+
/** Data related to the error. */
|
|
1907
|
+
data?: Record<string, any> | null;
|
|
1908
|
+
}
|
|
1909
|
+
interface BulkActionMetadata {
|
|
1910
|
+
/** Number of items that were successfully processed. */
|
|
1911
|
+
totalSuccesses?: number;
|
|
1912
|
+
/** Number of items that couldn't be processed. */
|
|
1913
|
+
totalFailures?: number;
|
|
1914
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1915
|
+
undetailedFailures?: number;
|
|
1916
|
+
}
|
|
2854
1917
|
interface CommitDeltasRequest {
|
|
2855
1918
|
/** Order id to be updated */
|
|
2856
1919
|
id: string;
|
|
@@ -3284,37 +2347,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
3284
2347
|
__responseType: Q;
|
|
3285
2348
|
__originalResponseType: R;
|
|
3286
2349
|
};
|
|
3287
|
-
declare function preparePaymentCollection(): __PublicMethodMetaInfo<'POST', {
|
|
3288
|
-
ecomOrderId: string;
|
|
3289
|
-
}, PreparePaymentCollectionRequest$1, PreparePaymentCollectionRequest, PreparePaymentCollectionResponse$1, PreparePaymentCollectionResponse>;
|
|
3290
|
-
declare function getPaymentCollectabilityStatus(): __PublicMethodMetaInfo<'GET', {
|
|
3291
|
-
ecomOrderId: string;
|
|
3292
|
-
}, GetPaymentCollectabilityStatusRequest$1, GetPaymentCollectabilityStatusRequest, GetPaymentCollectabilityStatusResponse$1, GetPaymentCollectabilityStatusResponse>;
|
|
3293
|
-
declare function recordManuallyCollectedPayment(): __PublicMethodMetaInfo<'POST', {
|
|
3294
|
-
orderId: string;
|
|
3295
|
-
}, RecordManuallyCollectedPaymentRequest$1, RecordManuallyCollectedPaymentRequest, RecordManuallyCollectedPaymentResponse$1, RecordManuallyCollectedPaymentResponse>;
|
|
3296
|
-
declare function paymentCollectionMarkOrderAsPaid(): __PublicMethodMetaInfo<'POST', {
|
|
3297
|
-
ecomOrderId: string;
|
|
3298
|
-
}, MarkOrderAsPaidRequest$1, MarkOrderAsPaidRequest, MarkOrderAsPaidResponse$1, MarkOrderAsPaidResponse>;
|
|
3299
|
-
declare function paymentCollectionBulkMarkOrdersAsPaid(): __PublicMethodMetaInfo<'POST', {}, BulkMarkOrdersAsPaidRequest$1, BulkMarkOrdersAsPaidRequest, BulkMarkOrdersAsPaidResponse$1, BulkMarkOrdersAsPaidResponse>;
|
|
3300
|
-
declare function getRefundabilityStatus(): __PublicMethodMetaInfo<'GET', {
|
|
3301
|
-
ecomOrderId: string;
|
|
3302
|
-
}, GetRefundabilityStatusRequest$1, GetRefundabilityStatusRequest, GetRefundabilityStatusResponse$1, GetRefundabilityStatusResponse>;
|
|
3303
|
-
declare function paymentCollectionCreatePaymentGatewayOrder(): __PublicMethodMetaInfo<'POST', {
|
|
3304
|
-
ecomOrderId: string;
|
|
3305
|
-
}, CreatePaymentGatewayOrderRequest$1, CreatePaymentGatewayOrderRequest, CreatePaymentGatewayOrderResponse$1, CreatePaymentGatewayOrderResponse>;
|
|
3306
|
-
declare function chargeMemberships(): __PublicMethodMetaInfo<'POST', {
|
|
3307
|
-
ecomOrderId: string;
|
|
3308
|
-
}, ChargeMembershipsRequest$1, ChargeMembershipsRequest, ChargeMembershipsResponse$1, ChargeMembershipsResponse>;
|
|
3309
|
-
declare function triggerRefund(): __PublicMethodMetaInfo<'POST', {
|
|
3310
|
-
ecomOrderId: string;
|
|
3311
|
-
}, TriggerRefundRequest$1, TriggerRefundRequest, TriggerRefundResponse$1, TriggerRefundResponse>;
|
|
3312
|
-
declare function voidAuthorizedPayments(): __PublicMethodMetaInfo<'POST', {
|
|
3313
|
-
ecomOrderId: string;
|
|
3314
|
-
}, VoidAuthorizedPaymentsRequest$1, VoidAuthorizedPaymentsRequest, VoidAuthorizedPaymentsResponse$1, VoidAuthorizedPaymentsResponse>;
|
|
3315
|
-
declare function captureAuthorizedPayments(): __PublicMethodMetaInfo<'POST', {
|
|
3316
|
-
ecomOrderId: string;
|
|
3317
|
-
}, CaptureAuthorizedPaymentsRequest$1, CaptureAuthorizedPaymentsRequest, CaptureAuthorizedPaymentsResponse$1, CaptureAuthorizedPaymentsResponse>;
|
|
3318
2350
|
declare function getOrder(): __PublicMethodMetaInfo<'GET', {
|
|
3319
2351
|
id: string;
|
|
3320
2352
|
}, GetOrderRequest$1, GetOrderRequest, GetOrderResponse$1, GetOrderResponse>;
|
|
@@ -3351,4 +2383,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
|
|
|
3351
2383
|
declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
|
|
3352
2384
|
declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
|
|
3353
2385
|
|
|
3354
|
-
export { type __PublicMethodMetaInfo, addActivity, aggregateOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder,
|
|
2386
|
+
export { type __PublicMethodMetaInfo, addActivity, aggregateOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, commitDeltas, createOrder, deleteActivity, getOrder, searchOrders, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus };
|