@wix/auto_sdk_ecom_orders 1.0.313 → 1.0.315
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-Dq-hzhTr.d.ts → ecom-v1-order-orders.universal-DXcKuMZ8.d.ts} +1705 -1705
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +80 -80
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +80 -80
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1705 -1705
- package/build/cjs/meta.js +80 -80
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-Dq-hzhTr.d.mts → ecom-v1-order-orders.universal-DXcKuMZ8.d.mts} +1705 -1705
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +80 -80
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +80 -80
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1705 -1705
- package/build/es/meta.mjs +80 -80
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-DLFaXYdm.d.ts → ecom-v1-order-orders.universal-Cc6i2pkz.d.ts} +1830 -1830
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +1830 -1830
- package/build/internal/es/{ecom-v1-order-orders.universal-DLFaXYdm.d.mts → ecom-v1-order-orders.universal-Cc6i2pkz.d.mts} +1830 -1830
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +1830 -1830
- package/package.json +2 -2
|
@@ -843,6 +843,23 @@ interface BillingAdjustmentPriceSummary {
|
|
|
843
843
|
/** Total price after tax. */
|
|
844
844
|
total?: Price;
|
|
845
845
|
}
|
|
846
|
+
/**
|
|
847
|
+
* Cycle price override as applied to a single billing cycle: the regular price and the price the
|
|
848
|
+
* override set for that cycle.
|
|
849
|
+
*/
|
|
850
|
+
interface CyclePriceOverride {
|
|
851
|
+
/**
|
|
852
|
+
* Billing cycle this order covers. `1` for the order created at checkout.
|
|
853
|
+
* Same value as `subscriptionInfo.cycleNumber`.
|
|
854
|
+
* @min 1
|
|
855
|
+
* @max 999
|
|
856
|
+
*/
|
|
857
|
+
cycle?: number;
|
|
858
|
+
/** Regular (recurring) unit price of the line item. */
|
|
859
|
+
basePrice?: Price;
|
|
860
|
+
/** Unit price the cycle price override set for this cycle, before line item discounts (coupons). */
|
|
861
|
+
overriddenPrice?: Price;
|
|
862
|
+
}
|
|
846
863
|
interface PriceDescription {
|
|
847
864
|
/**
|
|
848
865
|
* __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
@@ -3898,2193 +3915,2176 @@ interface BulkDeleteImportedOrdersResponse {
|
|
|
3898
3915
|
*/
|
|
3899
3916
|
jobId?: string;
|
|
3900
3917
|
}
|
|
3901
|
-
|
|
3902
|
-
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
interface
|
|
3918
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
3919
|
+
/** @format GUID */
|
|
3920
|
+
orderId?: string;
|
|
3921
|
+
}
|
|
3922
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
3923
|
+
}
|
|
3924
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3906
3925
|
/**
|
|
3907
|
-
*
|
|
3908
|
-
*
|
|
3909
|
-
* @min 1
|
|
3910
|
-
* @max 999
|
|
3926
|
+
* @minLength 1
|
|
3927
|
+
* @maxLength 100
|
|
3911
3928
|
*/
|
|
3912
|
-
|
|
3913
|
-
/** Regular (recurring) unit price of the line item. */
|
|
3914
|
-
basePrice?: Price;
|
|
3915
|
-
/** Unit price the cycle price override set for this cycle, before line item discounts (coupons). */
|
|
3916
|
-
overriddenPrice?: Price;
|
|
3929
|
+
orderId?: string;
|
|
3917
3930
|
}
|
|
3918
|
-
interface
|
|
3919
|
-
|
|
3920
|
-
|
|
3931
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
3932
|
+
}
|
|
3933
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
3921
3934
|
/**
|
|
3922
3935
|
* @minLength 1
|
|
3923
3936
|
* @maxLength 100
|
|
3924
|
-
|
|
3937
|
+
*/
|
|
3938
|
+
orderId?: string;
|
|
3939
|
+
}
|
|
3940
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
3941
|
+
}
|
|
3942
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3943
|
+
/**
|
|
3944
|
+
* IDs of orders to send pickup emails for.
|
|
3945
|
+
* @minSize 1
|
|
3946
|
+
* @maxSize 300
|
|
3925
3947
|
*/
|
|
3926
3948
|
orderIds?: string[];
|
|
3927
3949
|
}
|
|
3928
|
-
interface
|
|
3950
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3929
3951
|
}
|
|
3930
|
-
interface
|
|
3931
|
-
/** @format GUID */
|
|
3932
|
-
metasiteId?: string;
|
|
3952
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
3933
3953
|
/**
|
|
3934
3954
|
* @minLength 1
|
|
3935
3955
|
* @maxLength 100
|
|
3936
3956
|
*/
|
|
3937
3957
|
orderId?: string;
|
|
3938
3958
|
}
|
|
3939
|
-
interface
|
|
3959
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
3960
|
+
}
|
|
3961
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3962
|
+
/**
|
|
3963
|
+
* IDs of orders to send pickup emails for.
|
|
3964
|
+
* @minSize 1
|
|
3965
|
+
* @maxSize 300
|
|
3966
|
+
*/
|
|
3967
|
+
orderIds?: string[];
|
|
3968
|
+
}
|
|
3969
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3970
|
+
}
|
|
3971
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
3940
3972
|
/**
|
|
3941
|
-
* Ecom order ID.
|
|
3942
3973
|
* @minLength 1
|
|
3943
3974
|
* @maxLength 100
|
|
3944
3975
|
*/
|
|
3945
|
-
|
|
3946
|
-
|
|
3947
|
-
|
|
3976
|
+
orderId?: string;
|
|
3977
|
+
}
|
|
3978
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
3979
|
+
}
|
|
3980
|
+
interface SendCancelRefundEmailRequest {
|
|
3948
3981
|
/**
|
|
3949
|
-
*
|
|
3950
|
-
*
|
|
3951
|
-
*
|
|
3982
|
+
* The ID of order that is canceled/refunded
|
|
3983
|
+
* @minLength 1
|
|
3984
|
+
* @maxLength 100
|
|
3952
3985
|
*/
|
|
3953
|
-
|
|
3986
|
+
orderId?: string;
|
|
3954
3987
|
/**
|
|
3955
|
-
*
|
|
3956
|
-
*
|
|
3957
|
-
* @
|
|
3958
|
-
* Default: false
|
|
3959
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
3960
|
-
* @targetRemovalDate 2024-09-30
|
|
3988
|
+
* Personal note added to the email (optional)
|
|
3989
|
+
* @minLength 1
|
|
3990
|
+
* @maxLength 1000
|
|
3961
3991
|
*/
|
|
3962
|
-
|
|
3963
|
-
/**
|
|
3964
|
-
|
|
3965
|
-
}
|
|
3966
|
-
interface RedirectUrls {
|
|
3992
|
+
customMessage?: string | null;
|
|
3993
|
+
/** Refund amount */
|
|
3994
|
+
refundAmount?: Price;
|
|
3967
3995
|
/**
|
|
3968
|
-
*
|
|
3969
|
-
* @format
|
|
3996
|
+
* Refund ID. (Optional)
|
|
3997
|
+
* @format GUID
|
|
3970
3998
|
*/
|
|
3971
|
-
|
|
3999
|
+
refundId?: string | null;
|
|
4000
|
+
}
|
|
4001
|
+
interface SendCancelRefundEmailResponse {
|
|
4002
|
+
}
|
|
4003
|
+
interface SendRefundEmailRequest {
|
|
3972
4004
|
/**
|
|
3973
|
-
*
|
|
3974
|
-
* @format
|
|
4005
|
+
* The ID of order that is refunded
|
|
4006
|
+
* @format GUID
|
|
3975
4007
|
*/
|
|
3976
|
-
|
|
4008
|
+
orderId?: string;
|
|
3977
4009
|
/**
|
|
3978
|
-
*
|
|
3979
|
-
* @format
|
|
4010
|
+
* Refund ID
|
|
4011
|
+
* @format GUID
|
|
3980
4012
|
*/
|
|
3981
|
-
|
|
4013
|
+
refundId?: string;
|
|
3982
4014
|
/**
|
|
3983
|
-
*
|
|
3984
|
-
* @
|
|
4015
|
+
* Personal note added to the email (optional)
|
|
4016
|
+
* @minLength 1
|
|
4017
|
+
* @maxLength 1000
|
|
3985
4018
|
*/
|
|
3986
|
-
|
|
3987
|
-
}
|
|
3988
|
-
interface DelayedCaptureSettings {
|
|
3989
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
3990
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
3991
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
3992
|
-
delayDuration?: Duration;
|
|
3993
|
-
}
|
|
3994
|
-
declare enum ScheduledAction {
|
|
3995
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
3996
|
-
VOID = "VOID",
|
|
3997
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
3998
|
-
CAPTURE = "CAPTURE"
|
|
4019
|
+
customMessage?: string | null;
|
|
3999
4020
|
}
|
|
4000
|
-
|
|
4001
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4002
|
-
interface Duration {
|
|
4003
|
-
/**
|
|
4004
|
-
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4005
|
-
* @min 1
|
|
4006
|
-
*/
|
|
4007
|
-
count?: number;
|
|
4008
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4009
|
-
unit?: DurationUnitWithLiterals;
|
|
4021
|
+
interface SendRefundEmailResponse {
|
|
4010
4022
|
}
|
|
4011
|
-
|
|
4012
|
-
|
|
4013
|
-
|
|
4014
|
-
|
|
4023
|
+
interface SendFulfillmentEmailRequest {
|
|
4024
|
+
/** @format GUID */
|
|
4025
|
+
orderId?: string;
|
|
4026
|
+
/** @format GUID */
|
|
4027
|
+
fulfillerId?: string;
|
|
4015
4028
|
}
|
|
4016
|
-
|
|
4017
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4018
|
-
interface PreparePaymentCollectionResponse {
|
|
4019
|
-
/** Payment gateway order id which is associated with given payment */
|
|
4020
|
-
paymentGatewayOrderId?: string;
|
|
4029
|
+
interface SendFulfillmentEmailResponse {
|
|
4021
4030
|
}
|
|
4022
|
-
interface
|
|
4031
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
4023
4032
|
/**
|
|
4024
|
-
* Ecom order ID.
|
|
4025
4033
|
* @minLength 1
|
|
4026
4034
|
* @maxLength 100
|
|
4027
4035
|
*/
|
|
4028
|
-
|
|
4036
|
+
orderId?: string;
|
|
4029
4037
|
}
|
|
4030
|
-
interface
|
|
4031
|
-
/** Payment collectability status */
|
|
4032
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4033
|
-
/** Collectable order amount */
|
|
4034
|
-
amount?: Price;
|
|
4038
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
4035
4039
|
}
|
|
4036
|
-
|
|
4037
|
-
|
|
4038
|
-
|
|
4039
|
-
|
|
4040
|
-
|
|
4041
|
-
|
|
4042
|
-
|
|
4043
|
-
|
|
4044
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4045
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4046
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4047
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4048
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
4049
|
-
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
4040
|
+
interface PreviewEmailByTypeRequest {
|
|
4041
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
4042
|
+
}
|
|
4043
|
+
declare enum PreviewEmailType {
|
|
4044
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
4045
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
4046
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
4047
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
4050
4048
|
}
|
|
4051
4049
|
/** @enumType */
|
|
4052
|
-
type
|
|
4053
|
-
interface
|
|
4050
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
4051
|
+
interface PreviewEmailByTypeResponse {
|
|
4052
|
+
emailPreview?: string;
|
|
4053
|
+
}
|
|
4054
|
+
interface PreviewRefundEmailRequest {
|
|
4054
4055
|
/**
|
|
4055
|
-
* Order ID.
|
|
4056
4056
|
* @minLength 1
|
|
4057
4057
|
* @maxLength 100
|
|
4058
4058
|
*/
|
|
4059
|
-
orderId
|
|
4060
|
-
/**
|
|
4061
|
-
|
|
4062
|
-
|
|
4063
|
-
|
|
4064
|
-
* User-defined payment method name.
|
|
4065
|
-
* Allows specifying either a predefined type or a custom name.
|
|
4066
|
-
*/
|
|
4067
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4068
|
-
/** Predefined payment method. */
|
|
4069
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4059
|
+
orderId?: string;
|
|
4060
|
+
/** Refund amount */
|
|
4061
|
+
refundAmount?: Price;
|
|
4062
|
+
/** Refund business details */
|
|
4063
|
+
details?: RefundDetails;
|
|
4070
4064
|
/**
|
|
4071
|
-
*
|
|
4072
|
-
*
|
|
4073
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4065
|
+
* Personal note added to the email (optional)
|
|
4074
4066
|
* @minLength 1
|
|
4075
|
-
* @maxLength
|
|
4067
|
+
* @maxLength 1000
|
|
4076
4068
|
*/
|
|
4077
|
-
|
|
4078
|
-
}
|
|
4079
|
-
/** @oneof */
|
|
4080
|
-
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4081
|
-
/** Predefined payment method. */
|
|
4082
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4069
|
+
customMessage?: string | null;
|
|
4083
4070
|
/**
|
|
4084
|
-
*
|
|
4085
|
-
*
|
|
4086
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4087
|
-
* @minLength 1
|
|
4088
|
-
* @maxLength 150
|
|
4071
|
+
* Refund ID. (Optional)
|
|
4072
|
+
* @format GUID
|
|
4089
4073
|
*/
|
|
4090
|
-
|
|
4091
|
-
}
|
|
4092
|
-
/** Predefined payment method types for offline/manual payments. */
|
|
4093
|
-
declare enum PredefinedPaymentMethod {
|
|
4094
|
-
/** Cash payment. */
|
|
4095
|
-
CASH = "CASH",
|
|
4096
|
-
/** Bank transfer. */
|
|
4097
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4098
|
-
/** Payment by check. */
|
|
4099
|
-
CHECK = "CHECK"
|
|
4100
|
-
}
|
|
4101
|
-
/** @enumType */
|
|
4102
|
-
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4103
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
4074
|
+
refundId?: string | null;
|
|
4104
4075
|
}
|
|
4105
|
-
|
|
4076
|
+
/** Business model of a refund request */
|
|
4077
|
+
interface RefundDetails {
|
|
4106
4078
|
/**
|
|
4107
|
-
*
|
|
4108
|
-
* @
|
|
4109
|
-
* @maxLength 100
|
|
4079
|
+
* Order line item IDs and quantities that were refunded.
|
|
4080
|
+
* @maxSize 300
|
|
4110
4081
|
*/
|
|
4111
|
-
|
|
4112
|
-
|
|
4113
|
-
|
|
4114
|
-
/** Updated order. */
|
|
4115
|
-
order?: Order;
|
|
4116
|
-
}
|
|
4117
|
-
interface BulkMarkOrdersAsPaidRequest {
|
|
4082
|
+
items?: RefundItem[];
|
|
4083
|
+
/** Whether the shipping fee was also refunded. */
|
|
4084
|
+
shippingIncluded?: boolean;
|
|
4118
4085
|
/**
|
|
4119
|
-
*
|
|
4120
|
-
* @
|
|
4086
|
+
* Reason for the refund, provided by customer (optional).
|
|
4087
|
+
* @maxLength 200
|
|
4088
|
+
*/
|
|
4089
|
+
reason?: string | null;
|
|
4090
|
+
/**
|
|
4091
|
+
* Line items that were refunded.
|
|
4092
|
+
* @maxSize 300
|
|
4093
|
+
*/
|
|
4094
|
+
lineItems?: LineItemRefund[];
|
|
4095
|
+
/**
|
|
4096
|
+
* Additional fees that were refunded.
|
|
4121
4097
|
* @maxSize 100
|
|
4122
|
-
* @minLength 1
|
|
4123
|
-
* @maxLength 100
|
|
4124
4098
|
*/
|
|
4125
|
-
|
|
4099
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
4100
|
+
/** Shipping amount that was refunded. */
|
|
4101
|
+
shipping?: ShippingRefund;
|
|
4126
4102
|
}
|
|
4127
|
-
interface
|
|
4103
|
+
interface RefundItem {
|
|
4128
4104
|
/**
|
|
4129
|
-
*
|
|
4130
|
-
*
|
|
4105
|
+
* Line item ID the refunded line item.
|
|
4106
|
+
* @format GUID
|
|
4131
4107
|
*/
|
|
4132
|
-
|
|
4133
|
-
/** Bulk action metadata. */
|
|
4134
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4135
|
-
}
|
|
4136
|
-
interface BulkOrderResult {
|
|
4137
|
-
/** Item metadata. */
|
|
4138
|
-
itemMetadata?: ItemMetadata;
|
|
4108
|
+
lineItemId?: string;
|
|
4139
4109
|
/**
|
|
4140
|
-
*
|
|
4141
|
-
*
|
|
4142
|
-
*
|
|
4110
|
+
* Line item quantity refunded.
|
|
4111
|
+
* @min 1
|
|
4112
|
+
* @max 100000
|
|
4143
4113
|
*/
|
|
4144
|
-
|
|
4145
|
-
}
|
|
4146
|
-
interface ItemMetadata {
|
|
4147
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
4148
|
-
_id?: string | null;
|
|
4149
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
4150
|
-
originalIndex?: number;
|
|
4151
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
4152
|
-
success?: boolean;
|
|
4153
|
-
/** Details about the error in case of failure. */
|
|
4154
|
-
error?: ApplicationError;
|
|
4155
|
-
}
|
|
4156
|
-
interface ApplicationError {
|
|
4157
|
-
/** Error code. */
|
|
4158
|
-
code?: string;
|
|
4159
|
-
/** Description of the error. */
|
|
4160
|
-
description?: string;
|
|
4161
|
-
/** Data related to the error. */
|
|
4162
|
-
data?: Record<string, any> | null;
|
|
4163
|
-
}
|
|
4164
|
-
interface BulkActionMetadata {
|
|
4165
|
-
/** Number of items that were successfully processed. */
|
|
4166
|
-
totalSuccesses?: number;
|
|
4167
|
-
/** Number of items that couldn't be processed. */
|
|
4168
|
-
totalFailures?: number;
|
|
4169
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4170
|
-
undetailedFailures?: number;
|
|
4114
|
+
quantity?: number;
|
|
4171
4115
|
}
|
|
4172
|
-
interface
|
|
4116
|
+
interface LineItemRefund {
|
|
4173
4117
|
/**
|
|
4174
|
-
*
|
|
4175
|
-
* @
|
|
4176
|
-
* @
|
|
4118
|
+
* Line item ID.
|
|
4119
|
+
* @format GUID
|
|
4120
|
+
* @immutable
|
|
4177
4121
|
*/
|
|
4178
|
-
|
|
4122
|
+
lineItemId?: string;
|
|
4123
|
+
/**
|
|
4124
|
+
* Refund quantity.
|
|
4125
|
+
* @min 1
|
|
4126
|
+
* @max 100000
|
|
4127
|
+
* @immutable
|
|
4128
|
+
*/
|
|
4129
|
+
quantity?: number;
|
|
4179
4130
|
}
|
|
4180
|
-
interface
|
|
4131
|
+
interface AdditionalFeeRefund {
|
|
4181
4132
|
/**
|
|
4182
|
-
*
|
|
4183
|
-
* @
|
|
4133
|
+
* Additional fee ID.
|
|
4134
|
+
* @format GUID
|
|
4135
|
+
* @immutable
|
|
4184
4136
|
*/
|
|
4185
|
-
|
|
4137
|
+
additionalFeeId?: string;
|
|
4186
4138
|
/**
|
|
4187
|
-
*
|
|
4188
|
-
* @
|
|
4139
|
+
* Refund amount.
|
|
4140
|
+
* @immutable
|
|
4189
4141
|
*/
|
|
4190
|
-
|
|
4191
|
-
}
|
|
4192
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4193
|
-
/** Reason why payment is not refundable. */
|
|
4194
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4195
|
-
/** Reason why payment is only refundable manually. */
|
|
4196
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4197
|
-
/** Payment ID. */
|
|
4198
|
-
paymentId?: string;
|
|
4199
|
-
/** Payment refundability status. */
|
|
4200
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4201
|
-
/** Link to payment provider dashboard. */
|
|
4202
|
-
providerLink?: string | null;
|
|
4203
|
-
}
|
|
4204
|
-
/** @oneof */
|
|
4205
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4206
|
-
/** Reason why payment is not refundable. */
|
|
4207
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4208
|
-
/** Reason why payment is only refundable manually. */
|
|
4209
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4210
|
-
}
|
|
4211
|
-
declare enum RefundableStatus {
|
|
4212
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4213
|
-
MANUAL = "MANUAL",
|
|
4214
|
-
REFUNDABLE = "REFUNDABLE"
|
|
4142
|
+
amount?: Price;
|
|
4215
4143
|
}
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
|
|
4219
|
-
|
|
4220
|
-
|
|
4221
|
-
|
|
4222
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4223
|
-
NOT_PAID = "NOT_PAID",
|
|
4224
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4225
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
4226
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4227
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
4228
|
-
FORBIDDEN = "FORBIDDEN",
|
|
4229
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4230
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4231
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4144
|
+
interface ShippingRefund {
|
|
4145
|
+
/**
|
|
4146
|
+
* Refund amount.
|
|
4147
|
+
* @immutable
|
|
4148
|
+
*/
|
|
4149
|
+
amount?: Price;
|
|
4232
4150
|
}
|
|
4233
|
-
|
|
4234
|
-
|
|
4235
|
-
declare enum ManuallyRefundableReason {
|
|
4236
|
-
EXPIRED = "EXPIRED",
|
|
4237
|
-
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4238
|
-
OFFLINE = "OFFLINE",
|
|
4239
|
-
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4151
|
+
interface PreviewRefundEmailResponse {
|
|
4152
|
+
emailPreview?: string;
|
|
4240
4153
|
}
|
|
4241
|
-
|
|
4242
|
-
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4243
|
-
interface CreatePaymentGatewayOrderRequest {
|
|
4154
|
+
interface PreviewCancelEmailRequest {
|
|
4244
4155
|
/**
|
|
4245
|
-
* Ecom order ID.
|
|
4246
4156
|
* @minLength 1
|
|
4247
4157
|
* @maxLength 100
|
|
4248
4158
|
*/
|
|
4249
|
-
|
|
4250
|
-
/** Information about the user who initiated the payment. */
|
|
4251
|
-
chargedBy?: ChargedBy;
|
|
4252
|
-
}
|
|
4253
|
-
interface ChargedBy {
|
|
4254
|
-
/**
|
|
4255
|
-
* ID - id of the user who initiated the payment
|
|
4256
|
-
* @format GUID
|
|
4257
|
-
*/
|
|
4258
|
-
_id?: string;
|
|
4159
|
+
orderId?: string;
|
|
4259
4160
|
/**
|
|
4260
|
-
*
|
|
4161
|
+
* Personal note added to the email (optional)
|
|
4261
4162
|
* @minLength 1
|
|
4262
|
-
* @maxLength
|
|
4163
|
+
* @maxLength 1000
|
|
4263
4164
|
*/
|
|
4264
|
-
|
|
4165
|
+
customMessage?: string | null;
|
|
4265
4166
|
}
|
|
4266
|
-
interface
|
|
4267
|
-
|
|
4268
|
-
paymentGatewayOrderId?: string;
|
|
4167
|
+
interface PreviewCancelEmailResponse {
|
|
4168
|
+
emailPreview?: string;
|
|
4269
4169
|
}
|
|
4270
|
-
interface
|
|
4170
|
+
interface PreviewCancelRefundEmailRequest {
|
|
4271
4171
|
/**
|
|
4272
|
-
* Order ID.
|
|
4273
4172
|
* @minLength 1
|
|
4274
4173
|
* @maxLength 100
|
|
4275
4174
|
*/
|
|
4276
|
-
|
|
4277
|
-
/**
|
|
4278
|
-
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4279
|
-
* but a user which is using the membership on behalf of the a member
|
|
4280
|
-
* @format GUID
|
|
4281
|
-
*/
|
|
4282
|
-
memberId: string;
|
|
4283
|
-
/**
|
|
4284
|
-
* List of items to be paid by memberships
|
|
4285
|
-
* @minSize 1
|
|
4286
|
-
* @maxSize 300
|
|
4287
|
-
*/
|
|
4288
|
-
membershipCharges?: MembershipChargeItem[];
|
|
4289
|
-
}
|
|
4290
|
-
interface MembershipChargeItem {
|
|
4175
|
+
orderId?: string;
|
|
4291
4176
|
/**
|
|
4292
|
-
*
|
|
4177
|
+
* Personal note added to the email (optional)
|
|
4293
4178
|
* @minLength 1
|
|
4294
|
-
* @maxLength
|
|
4179
|
+
* @maxLength 1000
|
|
4295
4180
|
*/
|
|
4296
|
-
|
|
4181
|
+
customMessage?: string | null;
|
|
4182
|
+
/** Refund amount */
|
|
4183
|
+
refundAmount?: Price;
|
|
4297
4184
|
/**
|
|
4298
|
-
* ID
|
|
4185
|
+
* Refund ID. (Optional)
|
|
4299
4186
|
* @format GUID
|
|
4300
4187
|
*/
|
|
4301
|
-
|
|
4302
|
-
/** The name of used membership */
|
|
4303
|
-
membershipName?: MembershipName;
|
|
4304
|
-
/** Additional data about this membership */
|
|
4305
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
4306
|
-
/** Catalog and item reference info. */
|
|
4307
|
-
catalogReference?: CatalogReference;
|
|
4308
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4309
|
-
serviceProperties?: ServiceProperties;
|
|
4310
|
-
/**
|
|
4311
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
4312
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4313
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4314
|
-
* @minLength 1
|
|
4315
|
-
* @maxLength 36
|
|
4316
|
-
*/
|
|
4317
|
-
rootCatalogItemId?: string | null;
|
|
4318
|
-
/**
|
|
4319
|
-
* line item id of Checkout/Order line item
|
|
4320
|
-
* @minLength 1
|
|
4321
|
-
* @maxLength 100
|
|
4322
|
-
*/
|
|
4323
|
-
lineItemId?: string;
|
|
4188
|
+
refundId?: string | null;
|
|
4324
4189
|
}
|
|
4325
|
-
interface
|
|
4326
|
-
|
|
4327
|
-
* Membership name in the site's original language.
|
|
4328
|
-
* @maxLength 100
|
|
4329
|
-
*/
|
|
4330
|
-
original?: string;
|
|
4331
|
-
/**
|
|
4332
|
-
* Membership name translated into the buyer's language.
|
|
4333
|
-
*
|
|
4334
|
-
* Default: The value of `original`
|
|
4335
|
-
* @maxLength 100
|
|
4336
|
-
*/
|
|
4337
|
-
translated?: string | null;
|
|
4190
|
+
interface PreviewCancelRefundEmailResponse {
|
|
4191
|
+
emailPreview?: string;
|
|
4338
4192
|
}
|
|
4339
|
-
interface
|
|
4193
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
4340
4194
|
}
|
|
4341
|
-
interface
|
|
4195
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
4196
|
+
emailPreview?: string;
|
|
4197
|
+
}
|
|
4198
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
4199
|
+
}
|
|
4200
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
4201
|
+
emailPreview?: string;
|
|
4202
|
+
}
|
|
4203
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
4204
|
+
}
|
|
4205
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
4206
|
+
emailPreview?: string;
|
|
4207
|
+
}
|
|
4208
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
4209
|
+
}
|
|
4210
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
4211
|
+
emailPreview?: string;
|
|
4212
|
+
}
|
|
4213
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
4214
|
+
}
|
|
4215
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
4216
|
+
emailPreview?: string;
|
|
4217
|
+
}
|
|
4218
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4219
|
+
/** Emitted on a meta site creation. */
|
|
4220
|
+
siteCreated?: SiteCreated;
|
|
4221
|
+
/** Emitted on a meta site transfer completion. */
|
|
4222
|
+
siteTransferred?: SiteTransferred;
|
|
4223
|
+
/** Emitted on a meta site deletion. */
|
|
4224
|
+
siteDeleted?: SiteDeleted;
|
|
4225
|
+
/** Emitted on a meta site restoration. */
|
|
4226
|
+
siteUndeleted?: SiteUndeleted;
|
|
4227
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4228
|
+
sitePublished?: SitePublished;
|
|
4229
|
+
/** Emitted on a meta site unpublish. */
|
|
4230
|
+
siteUnpublished?: SiteUnpublished;
|
|
4231
|
+
/** Emitted when meta site is marked as template. */
|
|
4232
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4233
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
4234
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4235
|
+
/** Emitted when an application is provisioned (installed). */
|
|
4236
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
4237
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
4238
|
+
serviceRemoved?: ServiceRemoved;
|
|
4239
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
4240
|
+
siteRenamedPayload?: SiteRenamed;
|
|
4241
|
+
/** Emitted when meta site was permanently deleted. */
|
|
4242
|
+
hardDeleted?: SiteHardDeleted;
|
|
4243
|
+
/** Emitted on a namespace change. */
|
|
4244
|
+
namespaceChanged?: NamespaceChanged;
|
|
4245
|
+
/** Emitted when Studio is attached. */
|
|
4246
|
+
studioAssigned?: StudioAssigned;
|
|
4247
|
+
/** Emitted when Studio is detached. */
|
|
4248
|
+
studioUnassigned?: StudioUnassigned;
|
|
4342
4249
|
/**
|
|
4343
|
-
*
|
|
4344
|
-
*
|
|
4345
|
-
*
|
|
4250
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4251
|
+
* the actual URL.
|
|
4252
|
+
*
|
|
4253
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4254
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4346
4255
|
*/
|
|
4347
|
-
|
|
4256
|
+
urlChanged?: SiteUrlChanged;
|
|
4257
|
+
/** Site is marked as PurgedExternally */
|
|
4258
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
4259
|
+
/** Emitted when Odeditor is attached. */
|
|
4260
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
4261
|
+
/** Emitted when Odeditor is detached. */
|
|
4262
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
4263
|
+
/** Emitted when Picasso is attached. */
|
|
4264
|
+
picassoAssigned?: PicassoAssigned;
|
|
4265
|
+
/** Emitted when Picasso is detached. */
|
|
4266
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
4267
|
+
/** Emitted when Wixel is attached. */
|
|
4268
|
+
wixelAssigned?: WixelAssigned;
|
|
4269
|
+
/** Emitted when Wixel is detached. */
|
|
4270
|
+
wixelUnassigned?: WixelUnassigned;
|
|
4271
|
+
/** Emitted when StudioTwo is attached. */
|
|
4272
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
4273
|
+
/** Emitted when StudioTwo is detached. */
|
|
4274
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4275
|
+
/** Emitted when media from user domain is enabled. */
|
|
4276
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4277
|
+
/** Emitted when media from user domain is disabled. */
|
|
4278
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4279
|
+
/** Emitted when Editorless is attached. */
|
|
4280
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
4281
|
+
/** Emitted when Editorless is detached. */
|
|
4282
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
4348
4283
|
/**
|
|
4349
|
-
*
|
|
4350
|
-
* @
|
|
4351
|
-
* @maxSize 1
|
|
4284
|
+
* A meta site id.
|
|
4285
|
+
* @format GUID
|
|
4352
4286
|
*/
|
|
4353
|
-
|
|
4354
|
-
/**
|
|
4355
|
-
|
|
4356
|
-
/**
|
|
4357
|
-
|
|
4358
|
-
}
|
|
4359
|
-
interface PaymentRefund {
|
|
4287
|
+
metaSiteId?: string;
|
|
4288
|
+
/** A meta site version. Monotonically increasing. */
|
|
4289
|
+
version?: string;
|
|
4290
|
+
/** A timestamp of the event. */
|
|
4291
|
+
timestamp?: string;
|
|
4360
4292
|
/**
|
|
4361
|
-
*
|
|
4362
|
-
*
|
|
4293
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
4294
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
4295
|
+
* @maxSize 4000
|
|
4363
4296
|
*/
|
|
4364
|
-
|
|
4365
|
-
|
|
4366
|
-
|
|
4297
|
+
assets?: Asset[];
|
|
4298
|
+
}
|
|
4299
|
+
/** @oneof */
|
|
4300
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4301
|
+
/** Emitted on a meta site creation. */
|
|
4302
|
+
siteCreated?: SiteCreated;
|
|
4303
|
+
/** Emitted on a meta site transfer completion. */
|
|
4304
|
+
siteTransferred?: SiteTransferred;
|
|
4305
|
+
/** Emitted on a meta site deletion. */
|
|
4306
|
+
siteDeleted?: SiteDeleted;
|
|
4307
|
+
/** Emitted on a meta site restoration. */
|
|
4308
|
+
siteUndeleted?: SiteUndeleted;
|
|
4309
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4310
|
+
sitePublished?: SitePublished;
|
|
4311
|
+
/** Emitted on a meta site unpublish. */
|
|
4312
|
+
siteUnpublished?: SiteUnpublished;
|
|
4313
|
+
/** Emitted when meta site is marked as template. */
|
|
4314
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4315
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
4316
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4317
|
+
/** Emitted when an application is provisioned (installed). */
|
|
4318
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
4319
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
4320
|
+
serviceRemoved?: ServiceRemoved;
|
|
4321
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
4322
|
+
siteRenamedPayload?: SiteRenamed;
|
|
4323
|
+
/** Emitted when meta site was permanently deleted. */
|
|
4324
|
+
hardDeleted?: SiteHardDeleted;
|
|
4325
|
+
/** Emitted on a namespace change. */
|
|
4326
|
+
namespaceChanged?: NamespaceChanged;
|
|
4327
|
+
/** Emitted when Studio is attached. */
|
|
4328
|
+
studioAssigned?: StudioAssigned;
|
|
4329
|
+
/** Emitted when Studio is detached. */
|
|
4330
|
+
studioUnassigned?: StudioUnassigned;
|
|
4367
4331
|
/**
|
|
4368
|
-
*
|
|
4369
|
-
*
|
|
4370
|
-
*
|
|
4332
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4333
|
+
* the actual URL.
|
|
4334
|
+
*
|
|
4335
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4336
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4371
4337
|
*/
|
|
4372
|
-
|
|
4338
|
+
urlChanged?: SiteUrlChanged;
|
|
4339
|
+
/** Site is marked as PurgedExternally */
|
|
4340
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
4341
|
+
/** Emitted when Odeditor is attached. */
|
|
4342
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
4343
|
+
/** Emitted when Odeditor is detached. */
|
|
4344
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
4345
|
+
/** Emitted when Picasso is attached. */
|
|
4346
|
+
picassoAssigned?: PicassoAssigned;
|
|
4347
|
+
/** Emitted when Picasso is detached. */
|
|
4348
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
4349
|
+
/** Emitted when Wixel is attached. */
|
|
4350
|
+
wixelAssigned?: WixelAssigned;
|
|
4351
|
+
/** Emitted when Wixel is detached. */
|
|
4352
|
+
wixelUnassigned?: WixelUnassigned;
|
|
4353
|
+
/** Emitted when StudioTwo is attached. */
|
|
4354
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
4355
|
+
/** Emitted when StudioTwo is detached. */
|
|
4356
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4357
|
+
/** Emitted when media from user domain is enabled. */
|
|
4358
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4359
|
+
/** Emitted when media from user domain is disabled. */
|
|
4360
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4361
|
+
/** Emitted when Editorless is attached. */
|
|
4362
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
4363
|
+
/** Emitted when Editorless is detached. */
|
|
4364
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
4373
4365
|
}
|
|
4374
|
-
|
|
4375
|
-
interface RefundDetails {
|
|
4366
|
+
interface Asset {
|
|
4376
4367
|
/**
|
|
4377
|
-
*
|
|
4378
|
-
* @
|
|
4368
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
4369
|
+
* @maxLength 36
|
|
4379
4370
|
*/
|
|
4380
|
-
|
|
4381
|
-
/** Whether the shipping fee was also refunded. */
|
|
4382
|
-
shippingIncluded?: boolean;
|
|
4371
|
+
appDefId?: string;
|
|
4383
4372
|
/**
|
|
4384
|
-
*
|
|
4373
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
4385
4374
|
* @maxLength 200
|
|
4386
4375
|
*/
|
|
4387
|
-
|
|
4376
|
+
instanceId?: string;
|
|
4377
|
+
/** An application state. */
|
|
4378
|
+
state?: StateWithLiterals;
|
|
4379
|
+
}
|
|
4380
|
+
declare enum State {
|
|
4381
|
+
UNKNOWN = "UNKNOWN",
|
|
4382
|
+
ENABLED = "ENABLED",
|
|
4383
|
+
DISABLED = "DISABLED",
|
|
4384
|
+
PENDING = "PENDING",
|
|
4385
|
+
DEMO = "DEMO"
|
|
4386
|
+
}
|
|
4387
|
+
/** @enumType */
|
|
4388
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
4389
|
+
interface SiteCreated {
|
|
4388
4390
|
/**
|
|
4389
|
-
*
|
|
4390
|
-
* @
|
|
4391
|
+
* A template identifier (empty if not created from a template).
|
|
4392
|
+
* @maxLength 36
|
|
4391
4393
|
*/
|
|
4392
|
-
|
|
4394
|
+
originTemplateId?: string;
|
|
4393
4395
|
/**
|
|
4394
|
-
*
|
|
4395
|
-
* @
|
|
4396
|
+
* An account id of the owner.
|
|
4397
|
+
* @format GUID
|
|
4396
4398
|
*/
|
|
4397
|
-
|
|
4398
|
-
/**
|
|
4399
|
-
|
|
4400
|
-
}
|
|
4401
|
-
interface RefundItem {
|
|
4399
|
+
ownerId?: string;
|
|
4400
|
+
/** A context in which meta site was created. */
|
|
4401
|
+
context?: SiteCreatedContextWithLiterals;
|
|
4402
4402
|
/**
|
|
4403
|
-
*
|
|
4403
|
+
* A meta site id from which this site was created.
|
|
4404
|
+
*
|
|
4405
|
+
* In case of a creation from a template it's a template id.
|
|
4406
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
4404
4407
|
* @format GUID
|
|
4405
4408
|
*/
|
|
4406
|
-
|
|
4409
|
+
originMetaSiteId?: string | null;
|
|
4407
4410
|
/**
|
|
4408
|
-
*
|
|
4409
|
-
* @
|
|
4410
|
-
* @max 100000
|
|
4411
|
+
* A meta site name (URL slug).
|
|
4412
|
+
* @maxLength 20
|
|
4411
4413
|
*/
|
|
4412
|
-
|
|
4414
|
+
siteName?: string;
|
|
4415
|
+
/** A namespace. */
|
|
4416
|
+
namespace?: NamespaceWithLiterals;
|
|
4413
4417
|
}
|
|
4414
|
-
|
|
4415
|
-
/**
|
|
4416
|
-
|
|
4417
|
-
|
|
4418
|
-
|
|
4419
|
-
|
|
4420
|
-
|
|
4418
|
+
declare enum SiteCreatedContext {
|
|
4419
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
4420
|
+
OTHER = "OTHER",
|
|
4421
|
+
/** A meta site was created from template. */
|
|
4422
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
4423
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
4424
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
4425
|
+
/** A copy of existing meta site. */
|
|
4426
|
+
DUPLICATE = "DUPLICATE",
|
|
4427
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
4428
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
4429
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
4430
|
+
FLASH = "FLASH"
|
|
4431
|
+
}
|
|
4432
|
+
/** @enumType */
|
|
4433
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
4434
|
+
declare enum Namespace {
|
|
4435
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4436
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4437
|
+
WIX = "WIX",
|
|
4438
|
+
/** 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. */
|
|
4439
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
4440
|
+
/** 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. */
|
|
4441
|
+
ALBUMS = "ALBUMS",
|
|
4442
|
+
/** 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. */
|
|
4443
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4444
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4445
|
+
HOTELS = "HOTELS",
|
|
4446
|
+
/** 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. */
|
|
4447
|
+
CLUBS = "CLUBS",
|
|
4448
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4449
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4421
4450
|
/**
|
|
4422
|
-
*
|
|
4423
|
-
*
|
|
4424
|
-
* @max 100000
|
|
4425
|
-
* @immutable
|
|
4451
|
+
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
4452
|
+
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
4426
4453
|
*/
|
|
4427
|
-
|
|
4428
|
-
|
|
4429
|
-
|
|
4454
|
+
DEV_SITE = "DEV_SITE",
|
|
4455
|
+
/** 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. */
|
|
4456
|
+
LOGOS = "LOGOS",
|
|
4457
|
+
/** 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. */
|
|
4458
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4459
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4460
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4461
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4462
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4430
4463
|
/**
|
|
4431
|
-
*
|
|
4432
|
-
*
|
|
4433
|
-
*
|
|
4464
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
4465
|
+
*
|
|
4466
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
4434
4467
|
*/
|
|
4435
|
-
|
|
4468
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
4436
4469
|
/**
|
|
4437
|
-
*
|
|
4438
|
-
*
|
|
4470
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
4471
|
+
* Will be accessible from Site List and will not have a website app.
|
|
4472
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4439
4473
|
*/
|
|
4440
|
-
|
|
4441
|
-
|
|
4442
|
-
|
|
4474
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
4475
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
4476
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
4477
|
+
/** It is to be used in the Business First efforts. */
|
|
4478
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4479
|
+
/** Bookings business flow with no site. */
|
|
4480
|
+
ANYWHERE = "ANYWHERE",
|
|
4481
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
4482
|
+
HEADLESS = "HEADLESS",
|
|
4443
4483
|
/**
|
|
4444
|
-
*
|
|
4445
|
-
*
|
|
4484
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
4485
|
+
* The site will be used for account level CSM feature for enterprise
|
|
4446
4486
|
*/
|
|
4447
|
-
|
|
4448
|
-
|
|
4449
|
-
|
|
4450
|
-
/** Inventory restock details as part of this refund. */
|
|
4451
|
-
restockInfo?: RestockInfo;
|
|
4452
|
-
/** Whether to send a refund confirmation email to the customer. */
|
|
4453
|
-
sendOrderRefundedEmail?: boolean;
|
|
4487
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
4488
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
4489
|
+
RISE = "RISE",
|
|
4454
4490
|
/**
|
|
4455
|
-
*
|
|
4456
|
-
*
|
|
4457
|
-
*
|
|
4491
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
4492
|
+
* There's a blank site behind the scene but it's blank).
|
|
4493
|
+
* The Mobile company will be the owner of this namespace.
|
|
4458
4494
|
*/
|
|
4459
|
-
|
|
4460
|
-
|
|
4461
|
-
|
|
4462
|
-
/** Restock type. */
|
|
4463
|
-
type?: RestockTypeWithLiterals;
|
|
4495
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
4496
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
4497
|
+
NOWNIA = "NOWNIA",
|
|
4464
4498
|
/**
|
|
4465
|
-
*
|
|
4466
|
-
*
|
|
4499
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
4500
|
+
* The Partners company owns this namespace.
|
|
4467
4501
|
*/
|
|
4468
|
-
|
|
4469
|
-
|
|
4470
|
-
|
|
4471
|
-
|
|
4472
|
-
|
|
4473
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
4474
|
-
}
|
|
4475
|
-
/** @enumType */
|
|
4476
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
4477
|
-
interface RestockItem {
|
|
4502
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
4503
|
+
/** Codux Headless Sites */
|
|
4504
|
+
CODUX = "CODUX",
|
|
4505
|
+
/** Bobb - AI Design Creator. */
|
|
4506
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4478
4507
|
/**
|
|
4479
|
-
*
|
|
4480
|
-
*
|
|
4508
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
4509
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
4481
4510
|
*/
|
|
4482
|
-
|
|
4511
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
4512
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4513
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
4514
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4515
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
4516
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4517
|
+
MIMIR = "MIMIR",
|
|
4518
|
+
/** Wix Twins platform. */
|
|
4519
|
+
TWINS = "TWINS",
|
|
4520
|
+
/** Wix Nano. */
|
|
4521
|
+
NANO = "NANO",
|
|
4522
|
+
/** Base44 headless sites. */
|
|
4523
|
+
BASE44 = "BASE44",
|
|
4524
|
+
/** Wix Channels Sites */
|
|
4525
|
+
CHANNELS = "CHANNELS",
|
|
4526
|
+
/** Nautilus platform. */
|
|
4527
|
+
NAUTILUS = "NAUTILUS",
|
|
4483
4528
|
/**
|
|
4484
|
-
*
|
|
4485
|
-
*
|
|
4486
|
-
* @max 100000
|
|
4529
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
4530
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
4487
4531
|
*/
|
|
4488
|
-
|
|
4489
|
-
|
|
4490
|
-
|
|
4491
|
-
/** All order's transactions after the refunds were added */
|
|
4492
|
-
orderTransactions?: OrderTransactions;
|
|
4493
|
-
/** Created refund ID */
|
|
4494
|
-
refundId?: string | null;
|
|
4495
|
-
/** Payment ID's that the refund execution had failed for */
|
|
4496
|
-
failedPaymentIds?: ItemMetadata[];
|
|
4497
|
-
}
|
|
4498
|
-
/**
|
|
4499
|
-
* A record of all payments and refunds associated with an order.
|
|
4500
|
-
*
|
|
4501
|
-
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
4502
|
-
*/
|
|
4503
|
-
interface OrderTransactions {
|
|
4532
|
+
SYMPHONY = "SYMPHONY",
|
|
4533
|
+
/** Nautilus platform app. */
|
|
4534
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
4504
4535
|
/**
|
|
4505
|
-
*
|
|
4506
|
-
*
|
|
4536
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
4537
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
4507
4538
|
*/
|
|
4508
|
-
|
|
4539
|
+
VIBU = "VIBU",
|
|
4509
4540
|
/**
|
|
4510
|
-
*
|
|
4511
|
-
*
|
|
4541
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
4542
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
4543
|
+
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
4544
|
+
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
4512
4545
|
*/
|
|
4513
|
-
|
|
4546
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
|
|
4514
4547
|
/**
|
|
4515
|
-
*
|
|
4516
|
-
*
|
|
4548
|
+
* Dev-center development sites (com.wixpress.devcenter.dsm).
|
|
4549
|
+
* DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
|
|
4517
4550
|
*/
|
|
4518
|
-
|
|
4551
|
+
DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
|
|
4519
4552
|
}
|
|
4520
|
-
|
|
4521
|
-
|
|
4522
|
-
|
|
4523
|
-
|
|
4524
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4525
|
-
/** Membership payment details. */
|
|
4526
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
4553
|
+
/** @enumType */
|
|
4554
|
+
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' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
|
|
4555
|
+
/** Site transferred to another user. */
|
|
4556
|
+
interface SiteTransferred {
|
|
4527
4557
|
/**
|
|
4528
|
-
*
|
|
4558
|
+
* A previous owner id (user that transfers meta site).
|
|
4529
4559
|
* @format GUID
|
|
4530
|
-
* @readonly
|
|
4531
|
-
*/
|
|
4532
|
-
_id?: string | null;
|
|
4533
|
-
/** 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. */
|
|
4534
|
-
_createdDate?: Date | null;
|
|
4535
|
-
/**
|
|
4536
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
4537
|
-
* @readonly
|
|
4538
|
-
*/
|
|
4539
|
-
_updatedDate?: Date | null;
|
|
4540
|
-
/** Payment amount. */
|
|
4541
|
-
amount?: Price;
|
|
4542
|
-
/**
|
|
4543
|
-
* Whether refunds for this payment are disabled.
|
|
4544
|
-
* + `true`: This payment is not refundable.
|
|
4545
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
4546
4560
|
*/
|
|
4547
|
-
|
|
4561
|
+
oldOwnerId?: string;
|
|
4548
4562
|
/**
|
|
4549
|
-
*
|
|
4550
|
-
*
|
|
4551
|
-
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
4552
|
-
* @readonly
|
|
4563
|
+
* A new owner id (user that accepts meta site).
|
|
4564
|
+
* @format GUID
|
|
4553
4565
|
*/
|
|
4554
|
-
|
|
4555
|
-
|
|
4556
|
-
|
|
4566
|
+
newOwnerId?: string;
|
|
4567
|
+
}
|
|
4568
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
4569
|
+
interface SiteDeleted {
|
|
4570
|
+
/** A deletion context. */
|
|
4571
|
+
deleteContext?: DeleteContext;
|
|
4572
|
+
}
|
|
4573
|
+
interface DeleteContext {
|
|
4574
|
+
/** When the meta site was deleted. */
|
|
4575
|
+
dateDeleted?: Date | null;
|
|
4576
|
+
/** A status. */
|
|
4577
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
4557
4578
|
/**
|
|
4558
|
-
*
|
|
4559
|
-
*
|
|
4560
|
-
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
4579
|
+
* A reason (flow).
|
|
4580
|
+
* @maxLength 255
|
|
4561
4581
|
*/
|
|
4562
|
-
|
|
4582
|
+
deleteOrigin?: string;
|
|
4563
4583
|
/**
|
|
4564
|
-
*
|
|
4565
|
-
* @
|
|
4584
|
+
* A service that deleted it.
|
|
4585
|
+
* @maxLength 255
|
|
4566
4586
|
*/
|
|
4567
|
-
|
|
4587
|
+
initiatorId?: string | null;
|
|
4568
4588
|
}
|
|
4569
|
-
|
|
4570
|
-
|
|
4571
|
-
|
|
4572
|
-
|
|
4573
|
-
|
|
4574
|
-
|
|
4575
|
-
/** Membership payment details. */
|
|
4576
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
4589
|
+
declare enum DeleteStatus {
|
|
4590
|
+
UNKNOWN = "UNKNOWN",
|
|
4591
|
+
TRASH = "TRASH",
|
|
4592
|
+
DELETED = "DELETED",
|
|
4593
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
4594
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
4577
4595
|
}
|
|
4578
|
-
/** @
|
|
4579
|
-
|
|
4596
|
+
/** @enumType */
|
|
4597
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
4598
|
+
/** Restoration of the meta site. */
|
|
4599
|
+
interface SiteUndeleted {
|
|
4580
4600
|
}
|
|
4581
|
-
/**
|
|
4582
|
-
interface
|
|
4601
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
4602
|
+
interface SitePublished {
|
|
4583
4603
|
}
|
|
4584
|
-
interface
|
|
4585
|
-
/** Credit card details. */
|
|
4586
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4604
|
+
interface SiteUnpublished {
|
|
4587
4605
|
/**
|
|
4588
|
-
*
|
|
4589
|
-
* @maxLength
|
|
4606
|
+
* A list of URLs previously associated with the meta site.
|
|
4607
|
+
* @maxLength 4000
|
|
4608
|
+
* @maxSize 10000
|
|
4590
4609
|
*/
|
|
4591
|
-
|
|
4610
|
+
urls?: string[];
|
|
4611
|
+
}
|
|
4612
|
+
interface SiteMarkedAsTemplate {
|
|
4613
|
+
}
|
|
4614
|
+
interface SiteMarkedAsWixSite {
|
|
4615
|
+
}
|
|
4616
|
+
/**
|
|
4617
|
+
* Represents a service provisioned a site.
|
|
4618
|
+
*
|
|
4619
|
+
* Note on `origin_instance_id`:
|
|
4620
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
4621
|
+
* This is because of the following scenario:
|
|
4622
|
+
*
|
|
4623
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
4624
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
4625
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
4626
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
4627
|
+
* your site remains consistent with what you initially received and does not include any
|
|
4628
|
+
* changes made to the original template afterward.
|
|
4629
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
4630
|
+
*/
|
|
4631
|
+
interface ServiceProvisioned {
|
|
4592
4632
|
/**
|
|
4593
|
-
*
|
|
4594
|
-
*
|
|
4595
|
-
* @maxLength 100
|
|
4633
|
+
* Either UUID or EmbeddedServiceType.
|
|
4634
|
+
* @maxLength 36
|
|
4596
4635
|
*/
|
|
4597
|
-
|
|
4636
|
+
appDefId?: string;
|
|
4598
4637
|
/**
|
|
4599
|
-
*
|
|
4600
|
-
*
|
|
4601
|
-
* Non-exhaustive list of supported values:
|
|
4602
|
-
* + `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`
|
|
4603
|
-
* @maxLength 150
|
|
4604
|
-
* @deprecated Payment method.
|
|
4605
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
4606
|
-
* Non-exhaustive list of supported values:
|
|
4607
|
-
* + `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`
|
|
4608
|
-
* @replacedBy payment_method_name
|
|
4609
|
-
* @targetRemovalDate 2026-07-01
|
|
4638
|
+
* Not only UUID. Something here could be something weird.
|
|
4639
|
+
* @maxLength 36
|
|
4610
4640
|
*/
|
|
4611
|
-
|
|
4641
|
+
instanceId?: string;
|
|
4612
4642
|
/**
|
|
4613
|
-
*
|
|
4614
|
-
* @maxLength
|
|
4643
|
+
* An instance id from which this instance is originated.
|
|
4644
|
+
* @maxLength 36
|
|
4615
4645
|
*/
|
|
4616
|
-
|
|
4617
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
4618
|
-
offlinePayment?: boolean;
|
|
4646
|
+
originInstanceId?: string;
|
|
4619
4647
|
/**
|
|
4620
|
-
*
|
|
4621
|
-
* @
|
|
4622
|
-
* @replacedBy payment.status
|
|
4623
|
-
* @targetRemovalDate 2026-11-01
|
|
4648
|
+
* A version.
|
|
4649
|
+
* @maxLength 500
|
|
4624
4650
|
*/
|
|
4625
|
-
|
|
4626
|
-
/** Whether there is a payment agreement that allows for future charges. */
|
|
4627
|
-
savedPaymentMethod?: boolean;
|
|
4628
|
-
/** Authorization details. */
|
|
4629
|
-
authorizationDetails?: AuthorizationDetails;
|
|
4651
|
+
version?: string | null;
|
|
4630
4652
|
/**
|
|
4631
|
-
*
|
|
4632
|
-
* @
|
|
4653
|
+
* The origin meta site id
|
|
4654
|
+
* @format GUID
|
|
4633
4655
|
*/
|
|
4634
|
-
|
|
4635
|
-
|
|
4636
|
-
|
|
4656
|
+
originMetaSiteId?: string | null;
|
|
4657
|
+
}
|
|
4658
|
+
interface ServiceRemoved {
|
|
4637
4659
|
/**
|
|
4638
|
-
*
|
|
4639
|
-
*
|
|
4640
|
-
* + `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`
|
|
4660
|
+
* Either UUID or EmbeddedServiceType.
|
|
4661
|
+
* @maxLength 36
|
|
4641
4662
|
*/
|
|
4642
|
-
|
|
4643
|
-
}
|
|
4644
|
-
/** @oneof */
|
|
4645
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
4646
|
-
/** Credit card details. */
|
|
4647
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4648
|
-
}
|
|
4649
|
-
declare enum TransactionStatus {
|
|
4650
|
-
UNDEFINED = "UNDEFINED",
|
|
4651
|
-
APPROVED = "APPROVED",
|
|
4652
|
-
PENDING = "PENDING",
|
|
4653
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
4654
|
-
CANCELED = "CANCELED",
|
|
4655
|
-
DECLINED = "DECLINED",
|
|
4656
|
-
REFUNDED = "REFUNDED",
|
|
4657
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4658
|
-
AUTHORIZED = "AUTHORIZED",
|
|
4659
|
-
VOIDED = "VOIDED"
|
|
4660
|
-
}
|
|
4661
|
-
/** @enumType */
|
|
4662
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
4663
|
-
interface CreditCardPaymentMethodDetails {
|
|
4663
|
+
appDefId?: string;
|
|
4664
4664
|
/**
|
|
4665
|
-
*
|
|
4666
|
-
* @maxLength
|
|
4665
|
+
* Not only UUID. Something here could be something weird.
|
|
4666
|
+
* @maxLength 36
|
|
4667
4667
|
*/
|
|
4668
|
-
|
|
4668
|
+
instanceId?: string;
|
|
4669
4669
|
/**
|
|
4670
|
-
*
|
|
4671
|
-
* @maxLength
|
|
4670
|
+
* A version.
|
|
4671
|
+
* @maxLength 500
|
|
4672
4672
|
*/
|
|
4673
|
-
|
|
4673
|
+
version?: string | null;
|
|
4674
4674
|
}
|
|
4675
|
-
|
|
4675
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
4676
|
+
interface SiteRenamed {
|
|
4676
4677
|
/**
|
|
4677
|
-
*
|
|
4678
|
-
* @
|
|
4678
|
+
* A new meta site name (URL slug).
|
|
4679
|
+
* @maxLength 20
|
|
4679
4680
|
*/
|
|
4680
|
-
|
|
4681
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4682
|
-
authorizedDate?: Date | null;
|
|
4681
|
+
newSiteName?: string;
|
|
4683
4682
|
/**
|
|
4684
|
-
*
|
|
4685
|
-
*
|
|
4686
|
-
* @maxSize 1
|
|
4683
|
+
* A previous meta site name (URL slug).
|
|
4684
|
+
* @maxLength 255
|
|
4687
4685
|
*/
|
|
4688
|
-
|
|
4689
|
-
/** Void associated with payment */
|
|
4690
|
-
void?: AuthorizationVoid;
|
|
4691
|
-
/** Scheduled action for this transaction */
|
|
4692
|
-
scheduledAction?: V1ScheduledAction;
|
|
4686
|
+
oldSiteName?: string;
|
|
4693
4687
|
}
|
|
4694
|
-
|
|
4695
|
-
|
|
4696
|
-
|
|
4697
|
-
|
|
4698
|
-
|
|
4699
|
-
|
|
4700
|
-
|
|
4701
|
-
|
|
4702
|
-
|
|
4688
|
+
/**
|
|
4689
|
+
* Hard deletion of the meta site.
|
|
4690
|
+
*
|
|
4691
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
4692
|
+
*/
|
|
4693
|
+
interface SiteHardDeleted {
|
|
4694
|
+
/** A deletion context. */
|
|
4695
|
+
deleteContext?: DeleteContext;
|
|
4696
|
+
}
|
|
4697
|
+
interface NamespaceChanged {
|
|
4698
|
+
/** A previous namespace. */
|
|
4699
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
4700
|
+
/** A new namespace. */
|
|
4701
|
+
newNamespace?: NamespaceWithLiterals;
|
|
4702
|
+
}
|
|
4703
|
+
/** Assigned Studio editor */
|
|
4704
|
+
interface StudioAssigned {
|
|
4705
|
+
}
|
|
4706
|
+
/** Unassigned Studio editor */
|
|
4707
|
+
interface StudioUnassigned {
|
|
4708
|
+
}
|
|
4709
|
+
/**
|
|
4710
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
4711
|
+
*
|
|
4712
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
4713
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
4714
|
+
*
|
|
4715
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
4716
|
+
*/
|
|
4717
|
+
interface SiteUrlChanged {
|
|
4718
|
+
}
|
|
4719
|
+
/**
|
|
4720
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
4721
|
+
* Consumed by other teams to remove relevant data.
|
|
4722
|
+
*/
|
|
4723
|
+
interface SitePurgedExternally {
|
|
4703
4724
|
/**
|
|
4704
|
-
*
|
|
4705
|
-
* @
|
|
4725
|
+
* @maxLength 2048
|
|
4726
|
+
* @maxSize 100
|
|
4727
|
+
* @deprecated
|
|
4728
|
+
* @targetRemovalDate 2025-04-15
|
|
4706
4729
|
*/
|
|
4707
|
-
|
|
4708
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4709
|
-
_createdDate?: Date | null;
|
|
4710
|
-
/** In case of status is FAILED may contain failure details */
|
|
4711
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
4730
|
+
appDefId?: string[];
|
|
4712
4731
|
}
|
|
4713
|
-
|
|
4714
|
-
|
|
4715
|
-
PENDING = "PENDING",
|
|
4716
|
-
/** Capture operation succeeded. */
|
|
4717
|
-
SUCCEEDED = "SUCCEEDED",
|
|
4718
|
-
/** Capture operation failed. */
|
|
4719
|
-
FAILED = "FAILED"
|
|
4732
|
+
/** Assigned Odeditor */
|
|
4733
|
+
interface OdeditorAssigned {
|
|
4720
4734
|
}
|
|
4721
|
-
/**
|
|
4722
|
-
|
|
4723
|
-
interface AuthorizationActionFailureDetails {
|
|
4724
|
-
/** @maxLength 100 */
|
|
4725
|
-
failureCode?: string;
|
|
4735
|
+
/** Unassigned Odeditor */
|
|
4736
|
+
interface OdeditorUnassigned {
|
|
4726
4737
|
}
|
|
4727
|
-
|
|
4728
|
-
|
|
4729
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
4730
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4731
|
-
voidedDate?: Date | null;
|
|
4732
|
-
/** In case of status is FAILED may contain failure details */
|
|
4733
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
4734
|
-
/** Reason of void action */
|
|
4735
|
-
reason?: ReasonWithLiterals;
|
|
4738
|
+
/** Assigned Picasso editor */
|
|
4739
|
+
interface PicassoAssigned {
|
|
4736
4740
|
}
|
|
4737
|
-
|
|
4738
|
-
|
|
4739
|
-
|
|
4740
|
-
|
|
4741
|
-
|
|
4742
|
-
|
|
4743
|
-
|
|
4741
|
+
/** Unassigned Picasso */
|
|
4742
|
+
interface PicassoUnassigned {
|
|
4743
|
+
}
|
|
4744
|
+
/** Assigned Wixel */
|
|
4745
|
+
interface WixelAssigned {
|
|
4746
|
+
}
|
|
4747
|
+
/** Unassigned Wixel */
|
|
4748
|
+
interface WixelUnassigned {
|
|
4749
|
+
}
|
|
4750
|
+
/** Assigned StudioTwo */
|
|
4751
|
+
interface StudioTwoAssigned {
|
|
4752
|
+
}
|
|
4753
|
+
/** Unassigned StudioTwo */
|
|
4754
|
+
interface StudioTwoUnassigned {
|
|
4755
|
+
}
|
|
4756
|
+
/** Media from user domain is enabled. */
|
|
4757
|
+
interface UserDomainMediaEnabled {
|
|
4758
|
+
}
|
|
4759
|
+
/** Media from user domain is disabled. */
|
|
4760
|
+
interface UserDomainMediaDisabled {
|
|
4761
|
+
}
|
|
4762
|
+
/** Assigned Editorless */
|
|
4763
|
+
interface EditorlessAssigned {
|
|
4764
|
+
}
|
|
4765
|
+
/** Unassigned Editorless */
|
|
4766
|
+
interface EditorlessUnassigned {
|
|
4767
|
+
}
|
|
4768
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
4769
|
+
}
|
|
4770
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
4771
|
+
hasCustomConfigurations?: boolean;
|
|
4772
|
+
}
|
|
4773
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
4774
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
4775
|
+
sendCustomEmailConfigs?: boolean;
|
|
4776
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
4777
|
+
origin?: OriginWithLiterals;
|
|
4778
|
+
}
|
|
4779
|
+
declare enum Origin {
|
|
4780
|
+
OPT_IN = "OPT_IN",
|
|
4781
|
+
MIGRATION = "MIGRATION"
|
|
4744
4782
|
}
|
|
4745
4783
|
/** @enumType */
|
|
4746
|
-
type
|
|
4747
|
-
|
|
4748
|
-
|
|
4749
|
-
/** Authorization was voided by user. */
|
|
4750
|
-
MANUAL = "MANUAL",
|
|
4751
|
-
/** Authorization passed execution date. */
|
|
4752
|
-
SCHEDULED = "SCHEDULED"
|
|
4784
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
4785
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
4786
|
+
success?: boolean;
|
|
4753
4787
|
}
|
|
4754
|
-
|
|
4755
|
-
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
4756
|
-
interface V1ScheduledAction {
|
|
4757
|
-
/** Type of the action. */
|
|
4758
|
-
actionType?: ActionTypeWithLiterals;
|
|
4759
|
-
/** The date and time of the action. */
|
|
4760
|
-
executionDate?: Date | null;
|
|
4788
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
4761
4789
|
}
|
|
4762
|
-
|
|
4763
|
-
|
|
4764
|
-
CAPTURE = "CAPTURE"
|
|
4790
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
4791
|
+
inPopulation?: boolean;
|
|
4765
4792
|
}
|
|
4766
|
-
|
|
4767
|
-
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
4768
|
-
interface Chargeback {
|
|
4793
|
+
interface PreparePaymentCollectionRequest {
|
|
4769
4794
|
/**
|
|
4770
|
-
*
|
|
4771
|
-
* @
|
|
4772
|
-
* @
|
|
4773
|
-
* @immutable
|
|
4795
|
+
* Ecom order ID.
|
|
4796
|
+
* @minLength 1
|
|
4797
|
+
* @maxLength 100
|
|
4774
4798
|
*/
|
|
4775
|
-
|
|
4799
|
+
ecomOrderId: string;
|
|
4800
|
+
/** Amount to collect */
|
|
4801
|
+
amount: Price;
|
|
4776
4802
|
/**
|
|
4777
|
-
*
|
|
4778
|
-
*
|
|
4779
|
-
*
|
|
4803
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4804
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
4805
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4780
4806
|
*/
|
|
4781
|
-
|
|
4807
|
+
paymentGatewayOrderId?: string | null;
|
|
4782
4808
|
/**
|
|
4783
|
-
*
|
|
4784
|
-
*
|
|
4809
|
+
* Whether to delay capture of the payment.
|
|
4810
|
+
* Default: false
|
|
4811
|
+
* @deprecated Whether to delay capture of the payment.
|
|
4812
|
+
* Default: false
|
|
4813
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4814
|
+
* @targetRemovalDate 2024-09-30
|
|
4785
4815
|
*/
|
|
4786
|
-
|
|
4816
|
+
delayedCapture?: boolean;
|
|
4817
|
+
/** Delayed capture payment settings */
|
|
4818
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4819
|
+
}
|
|
4820
|
+
interface RedirectUrls {
|
|
4787
4821
|
/**
|
|
4788
|
-
*
|
|
4789
|
-
* @
|
|
4790
|
-
* @immutable
|
|
4822
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
4823
|
+
* @format WEB_URL
|
|
4791
4824
|
*/
|
|
4792
|
-
|
|
4825
|
+
successUrl?: string | null;
|
|
4793
4826
|
/**
|
|
4794
|
-
*
|
|
4795
|
-
* @
|
|
4827
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4828
|
+
* @format WEB_URL
|
|
4796
4829
|
*/
|
|
4797
|
-
|
|
4830
|
+
cancelUrl?: string | null;
|
|
4798
4831
|
/**
|
|
4799
|
-
*
|
|
4800
|
-
*
|
|
4801
|
-
* Default: `"APPROVED"`.
|
|
4832
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
4833
|
+
* @format WEB_URL
|
|
4802
4834
|
*/
|
|
4803
|
-
|
|
4835
|
+
errorUrl?: string | null;
|
|
4804
4836
|
/**
|
|
4805
|
-
*
|
|
4806
|
-
* @format
|
|
4807
|
-
* @readonly
|
|
4808
|
-
* @immutable
|
|
4837
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4838
|
+
* @format WEB_URL
|
|
4809
4839
|
*/
|
|
4810
|
-
|
|
4840
|
+
pendingUrl?: string | null;
|
|
4811
4841
|
}
|
|
4812
|
-
|
|
4813
|
-
/**
|
|
4814
|
-
|
|
4815
|
-
/**
|
|
4816
|
-
|
|
4842
|
+
interface DelayedCaptureSettings {
|
|
4843
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4844
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
4845
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4846
|
+
delayDuration?: Duration;
|
|
4847
|
+
}
|
|
4848
|
+
declare enum ScheduledAction {
|
|
4849
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
4850
|
+
VOID = "VOID",
|
|
4851
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
4852
|
+
CAPTURE = "CAPTURE"
|
|
4817
4853
|
}
|
|
4818
4854
|
/** @enumType */
|
|
4819
|
-
type
|
|
4820
|
-
interface
|
|
4821
|
-
/**
|
|
4822
|
-
* Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
|
|
4823
|
-
* @maxLength 150
|
|
4824
|
-
*/
|
|
4825
|
-
buyerLanguageName?: string | null;
|
|
4826
|
-
/**
|
|
4827
|
-
* Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
|
|
4828
|
-
*
|
|
4829
|
-
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
4830
|
-
* @maxLength 150
|
|
4831
|
-
*/
|
|
4832
|
-
siteLanguageName?: string | null;
|
|
4855
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4856
|
+
interface Duration {
|
|
4833
4857
|
/**
|
|
4834
|
-
*
|
|
4835
|
-
*
|
|
4836
|
-
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
4858
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4859
|
+
* @min 1
|
|
4837
4860
|
*/
|
|
4838
|
-
|
|
4861
|
+
count?: number;
|
|
4862
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4863
|
+
unit?: DurationUnitWithLiterals;
|
|
4839
4864
|
}
|
|
4840
|
-
|
|
4841
|
-
|
|
4842
|
-
|
|
4843
|
-
|
|
4844
|
-
*/
|
|
4845
|
-
giftCardPaymentId?: string;
|
|
4846
|
-
/**
|
|
4847
|
-
* ID of the app that created the gift card.
|
|
4848
|
-
* @format GUID
|
|
4849
|
-
*/
|
|
4850
|
-
appId?: string;
|
|
4851
|
-
/**
|
|
4852
|
-
* Whether the gift card is voided.
|
|
4853
|
-
* @readonly
|
|
4854
|
-
* @deprecated Whether the gift card is voided.
|
|
4855
|
-
* @replacedBy payment.status
|
|
4856
|
-
* @targetRemovalDate 2026-11-01
|
|
4857
|
-
*/
|
|
4858
|
-
voided?: boolean;
|
|
4859
|
-
/**
|
|
4860
|
-
* Gift card code with all but the last four characters masked. For example, `************QXY1`.
|
|
4861
|
-
* @maxLength 30
|
|
4862
|
-
* @immutable
|
|
4863
|
-
*/
|
|
4864
|
-
obfuscatedCode?: string | null;
|
|
4865
|
+
declare enum DurationUnit {
|
|
4866
|
+
MINUTES = "MINUTES",
|
|
4867
|
+
HOURS = "HOURS",
|
|
4868
|
+
DAYS = "DAYS"
|
|
4865
4869
|
}
|
|
4866
|
-
|
|
4867
|
-
|
|
4868
|
-
|
|
4869
|
-
|
|
4870
|
-
|
|
4871
|
-
|
|
4870
|
+
/** @enumType */
|
|
4871
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4872
|
+
interface PreparePaymentCollectionResponse {
|
|
4873
|
+
/** Payment gateway order id which is associated with given payment */
|
|
4874
|
+
paymentGatewayOrderId?: string;
|
|
4875
|
+
}
|
|
4876
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
4872
4877
|
/**
|
|
4873
|
-
*
|
|
4878
|
+
* Ecom order ID.
|
|
4874
4879
|
* @minLength 1
|
|
4875
4880
|
* @maxLength 100
|
|
4876
4881
|
*/
|
|
4877
|
-
|
|
4878
|
-
|
|
4879
|
-
|
|
4880
|
-
|
|
4881
|
-
|
|
4882
|
-
|
|
4883
|
-
|
|
4884
|
-
|
|
4885
|
-
|
|
4886
|
-
|
|
4882
|
+
ecomOrderId: string;
|
|
4883
|
+
}
|
|
4884
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
4885
|
+
/** Payment collectability status */
|
|
4886
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4887
|
+
/** Collectable order amount */
|
|
4888
|
+
amount?: Price;
|
|
4889
|
+
}
|
|
4890
|
+
declare enum PaymentCollectabilityStatus {
|
|
4891
|
+
UNKNOWN = "UNKNOWN",
|
|
4892
|
+
COLLECTABLE = "COLLECTABLE",
|
|
4893
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4894
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4895
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4896
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4897
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4898
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4899
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4900
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4901
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4902
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
4903
|
+
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
4904
|
+
}
|
|
4905
|
+
/** @enumType */
|
|
4906
|
+
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' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
|
|
4907
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
4887
4908
|
/**
|
|
4888
|
-
*
|
|
4909
|
+
* Order ID.
|
|
4889
4910
|
* @minLength 1
|
|
4890
4911
|
* @maxLength 100
|
|
4891
4912
|
*/
|
|
4892
|
-
|
|
4913
|
+
orderId: string;
|
|
4914
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
4915
|
+
amount: Price;
|
|
4916
|
+
}
|
|
4917
|
+
/**
|
|
4918
|
+
* User-defined payment method name.
|
|
4919
|
+
* Allows specifying either a predefined type or a custom name.
|
|
4920
|
+
*/
|
|
4921
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4922
|
+
/** Predefined payment method. */
|
|
4923
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4893
4924
|
/**
|
|
4894
|
-
*
|
|
4895
|
-
*
|
|
4896
|
-
*
|
|
4897
|
-
* @
|
|
4898
|
-
* @
|
|
4925
|
+
* Custom payment method name provided by user.
|
|
4926
|
+
*
|
|
4927
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4928
|
+
* @minLength 1
|
|
4929
|
+
* @maxLength 150
|
|
4899
4930
|
*/
|
|
4900
|
-
|
|
4931
|
+
custom?: string | null;
|
|
4932
|
+
}
|
|
4933
|
+
/** @oneof */
|
|
4934
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4935
|
+
/** Predefined payment method. */
|
|
4936
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4901
4937
|
/**
|
|
4902
|
-
*
|
|
4903
|
-
*
|
|
4938
|
+
* Custom payment method name provided by user.
|
|
4939
|
+
*
|
|
4940
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4941
|
+
* @minLength 1
|
|
4942
|
+
* @maxLength 150
|
|
4904
4943
|
*/
|
|
4905
|
-
|
|
4906
|
-
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
4907
|
-
futureMembership?: FutureMembershipDetails;
|
|
4944
|
+
custom?: string | null;
|
|
4908
4945
|
}
|
|
4909
|
-
|
|
4910
|
-
|
|
4911
|
-
|
|
4912
|
-
|
|
4913
|
-
|
|
4914
|
-
|
|
4915
|
-
|
|
4916
|
-
|
|
4917
|
-
VOIDED = "VOIDED"
|
|
4946
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
4947
|
+
declare enum PredefinedPaymentMethod {
|
|
4948
|
+
/** Cash payment. */
|
|
4949
|
+
CASH = "CASH",
|
|
4950
|
+
/** Bank transfer. */
|
|
4951
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4952
|
+
/** Payment by check. */
|
|
4953
|
+
CHECK = "CHECK"
|
|
4918
4954
|
}
|
|
4919
4955
|
/** @enumType */
|
|
4920
|
-
type
|
|
4921
|
-
interface
|
|
4922
|
-
/**
|
|
4923
|
-
* ID of the plan line item in the order from which the membership will be created.
|
|
4924
|
-
* @format GUID
|
|
4925
|
-
*/
|
|
4926
|
-
lineItemId?: string;
|
|
4927
|
-
/**
|
|
4928
|
-
* ID of the benefit the future membership will grant.
|
|
4929
|
-
* @maxLength 200
|
|
4930
|
-
*/
|
|
4931
|
-
benefitId?: string;
|
|
4956
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4957
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
4932
4958
|
}
|
|
4933
|
-
interface
|
|
4959
|
+
interface MarkOrderAsPaidRequest {
|
|
4934
4960
|
/**
|
|
4935
|
-
*
|
|
4936
|
-
* @
|
|
4961
|
+
* Ecom order ID.
|
|
4962
|
+
* @minLength 1
|
|
4963
|
+
* @maxLength 100
|
|
4937
4964
|
*/
|
|
4938
|
-
|
|
4965
|
+
ecomOrderId: string;
|
|
4966
|
+
}
|
|
4967
|
+
interface MarkOrderAsPaidResponse {
|
|
4968
|
+
/** Updated order. */
|
|
4969
|
+
order?: Order;
|
|
4970
|
+
}
|
|
4971
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
4939
4972
|
/**
|
|
4940
|
-
*
|
|
4973
|
+
* IDs of orders to mark as paid.
|
|
4974
|
+
* @minSize 1
|
|
4975
|
+
* @maxSize 100
|
|
4941
4976
|
* @minLength 1
|
|
4942
|
-
* @maxLength
|
|
4977
|
+
* @maxLength 100
|
|
4943
4978
|
*/
|
|
4944
|
-
|
|
4979
|
+
ecomOrderIds: string[];
|
|
4945
4980
|
}
|
|
4946
|
-
interface
|
|
4981
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
4947
4982
|
/**
|
|
4948
|
-
*
|
|
4949
|
-
*
|
|
4983
|
+
* Items updated by the bulk action.
|
|
4984
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
4950
4985
|
*/
|
|
4951
|
-
|
|
4986
|
+
results?: BulkOrderResult[];
|
|
4987
|
+
/** Bulk action metadata. */
|
|
4988
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4989
|
+
}
|
|
4990
|
+
interface BulkOrderResult {
|
|
4991
|
+
/** Item metadata. */
|
|
4992
|
+
itemMetadata?: ItemMetadata;
|
|
4952
4993
|
/**
|
|
4953
|
-
*
|
|
4954
|
-
*
|
|
4994
|
+
* Updated order.
|
|
4995
|
+
*
|
|
4996
|
+
* Returned when `returnFullEntity = true`.
|
|
4955
4997
|
*/
|
|
4956
|
-
|
|
4998
|
+
item?: Order;
|
|
4999
|
+
}
|
|
5000
|
+
interface ItemMetadata {
|
|
5001
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
5002
|
+
_id?: string | null;
|
|
5003
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
5004
|
+
originalIndex?: number;
|
|
5005
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
5006
|
+
success?: boolean;
|
|
5007
|
+
/** Details about the error in case of failure. */
|
|
5008
|
+
error?: ApplicationError;
|
|
5009
|
+
}
|
|
5010
|
+
interface ApplicationError {
|
|
5011
|
+
/** Error code. */
|
|
5012
|
+
code?: string;
|
|
5013
|
+
/** Description of the error. */
|
|
5014
|
+
description?: string;
|
|
5015
|
+
/** Data related to the error. */
|
|
5016
|
+
data?: Record<string, any> | null;
|
|
5017
|
+
}
|
|
5018
|
+
interface BulkActionMetadata {
|
|
5019
|
+
/** Number of items that were successfully processed. */
|
|
5020
|
+
totalSuccesses?: number;
|
|
5021
|
+
/** Number of items that couldn't be processed. */
|
|
5022
|
+
totalFailures?: number;
|
|
5023
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
5024
|
+
undetailedFailures?: number;
|
|
5025
|
+
}
|
|
5026
|
+
interface GetRefundabilityStatusRequest {
|
|
4957
5027
|
/**
|
|
4958
|
-
*
|
|
5028
|
+
* Order ID.
|
|
4959
5029
|
* @minLength 1
|
|
4960
|
-
* @maxLength
|
|
5030
|
+
* @maxLength 100
|
|
4961
5031
|
*/
|
|
4962
|
-
|
|
5032
|
+
ecomOrderId: string;
|
|
4963
5033
|
}
|
|
4964
|
-
interface
|
|
5034
|
+
interface GetRefundabilityStatusResponse {
|
|
4965
5035
|
/**
|
|
4966
|
-
*
|
|
4967
|
-
*
|
|
4968
|
-
* to prevent false overpayment or underpayment due to rounding.
|
|
5036
|
+
* Refundability details.
|
|
5037
|
+
* @maxSize 300
|
|
4969
5038
|
*/
|
|
4970
|
-
|
|
5039
|
+
refundabilities?: Refundability[];
|
|
4971
5040
|
/**
|
|
4972
|
-
*
|
|
4973
|
-
*
|
|
4974
|
-
* @readonly
|
|
5041
|
+
* Whether the order supports refunding per item.
|
|
5042
|
+
* @deprecated
|
|
4975
5043
|
*/
|
|
4976
|
-
|
|
5044
|
+
refundablePerItem?: boolean;
|
|
4977
5045
|
}
|
|
4978
|
-
|
|
4979
|
-
/**
|
|
4980
|
-
|
|
4981
|
-
/**
|
|
4982
|
-
|
|
4983
|
-
/** Payment
|
|
4984
|
-
|
|
4985
|
-
/** Payment
|
|
4986
|
-
|
|
4987
|
-
/**
|
|
4988
|
-
|
|
4989
|
-
/** Payment was fully refunded. */
|
|
4990
|
-
REFUNDED = "REFUNDED",
|
|
4991
|
-
/** Part of the payment amount was refunded. */
|
|
4992
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4993
|
-
/** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
|
|
4994
|
-
AUTHORIZED = "AUTHORIZED",
|
|
4995
|
-
/**
|
|
4996
|
-
* Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
|
|
4997
|
-
*
|
|
4998
|
-
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
4999
|
-
*/
|
|
5000
|
-
VOIDED = "VOIDED"
|
|
5046
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5047
|
+
/** Reason why payment is not refundable. */
|
|
5048
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5049
|
+
/** Reason why payment is only refundable manually. */
|
|
5050
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5051
|
+
/** Payment ID. */
|
|
5052
|
+
paymentId?: string;
|
|
5053
|
+
/** Payment refundability status. */
|
|
5054
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
5055
|
+
/** Link to payment provider dashboard. */
|
|
5056
|
+
providerLink?: string | null;
|
|
5001
5057
|
}
|
|
5002
|
-
/** @
|
|
5003
|
-
|
|
5004
|
-
|
|
5005
|
-
|
|
5058
|
+
/** @oneof */
|
|
5059
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5060
|
+
/** Reason why payment is not refundable. */
|
|
5061
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5062
|
+
/** Reason why payment is only refundable manually. */
|
|
5063
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5006
5064
|
}
|
|
5007
|
-
declare enum
|
|
5008
|
-
|
|
5009
|
-
|
|
5010
|
-
|
|
5011
|
-
EXPIRED = "EXPIRED"
|
|
5065
|
+
declare enum RefundableStatus {
|
|
5066
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
5067
|
+
MANUAL = "MANUAL",
|
|
5068
|
+
REFUNDABLE = "REFUNDABLE"
|
|
5012
5069
|
}
|
|
5013
5070
|
/** @enumType */
|
|
5014
|
-
type
|
|
5015
|
-
|
|
5016
|
-
|
|
5017
|
-
|
|
5018
|
-
|
|
5019
|
-
|
|
5020
|
-
|
|
5021
|
-
|
|
5022
|
-
|
|
5023
|
-
|
|
5024
|
-
|
|
5025
|
-
|
|
5026
|
-
|
|
5071
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
5072
|
+
declare enum NonRefundableReason {
|
|
5073
|
+
NONE = "NONE",
|
|
5074
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
5075
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
5076
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
5077
|
+
NOT_PAID = "NOT_PAID",
|
|
5078
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5079
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
5080
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5081
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
5082
|
+
FORBIDDEN = "FORBIDDEN",
|
|
5083
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5084
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5085
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
5027
5086
|
}
|
|
5028
5087
|
/** @enumType */
|
|
5029
|
-
type
|
|
5030
|
-
|
|
5031
|
-
|
|
5032
|
-
|
|
5033
|
-
|
|
5034
|
-
|
|
5035
|
-
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
5036
|
-
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
5037
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
5088
|
+
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';
|
|
5089
|
+
declare enum ManuallyRefundableReason {
|
|
5090
|
+
EXPIRED = "EXPIRED",
|
|
5091
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
5092
|
+
OFFLINE = "OFFLINE",
|
|
5093
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
5038
5094
|
}
|
|
5039
5095
|
/** @enumType */
|
|
5040
|
-
type
|
|
5041
|
-
interface
|
|
5042
|
-
|
|
5043
|
-
|
|
5044
|
-
|
|
5096
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
5097
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
5098
|
+
/**
|
|
5099
|
+
* Ecom order ID.
|
|
5100
|
+
* @minLength 1
|
|
5101
|
+
* @maxLength 100
|
|
5102
|
+
*/
|
|
5103
|
+
ecomOrderId: string;
|
|
5104
|
+
/** Information about the user who initiated the payment. */
|
|
5105
|
+
chargedBy?: ChargedBy;
|
|
5045
5106
|
}
|
|
5046
|
-
interface
|
|
5107
|
+
interface ChargedBy {
|
|
5047
5108
|
/**
|
|
5048
|
-
*
|
|
5109
|
+
* ID - id of the user who initiated the payment
|
|
5049
5110
|
* @format GUID
|
|
5050
|
-
* @readonly
|
|
5051
5111
|
*/
|
|
5052
5112
|
_id?: string;
|
|
5053
5113
|
/**
|
|
5054
|
-
*
|
|
5055
|
-
* @
|
|
5114
|
+
* Full name - name of the user who initiated the payment
|
|
5115
|
+
* @minLength 1
|
|
5116
|
+
* @maxLength 200
|
|
5056
5117
|
*/
|
|
5057
|
-
|
|
5058
|
-
|
|
5059
|
-
|
|
5118
|
+
fullName?: string | null;
|
|
5119
|
+
}
|
|
5120
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
5121
|
+
/** ID of the order created in the payment gateway */
|
|
5122
|
+
paymentGatewayOrderId?: string;
|
|
5123
|
+
}
|
|
5124
|
+
interface ChargeMembershipsRequest {
|
|
5060
5125
|
/**
|
|
5061
|
-
*
|
|
5062
|
-
* @
|
|
5063
|
-
* @
|
|
5126
|
+
* Order ID.
|
|
5127
|
+
* @minLength 1
|
|
5128
|
+
* @maxLength 100
|
|
5129
|
+
*/
|
|
5130
|
+
ecomOrderId: string;
|
|
5131
|
+
/**
|
|
5132
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
5133
|
+
* but a user which is using the membership on behalf of the a member
|
|
5134
|
+
* @format GUID
|
|
5135
|
+
*/
|
|
5136
|
+
memberId: string;
|
|
5137
|
+
/**
|
|
5138
|
+
* List of items to be paid by memberships
|
|
5139
|
+
* @minSize 1
|
|
5140
|
+
* @maxSize 300
|
|
5064
5141
|
*/
|
|
5065
|
-
|
|
5142
|
+
membershipCharges?: MembershipChargeItem[];
|
|
5143
|
+
}
|
|
5144
|
+
interface MembershipChargeItem {
|
|
5066
5145
|
/**
|
|
5067
|
-
*
|
|
5068
|
-
* @
|
|
5146
|
+
* The id of used membership
|
|
5147
|
+
* @minLength 1
|
|
5148
|
+
* @maxLength 100
|
|
5069
5149
|
*/
|
|
5070
|
-
|
|
5150
|
+
membershipId?: string;
|
|
5071
5151
|
/**
|
|
5072
|
-
* ID of the
|
|
5152
|
+
* ID of the application providing this payment option
|
|
5073
5153
|
* @format GUID
|
|
5074
|
-
* @readonly
|
|
5075
|
-
* @immutable
|
|
5076
5154
|
*/
|
|
5077
|
-
|
|
5078
|
-
|
|
5079
|
-
|
|
5155
|
+
appId?: string;
|
|
5156
|
+
/** The name of used membership */
|
|
5157
|
+
membershipName?: MembershipName;
|
|
5158
|
+
/** Additional data about this membership */
|
|
5159
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
5160
|
+
/** Catalog and item reference info. */
|
|
5161
|
+
catalogReference?: CatalogReference;
|
|
5162
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5163
|
+
serviceProperties?: ServiceProperties;
|
|
5080
5164
|
/**
|
|
5081
|
-
*
|
|
5082
|
-
*
|
|
5083
|
-
*
|
|
5165
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
5166
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
5167
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
5168
|
+
* @minLength 1
|
|
5169
|
+
* @maxLength 36
|
|
5084
5170
|
*/
|
|
5085
|
-
|
|
5171
|
+
rootCatalogItemId?: string | null;
|
|
5086
5172
|
/**
|
|
5087
|
-
*
|
|
5088
|
-
* @
|
|
5173
|
+
* line item id of Checkout/Order line item
|
|
5174
|
+
* @minLength 1
|
|
5175
|
+
* @maxLength 100
|
|
5089
5176
|
*/
|
|
5090
|
-
|
|
5091
|
-
|
|
5092
|
-
|
|
5093
|
-
/** Optional details of current refund status. */
|
|
5094
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
5177
|
+
lineItemId?: string;
|
|
5178
|
+
}
|
|
5179
|
+
interface MembershipName {
|
|
5095
5180
|
/**
|
|
5096
|
-
*
|
|
5097
|
-
*
|
|
5098
|
-
* @format GUID
|
|
5181
|
+
* Membership name in the site's original language.
|
|
5182
|
+
* @maxLength 100
|
|
5099
5183
|
*/
|
|
5100
|
-
|
|
5101
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5102
|
-
providerRefundId?: string | null;
|
|
5184
|
+
original?: string;
|
|
5103
5185
|
/**
|
|
5104
|
-
*
|
|
5105
|
-
*
|
|
5186
|
+
* Membership name translated into the buyer's language.
|
|
5187
|
+
*
|
|
5188
|
+
* Default: The value of `original`
|
|
5189
|
+
* @maxLength 100
|
|
5106
5190
|
*/
|
|
5107
|
-
|
|
5191
|
+
translated?: string | null;
|
|
5108
5192
|
}
|
|
5109
|
-
|
|
5110
|
-
declare enum RefundStatus {
|
|
5111
|
-
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
5112
|
-
PENDING = "PENDING",
|
|
5113
|
-
/** Refund transaction succeeded. */
|
|
5114
|
-
SUCCEEDED = "SUCCEEDED",
|
|
5115
|
-
/** Refund transaction failed. */
|
|
5116
|
-
FAILED = "FAILED",
|
|
5117
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
5118
|
-
SCHEDULED = "SCHEDULED",
|
|
5119
|
-
/** Refund was initiated on payment provider side. */
|
|
5120
|
-
STARTED = "STARTED"
|
|
5193
|
+
interface ChargeMembershipsResponse {
|
|
5121
5194
|
}
|
|
5122
|
-
|
|
5123
|
-
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5124
|
-
interface RefundStatusInfo {
|
|
5195
|
+
interface TriggerRefundRequest {
|
|
5125
5196
|
/**
|
|
5126
|
-
*
|
|
5127
|
-
*
|
|
5128
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5197
|
+
* The order this refund related to
|
|
5129
5198
|
* @minLength 1
|
|
5130
|
-
* @maxLength
|
|
5199
|
+
* @maxLength 100
|
|
5131
5200
|
*/
|
|
5132
|
-
|
|
5201
|
+
ecomOrderId: string;
|
|
5133
5202
|
/**
|
|
5134
|
-
*
|
|
5135
|
-
* @
|
|
5136
|
-
* @
|
|
5203
|
+
* Refund operations information
|
|
5204
|
+
* @minSize 1
|
|
5205
|
+
* @maxSize 1
|
|
5137
5206
|
*/
|
|
5138
|
-
|
|
5139
|
-
|
|
5140
|
-
|
|
5141
|
-
/**
|
|
5142
|
-
|
|
5143
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5144
|
-
pendingRefund?: Price;
|
|
5145
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5146
|
-
refunded?: Price;
|
|
5147
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5148
|
-
failedRefundAmount?: Price;
|
|
5149
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5150
|
-
pending?: boolean;
|
|
5151
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5152
|
-
breakdown?: RefundItemsBreakdown;
|
|
5207
|
+
payments: PaymentRefund[];
|
|
5208
|
+
/** Business model of a refund */
|
|
5209
|
+
details?: RefundDetails;
|
|
5210
|
+
/** Side effect details related to refund */
|
|
5211
|
+
sideEffects?: RefundSideEffects;
|
|
5153
5212
|
}
|
|
5154
|
-
interface
|
|
5213
|
+
interface PaymentRefund {
|
|
5155
5214
|
/**
|
|
5156
|
-
*
|
|
5157
|
-
* @
|
|
5215
|
+
* Specific payment within the order to refund
|
|
5216
|
+
* @format GUID
|
|
5158
5217
|
*/
|
|
5159
|
-
|
|
5160
|
-
|
|
5161
|
-
|
|
5218
|
+
paymentId?: string;
|
|
5219
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5220
|
+
amount?: Price;
|
|
5162
5221
|
/**
|
|
5163
|
-
*
|
|
5164
|
-
*
|
|
5222
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5223
|
+
* 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.
|
|
5224
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5165
5225
|
*/
|
|
5166
|
-
|
|
5167
|
-
/** Total refunded amount for the line item. */
|
|
5168
|
-
totalRefundedAmount?: Price;
|
|
5226
|
+
externalRefund?: boolean;
|
|
5169
5227
|
}
|
|
5170
|
-
interface
|
|
5228
|
+
interface RefundSideEffects {
|
|
5229
|
+
/** Inventory restock details as part of this refund. */
|
|
5230
|
+
restockInfo?: RestockInfo;
|
|
5231
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
5232
|
+
sendOrderRefundedEmail?: boolean;
|
|
5171
5233
|
/**
|
|
5172
|
-
*
|
|
5234
|
+
* Custom message added to the refund confirmation email.
|
|
5173
5235
|
* @minLength 1
|
|
5174
|
-
* @maxLength
|
|
5236
|
+
* @maxLength 1000
|
|
5175
5237
|
*/
|
|
5176
|
-
|
|
5238
|
+
customMessage?: string | null;
|
|
5239
|
+
}
|
|
5240
|
+
interface RestockInfo {
|
|
5241
|
+
/** Restock type. */
|
|
5242
|
+
type?: RestockTypeWithLiterals;
|
|
5177
5243
|
/**
|
|
5178
|
-
*
|
|
5244
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
5179
5245
|
* @maxSize 300
|
|
5180
5246
|
*/
|
|
5181
|
-
|
|
5182
|
-
/** Should include shipping in refund calculation */
|
|
5183
|
-
refundShipping?: boolean;
|
|
5247
|
+
items?: RestockItem[];
|
|
5184
5248
|
}
|
|
5185
|
-
|
|
5249
|
+
declare enum RestockType {
|
|
5250
|
+
NO_ITEMS = "NO_ITEMS",
|
|
5251
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
5252
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
5253
|
+
}
|
|
5254
|
+
/** @enumType */
|
|
5255
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5256
|
+
interface RestockItem {
|
|
5186
5257
|
/**
|
|
5187
|
-
* ID of the line item being
|
|
5258
|
+
* ID of the line item being restocked.
|
|
5188
5259
|
* @format GUID
|
|
5189
5260
|
*/
|
|
5190
|
-
|
|
5261
|
+
lineItemId?: string;
|
|
5191
5262
|
/**
|
|
5192
|
-
*
|
|
5263
|
+
* Line item quantity being restocked.
|
|
5193
5264
|
* @min 1
|
|
5194
5265
|
* @max 100000
|
|
5195
5266
|
*/
|
|
5196
5267
|
quantity?: number;
|
|
5197
5268
|
}
|
|
5198
|
-
interface
|
|
5199
|
-
/**
|
|
5200
|
-
|
|
5201
|
-
/**
|
|
5202
|
-
|
|
5203
|
-
/**
|
|
5204
|
-
|
|
5205
|
-
/** Total cost of the order (without tax) */
|
|
5206
|
-
subtotal?: Price;
|
|
5207
|
-
/** Total shipping cost for order */
|
|
5208
|
-
shipping?: Price;
|
|
5209
|
-
/** Previous refund given on that order */
|
|
5210
|
-
previouslyRefundedAmount?: Price;
|
|
5211
|
-
/**
|
|
5212
|
-
* The refundable items of that order
|
|
5213
|
-
* @maxSize 300
|
|
5214
|
-
*/
|
|
5215
|
-
items?: CalculateRefundItemResponse[];
|
|
5269
|
+
interface TriggerRefundResponse {
|
|
5270
|
+
/** All order's transactions after the refunds were added */
|
|
5271
|
+
orderTransactions?: OrderTransactions;
|
|
5272
|
+
/** Created refund ID */
|
|
5273
|
+
refundId?: string | null;
|
|
5274
|
+
/** Payment ID's that the refund execution had failed for */
|
|
5275
|
+
failedPaymentIds?: ItemMetadata[];
|
|
5216
5276
|
}
|
|
5217
|
-
|
|
5277
|
+
/**
|
|
5278
|
+
* A record of all payments and refunds associated with an order.
|
|
5279
|
+
*
|
|
5280
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5281
|
+
*/
|
|
5282
|
+
interface OrderTransactions {
|
|
5218
5283
|
/**
|
|
5219
|
-
*
|
|
5284
|
+
* Order ID.
|
|
5220
5285
|
* @format GUID
|
|
5221
5286
|
*/
|
|
5222
|
-
|
|
5223
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
5224
|
-
price?: Price;
|
|
5225
|
-
}
|
|
5226
|
-
interface VoidAuthorizedPaymentsRequest {
|
|
5287
|
+
orderId?: string;
|
|
5227
5288
|
/**
|
|
5228
|
-
*
|
|
5229
|
-
* @
|
|
5230
|
-
* @maxLength 100
|
|
5289
|
+
* Record of payments made to the merchant.
|
|
5290
|
+
* @maxSize 100
|
|
5231
5291
|
*/
|
|
5232
|
-
|
|
5292
|
+
payments?: Payment[];
|
|
5233
5293
|
/**
|
|
5234
|
-
*
|
|
5235
|
-
* @
|
|
5236
|
-
* @maxSize 100
|
|
5237
|
-
* @format GUID
|
|
5294
|
+
* Record of refunds made to the buyer.
|
|
5295
|
+
* @maxSize 300
|
|
5238
5296
|
*/
|
|
5239
|
-
|
|
5240
|
-
}
|
|
5241
|
-
interface VoidAuthorizedPaymentsResponse {
|
|
5242
|
-
/** All order's transactions after the void was triggered */
|
|
5243
|
-
orderTransactions?: OrderTransactions;
|
|
5297
|
+
refunds?: Refund[];
|
|
5244
5298
|
}
|
|
5245
|
-
interface
|
|
5299
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
|
|
5300
|
+
/** Regular payment details. */
|
|
5301
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5302
|
+
/** Gift card payment details. */
|
|
5303
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5304
|
+
/** Membership payment details. */
|
|
5305
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5246
5306
|
/**
|
|
5247
|
-
*
|
|
5248
|
-
* @
|
|
5249
|
-
* @
|
|
5307
|
+
* Payment ID.
|
|
5308
|
+
* @format GUID
|
|
5309
|
+
* @readonly
|
|
5310
|
+
*/
|
|
5311
|
+
_id?: string | null;
|
|
5312
|
+
/** 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. */
|
|
5313
|
+
_createdDate?: Date | null;
|
|
5314
|
+
/**
|
|
5315
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5316
|
+
* @readonly
|
|
5250
5317
|
*/
|
|
5251
|
-
|
|
5318
|
+
_updatedDate?: Date | null;
|
|
5319
|
+
/** Payment amount. */
|
|
5320
|
+
amount?: Price;
|
|
5252
5321
|
/**
|
|
5253
|
-
*
|
|
5254
|
-
*
|
|
5255
|
-
*
|
|
5322
|
+
* Whether refunds for this payment are disabled.
|
|
5323
|
+
* + `true`: This payment is not refundable.
|
|
5324
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5256
5325
|
*/
|
|
5257
|
-
|
|
5258
|
-
}
|
|
5259
|
-
interface PaymentCapture {
|
|
5326
|
+
refundDisabled?: boolean;
|
|
5260
5327
|
/**
|
|
5261
|
-
*
|
|
5262
|
-
*
|
|
5328
|
+
* Whether receipt generation is allowed for this payment.
|
|
5329
|
+
* + `true`: This payment supports receipt generation.
|
|
5330
|
+
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5331
|
+
* @readonly
|
|
5263
5332
|
*/
|
|
5264
|
-
|
|
5333
|
+
supportReceiptGeneration?: boolean;
|
|
5334
|
+
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5335
|
+
cashRounding?: CashRoundingDetails;
|
|
5265
5336
|
/**
|
|
5266
|
-
*
|
|
5267
|
-
*
|
|
5337
|
+
* Overall payment status.
|
|
5338
|
+
*
|
|
5339
|
+
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
5268
5340
|
*/
|
|
5269
|
-
|
|
5270
|
-
}
|
|
5271
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
5272
|
-
/** All order's transactions after the capture was triggered */
|
|
5273
|
-
orderTransactions?: OrderTransactions;
|
|
5274
|
-
}
|
|
5275
|
-
interface ChargeSavedPaymentMethodRequest {
|
|
5341
|
+
status?: PaymentStatusWithLiterals;
|
|
5276
5342
|
/**
|
|
5277
|
-
*
|
|
5278
|
-
* @
|
|
5279
|
-
* @maxLength 100
|
|
5343
|
+
* ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
|
|
5344
|
+
* @format GUID
|
|
5280
5345
|
*/
|
|
5281
|
-
|
|
5282
|
-
/** Amount to be charged */
|
|
5283
|
-
amount?: Price;
|
|
5346
|
+
chargeCorrelationId?: string | null;
|
|
5284
5347
|
}
|
|
5285
|
-
|
|
5286
|
-
|
|
5287
|
-
|
|
5348
|
+
/** @oneof */
|
|
5349
|
+
interface PaymentPaymentDetailsOneOf {
|
|
5350
|
+
/** Regular payment details. */
|
|
5351
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5352
|
+
/** Gift card payment details. */
|
|
5353
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5354
|
+
/** Membership payment details. */
|
|
5355
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5288
5356
|
}
|
|
5289
|
-
|
|
5290
|
-
|
|
5291
|
-
orderId?: string;
|
|
5357
|
+
/** @oneof */
|
|
5358
|
+
interface PaymentReceiptInfoOneOf {
|
|
5292
5359
|
}
|
|
5293
|
-
|
|
5360
|
+
/** @oneof */
|
|
5361
|
+
interface PaymentStatusDetailsOneOf {
|
|
5294
5362
|
}
|
|
5295
|
-
interface
|
|
5363
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5364
|
+
/** Credit card details. */
|
|
5365
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5296
5366
|
/**
|
|
5297
|
-
*
|
|
5367
|
+
* Wix Payments order ID.
|
|
5298
5368
|
* @maxLength 100
|
|
5299
5369
|
*/
|
|
5300
|
-
|
|
5301
|
-
}
|
|
5302
|
-
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
5303
|
-
}
|
|
5304
|
-
interface SendBuyerPickupConfirmationEmailRequest {
|
|
5370
|
+
paymentOrderId?: string | null;
|
|
5305
5371
|
/**
|
|
5306
|
-
*
|
|
5372
|
+
* Payment gateway's transaction ID.
|
|
5373
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
5307
5374
|
* @maxLength 100
|
|
5308
5375
|
*/
|
|
5309
|
-
|
|
5310
|
-
}
|
|
5311
|
-
interface SendBuyerPickupConfirmationEmailResponse {
|
|
5312
|
-
}
|
|
5313
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
5376
|
+
gatewayTransactionId?: string | null;
|
|
5314
5377
|
/**
|
|
5315
|
-
*
|
|
5316
|
-
*
|
|
5317
|
-
*
|
|
5378
|
+
* Payment method.
|
|
5379
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5380
|
+
* Non-exhaustive list of supported values:
|
|
5381
|
+
* + `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`
|
|
5382
|
+
* @maxLength 150
|
|
5383
|
+
* @deprecated Payment method.
|
|
5384
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5385
|
+
* Non-exhaustive list of supported values:
|
|
5386
|
+
* + `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`
|
|
5387
|
+
* @replacedBy payment_method_name
|
|
5388
|
+
* @targetRemovalDate 2026-07-01
|
|
5318
5389
|
*/
|
|
5319
|
-
|
|
5320
|
-
}
|
|
5321
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
5322
|
-
}
|
|
5323
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
5390
|
+
paymentMethod?: string | null;
|
|
5324
5391
|
/**
|
|
5325
|
-
*
|
|
5392
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
5326
5393
|
* @maxLength 100
|
|
5327
5394
|
*/
|
|
5328
|
-
|
|
5329
|
-
|
|
5330
|
-
|
|
5331
|
-
}
|
|
5332
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
5395
|
+
providerTransactionId?: string | null;
|
|
5396
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5397
|
+
offlinePayment?: boolean;
|
|
5333
5398
|
/**
|
|
5334
|
-
*
|
|
5335
|
-
* @
|
|
5336
|
-
* @
|
|
5399
|
+
* Payment status.
|
|
5400
|
+
* @deprecated Payment status.
|
|
5401
|
+
* @replacedBy payment.status
|
|
5402
|
+
* @targetRemovalDate 2026-11-01
|
|
5337
5403
|
*/
|
|
5338
|
-
|
|
5404
|
+
status?: TransactionStatusWithLiterals;
|
|
5405
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
5406
|
+
savedPaymentMethod?: boolean;
|
|
5407
|
+
/** Authorization details. */
|
|
5408
|
+
authorizationDetails?: AuthorizationDetails;
|
|
5409
|
+
/**
|
|
5410
|
+
* Record of chargebacks made by the buyer.
|
|
5411
|
+
* @maxSize 6
|
|
5412
|
+
*/
|
|
5413
|
+
chargebacks?: Chargeback[];
|
|
5414
|
+
/** Platform fee amount associated with this payment. */
|
|
5415
|
+
platformFee?: Price;
|
|
5416
|
+
/**
|
|
5417
|
+
* Payment method with buyer and optional owner translations.
|
|
5418
|
+
* Non-exhaustive list of supported values:
|
|
5419
|
+
* + `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`
|
|
5420
|
+
*/
|
|
5421
|
+
paymentMethodName?: PaymentMethodName;
|
|
5339
5422
|
}
|
|
5340
|
-
|
|
5423
|
+
/** @oneof */
|
|
5424
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5425
|
+
/** Credit card details. */
|
|
5426
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5341
5427
|
}
|
|
5342
|
-
|
|
5428
|
+
declare enum TransactionStatus {
|
|
5429
|
+
UNDEFINED = "UNDEFINED",
|
|
5430
|
+
APPROVED = "APPROVED",
|
|
5431
|
+
PENDING = "PENDING",
|
|
5432
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5433
|
+
CANCELED = "CANCELED",
|
|
5434
|
+
DECLINED = "DECLINED",
|
|
5435
|
+
REFUNDED = "REFUNDED",
|
|
5436
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5437
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5438
|
+
VOIDED = "VOIDED"
|
|
5439
|
+
}
|
|
5440
|
+
/** @enumType */
|
|
5441
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5442
|
+
interface CreditCardPaymentMethodDetails {
|
|
5343
5443
|
/**
|
|
5344
|
-
*
|
|
5444
|
+
* The last 4 digits of the card number.
|
|
5445
|
+
* @maxLength 4
|
|
5446
|
+
*/
|
|
5447
|
+
lastFourDigits?: string | null;
|
|
5448
|
+
/**
|
|
5449
|
+
* Card issuer's brand.
|
|
5345
5450
|
* @maxLength 100
|
|
5346
5451
|
*/
|
|
5347
|
-
|
|
5348
|
-
}
|
|
5349
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
5452
|
+
brand?: string | null;
|
|
5350
5453
|
}
|
|
5351
|
-
interface
|
|
5454
|
+
interface AuthorizationDetails {
|
|
5352
5455
|
/**
|
|
5353
|
-
*
|
|
5354
|
-
* @
|
|
5355
|
-
* @maxLength 100
|
|
5456
|
+
* Whether the authorized payment is of a delayed capture.
|
|
5457
|
+
* @readonly
|
|
5356
5458
|
*/
|
|
5357
|
-
|
|
5459
|
+
delayedCapture?: boolean;
|
|
5460
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5461
|
+
authorizedDate?: Date | null;
|
|
5358
5462
|
/**
|
|
5359
|
-
*
|
|
5360
|
-
*
|
|
5361
|
-
* @
|
|
5463
|
+
* List of captures associated with payment
|
|
5464
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
5465
|
+
* @maxSize 1
|
|
5362
5466
|
*/
|
|
5363
|
-
|
|
5364
|
-
/**
|
|
5365
|
-
|
|
5467
|
+
captures?: AuthorizationCapture[];
|
|
5468
|
+
/** Void associated with payment */
|
|
5469
|
+
void?: AuthorizationVoid;
|
|
5470
|
+
/** Scheduled action for this transaction */
|
|
5471
|
+
scheduledAction?: V1ScheduledAction;
|
|
5472
|
+
}
|
|
5473
|
+
interface AuthorizationCapture {
|
|
5366
5474
|
/**
|
|
5367
|
-
*
|
|
5475
|
+
* Capture ID.
|
|
5368
5476
|
* @format GUID
|
|
5477
|
+
* @readonly
|
|
5369
5478
|
*/
|
|
5370
|
-
|
|
5479
|
+
_id?: string | null;
|
|
5480
|
+
/** Status of this capture action */
|
|
5481
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
5482
|
+
/**
|
|
5483
|
+
* Amount of this capture
|
|
5484
|
+
* @immutable
|
|
5485
|
+
*/
|
|
5486
|
+
amount?: Price;
|
|
5487
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5488
|
+
_createdDate?: Date | null;
|
|
5489
|
+
/** In case of status is FAILED may contain failure details */
|
|
5490
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5491
|
+
}
|
|
5492
|
+
declare enum AuthorizationCaptureStatus {
|
|
5493
|
+
/** Capture operation still in progress. */
|
|
5494
|
+
PENDING = "PENDING",
|
|
5495
|
+
/** Capture operation succeeded. */
|
|
5496
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5497
|
+
/** Capture operation failed. */
|
|
5498
|
+
FAILED = "FAILED"
|
|
5499
|
+
}
|
|
5500
|
+
/** @enumType */
|
|
5501
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5502
|
+
interface AuthorizationActionFailureDetails {
|
|
5503
|
+
/** @maxLength 100 */
|
|
5504
|
+
failureCode?: string;
|
|
5505
|
+
}
|
|
5506
|
+
interface AuthorizationVoid {
|
|
5507
|
+
/** Status of this void action */
|
|
5508
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
5509
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5510
|
+
voidedDate?: Date | null;
|
|
5511
|
+
/** In case of status is FAILED may contain failure details */
|
|
5512
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5513
|
+
/** Reason of void action */
|
|
5514
|
+
reason?: ReasonWithLiterals;
|
|
5515
|
+
}
|
|
5516
|
+
declare enum AuthorizationVoidStatus {
|
|
5517
|
+
/** Void operation still in progress. */
|
|
5518
|
+
PENDING = "PENDING",
|
|
5519
|
+
/** Void operation succeeded. */
|
|
5520
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5521
|
+
/** Void operation failed. */
|
|
5522
|
+
FAILED = "FAILED"
|
|
5523
|
+
}
|
|
5524
|
+
/** @enumType */
|
|
5525
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5526
|
+
/** Reason the authorization was voided. */
|
|
5527
|
+
declare enum Reason {
|
|
5528
|
+
/** Authorization was voided by user. */
|
|
5529
|
+
MANUAL = "MANUAL",
|
|
5530
|
+
/** Authorization passed execution date. */
|
|
5531
|
+
SCHEDULED = "SCHEDULED"
|
|
5371
5532
|
}
|
|
5372
|
-
|
|
5533
|
+
/** @enumType */
|
|
5534
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
5535
|
+
interface V1ScheduledAction {
|
|
5536
|
+
/** Type of the action. */
|
|
5537
|
+
actionType?: ActionTypeWithLiterals;
|
|
5538
|
+
/** The date and time of the action. */
|
|
5539
|
+
executionDate?: Date | null;
|
|
5373
5540
|
}
|
|
5374
|
-
|
|
5541
|
+
declare enum ActionType {
|
|
5542
|
+
VOID = "VOID",
|
|
5543
|
+
CAPTURE = "CAPTURE"
|
|
5544
|
+
}
|
|
5545
|
+
/** @enumType */
|
|
5546
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5547
|
+
interface Chargeback {
|
|
5375
5548
|
/**
|
|
5376
|
-
*
|
|
5549
|
+
* Chargeback ID.
|
|
5377
5550
|
* @format GUID
|
|
5551
|
+
* @readonly
|
|
5552
|
+
* @immutable
|
|
5378
5553
|
*/
|
|
5379
|
-
|
|
5554
|
+
_id?: string;
|
|
5380
5555
|
/**
|
|
5381
|
-
*
|
|
5382
|
-
* @
|
|
5556
|
+
* 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.
|
|
5557
|
+
* @readonly
|
|
5558
|
+
* @immutable
|
|
5383
5559
|
*/
|
|
5384
|
-
|
|
5560
|
+
_createdDate?: Date | null;
|
|
5385
5561
|
/**
|
|
5386
|
-
*
|
|
5387
|
-
* @
|
|
5388
|
-
* @maxLength 1000
|
|
5562
|
+
* 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.
|
|
5563
|
+
* @readonly
|
|
5389
5564
|
*/
|
|
5390
|
-
|
|
5391
|
-
}
|
|
5392
|
-
interface SendRefundEmailResponse {
|
|
5393
|
-
}
|
|
5394
|
-
interface SendFulfillmentEmailRequest {
|
|
5395
|
-
/** @format GUID */
|
|
5396
|
-
orderId?: string;
|
|
5397
|
-
/** @format GUID */
|
|
5398
|
-
fulfillerId?: string;
|
|
5399
|
-
}
|
|
5400
|
-
interface SendFulfillmentEmailResponse {
|
|
5401
|
-
}
|
|
5402
|
-
interface SendMerchantOrderReceivedPushRequest {
|
|
5565
|
+
_updatedDate?: Date | null;
|
|
5403
5566
|
/**
|
|
5404
|
-
*
|
|
5405
|
-
* @
|
|
5567
|
+
* Amount.
|
|
5568
|
+
* @readonly
|
|
5569
|
+
* @immutable
|
|
5406
5570
|
*/
|
|
5407
|
-
|
|
5408
|
-
}
|
|
5409
|
-
interface SendMerchantOrderReceivedPushResponse {
|
|
5410
|
-
}
|
|
5411
|
-
interface PreviewEmailByTypeRequest {
|
|
5412
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
5413
|
-
}
|
|
5414
|
-
declare enum PreviewEmailType {
|
|
5415
|
-
ORDER_PLACED = "ORDER_PLACED",
|
|
5416
|
-
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
5417
|
-
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
5418
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
5419
|
-
}
|
|
5420
|
-
/** @enumType */
|
|
5421
|
-
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
5422
|
-
interface PreviewEmailByTypeResponse {
|
|
5423
|
-
emailPreview?: string;
|
|
5424
|
-
}
|
|
5425
|
-
interface PreviewRefundEmailRequest {
|
|
5571
|
+
amount?: Price;
|
|
5426
5572
|
/**
|
|
5427
|
-
*
|
|
5428
|
-
* @
|
|
5573
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
5574
|
+
* @readonly
|
|
5429
5575
|
*/
|
|
5430
|
-
|
|
5431
|
-
/** Refund amount */
|
|
5432
|
-
refundAmount?: Price;
|
|
5433
|
-
/** Refund business details */
|
|
5434
|
-
details?: RefundDetails;
|
|
5576
|
+
reversalAmount?: Price;
|
|
5435
5577
|
/**
|
|
5436
|
-
*
|
|
5437
|
-
*
|
|
5438
|
-
*
|
|
5578
|
+
* Status.
|
|
5579
|
+
*
|
|
5580
|
+
* Default: `"APPROVED"`.
|
|
5439
5581
|
*/
|
|
5440
|
-
|
|
5582
|
+
status?: ChargebackStatusWithLiterals;
|
|
5441
5583
|
/**
|
|
5442
|
-
*
|
|
5584
|
+
* External chargeback ID.
|
|
5443
5585
|
* @format GUID
|
|
5586
|
+
* @readonly
|
|
5587
|
+
* @immutable
|
|
5444
5588
|
*/
|
|
5445
|
-
|
|
5589
|
+
externalId?: string | null;
|
|
5446
5590
|
}
|
|
5447
|
-
|
|
5448
|
-
|
|
5591
|
+
declare enum ChargebackStatus {
|
|
5592
|
+
/** Chargeback was approved. */
|
|
5593
|
+
APPROVED = "APPROVED",
|
|
5594
|
+
/** Chargeback was reversed. */
|
|
5595
|
+
REVERSED = "REVERSED"
|
|
5449
5596
|
}
|
|
5450
|
-
|
|
5597
|
+
/** @enumType */
|
|
5598
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5599
|
+
interface PaymentMethodName {
|
|
5451
5600
|
/**
|
|
5452
|
-
*
|
|
5453
|
-
* @maxLength
|
|
5601
|
+
* Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
|
|
5602
|
+
* @maxLength 150
|
|
5454
5603
|
*/
|
|
5455
|
-
|
|
5604
|
+
buyerLanguageName?: string | null;
|
|
5456
5605
|
/**
|
|
5457
|
-
*
|
|
5458
|
-
*
|
|
5459
|
-
*
|
|
5606
|
+
* Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
|
|
5607
|
+
*
|
|
5608
|
+
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
5609
|
+
* @maxLength 150
|
|
5460
5610
|
*/
|
|
5461
|
-
|
|
5462
|
-
}
|
|
5463
|
-
interface PreviewCancelEmailResponse {
|
|
5464
|
-
emailPreview?: string;
|
|
5465
|
-
}
|
|
5466
|
-
interface PreviewCancelRefundEmailRequest {
|
|
5611
|
+
siteLanguageName?: string | null;
|
|
5467
5612
|
/**
|
|
5468
|
-
*
|
|
5469
|
-
*
|
|
5613
|
+
* User-provided payment method name.
|
|
5614
|
+
*
|
|
5615
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5470
5616
|
*/
|
|
5471
|
-
|
|
5617
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
5618
|
+
}
|
|
5619
|
+
interface GiftCardPaymentDetails {
|
|
5472
5620
|
/**
|
|
5473
|
-
*
|
|
5474
|
-
* @
|
|
5475
|
-
* @maxLength 1000
|
|
5621
|
+
* Gift card payment ID.
|
|
5622
|
+
* @maxLength 100
|
|
5476
5623
|
*/
|
|
5477
|
-
|
|
5478
|
-
/** Refund amount */
|
|
5479
|
-
refundAmount?: Price;
|
|
5624
|
+
giftCardPaymentId?: string;
|
|
5480
5625
|
/**
|
|
5481
|
-
*
|
|
5626
|
+
* ID of the app that created the gift card.
|
|
5482
5627
|
* @format GUID
|
|
5483
5628
|
*/
|
|
5484
|
-
|
|
5485
|
-
}
|
|
5486
|
-
interface PreviewCancelRefundEmailResponse {
|
|
5487
|
-
emailPreview?: string;
|
|
5488
|
-
}
|
|
5489
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
5490
|
-
}
|
|
5491
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
5492
|
-
emailPreview?: string;
|
|
5493
|
-
}
|
|
5494
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
5495
|
-
}
|
|
5496
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
5497
|
-
emailPreview?: string;
|
|
5498
|
-
}
|
|
5499
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
5500
|
-
}
|
|
5501
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
5502
|
-
emailPreview?: string;
|
|
5503
|
-
}
|
|
5504
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
5505
|
-
}
|
|
5506
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
5507
|
-
emailPreview?: string;
|
|
5508
|
-
}
|
|
5509
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
5510
|
-
}
|
|
5511
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
5512
|
-
emailPreview?: string;
|
|
5513
|
-
}
|
|
5514
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
5515
|
-
/** Emitted on a meta site creation. */
|
|
5516
|
-
siteCreated?: SiteCreated;
|
|
5517
|
-
/** Emitted on a meta site transfer completion. */
|
|
5518
|
-
siteTransferred?: SiteTransferred;
|
|
5519
|
-
/** Emitted on a meta site deletion. */
|
|
5520
|
-
siteDeleted?: SiteDeleted;
|
|
5521
|
-
/** Emitted on a meta site restoration. */
|
|
5522
|
-
siteUndeleted?: SiteUndeleted;
|
|
5523
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5524
|
-
sitePublished?: SitePublished;
|
|
5525
|
-
/** Emitted on a meta site unpublish. */
|
|
5526
|
-
siteUnpublished?: SiteUnpublished;
|
|
5527
|
-
/** Emitted when meta site is marked as template. */
|
|
5528
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5529
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5530
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5531
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5532
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5533
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5534
|
-
serviceRemoved?: ServiceRemoved;
|
|
5535
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5536
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5537
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5538
|
-
hardDeleted?: SiteHardDeleted;
|
|
5539
|
-
/** Emitted on a namespace change. */
|
|
5540
|
-
namespaceChanged?: NamespaceChanged;
|
|
5541
|
-
/** Emitted when Studio is attached. */
|
|
5542
|
-
studioAssigned?: StudioAssigned;
|
|
5543
|
-
/** Emitted when Studio is detached. */
|
|
5544
|
-
studioUnassigned?: StudioUnassigned;
|
|
5545
|
-
/**
|
|
5546
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5547
|
-
* the actual URL.
|
|
5548
|
-
*
|
|
5549
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5550
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5551
|
-
*/
|
|
5552
|
-
urlChanged?: SiteUrlChanged;
|
|
5553
|
-
/** Site is marked as PurgedExternally */
|
|
5554
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5555
|
-
/** Emitted when Odeditor is attached. */
|
|
5556
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5557
|
-
/** Emitted when Odeditor is detached. */
|
|
5558
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5559
|
-
/** Emitted when Picasso is attached. */
|
|
5560
|
-
picassoAssigned?: PicassoAssigned;
|
|
5561
|
-
/** Emitted when Picasso is detached. */
|
|
5562
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5563
|
-
/** Emitted when Wixel is attached. */
|
|
5564
|
-
wixelAssigned?: WixelAssigned;
|
|
5565
|
-
/** Emitted when Wixel is detached. */
|
|
5566
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5567
|
-
/** Emitted when StudioTwo is attached. */
|
|
5568
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5569
|
-
/** Emitted when StudioTwo is detached. */
|
|
5570
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5571
|
-
/** Emitted when media from user domain is enabled. */
|
|
5572
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5573
|
-
/** Emitted when media from user domain is disabled. */
|
|
5574
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5575
|
-
/** Emitted when Editorless is attached. */
|
|
5576
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5577
|
-
/** Emitted when Editorless is detached. */
|
|
5578
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5629
|
+
appId?: string;
|
|
5579
5630
|
/**
|
|
5580
|
-
*
|
|
5581
|
-
* @
|
|
5631
|
+
* Whether the gift card is voided.
|
|
5632
|
+
* @readonly
|
|
5633
|
+
* @deprecated Whether the gift card is voided.
|
|
5634
|
+
* @replacedBy payment.status
|
|
5635
|
+
* @targetRemovalDate 2026-11-01
|
|
5582
5636
|
*/
|
|
5583
|
-
|
|
5584
|
-
/** A meta site version. Monotonically increasing. */
|
|
5585
|
-
version?: string;
|
|
5586
|
-
/** A timestamp of the event. */
|
|
5587
|
-
timestamp?: string;
|
|
5637
|
+
voided?: boolean;
|
|
5588
5638
|
/**
|
|
5589
|
-
*
|
|
5590
|
-
*
|
|
5591
|
-
* @
|
|
5639
|
+
* Gift card code with all but the last four characters masked. For example, `************QXY1`.
|
|
5640
|
+
* @maxLength 30
|
|
5641
|
+
* @immutable
|
|
5592
5642
|
*/
|
|
5593
|
-
|
|
5643
|
+
obfuscatedCode?: string | null;
|
|
5594
5644
|
}
|
|
5595
|
-
|
|
5596
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
5597
|
-
/** Emitted on a meta site creation. */
|
|
5598
|
-
siteCreated?: SiteCreated;
|
|
5599
|
-
/** Emitted on a meta site transfer completion. */
|
|
5600
|
-
siteTransferred?: SiteTransferred;
|
|
5601
|
-
/** Emitted on a meta site deletion. */
|
|
5602
|
-
siteDeleted?: SiteDeleted;
|
|
5603
|
-
/** Emitted on a meta site restoration. */
|
|
5604
|
-
siteUndeleted?: SiteUndeleted;
|
|
5605
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5606
|
-
sitePublished?: SitePublished;
|
|
5607
|
-
/** Emitted on a meta site unpublish. */
|
|
5608
|
-
siteUnpublished?: SiteUnpublished;
|
|
5609
|
-
/** Emitted when meta site is marked as template. */
|
|
5610
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5611
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5612
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5613
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5614
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5615
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5616
|
-
serviceRemoved?: ServiceRemoved;
|
|
5617
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5618
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5619
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5620
|
-
hardDeleted?: SiteHardDeleted;
|
|
5621
|
-
/** Emitted on a namespace change. */
|
|
5622
|
-
namespaceChanged?: NamespaceChanged;
|
|
5623
|
-
/** Emitted when Studio is attached. */
|
|
5624
|
-
studioAssigned?: StudioAssigned;
|
|
5625
|
-
/** Emitted when Studio is detached. */
|
|
5626
|
-
studioUnassigned?: StudioUnassigned;
|
|
5645
|
+
interface MembershipPaymentDetails {
|
|
5627
5646
|
/**
|
|
5628
|
-
*
|
|
5629
|
-
*
|
|
5630
|
-
*
|
|
5631
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5632
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5647
|
+
* Membership ID.
|
|
5648
|
+
* @maxLength 200
|
|
5633
5649
|
*/
|
|
5634
|
-
|
|
5635
|
-
/** Site is marked as PurgedExternally */
|
|
5636
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5637
|
-
/** Emitted when Odeditor is attached. */
|
|
5638
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5639
|
-
/** Emitted when Odeditor is detached. */
|
|
5640
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5641
|
-
/** Emitted when Picasso is attached. */
|
|
5642
|
-
picassoAssigned?: PicassoAssigned;
|
|
5643
|
-
/** Emitted when Picasso is detached. */
|
|
5644
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5645
|
-
/** Emitted when Wixel is attached. */
|
|
5646
|
-
wixelAssigned?: WixelAssigned;
|
|
5647
|
-
/** Emitted when Wixel is detached. */
|
|
5648
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5649
|
-
/** Emitted when StudioTwo is attached. */
|
|
5650
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5651
|
-
/** Emitted when StudioTwo is detached. */
|
|
5652
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5653
|
-
/** Emitted when media from user domain is enabled. */
|
|
5654
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5655
|
-
/** Emitted when media from user domain is disabled. */
|
|
5656
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5657
|
-
/** Emitted when Editorless is attached. */
|
|
5658
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5659
|
-
/** Emitted when Editorless is detached. */
|
|
5660
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5661
|
-
}
|
|
5662
|
-
interface Asset {
|
|
5650
|
+
membershipId?: string;
|
|
5663
5651
|
/**
|
|
5664
|
-
*
|
|
5665
|
-
* @
|
|
5652
|
+
* ID of the line item this membership applies to.
|
|
5653
|
+
* @minLength 1
|
|
5654
|
+
* @maxLength 100
|
|
5666
5655
|
*/
|
|
5667
|
-
|
|
5656
|
+
lineItemId?: string;
|
|
5668
5657
|
/**
|
|
5669
|
-
*
|
|
5670
|
-
* @
|
|
5658
|
+
* Payment status.
|
|
5659
|
+
* @deprecated Payment status.
|
|
5660
|
+
* @replacedBy payment.status
|
|
5661
|
+
* @targetRemovalDate 2026-11-01
|
|
5671
5662
|
*/
|
|
5672
|
-
|
|
5673
|
-
/**
|
|
5674
|
-
|
|
5663
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
5664
|
+
/** Membership name. */
|
|
5665
|
+
name?: MembershipName;
|
|
5666
|
+
/**
|
|
5667
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
5668
|
+
* @minLength 1
|
|
5669
|
+
* @maxLength 100
|
|
5670
|
+
*/
|
|
5671
|
+
externalTransactionId?: string | null;
|
|
5672
|
+
/**
|
|
5673
|
+
* Whether the membership is voided.
|
|
5674
|
+
* @readonly
|
|
5675
|
+
* @deprecated Whether the membership is voided.
|
|
5676
|
+
* @replacedBy payment.status
|
|
5677
|
+
* @targetRemovalDate 2026-11-01
|
|
5678
|
+
*/
|
|
5679
|
+
voided?: boolean;
|
|
5680
|
+
/**
|
|
5681
|
+
* ID of the application providing this payment option.
|
|
5682
|
+
* @format GUID
|
|
5683
|
+
*/
|
|
5684
|
+
providerAppId?: string;
|
|
5685
|
+
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
5686
|
+
futureMembership?: FutureMembershipDetails;
|
|
5675
5687
|
}
|
|
5676
|
-
declare enum
|
|
5677
|
-
|
|
5678
|
-
|
|
5679
|
-
|
|
5680
|
-
|
|
5681
|
-
|
|
5688
|
+
declare enum MembershipPaymentStatus {
|
|
5689
|
+
/** Payment was charged. */
|
|
5690
|
+
CHARGED = "CHARGED",
|
|
5691
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5692
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5693
|
+
/** Payment is pending. */
|
|
5694
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5695
|
+
/** Payment was voided. */
|
|
5696
|
+
VOIDED = "VOIDED"
|
|
5682
5697
|
}
|
|
5683
5698
|
/** @enumType */
|
|
5684
|
-
type
|
|
5685
|
-
interface
|
|
5699
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
5700
|
+
interface FutureMembershipDetails {
|
|
5686
5701
|
/**
|
|
5687
|
-
*
|
|
5688
|
-
* @
|
|
5702
|
+
* ID of the plan line item in the order from which the membership will be created.
|
|
5703
|
+
* @format GUID
|
|
5689
5704
|
*/
|
|
5690
|
-
|
|
5705
|
+
lineItemId?: string;
|
|
5691
5706
|
/**
|
|
5692
|
-
*
|
|
5693
|
-
* @
|
|
5707
|
+
* ID of the benefit the future membership will grant.
|
|
5708
|
+
* @maxLength 200
|
|
5694
5709
|
*/
|
|
5695
|
-
|
|
5696
|
-
|
|
5697
|
-
|
|
5710
|
+
benefitId?: string;
|
|
5711
|
+
}
|
|
5712
|
+
interface WixReceiptInfo {
|
|
5698
5713
|
/**
|
|
5699
|
-
*
|
|
5700
|
-
*
|
|
5701
|
-
* In case of a creation from a template it's a template id.
|
|
5702
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5714
|
+
* Receipt ID
|
|
5703
5715
|
* @format GUID
|
|
5704
5716
|
*/
|
|
5705
|
-
|
|
5717
|
+
receiptId?: string;
|
|
5706
5718
|
/**
|
|
5707
|
-
*
|
|
5708
|
-
* @
|
|
5719
|
+
* Display number of receipt
|
|
5720
|
+
* @minLength 1
|
|
5721
|
+
* @maxLength 40
|
|
5709
5722
|
*/
|
|
5710
|
-
|
|
5711
|
-
/** A namespace. */
|
|
5712
|
-
namespace?: NamespaceWithLiterals;
|
|
5713
|
-
}
|
|
5714
|
-
declare enum SiteCreatedContext {
|
|
5715
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
5716
|
-
OTHER = "OTHER",
|
|
5717
|
-
/** A meta site was created from template. */
|
|
5718
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
5719
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
5720
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
5721
|
-
/** A copy of existing meta site. */
|
|
5722
|
-
DUPLICATE = "DUPLICATE",
|
|
5723
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
5724
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
5725
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
5726
|
-
FLASH = "FLASH"
|
|
5723
|
+
displayNumber?: string | null;
|
|
5727
5724
|
}
|
|
5728
|
-
|
|
5729
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
5730
|
-
declare enum Namespace {
|
|
5731
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5732
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5733
|
-
WIX = "WIX",
|
|
5734
|
-
/** 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. */
|
|
5735
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
5736
|
-
/** 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. */
|
|
5737
|
-
ALBUMS = "ALBUMS",
|
|
5738
|
-
/** 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. */
|
|
5739
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5740
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5741
|
-
HOTELS = "HOTELS",
|
|
5742
|
-
/** 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. */
|
|
5743
|
-
CLUBS = "CLUBS",
|
|
5744
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5745
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5725
|
+
interface ExternalReceiptInfo {
|
|
5746
5726
|
/**
|
|
5747
|
-
*
|
|
5748
|
-
*
|
|
5727
|
+
* External receipt ID
|
|
5728
|
+
* @maxLength 100
|
|
5749
5729
|
*/
|
|
5750
|
-
|
|
5751
|
-
/** 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. */
|
|
5752
|
-
LOGOS = "LOGOS",
|
|
5753
|
-
/** 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. */
|
|
5754
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5755
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5756
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5757
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5758
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5730
|
+
receiptId?: string | null;
|
|
5759
5731
|
/**
|
|
5760
|
-
*
|
|
5761
|
-
*
|
|
5762
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5732
|
+
* ID of the app providing the receipt
|
|
5733
|
+
* @format GUID
|
|
5763
5734
|
*/
|
|
5764
|
-
|
|
5735
|
+
appId?: string | null;
|
|
5765
5736
|
/**
|
|
5766
|
-
*
|
|
5767
|
-
*
|
|
5768
|
-
*
|
|
5737
|
+
* Display number of receipt
|
|
5738
|
+
* @minLength 1
|
|
5739
|
+
* @maxLength 40
|
|
5769
5740
|
*/
|
|
5770
|
-
|
|
5771
|
-
|
|
5772
|
-
|
|
5773
|
-
/** It is to be used in the Business First efforts. */
|
|
5774
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5775
|
-
/** Bookings business flow with no site. */
|
|
5776
|
-
ANYWHERE = "ANYWHERE",
|
|
5777
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
5778
|
-
HEADLESS = "HEADLESS",
|
|
5741
|
+
displayNumber?: string | null;
|
|
5742
|
+
}
|
|
5743
|
+
interface CashRoundingDetails {
|
|
5779
5744
|
/**
|
|
5780
|
-
*
|
|
5781
|
-
*
|
|
5745
|
+
* Payment amount before cash rounding was applied.
|
|
5746
|
+
* When provided, balance and status calculations use this value instead of `amount`
|
|
5747
|
+
* to prevent false overpayment or underpayment due to rounding.
|
|
5782
5748
|
*/
|
|
5783
|
-
|
|
5784
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
5785
|
-
RISE = "RISE",
|
|
5749
|
+
unroundedAmount?: Price;
|
|
5786
5750
|
/**
|
|
5787
|
-
*
|
|
5788
|
-
*
|
|
5789
|
-
*
|
|
5751
|
+
* The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
|
|
5752
|
+
* A positive value indicates the price was rounded up; a negative value indicates a round-down.
|
|
5753
|
+
* @readonly
|
|
5790
5754
|
*/
|
|
5791
|
-
|
|
5792
|
-
|
|
5793
|
-
|
|
5755
|
+
roundingAdjustment?: CashRounding;
|
|
5756
|
+
}
|
|
5757
|
+
declare enum PaymentStatus {
|
|
5758
|
+
/** Payment was charged successfully. */
|
|
5759
|
+
APPROVED = "APPROVED",
|
|
5760
|
+
/** Payment is being processed and hasn't been confirmed yet. */
|
|
5761
|
+
PENDING = "PENDING",
|
|
5762
|
+
/** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
|
|
5763
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5764
|
+
/** Payment was canceled before it was charged. */
|
|
5765
|
+
CANCELED = "CANCELED",
|
|
5766
|
+
/** Payment was declined by the payment provider. */
|
|
5767
|
+
DECLINED = "DECLINED",
|
|
5768
|
+
/** Payment was fully refunded. */
|
|
5769
|
+
REFUNDED = "REFUNDED",
|
|
5770
|
+
/** Part of the payment amount was refunded. */
|
|
5771
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5772
|
+
/** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
|
|
5773
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5794
5774
|
/**
|
|
5795
|
-
*
|
|
5796
|
-
*
|
|
5775
|
+
* Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
|
|
5776
|
+
*
|
|
5777
|
+
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
5797
5778
|
*/
|
|
5798
|
-
|
|
5799
|
-
|
|
5800
|
-
|
|
5801
|
-
|
|
5802
|
-
|
|
5779
|
+
VOIDED = "VOIDED"
|
|
5780
|
+
}
|
|
5781
|
+
/** @enumType */
|
|
5782
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5783
|
+
interface CanceledStatusDetails {
|
|
5784
|
+
reason?: CanceledReasonWithLiterals;
|
|
5785
|
+
}
|
|
5786
|
+
declare enum CanceledReason {
|
|
5787
|
+
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
5788
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
5789
|
+
/** Payment was not completed by user and expired. */
|
|
5790
|
+
EXPIRED = "EXPIRED"
|
|
5791
|
+
}
|
|
5792
|
+
/** @enumType */
|
|
5793
|
+
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
5794
|
+
interface DeclinedStatusDetails {
|
|
5795
|
+
reason?: DeclinedReasonWithLiterals;
|
|
5796
|
+
}
|
|
5797
|
+
declare enum DeclinedReason {
|
|
5798
|
+
/** Corresponding charge failed. */
|
|
5799
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5800
|
+
/** Payment details expired. */
|
|
5801
|
+
EXPIRED = "EXPIRED",
|
|
5802
|
+
/** Insufficient funds. */
|
|
5803
|
+
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
5804
|
+
/** Gift card was disabled before charge was attempted. */
|
|
5805
|
+
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
5806
|
+
}
|
|
5807
|
+
/** @enumType */
|
|
5808
|
+
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
5809
|
+
interface VoidedStatusDetails {
|
|
5810
|
+
reason?: VoidedReasonWithLiterals;
|
|
5811
|
+
}
|
|
5812
|
+
declare enum VoidedReason {
|
|
5813
|
+
/** Payment was voided by merchant request. */
|
|
5814
|
+
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
5815
|
+
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
5816
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
5817
|
+
}
|
|
5818
|
+
/** @enumType */
|
|
5819
|
+
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
5820
|
+
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
5821
|
+
}
|
|
5822
|
+
/** @oneof */
|
|
5823
|
+
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
5824
|
+
}
|
|
5825
|
+
interface Refund {
|
|
5803
5826
|
/**
|
|
5804
|
-
*
|
|
5805
|
-
*
|
|
5827
|
+
* Refund ID.
|
|
5828
|
+
* @format GUID
|
|
5829
|
+
* @readonly
|
|
5806
5830
|
*/
|
|
5807
|
-
|
|
5808
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5809
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
5810
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5811
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
5812
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
5813
|
-
MIMIR = "MIMIR",
|
|
5814
|
-
/** Wix Twins platform. */
|
|
5815
|
-
TWINS = "TWINS",
|
|
5816
|
-
/** Wix Nano. */
|
|
5817
|
-
NANO = "NANO",
|
|
5818
|
-
/** Base44 headless sites. */
|
|
5819
|
-
BASE44 = "BASE44",
|
|
5820
|
-
/** Wix Channels Sites */
|
|
5821
|
-
CHANNELS = "CHANNELS",
|
|
5822
|
-
/** Nautilus platform. */
|
|
5823
|
-
NAUTILUS = "NAUTILUS",
|
|
5831
|
+
_id?: string;
|
|
5824
5832
|
/**
|
|
5825
|
-
*
|
|
5826
|
-
*
|
|
5833
|
+
* List of transactions.
|
|
5834
|
+
* @maxSize 50
|
|
5827
5835
|
*/
|
|
5828
|
-
|
|
5829
|
-
/**
|
|
5830
|
-
|
|
5836
|
+
transactions?: RefundTransaction[];
|
|
5837
|
+
/** Refund business details. */
|
|
5838
|
+
details?: RefundDetails;
|
|
5831
5839
|
/**
|
|
5832
|
-
*
|
|
5833
|
-
*
|
|
5840
|
+
* 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.
|
|
5841
|
+
* @readonly
|
|
5842
|
+
* @immutable
|
|
5834
5843
|
*/
|
|
5835
|
-
|
|
5844
|
+
_createdDate?: Date | null;
|
|
5836
5845
|
/**
|
|
5837
|
-
*
|
|
5838
|
-
*
|
|
5839
|
-
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
5840
|
-
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5846
|
+
* Aggregated refund summary.
|
|
5847
|
+
* @readonly
|
|
5841
5848
|
*/
|
|
5842
|
-
|
|
5849
|
+
summary?: AggregatedRefundSummary;
|
|
5843
5850
|
/**
|
|
5844
|
-
*
|
|
5845
|
-
*
|
|
5851
|
+
* ID of the app that initiated this refund.
|
|
5852
|
+
* @format GUID
|
|
5853
|
+
* @readonly
|
|
5854
|
+
* @immutable
|
|
5846
5855
|
*/
|
|
5847
|
-
|
|
5856
|
+
requestingServiceAppId?: string | null;
|
|
5848
5857
|
}
|
|
5849
|
-
|
|
5850
|
-
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' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
|
|
5851
|
-
/** Site transferred to another user. */
|
|
5852
|
-
interface SiteTransferred {
|
|
5858
|
+
interface RefundTransaction {
|
|
5853
5859
|
/**
|
|
5854
|
-
*
|
|
5860
|
+
* ID of the payment associated with this refund.
|
|
5855
5861
|
* @format GUID
|
|
5862
|
+
* @immutable
|
|
5856
5863
|
*/
|
|
5857
|
-
|
|
5864
|
+
paymentId?: string;
|
|
5858
5865
|
/**
|
|
5859
|
-
*
|
|
5860
|
-
* @
|
|
5866
|
+
* Refund amount.
|
|
5867
|
+
* @immutable
|
|
5861
5868
|
*/
|
|
5862
|
-
|
|
5863
|
-
|
|
5864
|
-
|
|
5865
|
-
|
|
5866
|
-
|
|
5867
|
-
deleteContext?: DeleteContext;
|
|
5868
|
-
}
|
|
5869
|
-
interface DeleteContext {
|
|
5870
|
-
/** When the meta site was deleted. */
|
|
5871
|
-
dateDeleted?: Date | null;
|
|
5872
|
-
/** A status. */
|
|
5873
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
5869
|
+
amount?: Price;
|
|
5870
|
+
/** Refund status. */
|
|
5871
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
5872
|
+
/** Optional details of current refund status. */
|
|
5873
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
5874
5874
|
/**
|
|
5875
|
-
*
|
|
5876
|
-
*
|
|
5875
|
+
* Payment gateway's refund ID.
|
|
5876
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
5877
|
+
* @format GUID
|
|
5877
5878
|
*/
|
|
5878
|
-
|
|
5879
|
+
gatewayRefundId?: string | null;
|
|
5880
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5881
|
+
providerRefundId?: string | null;
|
|
5879
5882
|
/**
|
|
5880
|
-
*
|
|
5881
|
-
* @
|
|
5883
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
5884
|
+
* @immutable
|
|
5882
5885
|
*/
|
|
5883
|
-
|
|
5886
|
+
externalRefund?: boolean;
|
|
5884
5887
|
}
|
|
5885
|
-
|
|
5886
|
-
|
|
5887
|
-
|
|
5888
|
-
|
|
5889
|
-
|
|
5890
|
-
|
|
5888
|
+
/** Refund transaction status. */
|
|
5889
|
+
declare enum RefundStatus {
|
|
5890
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
5891
|
+
PENDING = "PENDING",
|
|
5892
|
+
/** Refund transaction succeeded. */
|
|
5893
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5894
|
+
/** Refund transaction failed. */
|
|
5895
|
+
FAILED = "FAILED",
|
|
5896
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
5897
|
+
SCHEDULED = "SCHEDULED",
|
|
5898
|
+
/** Refund was initiated on payment provider side. */
|
|
5899
|
+
STARTED = "STARTED"
|
|
5891
5900
|
}
|
|
5892
5901
|
/** @enumType */
|
|
5893
|
-
type
|
|
5894
|
-
|
|
5895
|
-
interface SiteUndeleted {
|
|
5896
|
-
}
|
|
5897
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5898
|
-
interface SitePublished {
|
|
5899
|
-
}
|
|
5900
|
-
interface SiteUnpublished {
|
|
5902
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5903
|
+
interface RefundStatusInfo {
|
|
5901
5904
|
/**
|
|
5902
|
-
*
|
|
5903
|
-
*
|
|
5904
|
-
*
|
|
5905
|
+
* Reason code for the refund's current status.
|
|
5906
|
+
*
|
|
5907
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5908
|
+
* @minLength 1
|
|
5909
|
+
* @maxLength 10
|
|
5905
5910
|
*/
|
|
5906
|
-
|
|
5907
|
-
|
|
5908
|
-
|
|
5909
|
-
|
|
5910
|
-
|
|
5911
|
+
paymentGatewayReasonCode?: string | null;
|
|
5912
|
+
/**
|
|
5913
|
+
* Free text explanation of current refund status.
|
|
5914
|
+
* @minLength 1
|
|
5915
|
+
* @maxLength 1000
|
|
5916
|
+
*/
|
|
5917
|
+
description?: string | null;
|
|
5911
5918
|
}
|
|
5912
|
-
|
|
5913
|
-
|
|
5914
|
-
|
|
5915
|
-
|
|
5916
|
-
|
|
5917
|
-
|
|
5918
|
-
|
|
5919
|
-
|
|
5920
|
-
|
|
5921
|
-
|
|
5922
|
-
|
|
5923
|
-
|
|
5924
|
-
|
|
5925
|
-
|
|
5926
|
-
|
|
5927
|
-
interface ServiceProvisioned {
|
|
5919
|
+
interface AggregatedRefundSummary {
|
|
5920
|
+
/** Total amount requested for refund. */
|
|
5921
|
+
requestedRefund?: Price;
|
|
5922
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5923
|
+
pendingRefund?: Price;
|
|
5924
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5925
|
+
refunded?: Price;
|
|
5926
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5927
|
+
failedRefundAmount?: Price;
|
|
5928
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5929
|
+
pending?: boolean;
|
|
5930
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5931
|
+
breakdown?: RefundItemsBreakdown;
|
|
5932
|
+
}
|
|
5933
|
+
interface RefundItemsBreakdown {
|
|
5928
5934
|
/**
|
|
5929
|
-
*
|
|
5930
|
-
* @
|
|
5935
|
+
* Refunded line items and the amount refunded for each.
|
|
5936
|
+
* @maxSize 300
|
|
5931
5937
|
*/
|
|
5932
|
-
|
|
5938
|
+
lineItems?: LineItemRefundSummary[];
|
|
5939
|
+
}
|
|
5940
|
+
interface LineItemRefundSummary {
|
|
5933
5941
|
/**
|
|
5934
|
-
*
|
|
5935
|
-
* @
|
|
5942
|
+
* ID of the refunded line item.
|
|
5943
|
+
* @format GUID
|
|
5936
5944
|
*/
|
|
5937
|
-
|
|
5945
|
+
lineItemId?: string;
|
|
5946
|
+
/** Total refunded amount for the line item. */
|
|
5947
|
+
totalRefundedAmount?: Price;
|
|
5948
|
+
}
|
|
5949
|
+
interface CalculateRefundRequest {
|
|
5938
5950
|
/**
|
|
5939
|
-
*
|
|
5940
|
-
* @
|
|
5951
|
+
* Order ID
|
|
5952
|
+
* @minLength 1
|
|
5953
|
+
* @maxLength 100
|
|
5941
5954
|
*/
|
|
5942
|
-
|
|
5955
|
+
ecomOrderId?: string;
|
|
5943
5956
|
/**
|
|
5944
|
-
*
|
|
5945
|
-
* @
|
|
5957
|
+
* Refunded line items and quantity
|
|
5958
|
+
* @maxSize 300
|
|
5946
5959
|
*/
|
|
5947
|
-
|
|
5960
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
5961
|
+
/** Should include shipping in refund calculation */
|
|
5962
|
+
refundShipping?: boolean;
|
|
5963
|
+
}
|
|
5964
|
+
interface CalculateRefundItemRequest {
|
|
5948
5965
|
/**
|
|
5949
|
-
*
|
|
5966
|
+
* ID of the line item being refunded
|
|
5950
5967
|
* @format GUID
|
|
5951
5968
|
*/
|
|
5952
|
-
|
|
5953
|
-
}
|
|
5954
|
-
interface ServiceRemoved {
|
|
5969
|
+
_id?: string;
|
|
5955
5970
|
/**
|
|
5956
|
-
*
|
|
5957
|
-
* @
|
|
5971
|
+
* How much of that line item is being refunded
|
|
5972
|
+
* @min 1
|
|
5973
|
+
* @max 100000
|
|
5958
5974
|
*/
|
|
5959
|
-
|
|
5975
|
+
quantity?: number;
|
|
5976
|
+
}
|
|
5977
|
+
interface CalculateRefundResponse {
|
|
5978
|
+
/** Total refundable amount */
|
|
5979
|
+
total?: Price;
|
|
5980
|
+
/** Tax cost of the order */
|
|
5981
|
+
tax?: Price;
|
|
5982
|
+
/** Discount given for this order */
|
|
5983
|
+
discount?: Price;
|
|
5984
|
+
/** Total cost of the order (without tax) */
|
|
5985
|
+
subtotal?: Price;
|
|
5986
|
+
/** Total shipping cost for order */
|
|
5987
|
+
shipping?: Price;
|
|
5988
|
+
/** Previous refund given on that order */
|
|
5989
|
+
previouslyRefundedAmount?: Price;
|
|
5960
5990
|
/**
|
|
5961
|
-
*
|
|
5962
|
-
* @
|
|
5991
|
+
* The refundable items of that order
|
|
5992
|
+
* @maxSize 300
|
|
5963
5993
|
*/
|
|
5964
|
-
|
|
5994
|
+
items?: CalculateRefundItemResponse[];
|
|
5995
|
+
}
|
|
5996
|
+
interface CalculateRefundItemResponse {
|
|
5965
5997
|
/**
|
|
5966
|
-
*
|
|
5967
|
-
* @
|
|
5998
|
+
* Line item ID
|
|
5999
|
+
* @format GUID
|
|
5968
6000
|
*/
|
|
5969
|
-
|
|
6001
|
+
_id?: string;
|
|
6002
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
6003
|
+
price?: Price;
|
|
5970
6004
|
}
|
|
5971
|
-
|
|
5972
|
-
interface SiteRenamed {
|
|
6005
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
5973
6006
|
/**
|
|
5974
|
-
*
|
|
5975
|
-
* @
|
|
6007
|
+
* Wix eCommerce order ID
|
|
6008
|
+
* @minLength 1
|
|
6009
|
+
* @maxLength 100
|
|
5976
6010
|
*/
|
|
5977
|
-
|
|
6011
|
+
ecomOrderId: string;
|
|
5978
6012
|
/**
|
|
5979
|
-
*
|
|
5980
|
-
* @
|
|
6013
|
+
* Payment IDs
|
|
6014
|
+
* @minSize 1
|
|
6015
|
+
* @maxSize 100
|
|
6016
|
+
* @format GUID
|
|
5981
6017
|
*/
|
|
5982
|
-
|
|
5983
|
-
}
|
|
5984
|
-
/**
|
|
5985
|
-
* Hard deletion of the meta site.
|
|
5986
|
-
*
|
|
5987
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
5988
|
-
*/
|
|
5989
|
-
interface SiteHardDeleted {
|
|
5990
|
-
/** A deletion context. */
|
|
5991
|
-
deleteContext?: DeleteContext;
|
|
5992
|
-
}
|
|
5993
|
-
interface NamespaceChanged {
|
|
5994
|
-
/** A previous namespace. */
|
|
5995
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
5996
|
-
/** A new namespace. */
|
|
5997
|
-
newNamespace?: NamespaceWithLiterals;
|
|
5998
|
-
}
|
|
5999
|
-
/** Assigned Studio editor */
|
|
6000
|
-
interface StudioAssigned {
|
|
6001
|
-
}
|
|
6002
|
-
/** Unassigned Studio editor */
|
|
6003
|
-
interface StudioUnassigned {
|
|
6018
|
+
paymentIds: string[];
|
|
6004
6019
|
}
|
|
6005
|
-
|
|
6006
|
-
|
|
6007
|
-
|
|
6008
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
6009
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
6010
|
-
*
|
|
6011
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
6012
|
-
*/
|
|
6013
|
-
interface SiteUrlChanged {
|
|
6020
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
6021
|
+
/** All order's transactions after the void was triggered */
|
|
6022
|
+
orderTransactions?: OrderTransactions;
|
|
6014
6023
|
}
|
|
6015
|
-
|
|
6016
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
6017
|
-
* Consumed by other teams to remove relevant data.
|
|
6018
|
-
*/
|
|
6019
|
-
interface SitePurgedExternally {
|
|
6024
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
6020
6025
|
/**
|
|
6021
|
-
*
|
|
6026
|
+
* Wix eCommerce order ID
|
|
6027
|
+
* @minLength 1
|
|
6028
|
+
* @maxLength 100
|
|
6029
|
+
*/
|
|
6030
|
+
ecomOrderId: string;
|
|
6031
|
+
/**
|
|
6032
|
+
* Capture payments information
|
|
6033
|
+
* @minSize 1
|
|
6022
6034
|
* @maxSize 100
|
|
6023
|
-
* @deprecated
|
|
6024
|
-
* @targetRemovalDate 2025-04-15
|
|
6025
6035
|
*/
|
|
6026
|
-
|
|
6027
|
-
}
|
|
6028
|
-
/** Assigned Odeditor */
|
|
6029
|
-
interface OdeditorAssigned {
|
|
6030
|
-
}
|
|
6031
|
-
/** Unassigned Odeditor */
|
|
6032
|
-
interface OdeditorUnassigned {
|
|
6033
|
-
}
|
|
6034
|
-
/** Assigned Picasso editor */
|
|
6035
|
-
interface PicassoAssigned {
|
|
6036
|
-
}
|
|
6037
|
-
/** Unassigned Picasso */
|
|
6038
|
-
interface PicassoUnassigned {
|
|
6039
|
-
}
|
|
6040
|
-
/** Assigned Wixel */
|
|
6041
|
-
interface WixelAssigned {
|
|
6042
|
-
}
|
|
6043
|
-
/** Unassigned Wixel */
|
|
6044
|
-
interface WixelUnassigned {
|
|
6045
|
-
}
|
|
6046
|
-
/** Assigned StudioTwo */
|
|
6047
|
-
interface StudioTwoAssigned {
|
|
6048
|
-
}
|
|
6049
|
-
/** Unassigned StudioTwo */
|
|
6050
|
-
interface StudioTwoUnassigned {
|
|
6051
|
-
}
|
|
6052
|
-
/** Media from user domain is enabled. */
|
|
6053
|
-
interface UserDomainMediaEnabled {
|
|
6054
|
-
}
|
|
6055
|
-
/** Media from user domain is disabled. */
|
|
6056
|
-
interface UserDomainMediaDisabled {
|
|
6057
|
-
}
|
|
6058
|
-
/** Assigned Editorless */
|
|
6059
|
-
interface EditorlessAssigned {
|
|
6060
|
-
}
|
|
6061
|
-
/** Unassigned Editorless */
|
|
6062
|
-
interface EditorlessUnassigned {
|
|
6036
|
+
payments: PaymentCapture[];
|
|
6063
6037
|
}
|
|
6064
|
-
interface
|
|
6038
|
+
interface PaymentCapture {
|
|
6039
|
+
/**
|
|
6040
|
+
* Payment ID
|
|
6041
|
+
* @format GUID
|
|
6042
|
+
*/
|
|
6043
|
+
paymentId?: string | null;
|
|
6044
|
+
/**
|
|
6045
|
+
* Capture amount.
|
|
6046
|
+
* If not provided - full authorized amount will be captured.
|
|
6047
|
+
*/
|
|
6048
|
+
amount?: Price;
|
|
6065
6049
|
}
|
|
6066
|
-
interface
|
|
6067
|
-
|
|
6050
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
6051
|
+
/** All order's transactions after the capture was triggered */
|
|
6052
|
+
orderTransactions?: OrderTransactions;
|
|
6068
6053
|
}
|
|
6069
|
-
interface
|
|
6070
|
-
/**
|
|
6071
|
-
|
|
6072
|
-
|
|
6073
|
-
|
|
6054
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
6055
|
+
/**
|
|
6056
|
+
* Ecom Order ID.
|
|
6057
|
+
* @minLength 1
|
|
6058
|
+
* @maxLength 100
|
|
6059
|
+
*/
|
|
6060
|
+
ecomOrderId?: string;
|
|
6061
|
+
/** Amount to be charged */
|
|
6062
|
+
amount?: Price;
|
|
6074
6063
|
}
|
|
6075
|
-
|
|
6076
|
-
|
|
6077
|
-
|
|
6064
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
6065
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
6066
|
+
paymentGatewayOrderId?: string;
|
|
6078
6067
|
}
|
|
6079
|
-
|
|
6080
|
-
|
|
6081
|
-
|
|
6082
|
-
|
|
6068
|
+
interface V1TriggerReindexRequest {
|
|
6069
|
+
/** @format GUID */
|
|
6070
|
+
metasiteId?: string;
|
|
6071
|
+
/**
|
|
6072
|
+
* @minLength 1
|
|
6073
|
+
* @maxLength 100
|
|
6074
|
+
* @maxSize 100
|
|
6075
|
+
*/
|
|
6076
|
+
orderIds?: string[];
|
|
6083
6077
|
}
|
|
6084
|
-
interface
|
|
6078
|
+
interface V1TriggerReindexResponse {
|
|
6085
6079
|
}
|
|
6086
|
-
interface
|
|
6087
|
-
|
|
6080
|
+
interface V1TriggerReindexOrderRequest {
|
|
6081
|
+
/** @format GUID */
|
|
6082
|
+
metasiteId?: string;
|
|
6083
|
+
/**
|
|
6084
|
+
* @minLength 1
|
|
6085
|
+
* @maxLength 100
|
|
6086
|
+
*/
|
|
6087
|
+
orderId?: string;
|
|
6088
6088
|
}
|
|
6089
6089
|
interface DiffmatokyPayload {
|
|
6090
6090
|
left?: string;
|
|
@@ -9320,4 +9320,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
9320
9320
|
unassignTags?: TagsTags;
|
|
9321
9321
|
}
|
|
9322
9322
|
|
|
9323
|
-
export { PaymentStatusEnumPaymentStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type Color as a$, FulfillmentStatus as a0, WeightUnit as a1, VatType as a2, PickupMethod as a3, OrderStatus as a4, DiscountType as a5, DiscountReason as a6, LineItemQuantityChangeType as a7, ActivityType as a8, OrderActivityTypeEnumActivityType as a9, CanceledReason as aA, DeclinedReason as aB, VoidedReason as aC, RefundStatus as aD, PreviewEmailType as aE, State as aF, SiteCreatedContext as aG, Namespace as aH, DeleteStatus as aI, Origin as aJ, SortOrder as aK, OrderApprovalStrategy as aL, Placement as aM, SubdivisionType as aN, SourceType as aO, CustomFieldGroup as aP, ValueType as aQ, DepositType as aR, InvoiceStatus as aS, type OrderLineItem as aT, type ProductName as aU, type CatalogReference as aV, type DescriptionLine as aW, type DescriptionLineValueOneOf as aX, type DescriptionLineDescriptionLineValueOneOf as aY, type DescriptionLineName as aZ, type PlainTextValue as a_, AttributionSource as aa, ChannelType as ab, AdditionalFeeSource as ac, OrderActionType as ad, SpecificItemsCouponBehavior as ae, ChargeType as af, VersioningMode as ag, DeltaPaymentOptionType as ah, InventoryAction as ai, WebhookIdentityType as aj, ScheduledAction as ak, DurationUnit as al, PaymentCollectabilityStatus as am, PredefinedPaymentMethod as an, RefundableStatus as ao, NonRefundableReason as ap, ManuallyRefundableReason as aq, RestockType as ar, TransactionStatus as as, AuthorizationCaptureStatus as at, AuthorizationVoidStatus as au, Reason as av, ActionType as aw, ChargebackStatus as ax, MembershipPaymentStatus as ay, PaymentStatus as az, type SetOrderNumberCounterResponse as b, type MerchantComment as b$, type FocalPoint as b0, type PhysicalProperties as b1, type Dimensions as b2, type ItemType as b3, type ItemTypeItemTypeDataOneOf as b4, type RestockLocation as b5, type ItemTaxFullDetails as b6, type LineItemTaxInfo as b7, type LineItemTaxBreakdown as b8, type DigitalFile as b9, type AddressLocation as bA, type FullAddressContactDetails as bB, type VatId as bC, type V1ShippingInformation as bD, type DeliveryLogistics as bE, type DeliveryLogisticsAddressOneOf as bF, type PickupDetails as bG, type PickupAddress as bH, type DeliveryTimeSlot as bI, type ShippingPrice as bJ, type ShippingRegion as bK, type TaxSummary as bL, type OrderTaxInfo as bM, type OrderTaxBreakdown as bN, type AppliedDiscount as bO, type AppliedDiscountDiscountSourceOneOf as bP, type Coupon as bQ, type MerchantDiscount as bR, type MerchantDiscountMerchantDiscountReasonOneOf as bS, type DiscountRule as bT, type DiscountRuleName as bU, type LineItemDiscount as bV, type ItemCombination as bW, type ItemCombinationLineItem as bX, type Activity as bY, type ActivityContentOneOf as bZ, type CustomActivity as b_, type SubscriptionInfo as ba, type SubscriptionTitle as bb, type SubscriptionDescription as bc, type SubscriptionSettings as bd, type FreeTrialPeriod as be, type BillingSettings 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 DecimalQuantity as bm, type DecimalQuantityUnitOneOf as bn, type TranslatableString as bo, type ExtendedFields as bp, type ModifierGroup as bq, type ItemModifier as br, type ServiceProperties as bs, type BuyerInfo as bt, type BuyerInfoIdOneOf as bu, type CurrencyConversionDetails as bv, type PriceSummary as bw, type AddressWithContact as bx, type Address as by, type StreetAddress as bz, type SetOrderNumberCounterApplicationErrors as c, type OrderSettings as c$, type OrderRefunded as c0, type OrderCreatedFromExchange as c1, type NewExchangeOrderCreated as c2, type LineItemExchangeData as c3, type DraftOrderChangesApplied as c4, type OrderChange as c5, type OrderChangeValueOneOf as c6, type LineItemChanges as c7, type LineItemQuantityChange as c8, type LineItemPriceChange as c9, type RegularPayment as cA, type RegularPaymentPaymentMethodDetailsOneOf as cB, type CreditCardDetails as cC, type PaymentCanceled as cD, type PaymentCanceledPaymentDetailsOneOf as cE, type PaymentDeclined as cF, type PaymentDeclinedPaymentDetailsOneOf as cG, type ReceiptCreated as cH, type ReceiptCreatedReceiptInfoOneOf as cI, type WixReceipt as cJ, type ExternalReceipt as cK, type ReceiptSent as cL, type ReceiptSentReceiptInfoOneOf as cM, type ChargebackCreated as cN, type ChargebackReversed as cO, type CreatedBy as cP, type CreatedByStringOneOf as cQ, type ChannelInfo as cR, type CustomField as cS, type BalanceSummary as cT, type Balance as cU, type CashRounding as cV, type AdditionalFee as cW, type FulfillmentStatusesAggregate as cX, type Tags as cY, type TagList as cZ, type Location as c_, type LineItemProductNameChange as ca, type LineItemDescriptionLineChange as cb, type LineItemModifiersChange as cc, type ManagedLineItem as cd, type ManagedDiscount as ce, type TranslatedValue as cf, type LineItemAmount as cg, type ManagedAdditionalFee as ch, type TotalPriceChange as ci, type ShippingInformationChange as cj, type ShippingInformation as ck, type SavedPaymentMethod as cl, type AuthorizedPaymentCreated as cm, type AuthorizedPaymentCaptured as cn, type AuthorizedPaymentVoided as co, type RefundInitiated as cp, type RefundedPayment as cq, type RefundedPaymentKindOneOf as cr, type RegularPaymentRefund as cs, type GiftCardPaymentRefund as ct, type MembershipPaymentRefund as cu, type PaymentRefunded as cv, type PaymentRefundFailed as cw, type RefundedAsStoreCredit as cx, type PaymentPending as cy, type PaymentPendingPaymentDetailsOneOf as cz, type PreparePaymentCollectionOptions as d, type V1TriggerReindexRequest as d$, type OrderSettingsAllowedActionsOneOf as d0, type OrderSettingsEditableByOneOf as d1, type CustomAllowedActions as d2, type OwnerApps as d3, type FormInfo as d4, type FormIdentifier as d5, type PlatformFeeSummary as d6, type PlatformFee as d7, type UpdateInternalDocumentsEvent as d8, type UpdateInternalDocumentsEventOperationOneOf as d9, type LineItemDelta as dA, type LineItemDeltaDeltaOneOf as dB, type AppliedDiscountDelta as dC, type AppliedDiscountDeltaDeltaOneOf as dD, type AdditionalFeeDelta as dE, type AdditionalFeeDeltaDeltaOneOf as dF, type DraftOrderCommitSettings as dG, type InventoryUpdateDetails as dH, type TriggerReindexRequest as dI, type TriggerReindexResponse as dJ, type DomainEvent as dK, type DomainEventBodyOneOf as dL, type EntityCreatedEvent as dM, type RestoreInfo as dN, type EntityUpdatedEvent as dO, type EntityDeletedEvent as dP, type ActionEvent as dQ, type Empty as dR, type TriggerReindexOrderRequest as dS, type MessageEnvelope as dT, type IdentificationData as dU, type IdentificationDataIdOneOf as dV, type AccountInfo as dW, type ImportOrderRequest as dX, type SetOrderNumberCounterRequest as dY, type BulkDeleteImportedOrdersRequest as dZ, type CyclePriceOverride as d_, type InternalDocument as da, type InternalDocumentUpdateOperation as db, type DeleteByIdsOperation as dc, type DeleteByFilterOperation as dd, type InternalDocumentUpdateByFilterOperation as de, type InternalUpdateExistingOperation as df, type VersionedDocumentUpdateOperation as dg, type VersionedDeleteByIdsOperation as dh, type VersionedDocumentId as di, type OrderApproved as dj, type OrdersExperiments as dk, type OrderRejectedEventOrderRejected as dl, type OrderItemsRestocked as dm, type V1RestockItem as dn, type OrderImported as dp, type ImportedOrderDeleted as dq, type PaymentStatusUpdated as dr, type FulfillmentStatusUpdated as ds, type OrderCanceledEventOrderCanceled as dt, type OrderDeltasCommitted as du, type CommittedDiffs as dv, type CommittedDiffsShippingUpdateInfoOneOf as dw, type ItemChangedDetails as dx, type OrderLineItemChangedDetails as dy, type DecimalQuantityUpdate as dz, type PreparePaymentCollectionResponse as e, type DeclinedStatusDetails as e$, type V1TriggerReindexResponse as e0, type V1TriggerReindexOrderRequest as e1, type PreparePaymentCollectionRequest as e2, type RedirectUrls as e3, type DelayedCaptureSettings as e4, type Duration as e5, type GetPaymentCollectabilityStatusRequest as e6, type RecordManuallyCollectedPaymentRequest as e7, type UserDefinedPaymentMethodName as e8, type UserDefinedPaymentMethodNameKindOneOf as e9, type ShippingRefund as eA, type RefundSideEffects as eB, type RestockInfo as eC, type RestockItem as eD, type TriggerRefundResponse as eE, type OrderTransactions as eF, type Payment as eG, type PaymentPaymentDetailsOneOf as eH, type PaymentReceiptInfoOneOf as eI, type PaymentStatusDetailsOneOf as eJ, type RegularPaymentDetails as eK, type RegularPaymentDetailsPaymentMethodDetailsOneOf as eL, type CreditCardPaymentMethodDetails as eM, type AuthorizationDetails as eN, type AuthorizationCapture as eO, type AuthorizationActionFailureDetails as eP, type AuthorizationVoid as eQ, type V1ScheduledAction as eR, type Chargeback as eS, type PaymentMethodName as eT, type GiftCardPaymentDetails as eU, type MembershipPaymentDetails as eV, type FutureMembershipDetails as eW, type WixReceiptInfo as eX, type ExternalReceiptInfo as eY, type CashRoundingDetails as eZ, type CanceledStatusDetails as e_, type RecordManuallyCollectedPaymentResponse as ea, type MarkOrderAsPaidRequest as eb, type MarkOrderAsPaidResponse as ec, type BulkMarkOrdersAsPaidRequest as ed, type BulkMarkOrdersAsPaidResponse as ee, type BulkOrderResult as ef, type ItemMetadata as eg, type ApplicationError as eh, type BulkActionMetadata as ei, type GetRefundabilityStatusRequest as ej, type GetRefundabilityStatusResponse as ek, type Refundability as el, type RefundabilityAdditionalRefundabilityInfoOneOf as em, type CreatePaymentGatewayOrderRequest as en, type ChargedBy as eo, type CreatePaymentGatewayOrderResponse as ep, type ChargeMembershipsRequest as eq, type MembershipChargeItem as er, type MembershipName as es, type ChargeMembershipsResponse as et, type TriggerRefundRequest as eu, type PaymentRefund as ev, type RefundDetails as ew, type RefundItem as ex, type LineItemRefund as ey, type AdditionalFeeRefund as ez, type PreparePaymentCollectionApplicationErrors as f, type DeleteContext as f$, type VoidedStatusDetails as f0, type PaymentStatusDetails as f1, type PaymentStatusDetailsStatusDetailsOneOf as f2, type Refund as f3, type RefundTransaction as f4, type RefundStatusInfo as f5, type AggregatedRefundSummary as f6, type RefundItemsBreakdown as f7, type LineItemRefundSummary as f8, type CalculateRefundRequest as f9, type SendFulfillmentEmailResponse as fA, type SendMerchantOrderReceivedPushRequest as fB, type SendMerchantOrderReceivedPushResponse as fC, type PreviewEmailByTypeRequest as fD, type PreviewEmailByTypeResponse as fE, type PreviewRefundEmailRequest as fF, type PreviewRefundEmailResponse as fG, type PreviewCancelEmailRequest as fH, type PreviewCancelEmailResponse as fI, type PreviewCancelRefundEmailRequest as fJ, type PreviewCancelRefundEmailResponse as fK, type PreviewBuyerPaymentsReceivedEmailRequest as fL, type PreviewBuyerPaymentsReceivedEmailResponse as fM, type PreviewBuyerConfirmationEmailRequest as fN, type PreviewBuyerConfirmationEmailResponse as fO, type PreviewBuyerPickupConfirmationEmailRequest as fP, type PreviewBuyerPickupConfirmationEmailResponse as fQ, type PreviewShippingConfirmationEmailRequest as fR, type PreviewShippingConfirmationEmailResponse as fS, type PreviewResendDownloadLinksEmailRequest as fT, type PreviewResendDownloadLinksEmailResponse as fU, type MetaSiteSpecialEvent as fV, type MetaSiteSpecialEventPayloadOneOf as fW, type Asset as fX, type SiteCreated as fY, type SiteTransferred as fZ, type SiteDeleted as f_, type CalculateRefundItemRequest as fa, type CalculateRefundResponse as fb, type CalculateRefundItemResponse as fc, type VoidAuthorizedPaymentsRequest as fd, type CaptureAuthorizedPaymentsRequest as fe, type ChargeSavedPaymentMethodRequest as ff, type ChargeSavedPaymentMethodResponse as fg, type SendBuyerConfirmationEmailRequest as fh, type SendBuyerConfirmationEmailResponse as fi, type SendBuyerPaymentsReceivedEmailRequest as fj, type SendBuyerPaymentsReceivedEmailResponse as fk, type SendBuyerPickupConfirmationEmailRequest as fl, type SendBuyerPickupConfirmationEmailResponse as fm, type BulkSendBuyerPickupConfirmationEmailsRequest as fn, type BulkSendBuyerPickupConfirmationEmailsResponse as fo, type SendBuyerShippingConfirmationEmailRequest as fp, type SendBuyerShippingConfirmationEmailResponse as fq, type BulkSendBuyerShippingConfirmationEmailsRequest as fr, type BulkSendBuyerShippingConfirmationEmailsResponse as fs, type SendMerchantOrderReceivedNotificationRequest as ft, type SendMerchantOrderReceivedNotificationResponse as fu, type SendCancelRefundEmailRequest as fv, type SendCancelRefundEmailResponse as fw, type SendRefundEmailRequest as fx, type SendRefundEmailResponse as fy, type SendFulfillmentEmailRequest as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type DraftOrderDiffsBillingUpdateInfoOneOf as g$, type SiteUndeleted as g0, type SitePublished as g1, type SiteUnpublished as g2, type SiteMarkedAsTemplate as g3, type SiteMarkedAsWixSite as g4, type ServiceProvisioned as g5, type ServiceRemoved as g6, type SiteRenamed as g7, type SiteHardDeleted as g8, type NamespaceChanged as g9, type InternalQueryOrdersRequest as gA, type PlatformQuery as gB, type PlatformQueryPagingMethodOneOf as gC, type Sorting as gD, type PlatformPaging as gE, type CursorPaging as gF, type InternalQueryOrdersResponse as gG, type PlatformPagingMetadata as gH, type Cursors as gI, type QueryOrderRequest as gJ, type QueryOrderResponse as gK, type SearchOrdersRequest as gL, type CursorSearch as gM, type CursorSearchPagingMethodOneOf as gN, type CursorPagingMetadata as gO, type CreateOrderRequest as gP, type OrderCreationSettings as gQ, type OrderCreationSettingsEditableByOneOf as gR, type OrderCreateNotifications as gS, type CreateOrderResponse as gT, type UpdateOrderRequest as gU, type UpdateOrderResponse as gV, type BulkUpdateOrdersRequest as gW, type CommitDeltasRequest as gX, type DraftOrderDiffs as gY, type DraftOrderDiffsShippingUpdateInfoOneOf as gZ, type DraftOrderDiffsBuyerUpdateInfoOneOf as g_, type StudioAssigned as ga, type StudioUnassigned as gb, type SiteUrlChanged as gc, type SitePurgedExternally as gd, type OdeditorAssigned as ge, type OdeditorUnassigned as gf, type PicassoAssigned as gg, type PicassoUnassigned as gh, type WixelAssigned as gi, type WixelUnassigned as gj, type StudioTwoAssigned as gk, type StudioTwoUnassigned as gl, type UserDomainMediaEnabled as gm, type UserDomainMediaDisabled as gn, type EditorlessAssigned as go, type EditorlessUnassigned as gp, type HasCustomEmailConfigurationsRequest as gq, type HasCustomEmailConfigurationsResponse as gr, type AddToAutomationMigrationPopulationRequest as gs, type AddToAutomationMigrationPopulationResponse as gt, type IsInAutomationMigrationPopulationRequest as gu, type IsInAutomationMigrationPopulationResponse as gv, type DiffmatokyPayload as gw, type ErrorInformation as gx, type GetOrderRequest as gy, type GetOrderResponse as gz, type PaymentCapture as h, type LineItemUpdate as h$, type DraftOrderDiffsRecipientUpdateInfoOneOf as h0, type V1LineItemDelta as h1, type V1LineItemDeltaDeltaOneOf as h2, type CommitDeltasResponse as h3, type ArchiveOrderRequest as h4, type ArchiveOrderResponse as h5, type BulkArchiveOrdersRequest as h6, type BulkArchiveOrdersResponse as h7, type BulkArchiveOrdersByFilterRequest as h8, type BulkArchiveOrdersByFilterResponse as h9, type OrderNotFulfilled as hA, type OrderCanceled as hB, type DownloadLinkSent as hC, type TrackingNumberAdded as hD, type TrackingNumberEdited as hE, type TrackingLinkAdded as hF, type ShippingConfirmationEmailSent as hG, type InvoiceAdded as hH, type InvoiceSent as hI, type FulfillerEmailSent as hJ, type ShippingAddressEdited as hK, type EmailEdited as hL, type PickupReadyEmailSent as hM, type OrderPartiallyPaid as hN, type OrderPending as hO, type OrderRejected as hP, type AddInternalActivityResponse as hQ, type AddActivityRequest as hR, type PublicActivity as hS, type PublicActivityContentOneOf as hT, type AddActivityResponse as hU, type AddActivitiesRequest as hV, type UpdateActivityRequest as hW, type UpdateActivityResponse as hX, type DeleteActivityRequest as hY, type DeleteActivityResponse as hZ, type UpdateLineItemsDescriptionLinesRequest as h_, type UnArchiveOrderRequest as ha, type UnArchiveOrderResponse as hb, type BulkUnArchiveOrdersRequest as hc, type BulkUnArchiveOrdersResponse as hd, type BulkUnArchiveOrdersByFilterRequest as he, type BulkUnArchiveOrdersByFilterResponse as hf, type UpdateBuyerInfoRequest as hg, type BuyerInfoUpdate as hh, type UpdateBuyerInfoResponse as hi, type UpdateBuyerEmailRequest as hj, type UpdateBuyerEmailResponse as hk, type UpdateOrderShippingAddressRequest as hl, type UpdateOrderShippingAddressResponse as hm, type UpdateBillingContactDetailsRequest as hn, type UpdateBillingContactDetailsResponse as ho, type UpdateOrderLineItemRequest as hp, type UpdateOrderLineItemResponse as hq, type UpdateOrderLineItemsRequest as hr, type MaskedOrderLineItem as hs, type UpdateOrderLineItemsResponse as ht, type AddInternalActivityRequest as hu, type InternalActivity as hv, type InternalActivityContentOneOf as hw, type OrderPlaced as hx, type OrderPaid as hy, type OrderFulfilled as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type InvoiceDates as i$, type UpdateLineItemsDescriptionLinesResponse as i0, type MarkOrderAsSeenByHumanRequest as i1, type MarkOrderAsSeenByHumanResponse as i2, type CancelOrderRequest as i3, type UpdateOrderStatusRequest as i4, type UpdateOrderStatusResponse as i5, type MarkAsFulfilledRequest as i6, type MarkAsFulfilledResponse as i7, type BulkMarkAsFulfilledRequest as i8, type BulkMarkAsFulfilledResponse as i9, type BulkUpdateOrderTagsRequest as iA, type TagsTags as iB, type TagsTagList as iC, type BulkUpdateOrderTagsResult as iD, type SendOrderUpdatedDomainEventRequest as iE, type SendOrderUpdatedDomainEventResponse as iF, type Task as iG, type TaskKey as iH, type TaskAction as iI, type TaskActionActionOneOf as iJ, type Complete as iK, type Cancel as iL, type Reschedule as iM, type InvoiceSentEvent as iN, type IdAndVersion as iO, type InvoiceFields as iP, type Customer as iQ, type Email as iR, type QuotesAddress as iS, type AddressDescription as iT, type Phone as iU, type Company as iV, type CommonAddress as iW, type CommonAddressStreetOneOf as iX, type Subdivision as iY, type StandardDetails as iZ, type ShippingContactDetails as i_, type BulkMarkAsFulfilledByFilterRequest as ia, type BulkMarkAsFulfilledByFilterResponse as ib, type MarkAsUnfulfilledRequest as ic, type MarkAsUnfulfilledResponse as id, type BulkMarkAsUnfulfilledRequest as ie, type BulkMarkAsUnfulfilledResponse as ig, type BulkMarkAsUnfulfilledByFilterRequest as ih, type BulkMarkAsUnfulfilledByFilterResponse as ii, type BulkSetBusinessLocationRequest as ij, type BulkSetBusinessLocationResponse as ik, type BulkSetBusinessLocationResult as il, type V1MarkOrderAsPaidRequest as im, type V1MarkOrderAsPaidResponse as io, type V1BulkMarkOrdersAsPaidRequest as ip, type V1BulkMarkOrdersAsPaidResponse as iq, type V1CreatePaymentGatewayOrderRequest as ir, type V1CreatePaymentGatewayOrderResponse as is, type GetShipmentsRequest as it, type GetShipmentsResponse as iu, type AggregateOrdersRequest as iv, type AggregateOrdersResponse as iw, type DecrementItemsQuantityRequest as ix, type DecrementData as iy, type DecrementItemsQuantityResponse as iz, type GetOrderApplicationErrors as j, type DeltaPaymentOptionTypeWithLiterals as j$, type LineItems as j0, type LineItem as j1, type BigDecimalWrapper as j2, type LineItemTax as j3, type Source as j4, type LineItemMetaData as j5, type Locale as j6, type TotalPrice as j7, type ItemizedFee as j8, type Discount as j9, type DimensionsUnitWithLiterals as jA, type ItemTypePresetWithLiterals as jB, type PaymentOptionTypeWithLiterals as jC, type JurisdictionTypeWithLiterals as jD, type SubscriptionFrequencyWithLiterals as jE, type ProductPeriodAlignmentWithLiterals as jF, type AdjustmentTypeWithLiterals as jG, type TaxableAddressTypeWithLiterals as jH, type MeasurementUnitWithLiterals as jI, type PaymentStatusEnumPaymentStatusWithLiterals as jJ, type FulfillmentStatusWithLiterals as jK, type WeightUnitWithLiterals as jL, type VatTypeWithLiterals as jM, type PickupMethodWithLiterals as jN, type OrderStatusWithLiterals as jO, type DiscountTypeWithLiterals as jP, type DiscountReasonWithLiterals as jQ, type LineItemQuantityChangeTypeWithLiterals as jR, type ActivityTypeWithLiterals as jS, type OrderActivityTypeEnumActivityTypeWithLiterals as jT, type AttributionSourceWithLiterals as jU, type ChannelTypeWithLiterals as jV, type AdditionalFeeSourceWithLiterals as jW, type OrderActionTypeWithLiterals as jX, type SpecificItemsCouponBehaviorWithLiterals as jY, type ChargeTypeWithLiterals as jZ, type VersioningModeWithLiterals as j_, type DiscountOneDiscountTypeOneOf as ja, type CalculatedTaxes as jb, type CalculatedTax as jc, type Payments as jd, type InvoicesPayment as je, type MetaData as jf, type InvoiceDynamicPriceTotals as jg, type CustomFieldValue as jh, type Value as ji, type Deposit as jj, type BaseEventMetadata as jk, type EventMetadata as jl, type AccountInfoMetadata as jm, type RecordManuallyCollectedPaymentOptions as jn, type PaymentCollectionMarkOrderAsPaidOptions as jo, type PaymentCollectionCreatePaymentGatewayOrderOptions as jp, type ChargeMembershipsOptions as jq, type TriggerRefundOptions as jr, type OrderSearchSpec as js, type UpdateOrderLineItemIdentifiers as jt, type UpdateOrderLineItem as ju, type UpdateActivityIdentifiers as jv, type DeleteActivityIdentifiers as jw, type AggregateOrdersOptions as jx, utils as jy, type DescriptionLineTypeWithLiterals as jz, type OrderSearch as k, addActivities as k$, type InventoryActionWithLiterals as k0, type WebhookIdentityTypeWithLiterals as k1, type ScheduledActionWithLiterals as k2, type DurationUnitWithLiterals as k3, type PaymentCollectabilityStatusWithLiterals as k4, type PredefinedPaymentMethodWithLiterals as k5, type RefundableStatusWithLiterals as k6, type NonRefundableReasonWithLiterals as k7, type ManuallyRefundableReasonWithLiterals as k8, type RestockTypeWithLiterals as k9, type InvoiceStatusWithLiterals as kA, type RecordManuallyCollectedPaymentApplicationErrors as kB, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kC, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kD, type TriggerRefundApplicationErrors as kE, type UpdateOrderStatusApplicationErrors as kF, type CommonSearchWithEntityContext as kG, onOrderApproved as kH, onOrderCanceled as kI, onOrderCommitted as kJ, onOrderCreated as kK, onOrderFulfilled as kL, onOrderImported as kM, onOrderImportedOrderDeleted as kN, onOrderPaymentStatusUpdated as kO, onOrderUpdated as kP, importOrder as kQ, setOrderNumberCounter as kR, bulkDeleteImportedOrders as kS, preparePaymentCollection as kT, getPaymentCollectabilityStatus as kU, voidAuthorizedPayments as kV, captureAuthorizedPayments as kW, getOrder as kX, createOrder as kY, updateOrder as kZ, bulkUpdateOrders as k_, type TransactionStatusWithLiterals as ka, type AuthorizationCaptureStatusWithLiterals as kb, type AuthorizationVoidStatusWithLiterals as kc, type ReasonWithLiterals as kd, type ActionTypeWithLiterals as ke, type ChargebackStatusWithLiterals as kf, type MembershipPaymentStatusWithLiterals as kg, type PaymentStatusWithLiterals as kh, type CanceledReasonWithLiterals as ki, type DeclinedReasonWithLiterals as kj, type VoidedReasonWithLiterals as kk, type RefundStatusWithLiterals as kl, type PreviewEmailTypeWithLiterals as km, type StateWithLiterals as kn, type SiteCreatedContextWithLiterals as ko, type NamespaceWithLiterals as kp, type DeleteStatusWithLiterals as kq, type OriginWithLiterals as kr, type SortOrderWithLiterals as ks, type OrderApprovalStrategyWithLiterals as kt, type PlacementWithLiterals as ku, type SubdivisionTypeWithLiterals as kv, type SourceTypeWithLiterals as kw, type CustomFieldGroupWithLiterals as kx, type ValueTypeWithLiterals as ky, type DepositTypeWithLiterals as kz, type SearchOrdersResponse as l, cancelOrder as l0, bulkUpdateOrderTags as l1, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };
|
|
9323
|
+
export { PaymentStatusEnumPaymentStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type Color as a$, FulfillmentStatus as a0, WeightUnit as a1, VatType as a2, PickupMethod as a3, OrderStatus as a4, DiscountType as a5, DiscountReason as a6, LineItemQuantityChangeType as a7, ActivityType as a8, OrderActivityTypeEnumActivityType as a9, AuthorizationVoidStatus as aA, Reason as aB, ActionType as aC, ChargebackStatus as aD, MembershipPaymentStatus as aE, PaymentStatus as aF, CanceledReason as aG, DeclinedReason as aH, VoidedReason as aI, RefundStatus as aJ, SortOrder as aK, OrderApprovalStrategy as aL, Placement as aM, SubdivisionType as aN, SourceType as aO, CustomFieldGroup as aP, ValueType as aQ, DepositType as aR, InvoiceStatus as aS, type OrderLineItem as aT, type ProductName as aU, type CatalogReference as aV, type DescriptionLine as aW, type DescriptionLineValueOneOf as aX, type DescriptionLineDescriptionLineValueOneOf as aY, type DescriptionLineName as aZ, type PlainTextValue as a_, AttributionSource as aa, ChannelType as ab, AdditionalFeeSource as ac, OrderActionType as ad, SpecificItemsCouponBehavior as ae, ChargeType as af, VersioningMode as ag, DeltaPaymentOptionType as ah, InventoryAction as ai, WebhookIdentityType as aj, PreviewEmailType as ak, State as al, SiteCreatedContext as am, Namespace as an, DeleteStatus as ao, Origin as ap, ScheduledAction as aq, DurationUnit as ar, PaymentCollectabilityStatus as as, PredefinedPaymentMethod as at, RefundableStatus as au, NonRefundableReason as av, ManuallyRefundableReason as aw, RestockType as ax, TransactionStatus as ay, AuthorizationCaptureStatus as az, type SetOrderNumberCounterResponse as b, type CustomActivity as b$, type FocalPoint as b0, type PhysicalProperties as b1, type Dimensions as b2, type ItemType as b3, type ItemTypeItemTypeDataOneOf as b4, type RestockLocation as b5, type ItemTaxFullDetails as b6, type LineItemTaxInfo as b7, type LineItemTaxBreakdown as b8, type DigitalFile as b9, type StreetAddress as bA, type AddressLocation as bB, type FullAddressContactDetails as bC, type VatId as bD, type V1ShippingInformation as bE, type DeliveryLogistics as bF, type DeliveryLogisticsAddressOneOf as bG, type PickupDetails as bH, type PickupAddress as bI, type DeliveryTimeSlot as bJ, type ShippingPrice as bK, type ShippingRegion as bL, type TaxSummary as bM, type OrderTaxInfo as bN, type OrderTaxBreakdown as bO, type AppliedDiscount as bP, type AppliedDiscountDiscountSourceOneOf as bQ, type Coupon as bR, type MerchantDiscount as bS, type MerchantDiscountMerchantDiscountReasonOneOf as bT, type DiscountRule as bU, type DiscountRuleName as bV, type LineItemDiscount as bW, type ItemCombination as bX, type ItemCombinationLineItem as bY, type Activity as bZ, type ActivityContentOneOf as b_, type SubscriptionInfo as ba, type SubscriptionTitle as bb, type SubscriptionDescription as bc, type SubscriptionSettings as bd, type FreeTrialPeriod as be, type BillingSettings as bf, type BillingAdjustment as bg, type BillingAdjustmentPriceSummary as bh, type CyclePriceOverride as bi, type PriceDescription as bj, type LocationAndQuantity as bk, type TaxableAddress as bl, type TaxableAddressTaxableAddressDataOneOf as bm, type DecimalQuantity as bn, type DecimalQuantityUnitOneOf as bo, type TranslatableString as bp, type ExtendedFields as bq, type ModifierGroup as br, type ItemModifier as bs, type ServiceProperties as bt, type BuyerInfo as bu, type BuyerInfoIdOneOf as bv, type CurrencyConversionDetails as bw, type PriceSummary as bx, type AddressWithContact as by, type Address as bz, type SetOrderNumberCounterApplicationErrors as c, type Location as c$, type MerchantComment as c0, type OrderRefunded as c1, type OrderCreatedFromExchange as c2, type NewExchangeOrderCreated as c3, type LineItemExchangeData as c4, type DraftOrderChangesApplied as c5, type OrderChange as c6, type OrderChangeValueOneOf as c7, type LineItemChanges as c8, type LineItemQuantityChange as c9, type PaymentPendingPaymentDetailsOneOf as cA, type RegularPayment as cB, type RegularPaymentPaymentMethodDetailsOneOf as cC, type CreditCardDetails as cD, type PaymentCanceled as cE, type PaymentCanceledPaymentDetailsOneOf as cF, type PaymentDeclined as cG, type PaymentDeclinedPaymentDetailsOneOf as cH, type ReceiptCreated as cI, type ReceiptCreatedReceiptInfoOneOf as cJ, type WixReceipt as cK, type ExternalReceipt as cL, type ReceiptSent as cM, type ReceiptSentReceiptInfoOneOf as cN, type ChargebackCreated as cO, type ChargebackReversed as cP, type CreatedBy as cQ, type CreatedByStringOneOf as cR, type ChannelInfo as cS, type CustomField as cT, type BalanceSummary as cU, type Balance as cV, type CashRounding as cW, type AdditionalFee as cX, type FulfillmentStatusesAggregate as cY, type Tags as cZ, type TagList as c_, type LineItemPriceChange as ca, type LineItemProductNameChange as cb, type LineItemDescriptionLineChange as cc, type LineItemModifiersChange as cd, type ManagedLineItem as ce, type ManagedDiscount as cf, type TranslatedValue as cg, type LineItemAmount as ch, type ManagedAdditionalFee as ci, type TotalPriceChange as cj, type ShippingInformationChange as ck, type ShippingInformation as cl, type SavedPaymentMethod as cm, type AuthorizedPaymentCreated as cn, type AuthorizedPaymentCaptured as co, type AuthorizedPaymentVoided as cp, type RefundInitiated as cq, type RefundedPayment as cr, type RefundedPaymentKindOneOf as cs, type RegularPaymentRefund as ct, type GiftCardPaymentRefund as cu, type MembershipPaymentRefund as cv, type PaymentRefunded as cw, type PaymentRefundFailed as cx, type RefundedAsStoreCredit as cy, type PaymentPending as cz, type PreparePaymentCollectionOptions as d, type SendBuyerConfirmationEmailRequest as d$, type OrderSettings as d0, type OrderSettingsAllowedActionsOneOf as d1, type OrderSettingsEditableByOneOf as d2, type CustomAllowedActions as d3, type OwnerApps as d4, type FormInfo as d5, type FormIdentifier as d6, type PlatformFeeSummary as d7, type PlatformFee as d8, type UpdateInternalDocumentsEvent as d9, type DecimalQuantityUpdate as dA, type LineItemDelta as dB, type LineItemDeltaDeltaOneOf as dC, type AppliedDiscountDelta as dD, type AppliedDiscountDeltaDeltaOneOf as dE, type AdditionalFeeDelta as dF, type AdditionalFeeDeltaDeltaOneOf as dG, type DraftOrderCommitSettings as dH, type InventoryUpdateDetails as dI, type TriggerReindexRequest as dJ, type TriggerReindexResponse as dK, type DomainEvent as dL, type DomainEventBodyOneOf as dM, type EntityCreatedEvent as dN, type RestoreInfo as dO, type EntityUpdatedEvent as dP, type EntityDeletedEvent as dQ, type ActionEvent as dR, type Empty as dS, type TriggerReindexOrderRequest as dT, type MessageEnvelope as dU, type IdentificationData as dV, type IdentificationDataIdOneOf as dW, type AccountInfo as dX, type ImportOrderRequest as dY, type SetOrderNumberCounterRequest as dZ, type BulkDeleteImportedOrdersRequest as d_, type UpdateInternalDocumentsEventOperationOneOf as da, type InternalDocument as db, type InternalDocumentUpdateOperation as dc, type DeleteByIdsOperation as dd, type DeleteByFilterOperation as de, type InternalDocumentUpdateByFilterOperation as df, type InternalUpdateExistingOperation as dg, type VersionedDocumentUpdateOperation as dh, type VersionedDeleteByIdsOperation as di, type VersionedDocumentId as dj, type OrderApproved as dk, type OrdersExperiments as dl, type OrderRejectedEventOrderRejected as dm, type OrderItemsRestocked as dn, type V1RestockItem as dp, type OrderImported as dq, type ImportedOrderDeleted as dr, type PaymentStatusUpdated as ds, type FulfillmentStatusUpdated as dt, type OrderCanceledEventOrderCanceled as du, type OrderDeltasCommitted as dv, type CommittedDiffs as dw, type CommittedDiffsShippingUpdateInfoOneOf as dx, type ItemChangedDetails as dy, type OrderLineItemChangedDetails as dz, type PreparePaymentCollectionResponse as e, type SiteUrlChanged as e$, type SendBuyerConfirmationEmailResponse as e0, type SendBuyerPaymentsReceivedEmailRequest as e1, type SendBuyerPaymentsReceivedEmailResponse as e2, type SendBuyerPickupConfirmationEmailRequest as e3, type SendBuyerPickupConfirmationEmailResponse as e4, type BulkSendBuyerPickupConfirmationEmailsRequest as e5, type BulkSendBuyerPickupConfirmationEmailsResponse as e6, type SendBuyerShippingConfirmationEmailRequest as e7, type SendBuyerShippingConfirmationEmailResponse as e8, type BulkSendBuyerShippingConfirmationEmailsRequest as e9, type PreviewBuyerConfirmationEmailRequest as eA, type PreviewBuyerConfirmationEmailResponse as eB, type PreviewBuyerPickupConfirmationEmailRequest as eC, type PreviewBuyerPickupConfirmationEmailResponse as eD, type PreviewShippingConfirmationEmailRequest as eE, type PreviewShippingConfirmationEmailResponse as eF, type PreviewResendDownloadLinksEmailRequest as eG, type PreviewResendDownloadLinksEmailResponse as eH, type MetaSiteSpecialEvent as eI, type MetaSiteSpecialEventPayloadOneOf as eJ, type Asset as eK, type SiteCreated as eL, type SiteTransferred as eM, type SiteDeleted as eN, type DeleteContext as eO, type SiteUndeleted as eP, type SitePublished as eQ, type SiteUnpublished as eR, type SiteMarkedAsTemplate as eS, type SiteMarkedAsWixSite as eT, type ServiceProvisioned as eU, type ServiceRemoved as eV, type SiteRenamed as eW, type SiteHardDeleted as eX, type NamespaceChanged as eY, type StudioAssigned as eZ, type StudioUnassigned as e_, type BulkSendBuyerShippingConfirmationEmailsResponse as ea, type SendMerchantOrderReceivedNotificationRequest as eb, type SendMerchantOrderReceivedNotificationResponse as ec, type SendCancelRefundEmailRequest as ed, type SendCancelRefundEmailResponse as ee, type SendRefundEmailRequest as ef, type SendRefundEmailResponse as eg, type SendFulfillmentEmailRequest as eh, type SendFulfillmentEmailResponse as ei, type SendMerchantOrderReceivedPushRequest as ej, type SendMerchantOrderReceivedPushResponse as ek, type PreviewEmailByTypeRequest as el, type PreviewEmailByTypeResponse as em, type PreviewRefundEmailRequest as en, type RefundDetails as eo, type RefundItem as ep, type LineItemRefund as eq, type AdditionalFeeRefund as er, type ShippingRefund as es, type PreviewRefundEmailResponse as et, type PreviewCancelEmailRequest as eu, type PreviewCancelEmailResponse as ev, type PreviewCancelRefundEmailRequest as ew, type PreviewCancelRefundEmailResponse as ex, type PreviewBuyerPaymentsReceivedEmailRequest as ey, type PreviewBuyerPaymentsReceivedEmailResponse as ez, type PreparePaymentCollectionApplicationErrors as f, type AuthorizationActionFailureDetails as f$, type SitePurgedExternally as f0, type OdeditorAssigned as f1, type OdeditorUnassigned as f2, type PicassoAssigned as f3, type PicassoUnassigned as f4, type WixelAssigned as f5, type WixelUnassigned as f6, type StudioTwoAssigned as f7, type StudioTwoUnassigned as f8, type UserDomainMediaEnabled as f9, type GetRefundabilityStatusRequest as fA, type GetRefundabilityStatusResponse as fB, type Refundability as fC, type RefundabilityAdditionalRefundabilityInfoOneOf as fD, type CreatePaymentGatewayOrderRequest as fE, type ChargedBy as fF, type CreatePaymentGatewayOrderResponse as fG, type ChargeMembershipsRequest as fH, type MembershipChargeItem as fI, type MembershipName as fJ, type ChargeMembershipsResponse as fK, type TriggerRefundRequest as fL, type PaymentRefund as fM, type RefundSideEffects as fN, type RestockInfo as fO, type RestockItem as fP, type TriggerRefundResponse as fQ, type OrderTransactions as fR, type Payment as fS, type PaymentPaymentDetailsOneOf as fT, type PaymentReceiptInfoOneOf as fU, type PaymentStatusDetailsOneOf as fV, type RegularPaymentDetails as fW, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fX, type CreditCardPaymentMethodDetails as fY, type AuthorizationDetails as fZ, type AuthorizationCapture as f_, type UserDomainMediaDisabled as fa, type EditorlessAssigned as fb, type EditorlessUnassigned as fc, type HasCustomEmailConfigurationsRequest as fd, type HasCustomEmailConfigurationsResponse as fe, type AddToAutomationMigrationPopulationRequest as ff, type AddToAutomationMigrationPopulationResponse as fg, type IsInAutomationMigrationPopulationRequest as fh, type IsInAutomationMigrationPopulationResponse as fi, type PreparePaymentCollectionRequest as fj, type RedirectUrls as fk, type DelayedCaptureSettings as fl, type Duration as fm, type GetPaymentCollectabilityStatusRequest as fn, type RecordManuallyCollectedPaymentRequest as fo, type UserDefinedPaymentMethodName as fp, type UserDefinedPaymentMethodNameKindOneOf as fq, type RecordManuallyCollectedPaymentResponse as fr, type MarkOrderAsPaidRequest as fs, type MarkOrderAsPaidResponse as ft, type BulkMarkOrdersAsPaidRequest as fu, type BulkMarkOrdersAsPaidResponse as fv, type BulkOrderResult as fw, type ItemMetadata as fx, type ApplicationError as fy, type BulkActionMetadata as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type DraftOrderDiffsBillingUpdateInfoOneOf as g$, type AuthorizationVoid as g0, type V1ScheduledAction as g1, type Chargeback as g2, type PaymentMethodName as g3, type GiftCardPaymentDetails as g4, type MembershipPaymentDetails as g5, type FutureMembershipDetails as g6, type WixReceiptInfo as g7, type ExternalReceiptInfo as g8, type CashRoundingDetails as g9, type InternalQueryOrdersRequest as gA, type PlatformQuery as gB, type PlatformQueryPagingMethodOneOf as gC, type Sorting as gD, type PlatformPaging as gE, type CursorPaging as gF, type InternalQueryOrdersResponse as gG, type PlatformPagingMetadata as gH, type Cursors as gI, type QueryOrderRequest as gJ, type QueryOrderResponse as gK, type SearchOrdersRequest as gL, type CursorSearch as gM, type CursorSearchPagingMethodOneOf as gN, type CursorPagingMetadata as gO, type CreateOrderRequest as gP, type OrderCreationSettings as gQ, type OrderCreationSettingsEditableByOneOf as gR, type OrderCreateNotifications as gS, type CreateOrderResponse as gT, type UpdateOrderRequest as gU, type UpdateOrderResponse as gV, type BulkUpdateOrdersRequest as gW, type CommitDeltasRequest as gX, type DraftOrderDiffs as gY, type DraftOrderDiffsShippingUpdateInfoOneOf as gZ, type DraftOrderDiffsBuyerUpdateInfoOneOf as g_, type CanceledStatusDetails as ga, type DeclinedStatusDetails as gb, type VoidedStatusDetails as gc, type PaymentStatusDetails as gd, type PaymentStatusDetailsStatusDetailsOneOf as ge, type Refund as gf, type RefundTransaction as gg, type RefundStatusInfo as gh, type AggregatedRefundSummary as gi, type RefundItemsBreakdown as gj, type LineItemRefundSummary as gk, type CalculateRefundRequest as gl, type CalculateRefundItemRequest as gm, type CalculateRefundResponse as gn, type CalculateRefundItemResponse as go, type VoidAuthorizedPaymentsRequest as gp, type CaptureAuthorizedPaymentsRequest as gq, type ChargeSavedPaymentMethodRequest as gr, type ChargeSavedPaymentMethodResponse as gs, type V1TriggerReindexRequest as gt, type V1TriggerReindexResponse as gu, type V1TriggerReindexOrderRequest as gv, type DiffmatokyPayload as gw, type ErrorInformation as gx, type GetOrderRequest as gy, type GetOrderResponse as gz, type PaymentCapture as h, type LineItemUpdate as h$, type DraftOrderDiffsRecipientUpdateInfoOneOf as h0, type V1LineItemDelta as h1, type V1LineItemDeltaDeltaOneOf as h2, type CommitDeltasResponse as h3, type ArchiveOrderRequest as h4, type ArchiveOrderResponse as h5, type BulkArchiveOrdersRequest as h6, type BulkArchiveOrdersResponse as h7, type BulkArchiveOrdersByFilterRequest as h8, type BulkArchiveOrdersByFilterResponse as h9, type OrderNotFulfilled as hA, type OrderCanceled as hB, type DownloadLinkSent as hC, type TrackingNumberAdded as hD, type TrackingNumberEdited as hE, type TrackingLinkAdded as hF, type ShippingConfirmationEmailSent as hG, type InvoiceAdded as hH, type InvoiceSent as hI, type FulfillerEmailSent as hJ, type ShippingAddressEdited as hK, type EmailEdited as hL, type PickupReadyEmailSent as hM, type OrderPartiallyPaid as hN, type OrderPending as hO, type OrderRejected as hP, type AddInternalActivityResponse as hQ, type AddActivityRequest as hR, type PublicActivity as hS, type PublicActivityContentOneOf as hT, type AddActivityResponse as hU, type AddActivitiesRequest as hV, type UpdateActivityRequest as hW, type UpdateActivityResponse as hX, type DeleteActivityRequest as hY, type DeleteActivityResponse as hZ, type UpdateLineItemsDescriptionLinesRequest as h_, type UnArchiveOrderRequest as ha, type UnArchiveOrderResponse as hb, type BulkUnArchiveOrdersRequest as hc, type BulkUnArchiveOrdersResponse as hd, type BulkUnArchiveOrdersByFilterRequest as he, type BulkUnArchiveOrdersByFilterResponse as hf, type UpdateBuyerInfoRequest as hg, type BuyerInfoUpdate as hh, type UpdateBuyerInfoResponse as hi, type UpdateBuyerEmailRequest as hj, type UpdateBuyerEmailResponse as hk, type UpdateOrderShippingAddressRequest as hl, type UpdateOrderShippingAddressResponse as hm, type UpdateBillingContactDetailsRequest as hn, type UpdateBillingContactDetailsResponse as ho, type UpdateOrderLineItemRequest as hp, type UpdateOrderLineItemResponse as hq, type UpdateOrderLineItemsRequest as hr, type MaskedOrderLineItem as hs, type UpdateOrderLineItemsResponse as ht, type AddInternalActivityRequest as hu, type InternalActivity as hv, type InternalActivityContentOneOf as hw, type OrderPlaced as hx, type OrderPaid as hy, type OrderFulfilled as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type InvoiceDates as i$, type UpdateLineItemsDescriptionLinesResponse as i0, type MarkOrderAsSeenByHumanRequest as i1, type MarkOrderAsSeenByHumanResponse as i2, type CancelOrderRequest as i3, type UpdateOrderStatusRequest as i4, type UpdateOrderStatusResponse as i5, type MarkAsFulfilledRequest as i6, type MarkAsFulfilledResponse as i7, type BulkMarkAsFulfilledRequest as i8, type BulkMarkAsFulfilledResponse as i9, type BulkUpdateOrderTagsRequest as iA, type TagsTags as iB, type TagsTagList as iC, type BulkUpdateOrderTagsResult as iD, type SendOrderUpdatedDomainEventRequest as iE, type SendOrderUpdatedDomainEventResponse as iF, type Task as iG, type TaskKey as iH, type TaskAction as iI, type TaskActionActionOneOf as iJ, type Complete as iK, type Cancel as iL, type Reschedule as iM, type InvoiceSentEvent as iN, type IdAndVersion as iO, type InvoiceFields as iP, type Customer as iQ, type Email as iR, type QuotesAddress as iS, type AddressDescription as iT, type Phone as iU, type Company as iV, type CommonAddress as iW, type CommonAddressStreetOneOf as iX, type Subdivision as iY, type StandardDetails as iZ, type ShippingContactDetails as i_, type BulkMarkAsFulfilledByFilterRequest as ia, type BulkMarkAsFulfilledByFilterResponse as ib, type MarkAsUnfulfilledRequest as ic, type MarkAsUnfulfilledResponse as id, type BulkMarkAsUnfulfilledRequest as ie, type BulkMarkAsUnfulfilledResponse as ig, type BulkMarkAsUnfulfilledByFilterRequest as ih, type BulkMarkAsUnfulfilledByFilterResponse as ii, type BulkSetBusinessLocationRequest as ij, type BulkSetBusinessLocationResponse as ik, type BulkSetBusinessLocationResult as il, type V1MarkOrderAsPaidRequest as im, type V1MarkOrderAsPaidResponse as io, type V1BulkMarkOrdersAsPaidRequest as ip, type V1BulkMarkOrdersAsPaidResponse as iq, type V1CreatePaymentGatewayOrderRequest as ir, type V1CreatePaymentGatewayOrderResponse as is, type GetShipmentsRequest as it, type GetShipmentsResponse as iu, type AggregateOrdersRequest as iv, type AggregateOrdersResponse as iw, type DecrementItemsQuantityRequest as ix, type DecrementData as iy, type DecrementItemsQuantityResponse as iz, type GetOrderApplicationErrors as j, type DeltaPaymentOptionTypeWithLiterals as j$, type LineItems as j0, type LineItem as j1, type BigDecimalWrapper as j2, type LineItemTax as j3, type Source as j4, type LineItemMetaData as j5, type Locale as j6, type TotalPrice as j7, type ItemizedFee as j8, type Discount as j9, type DimensionsUnitWithLiterals as jA, type ItemTypePresetWithLiterals as jB, type PaymentOptionTypeWithLiterals as jC, type JurisdictionTypeWithLiterals as jD, type SubscriptionFrequencyWithLiterals as jE, type ProductPeriodAlignmentWithLiterals as jF, type AdjustmentTypeWithLiterals as jG, type TaxableAddressTypeWithLiterals as jH, type MeasurementUnitWithLiterals as jI, type PaymentStatusEnumPaymentStatusWithLiterals as jJ, type FulfillmentStatusWithLiterals as jK, type WeightUnitWithLiterals as jL, type VatTypeWithLiterals as jM, type PickupMethodWithLiterals as jN, type OrderStatusWithLiterals as jO, type DiscountTypeWithLiterals as jP, type DiscountReasonWithLiterals as jQ, type LineItemQuantityChangeTypeWithLiterals as jR, type ActivityTypeWithLiterals as jS, type OrderActivityTypeEnumActivityTypeWithLiterals as jT, type AttributionSourceWithLiterals as jU, type ChannelTypeWithLiterals as jV, type AdditionalFeeSourceWithLiterals as jW, type OrderActionTypeWithLiterals as jX, type SpecificItemsCouponBehaviorWithLiterals as jY, type ChargeTypeWithLiterals as jZ, type VersioningModeWithLiterals as j_, type DiscountOneDiscountTypeOneOf as ja, type CalculatedTaxes as jb, type CalculatedTax as jc, type Payments as jd, type InvoicesPayment as je, type MetaData as jf, type InvoiceDynamicPriceTotals as jg, type CustomFieldValue as jh, type Value as ji, type Deposit as jj, type BaseEventMetadata as jk, type EventMetadata as jl, type AccountInfoMetadata as jm, type RecordManuallyCollectedPaymentOptions as jn, type PaymentCollectionMarkOrderAsPaidOptions as jo, type PaymentCollectionCreatePaymentGatewayOrderOptions as jp, type ChargeMembershipsOptions as jq, type TriggerRefundOptions as jr, type OrderSearchSpec as js, type UpdateOrderLineItemIdentifiers as jt, type UpdateOrderLineItem as ju, type UpdateActivityIdentifiers as jv, type DeleteActivityIdentifiers as jw, type AggregateOrdersOptions as jx, utils as jy, type DescriptionLineTypeWithLiterals as jz, type OrderSearch as k, addActivities as k$, type InventoryActionWithLiterals as k0, type WebhookIdentityTypeWithLiterals as k1, type PreviewEmailTypeWithLiterals as k2, type StateWithLiterals as k3, type SiteCreatedContextWithLiterals as k4, type NamespaceWithLiterals as k5, type DeleteStatusWithLiterals as k6, type OriginWithLiterals as k7, type ScheduledActionWithLiterals as k8, type DurationUnitWithLiterals as k9, type InvoiceStatusWithLiterals as kA, type RecordManuallyCollectedPaymentApplicationErrors as kB, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kC, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kD, type TriggerRefundApplicationErrors as kE, type UpdateOrderStatusApplicationErrors as kF, type CommonSearchWithEntityContext as kG, onOrderApproved as kH, onOrderCanceled as kI, onOrderCommitted as kJ, onOrderCreated as kK, onOrderFulfilled as kL, onOrderImported as kM, onOrderImportedOrderDeleted as kN, onOrderPaymentStatusUpdated as kO, onOrderUpdated as kP, importOrder as kQ, setOrderNumberCounter as kR, bulkDeleteImportedOrders as kS, preparePaymentCollection as kT, getPaymentCollectabilityStatus as kU, voidAuthorizedPayments as kV, captureAuthorizedPayments as kW, getOrder as kX, createOrder as kY, updateOrder as kZ, bulkUpdateOrders as k_, type PaymentCollectabilityStatusWithLiterals as ka, type PredefinedPaymentMethodWithLiterals as kb, type RefundableStatusWithLiterals as kc, type NonRefundableReasonWithLiterals as kd, type ManuallyRefundableReasonWithLiterals as ke, type RestockTypeWithLiterals as kf, type TransactionStatusWithLiterals as kg, type AuthorizationCaptureStatusWithLiterals as kh, type AuthorizationVoidStatusWithLiterals as ki, type ReasonWithLiterals as kj, type ActionTypeWithLiterals as kk, type ChargebackStatusWithLiterals as kl, type MembershipPaymentStatusWithLiterals as km, type PaymentStatusWithLiterals as kn, type CanceledReasonWithLiterals as ko, type DeclinedReasonWithLiterals as kp, type VoidedReasonWithLiterals as kq, type RefundStatusWithLiterals as kr, type SortOrderWithLiterals as ks, type OrderApprovalStrategyWithLiterals as kt, type PlacementWithLiterals as ku, type SubdivisionTypeWithLiterals as kv, type SourceTypeWithLiterals as kw, type CustomFieldGroupWithLiterals as kx, type ValueTypeWithLiterals as ky, type DepositTypeWithLiterals as kz, type SearchOrdersResponse as l, cancelOrder as l0, bulkUpdateOrderTags as l1, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };
|