@wix/auto_sdk_ecom_orders 1.0.294 → 1.0.295
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-CeSyrIwk.d.ts → ecom-v1-order-orders.universal-DlLhZyNg.d.ts} +1685 -1685
- 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 +1685 -1685
- package/build/cjs/meta.js +80 -80
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-CeSyrIwk.d.mts → ecom-v1-order-orders.universal-DlLhZyNg.d.mts} +1685 -1685
- 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 +1685 -1685
- package/build/es/meta.mjs +80 -80
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-DEhqrc38.d.ts → ecom-v1-order-orders.universal-DwXimT2J.d.ts} +1841 -1841
- 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 +1841 -1841
- package/build/internal/es/{ecom-v1-order-orders.universal-DEhqrc38.d.mts → ecom-v1-order-orders.universal-DwXimT2J.d.mts} +1841 -1841
- 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 +1841 -1841
- package/package.json +2 -2
package/build/es/meta.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { dX as ImportOrderRequest$1, I as ImportOrderResponse$1, dY as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, dZ as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1,
|
|
1
|
+
import { dX as ImportOrderRequest$1, I as ImportOrderResponse$1, dY as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, dZ as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, e1 as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, e5 as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, e6 as RecordManuallyCollectedPaymentRequest$1, e9 as RecordManuallyCollectedPaymentResponse$1, ea as MarkOrderAsPaidRequest$1, eb as MarkOrderAsPaidResponse$1, ec as BulkMarkOrdersAsPaidRequest$1, ed as BulkMarkOrdersAsPaidResponse$1, ei as GetRefundabilityStatusRequest$1, ej as GetRefundabilityStatusResponse$1, em as CreatePaymentGatewayOrderRequest$1, eo as CreatePaymentGatewayOrderResponse$1, ep as ChargeMembershipsRequest$1, es as ChargeMembershipsResponse$1, et as TriggerRefundRequest$1, eD as TriggerRefundResponse$1, fc as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fd as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gx as GetOrderRequest$1, gy as GetOrderResponse$1, gK as SearchOrdersRequest$1, l as SearchOrdersResponse$1, gO as CreateOrderRequest$1, gS as CreateOrderResponse$1, gT as UpdateOrderRequest$1, gU as UpdateOrderResponse$1, gV as BulkUpdateOrdersRequest$1, q as BulkUpdateOrdersResponse$1, ho as UpdateOrderLineItemRequest$1, hp as UpdateOrderLineItemResponse$1, hQ as AddActivityRequest$1, hT as AddActivityResponse$1, hU as AddActivitiesRequest$1, r as AddActivitiesResponse$1, hV as UpdateActivityRequest$1, hW as UpdateActivityResponse$1, hX as DeleteActivityRequest$1, hY as DeleteActivityResponse$1, i2 as CancelOrderRequest$1, t as CancelOrderResponse$1, i3 as UpdateOrderStatusRequest$1, i4 as UpdateOrderStatusResponse$1, iu as AggregateOrdersRequest$1, iv as AggregateOrdersResponse$1, iz as BulkUpdateOrderTagsRequest$1, w as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-DlLhZyNg.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -3912,163 +3912,458 @@ interface BulkDeleteImportedOrdersResponse {
|
|
|
3912
3912
|
*/
|
|
3913
3913
|
jobId?: string;
|
|
3914
3914
|
}
|
|
3915
|
-
interface
|
|
3915
|
+
interface V1TriggerReindexRequest {
|
|
3916
3916
|
/** @format GUID */
|
|
3917
|
-
|
|
3918
|
-
}
|
|
3919
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
3920
|
-
}
|
|
3921
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3917
|
+
metasiteId?: string;
|
|
3922
3918
|
/**
|
|
3923
3919
|
* @minLength 1
|
|
3924
3920
|
* @maxLength 100
|
|
3921
|
+
* @maxSize 100
|
|
3925
3922
|
*/
|
|
3926
|
-
|
|
3923
|
+
orderIds?: string[];
|
|
3927
3924
|
}
|
|
3928
|
-
interface
|
|
3925
|
+
interface V1TriggerReindexResponse {
|
|
3929
3926
|
}
|
|
3930
|
-
interface
|
|
3927
|
+
interface V1TriggerReindexOrderRequest {
|
|
3928
|
+
/** @format GUID */
|
|
3929
|
+
metasiteId?: string;
|
|
3931
3930
|
/**
|
|
3932
3931
|
* @minLength 1
|
|
3933
3932
|
* @maxLength 100
|
|
3934
3933
|
*/
|
|
3935
3934
|
orderId?: string;
|
|
3936
3935
|
}
|
|
3937
|
-
interface
|
|
3938
|
-
}
|
|
3939
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3940
|
-
/**
|
|
3941
|
-
* IDs of orders to send pickup emails for.
|
|
3942
|
-
* @minSize 1
|
|
3943
|
-
* @maxSize 300
|
|
3944
|
-
*/
|
|
3945
|
-
orderIds?: string[];
|
|
3946
|
-
}
|
|
3947
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3948
|
-
}
|
|
3949
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
3936
|
+
interface PreparePaymentCollectionRequest {
|
|
3950
3937
|
/**
|
|
3938
|
+
* Ecom order ID.
|
|
3951
3939
|
* @minLength 1
|
|
3952
3940
|
* @maxLength 100
|
|
3953
3941
|
*/
|
|
3954
|
-
|
|
3955
|
-
|
|
3956
|
-
|
|
3957
|
-
}
|
|
3958
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3942
|
+
ecomOrderId: string;
|
|
3943
|
+
/** Amount to collect */
|
|
3944
|
+
amount: Price;
|
|
3959
3945
|
/**
|
|
3960
|
-
*
|
|
3961
|
-
*
|
|
3962
|
-
*
|
|
3946
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
3947
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
3948
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
3963
3949
|
*/
|
|
3964
|
-
|
|
3965
|
-
}
|
|
3966
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3967
|
-
}
|
|
3968
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
3950
|
+
paymentGatewayOrderId?: string | null;
|
|
3969
3951
|
/**
|
|
3970
|
-
*
|
|
3971
|
-
*
|
|
3952
|
+
* Whether to delay capture of the payment.
|
|
3953
|
+
* Default: false
|
|
3954
|
+
* @deprecated Whether to delay capture of the payment.
|
|
3955
|
+
* Default: false
|
|
3956
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
3957
|
+
* @targetRemovalDate 2024-09-30
|
|
3972
3958
|
*/
|
|
3973
|
-
|
|
3974
|
-
|
|
3975
|
-
|
|
3959
|
+
delayedCapture?: boolean;
|
|
3960
|
+
/** Delayed capture payment settings */
|
|
3961
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
3976
3962
|
}
|
|
3977
|
-
interface
|
|
3963
|
+
interface RedirectUrls {
|
|
3978
3964
|
/**
|
|
3979
|
-
*
|
|
3980
|
-
* @
|
|
3981
|
-
* @maxLength 100
|
|
3965
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
3966
|
+
* @format WEB_URL
|
|
3982
3967
|
*/
|
|
3983
|
-
|
|
3968
|
+
successUrl?: string | null;
|
|
3984
3969
|
/**
|
|
3985
|
-
*
|
|
3986
|
-
* @
|
|
3987
|
-
* @maxLength 1000
|
|
3970
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
3971
|
+
* @format WEB_URL
|
|
3988
3972
|
*/
|
|
3989
|
-
|
|
3990
|
-
/** Refund amount */
|
|
3991
|
-
refundAmount?: Price;
|
|
3973
|
+
cancelUrl?: string | null;
|
|
3992
3974
|
/**
|
|
3993
|
-
*
|
|
3994
|
-
* @format
|
|
3975
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
3976
|
+
* @format WEB_URL
|
|
3995
3977
|
*/
|
|
3996
|
-
|
|
3997
|
-
}
|
|
3998
|
-
interface SendCancelRefundEmailResponse {
|
|
3999
|
-
}
|
|
4000
|
-
interface SendRefundEmailRequest {
|
|
3978
|
+
errorUrl?: string | null;
|
|
4001
3979
|
/**
|
|
4002
|
-
*
|
|
4003
|
-
* @format
|
|
3980
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
3981
|
+
* @format WEB_URL
|
|
4004
3982
|
*/
|
|
4005
|
-
|
|
3983
|
+
pendingUrl?: string | null;
|
|
3984
|
+
}
|
|
3985
|
+
interface DelayedCaptureSettings {
|
|
3986
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
3987
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
3988
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
3989
|
+
delayDuration?: Duration;
|
|
3990
|
+
}
|
|
3991
|
+
declare enum ScheduledAction {
|
|
3992
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
3993
|
+
VOID = "VOID",
|
|
3994
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
3995
|
+
CAPTURE = "CAPTURE"
|
|
3996
|
+
}
|
|
3997
|
+
/** @enumType */
|
|
3998
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
3999
|
+
interface Duration {
|
|
4006
4000
|
/**
|
|
4007
|
-
*
|
|
4008
|
-
* @
|
|
4001
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4002
|
+
* @min 1
|
|
4009
4003
|
*/
|
|
4010
|
-
|
|
4004
|
+
count?: number;
|
|
4005
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4006
|
+
unit?: DurationUnitWithLiterals;
|
|
4007
|
+
}
|
|
4008
|
+
declare enum DurationUnit {
|
|
4009
|
+
MINUTES = "MINUTES",
|
|
4010
|
+
HOURS = "HOURS",
|
|
4011
|
+
DAYS = "DAYS"
|
|
4012
|
+
}
|
|
4013
|
+
/** @enumType */
|
|
4014
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4015
|
+
interface PreparePaymentCollectionResponse {
|
|
4016
|
+
/** Payment gateway order id which is associated with given payment */
|
|
4017
|
+
paymentGatewayOrderId?: string;
|
|
4018
|
+
}
|
|
4019
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
4011
4020
|
/**
|
|
4012
|
-
*
|
|
4021
|
+
* Ecom order ID.
|
|
4013
4022
|
* @minLength 1
|
|
4014
|
-
* @maxLength
|
|
4023
|
+
* @maxLength 100
|
|
4015
4024
|
*/
|
|
4016
|
-
|
|
4017
|
-
}
|
|
4018
|
-
interface SendRefundEmailResponse {
|
|
4025
|
+
ecomOrderId: string;
|
|
4019
4026
|
}
|
|
4020
|
-
interface
|
|
4021
|
-
/**
|
|
4022
|
-
|
|
4023
|
-
/**
|
|
4024
|
-
|
|
4027
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
4028
|
+
/** Payment collectability status */
|
|
4029
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4030
|
+
/** Collectable order amount */
|
|
4031
|
+
amount?: Price;
|
|
4025
4032
|
}
|
|
4026
|
-
|
|
4033
|
+
declare enum PaymentCollectabilityStatus {
|
|
4034
|
+
UNKNOWN = "UNKNOWN",
|
|
4035
|
+
COLLECTABLE = "COLLECTABLE",
|
|
4036
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4037
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4038
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4039
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4040
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4041
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4042
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4043
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4044
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4045
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
4027
4046
|
}
|
|
4028
|
-
|
|
4047
|
+
/** @enumType */
|
|
4048
|
+
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';
|
|
4049
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
4029
4050
|
/**
|
|
4051
|
+
* Order ID.
|
|
4030
4052
|
* @minLength 1
|
|
4031
4053
|
* @maxLength 100
|
|
4032
4054
|
*/
|
|
4033
|
-
orderId
|
|
4055
|
+
orderId: string;
|
|
4056
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
4057
|
+
amount: Price;
|
|
4034
4058
|
}
|
|
4035
|
-
|
|
4059
|
+
/**
|
|
4060
|
+
* User-defined payment method name.
|
|
4061
|
+
* Allows specifying either a predefined type or a custom name.
|
|
4062
|
+
*/
|
|
4063
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4064
|
+
/** Predefined payment method. */
|
|
4065
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4066
|
+
/**
|
|
4067
|
+
* Custom payment method name provided by user.
|
|
4068
|
+
*
|
|
4069
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4070
|
+
* @minLength 1
|
|
4071
|
+
* @maxLength 150
|
|
4072
|
+
*/
|
|
4073
|
+
custom?: string | null;
|
|
4036
4074
|
}
|
|
4037
|
-
|
|
4038
|
-
|
|
4075
|
+
/** @oneof */
|
|
4076
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4077
|
+
/** Predefined payment method. */
|
|
4078
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4079
|
+
/**
|
|
4080
|
+
* Custom payment method name provided by user.
|
|
4081
|
+
*
|
|
4082
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4083
|
+
* @minLength 1
|
|
4084
|
+
* @maxLength 150
|
|
4085
|
+
*/
|
|
4086
|
+
custom?: string | null;
|
|
4039
4087
|
}
|
|
4040
|
-
|
|
4041
|
-
|
|
4042
|
-
|
|
4043
|
-
|
|
4044
|
-
|
|
4088
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
4089
|
+
declare enum PredefinedPaymentMethod {
|
|
4090
|
+
/** Cash payment. */
|
|
4091
|
+
CASH = "CASH",
|
|
4092
|
+
/** Bank transfer. */
|
|
4093
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4094
|
+
/** Payment by check. */
|
|
4095
|
+
CHECK = "CHECK"
|
|
4045
4096
|
}
|
|
4046
4097
|
/** @enumType */
|
|
4047
|
-
type
|
|
4048
|
-
interface
|
|
4049
|
-
emailPreview?: string;
|
|
4098
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4099
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
4050
4100
|
}
|
|
4051
|
-
interface
|
|
4101
|
+
interface MarkOrderAsPaidRequest {
|
|
4052
4102
|
/**
|
|
4103
|
+
* Ecom order ID.
|
|
4053
4104
|
* @minLength 1
|
|
4054
4105
|
* @maxLength 100
|
|
4055
4106
|
*/
|
|
4056
|
-
|
|
4057
|
-
|
|
4058
|
-
|
|
4059
|
-
/**
|
|
4060
|
-
|
|
4107
|
+
ecomOrderId: string;
|
|
4108
|
+
}
|
|
4109
|
+
interface MarkOrderAsPaidResponse {
|
|
4110
|
+
/** Updated order. */
|
|
4111
|
+
order?: Order;
|
|
4112
|
+
}
|
|
4113
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
4061
4114
|
/**
|
|
4062
|
-
*
|
|
4115
|
+
* IDs of orders to mark as paid.
|
|
4116
|
+
* @minSize 1
|
|
4117
|
+
* @maxSize 100
|
|
4063
4118
|
* @minLength 1
|
|
4064
|
-
* @maxLength
|
|
4119
|
+
* @maxLength 100
|
|
4065
4120
|
*/
|
|
4066
|
-
|
|
4121
|
+
ecomOrderIds: string[];
|
|
4122
|
+
}
|
|
4123
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
4067
4124
|
/**
|
|
4068
|
-
*
|
|
4069
|
-
*
|
|
4125
|
+
* Items updated by the bulk action.
|
|
4126
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
4070
4127
|
*/
|
|
4071
|
-
|
|
4128
|
+
results?: BulkOrderResult[];
|
|
4129
|
+
/** Bulk action metadata. */
|
|
4130
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4131
|
+
}
|
|
4132
|
+
interface BulkOrderResult {
|
|
4133
|
+
/** Item metadata. */
|
|
4134
|
+
itemMetadata?: ItemMetadata;
|
|
4135
|
+
/**
|
|
4136
|
+
* Updated order.
|
|
4137
|
+
*
|
|
4138
|
+
* Returned when `returnFullEntity = true`.
|
|
4139
|
+
*/
|
|
4140
|
+
item?: Order;
|
|
4141
|
+
}
|
|
4142
|
+
interface ItemMetadata {
|
|
4143
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
4144
|
+
id?: string | null;
|
|
4145
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
4146
|
+
originalIndex?: number;
|
|
4147
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
4148
|
+
success?: boolean;
|
|
4149
|
+
/** Details about the error in case of failure. */
|
|
4150
|
+
error?: ApplicationError;
|
|
4151
|
+
}
|
|
4152
|
+
interface ApplicationError {
|
|
4153
|
+
/** Error code. */
|
|
4154
|
+
code?: string;
|
|
4155
|
+
/** Description of the error. */
|
|
4156
|
+
description?: string;
|
|
4157
|
+
/** Data related to the error. */
|
|
4158
|
+
data?: Record<string, any> | null;
|
|
4159
|
+
}
|
|
4160
|
+
interface BulkActionMetadata {
|
|
4161
|
+
/** Number of items that were successfully processed. */
|
|
4162
|
+
totalSuccesses?: number;
|
|
4163
|
+
/** Number of items that couldn't be processed. */
|
|
4164
|
+
totalFailures?: number;
|
|
4165
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4166
|
+
undetailedFailures?: number;
|
|
4167
|
+
}
|
|
4168
|
+
interface GetRefundabilityStatusRequest {
|
|
4169
|
+
/**
|
|
4170
|
+
* Order ID.
|
|
4171
|
+
* @minLength 1
|
|
4172
|
+
* @maxLength 100
|
|
4173
|
+
*/
|
|
4174
|
+
ecomOrderId: string;
|
|
4175
|
+
}
|
|
4176
|
+
interface GetRefundabilityStatusResponse {
|
|
4177
|
+
/**
|
|
4178
|
+
* Refundability details.
|
|
4179
|
+
* @maxSize 300
|
|
4180
|
+
*/
|
|
4181
|
+
refundabilities?: Refundability[];
|
|
4182
|
+
/**
|
|
4183
|
+
* Whether the order supports refunding per item.
|
|
4184
|
+
* @deprecated
|
|
4185
|
+
*/
|
|
4186
|
+
refundablePerItem?: boolean;
|
|
4187
|
+
}
|
|
4188
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4189
|
+
/** Reason why payment is not refundable. */
|
|
4190
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4191
|
+
/** Reason why payment is only refundable manually. */
|
|
4192
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4193
|
+
/** Payment ID. */
|
|
4194
|
+
paymentId?: string;
|
|
4195
|
+
/** Payment refundability status. */
|
|
4196
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4197
|
+
/** Link to payment provider dashboard. */
|
|
4198
|
+
providerLink?: string | null;
|
|
4199
|
+
}
|
|
4200
|
+
/** @oneof */
|
|
4201
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4202
|
+
/** Reason why payment is not refundable. */
|
|
4203
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4204
|
+
/** Reason why payment is only refundable manually. */
|
|
4205
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4206
|
+
}
|
|
4207
|
+
declare enum RefundableStatus {
|
|
4208
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4209
|
+
MANUAL = "MANUAL",
|
|
4210
|
+
REFUNDABLE = "REFUNDABLE"
|
|
4211
|
+
}
|
|
4212
|
+
/** @enumType */
|
|
4213
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
4214
|
+
declare enum NonRefundableReason {
|
|
4215
|
+
NONE = "NONE",
|
|
4216
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4217
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4218
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4219
|
+
NOT_PAID = "NOT_PAID",
|
|
4220
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4221
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
4222
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4223
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
4224
|
+
FORBIDDEN = "FORBIDDEN",
|
|
4225
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4226
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4227
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4228
|
+
}
|
|
4229
|
+
/** @enumType */
|
|
4230
|
+
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';
|
|
4231
|
+
declare enum ManuallyRefundableReason {
|
|
4232
|
+
EXPIRED = "EXPIRED",
|
|
4233
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4234
|
+
OFFLINE = "OFFLINE",
|
|
4235
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4236
|
+
}
|
|
4237
|
+
/** @enumType */
|
|
4238
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4239
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
4240
|
+
/**
|
|
4241
|
+
* Ecom order ID.
|
|
4242
|
+
* @minLength 1
|
|
4243
|
+
* @maxLength 100
|
|
4244
|
+
*/
|
|
4245
|
+
ecomOrderId: string;
|
|
4246
|
+
/** Information about the user who initiated the payment. */
|
|
4247
|
+
chargedBy?: ChargedBy;
|
|
4248
|
+
}
|
|
4249
|
+
interface ChargedBy {
|
|
4250
|
+
/**
|
|
4251
|
+
* ID - id of the user who initiated the payment
|
|
4252
|
+
* @format GUID
|
|
4253
|
+
*/
|
|
4254
|
+
id?: string;
|
|
4255
|
+
/**
|
|
4256
|
+
* Full name - name of the user who initiated the payment
|
|
4257
|
+
* @minLength 1
|
|
4258
|
+
* @maxLength 200
|
|
4259
|
+
*/
|
|
4260
|
+
fullName?: string | null;
|
|
4261
|
+
}
|
|
4262
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
4263
|
+
/** ID of the order created in the payment gateway */
|
|
4264
|
+
paymentGatewayOrderId?: string;
|
|
4265
|
+
}
|
|
4266
|
+
interface ChargeMembershipsRequest {
|
|
4267
|
+
/**
|
|
4268
|
+
* Order ID.
|
|
4269
|
+
* @minLength 1
|
|
4270
|
+
* @maxLength 100
|
|
4271
|
+
*/
|
|
4272
|
+
ecomOrderId: string;
|
|
4273
|
+
/**
|
|
4274
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4275
|
+
* but a user which is using the membership on behalf of the a member
|
|
4276
|
+
* @format GUID
|
|
4277
|
+
*/
|
|
4278
|
+
memberId: string;
|
|
4279
|
+
/**
|
|
4280
|
+
* List of items to be paid by memberships
|
|
4281
|
+
* @minSize 1
|
|
4282
|
+
* @maxSize 300
|
|
4283
|
+
*/
|
|
4284
|
+
membershipCharges?: MembershipChargeItem[];
|
|
4285
|
+
}
|
|
4286
|
+
interface MembershipChargeItem {
|
|
4287
|
+
/**
|
|
4288
|
+
* The id of used membership
|
|
4289
|
+
* @minLength 1
|
|
4290
|
+
* @maxLength 100
|
|
4291
|
+
*/
|
|
4292
|
+
membershipId?: string;
|
|
4293
|
+
/**
|
|
4294
|
+
* ID of the application providing this payment option
|
|
4295
|
+
* @format GUID
|
|
4296
|
+
*/
|
|
4297
|
+
appId?: string;
|
|
4298
|
+
/** The name of used membership */
|
|
4299
|
+
membershipName?: MembershipName;
|
|
4300
|
+
/** Additional data about this membership */
|
|
4301
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
4302
|
+
/** Catalog and item reference info. */
|
|
4303
|
+
catalogReference?: CatalogReference;
|
|
4304
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4305
|
+
serviceProperties?: ServiceProperties;
|
|
4306
|
+
/**
|
|
4307
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
4308
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4309
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4310
|
+
* @minLength 1
|
|
4311
|
+
* @maxLength 36
|
|
4312
|
+
*/
|
|
4313
|
+
rootCatalogItemId?: string | null;
|
|
4314
|
+
/**
|
|
4315
|
+
* line item id of Checkout/Order line item
|
|
4316
|
+
* @minLength 1
|
|
4317
|
+
* @maxLength 100
|
|
4318
|
+
*/
|
|
4319
|
+
lineItemId?: string;
|
|
4320
|
+
}
|
|
4321
|
+
interface MembershipName {
|
|
4322
|
+
/**
|
|
4323
|
+
* Membership name.
|
|
4324
|
+
* @maxLength 100
|
|
4325
|
+
*/
|
|
4326
|
+
original?: string;
|
|
4327
|
+
/**
|
|
4328
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
4329
|
+
* @maxLength 100
|
|
4330
|
+
*/
|
|
4331
|
+
translated?: string | null;
|
|
4332
|
+
}
|
|
4333
|
+
interface ChargeMembershipsResponse {
|
|
4334
|
+
}
|
|
4335
|
+
interface TriggerRefundRequest {
|
|
4336
|
+
/**
|
|
4337
|
+
* The order this refund related to
|
|
4338
|
+
* @minLength 1
|
|
4339
|
+
* @maxLength 100
|
|
4340
|
+
*/
|
|
4341
|
+
ecomOrderId: string;
|
|
4342
|
+
/**
|
|
4343
|
+
* Refund operations information
|
|
4344
|
+
* @minSize 1
|
|
4345
|
+
* @maxSize 1
|
|
4346
|
+
*/
|
|
4347
|
+
payments: PaymentRefund[];
|
|
4348
|
+
/** Business model of a refund */
|
|
4349
|
+
details?: RefundDetails;
|
|
4350
|
+
/** Side effect details related to refund */
|
|
4351
|
+
sideEffects?: RefundSideEffects;
|
|
4352
|
+
}
|
|
4353
|
+
interface PaymentRefund {
|
|
4354
|
+
/**
|
|
4355
|
+
* Specific payment within the order to refund
|
|
4356
|
+
* @format GUID
|
|
4357
|
+
*/
|
|
4358
|
+
paymentId?: string;
|
|
4359
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
4360
|
+
amount?: Price;
|
|
4361
|
+
/**
|
|
4362
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
4363
|
+
* 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.
|
|
4364
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
4365
|
+
*/
|
|
4366
|
+
externalRefund?: boolean;
|
|
4072
4367
|
}
|
|
4073
4368
|
/** Business model of a refund request */
|
|
4074
4369
|
interface RefundDetails {
|
|
@@ -4145,1938 +4440,1643 @@ interface ShippingRefund {
|
|
|
4145
4440
|
*/
|
|
4146
4441
|
amount?: Price;
|
|
4147
4442
|
}
|
|
4148
|
-
interface
|
|
4149
|
-
|
|
4150
|
-
|
|
4151
|
-
|
|
4152
|
-
|
|
4153
|
-
* @minLength 1
|
|
4154
|
-
* @maxLength 100
|
|
4155
|
-
*/
|
|
4156
|
-
orderId?: string;
|
|
4443
|
+
interface RefundSideEffects {
|
|
4444
|
+
/** Inventory restock details as part of this refund. */
|
|
4445
|
+
restockInfo?: RestockInfo;
|
|
4446
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
4447
|
+
sendOrderRefundedEmail?: boolean;
|
|
4157
4448
|
/**
|
|
4158
|
-
*
|
|
4449
|
+
* Custom message added to the refund confirmation email.
|
|
4159
4450
|
* @minLength 1
|
|
4160
4451
|
* @maxLength 1000
|
|
4161
4452
|
*/
|
|
4162
4453
|
customMessage?: string | null;
|
|
4163
4454
|
}
|
|
4164
|
-
interface
|
|
4165
|
-
|
|
4166
|
-
|
|
4167
|
-
interface PreviewCancelRefundEmailRequest {
|
|
4168
|
-
/**
|
|
4169
|
-
* @minLength 1
|
|
4170
|
-
* @maxLength 100
|
|
4171
|
-
*/
|
|
4172
|
-
orderId?: string;
|
|
4173
|
-
/**
|
|
4174
|
-
* Personal note added to the email (optional)
|
|
4175
|
-
* @minLength 1
|
|
4176
|
-
* @maxLength 1000
|
|
4177
|
-
*/
|
|
4178
|
-
customMessage?: string | null;
|
|
4179
|
-
/** Refund amount */
|
|
4180
|
-
refundAmount?: Price;
|
|
4181
|
-
/**
|
|
4182
|
-
* Refund ID. (Optional)
|
|
4183
|
-
* @format GUID
|
|
4184
|
-
*/
|
|
4185
|
-
refundId?: string | null;
|
|
4186
|
-
}
|
|
4187
|
-
interface PreviewCancelRefundEmailResponse {
|
|
4188
|
-
emailPreview?: string;
|
|
4189
|
-
}
|
|
4190
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
4191
|
-
}
|
|
4192
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
4193
|
-
emailPreview?: string;
|
|
4194
|
-
}
|
|
4195
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
4196
|
-
}
|
|
4197
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
4198
|
-
emailPreview?: string;
|
|
4199
|
-
}
|
|
4200
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
4201
|
-
}
|
|
4202
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
4203
|
-
emailPreview?: string;
|
|
4204
|
-
}
|
|
4205
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
4206
|
-
}
|
|
4207
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
4208
|
-
emailPreview?: string;
|
|
4209
|
-
}
|
|
4210
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
4211
|
-
}
|
|
4212
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
4213
|
-
emailPreview?: string;
|
|
4214
|
-
}
|
|
4215
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4216
|
-
/** Emitted on a meta site creation. */
|
|
4217
|
-
siteCreated?: SiteCreated;
|
|
4218
|
-
/** Emitted on a meta site transfer completion. */
|
|
4219
|
-
siteTransferred?: SiteTransferred;
|
|
4220
|
-
/** Emitted on a meta site deletion. */
|
|
4221
|
-
siteDeleted?: SiteDeleted;
|
|
4222
|
-
/** Emitted on a meta site restoration. */
|
|
4223
|
-
siteUndeleted?: SiteUndeleted;
|
|
4224
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4225
|
-
sitePublished?: SitePublished;
|
|
4226
|
-
/** Emitted on a meta site unpublish. */
|
|
4227
|
-
siteUnpublished?: SiteUnpublished;
|
|
4228
|
-
/** Emitted when meta site is marked as template. */
|
|
4229
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4230
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4231
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4232
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4233
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4234
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4235
|
-
serviceRemoved?: ServiceRemoved;
|
|
4236
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4237
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4238
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4239
|
-
hardDeleted?: SiteHardDeleted;
|
|
4240
|
-
/** Emitted on a namespace change. */
|
|
4241
|
-
namespaceChanged?: NamespaceChanged;
|
|
4242
|
-
/** Emitted when Studio is attached. */
|
|
4243
|
-
studioAssigned?: StudioAssigned;
|
|
4244
|
-
/** Emitted when Studio is detached. */
|
|
4245
|
-
studioUnassigned?: StudioUnassigned;
|
|
4246
|
-
/**
|
|
4247
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4248
|
-
* the actual URL.
|
|
4249
|
-
*
|
|
4250
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4251
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4252
|
-
*/
|
|
4253
|
-
urlChanged?: SiteUrlChanged;
|
|
4254
|
-
/** Site is marked as PurgedExternally */
|
|
4255
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4256
|
-
/** Emitted when Odeditor is attached. */
|
|
4257
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4258
|
-
/** Emitted when Odeditor is detached. */
|
|
4259
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4260
|
-
/** Emitted when Picasso is attached. */
|
|
4261
|
-
picassoAssigned?: PicassoAssigned;
|
|
4262
|
-
/** Emitted when Picasso is detached. */
|
|
4263
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4264
|
-
/** Emitted when Wixel is attached. */
|
|
4265
|
-
wixelAssigned?: WixelAssigned;
|
|
4266
|
-
/** Emitted when Wixel is detached. */
|
|
4267
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4268
|
-
/** Emitted when StudioTwo is attached. */
|
|
4269
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4270
|
-
/** Emitted when StudioTwo is detached. */
|
|
4271
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4272
|
-
/** Emitted when media from user domain is enabled. */
|
|
4273
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4274
|
-
/** Emitted when media from user domain is disabled. */
|
|
4275
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4276
|
-
/** Emitted when Editorless is attached. */
|
|
4277
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4278
|
-
/** Emitted when Editorless is detached. */
|
|
4279
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4280
|
-
/**
|
|
4281
|
-
* A meta site id.
|
|
4282
|
-
* @format GUID
|
|
4283
|
-
*/
|
|
4284
|
-
metaSiteId?: string;
|
|
4285
|
-
/** A meta site version. Monotonically increasing. */
|
|
4286
|
-
version?: string;
|
|
4287
|
-
/** A timestamp of the event. */
|
|
4288
|
-
timestamp?: string;
|
|
4289
|
-
/**
|
|
4290
|
-
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
4291
|
-
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
4292
|
-
* @maxSize 4000
|
|
4293
|
-
*/
|
|
4294
|
-
assets?: Asset[];
|
|
4295
|
-
}
|
|
4296
|
-
/** @oneof */
|
|
4297
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4298
|
-
/** Emitted on a meta site creation. */
|
|
4299
|
-
siteCreated?: SiteCreated;
|
|
4300
|
-
/** Emitted on a meta site transfer completion. */
|
|
4301
|
-
siteTransferred?: SiteTransferred;
|
|
4302
|
-
/** Emitted on a meta site deletion. */
|
|
4303
|
-
siteDeleted?: SiteDeleted;
|
|
4304
|
-
/** Emitted on a meta site restoration. */
|
|
4305
|
-
siteUndeleted?: SiteUndeleted;
|
|
4306
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4307
|
-
sitePublished?: SitePublished;
|
|
4308
|
-
/** Emitted on a meta site unpublish. */
|
|
4309
|
-
siteUnpublished?: SiteUnpublished;
|
|
4310
|
-
/** Emitted when meta site is marked as template. */
|
|
4311
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4312
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4313
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4314
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4315
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4316
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4317
|
-
serviceRemoved?: ServiceRemoved;
|
|
4318
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4319
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4320
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4321
|
-
hardDeleted?: SiteHardDeleted;
|
|
4322
|
-
/** Emitted on a namespace change. */
|
|
4323
|
-
namespaceChanged?: NamespaceChanged;
|
|
4324
|
-
/** Emitted when Studio is attached. */
|
|
4325
|
-
studioAssigned?: StudioAssigned;
|
|
4326
|
-
/** Emitted when Studio is detached. */
|
|
4327
|
-
studioUnassigned?: StudioUnassigned;
|
|
4328
|
-
/**
|
|
4329
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4330
|
-
* the actual URL.
|
|
4331
|
-
*
|
|
4332
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4333
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4334
|
-
*/
|
|
4335
|
-
urlChanged?: SiteUrlChanged;
|
|
4336
|
-
/** Site is marked as PurgedExternally */
|
|
4337
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4338
|
-
/** Emitted when Odeditor is attached. */
|
|
4339
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4340
|
-
/** Emitted when Odeditor is detached. */
|
|
4341
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4342
|
-
/** Emitted when Picasso is attached. */
|
|
4343
|
-
picassoAssigned?: PicassoAssigned;
|
|
4344
|
-
/** Emitted when Picasso is detached. */
|
|
4345
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4346
|
-
/** Emitted when Wixel is attached. */
|
|
4347
|
-
wixelAssigned?: WixelAssigned;
|
|
4348
|
-
/** Emitted when Wixel is detached. */
|
|
4349
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4350
|
-
/** Emitted when StudioTwo is attached. */
|
|
4351
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4352
|
-
/** Emitted when StudioTwo is detached. */
|
|
4353
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4354
|
-
/** Emitted when media from user domain is enabled. */
|
|
4355
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4356
|
-
/** Emitted when media from user domain is disabled. */
|
|
4357
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4358
|
-
/** Emitted when Editorless is attached. */
|
|
4359
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4360
|
-
/** Emitted when Editorless is detached. */
|
|
4361
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4362
|
-
}
|
|
4363
|
-
interface Asset {
|
|
4364
|
-
/**
|
|
4365
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
4366
|
-
* @maxLength 36
|
|
4367
|
-
*/
|
|
4368
|
-
appDefId?: string;
|
|
4369
|
-
/**
|
|
4370
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
4371
|
-
* @maxLength 200
|
|
4372
|
-
*/
|
|
4373
|
-
instanceId?: string;
|
|
4374
|
-
/** An application state. */
|
|
4375
|
-
state?: StateWithLiterals;
|
|
4376
|
-
}
|
|
4377
|
-
declare enum State {
|
|
4378
|
-
UNKNOWN = "UNKNOWN",
|
|
4379
|
-
ENABLED = "ENABLED",
|
|
4380
|
-
DISABLED = "DISABLED",
|
|
4381
|
-
PENDING = "PENDING",
|
|
4382
|
-
DEMO = "DEMO"
|
|
4383
|
-
}
|
|
4384
|
-
/** @enumType */
|
|
4385
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
4386
|
-
interface SiteCreated {
|
|
4387
|
-
/**
|
|
4388
|
-
* A template identifier (empty if not created from a template).
|
|
4389
|
-
* @maxLength 36
|
|
4390
|
-
*/
|
|
4391
|
-
originTemplateId?: string;
|
|
4392
|
-
/**
|
|
4393
|
-
* An account id of the owner.
|
|
4394
|
-
* @format GUID
|
|
4395
|
-
*/
|
|
4396
|
-
ownerId?: string;
|
|
4397
|
-
/** A context in which meta site was created. */
|
|
4398
|
-
context?: SiteCreatedContextWithLiterals;
|
|
4399
|
-
/**
|
|
4400
|
-
* A meta site id from which this site was created.
|
|
4401
|
-
*
|
|
4402
|
-
* In case of a creation from a template it's a template id.
|
|
4403
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
4404
|
-
* @format GUID
|
|
4405
|
-
*/
|
|
4406
|
-
originMetaSiteId?: string | null;
|
|
4407
|
-
/**
|
|
4408
|
-
* A meta site name (URL slug).
|
|
4409
|
-
* @maxLength 20
|
|
4410
|
-
*/
|
|
4411
|
-
siteName?: string;
|
|
4412
|
-
/** A namespace. */
|
|
4413
|
-
namespace?: NamespaceWithLiterals;
|
|
4414
|
-
}
|
|
4415
|
-
declare enum SiteCreatedContext {
|
|
4416
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
4417
|
-
OTHER = "OTHER",
|
|
4418
|
-
/** A meta site was created from template. */
|
|
4419
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
4420
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
4421
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
4422
|
-
/** A copy of existing meta site. */
|
|
4423
|
-
DUPLICATE = "DUPLICATE",
|
|
4424
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
4425
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
4426
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
4427
|
-
FLASH = "FLASH"
|
|
4428
|
-
}
|
|
4429
|
-
/** @enumType */
|
|
4430
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
4431
|
-
declare enum Namespace {
|
|
4432
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4433
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4434
|
-
WIX = "WIX",
|
|
4435
|
-
/** 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. */
|
|
4436
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
4437
|
-
/** 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. */
|
|
4438
|
-
ALBUMS = "ALBUMS",
|
|
4439
|
-
/** 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. */
|
|
4440
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4441
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4442
|
-
HOTELS = "HOTELS",
|
|
4443
|
-
/** 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. */
|
|
4444
|
-
CLUBS = "CLUBS",
|
|
4445
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4446
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4447
|
-
/**
|
|
4448
|
-
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
4449
|
-
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
4450
|
-
*/
|
|
4451
|
-
DEV_SITE = "DEV_SITE",
|
|
4452
|
-
/** 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. */
|
|
4453
|
-
LOGOS = "LOGOS",
|
|
4454
|
-
/** 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. */
|
|
4455
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4456
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4457
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4458
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4459
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4455
|
+
interface RestockInfo {
|
|
4456
|
+
/** Restock type. */
|
|
4457
|
+
type?: RestockTypeWithLiterals;
|
|
4460
4458
|
/**
|
|
4461
|
-
*
|
|
4462
|
-
*
|
|
4463
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
4459
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
4460
|
+
* @maxSize 300
|
|
4464
4461
|
*/
|
|
4465
|
-
|
|
4462
|
+
items?: RestockItem[];
|
|
4463
|
+
}
|
|
4464
|
+
declare enum RestockType {
|
|
4465
|
+
NO_ITEMS = "NO_ITEMS",
|
|
4466
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
4467
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
4468
|
+
}
|
|
4469
|
+
/** @enumType */
|
|
4470
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
4471
|
+
interface RestockItem {
|
|
4466
4472
|
/**
|
|
4467
|
-
*
|
|
4468
|
-
*
|
|
4469
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4473
|
+
* ID of the line item being restocked.
|
|
4474
|
+
* @format GUID
|
|
4470
4475
|
*/
|
|
4471
|
-
|
|
4472
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
4473
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
4474
|
-
/** It is to be used in the Business First efforts. */
|
|
4475
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4476
|
-
/** Bookings business flow with no site. */
|
|
4477
|
-
ANYWHERE = "ANYWHERE",
|
|
4478
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
4479
|
-
HEADLESS = "HEADLESS",
|
|
4476
|
+
lineItemId?: string;
|
|
4480
4477
|
/**
|
|
4481
|
-
*
|
|
4482
|
-
*
|
|
4478
|
+
* Line item quantity being restocked.
|
|
4479
|
+
* @min 1
|
|
4480
|
+
* @max 100000
|
|
4483
4481
|
*/
|
|
4484
|
-
|
|
4485
|
-
|
|
4486
|
-
|
|
4482
|
+
quantity?: number;
|
|
4483
|
+
}
|
|
4484
|
+
interface TriggerRefundResponse {
|
|
4485
|
+
/** All order's transactions after the refunds were added */
|
|
4486
|
+
orderTransactions?: OrderTransactions;
|
|
4487
|
+
/** Created refund ID */
|
|
4488
|
+
refundId?: string | null;
|
|
4489
|
+
/** Payment ID's that the refund execution had failed for */
|
|
4490
|
+
failedPaymentIds?: ItemMetadata[];
|
|
4491
|
+
}
|
|
4492
|
+
/**
|
|
4493
|
+
* A record of all payments and refunds associated with an order.
|
|
4494
|
+
*
|
|
4495
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
4496
|
+
*/
|
|
4497
|
+
interface OrderTransactions {
|
|
4487
4498
|
/**
|
|
4488
|
-
*
|
|
4489
|
-
*
|
|
4490
|
-
* The Mobile company will be the owner of this namespace.
|
|
4499
|
+
* Order ID.
|
|
4500
|
+
* @format GUID
|
|
4491
4501
|
*/
|
|
4492
|
-
|
|
4493
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
4494
|
-
NOWNIA = "NOWNIA",
|
|
4502
|
+
orderId?: string;
|
|
4495
4503
|
/**
|
|
4496
|
-
*
|
|
4497
|
-
*
|
|
4504
|
+
* Record of payments made to the merchant.
|
|
4505
|
+
* @maxSize 100
|
|
4498
4506
|
*/
|
|
4499
|
-
|
|
4500
|
-
/** Codux Headless Sites */
|
|
4501
|
-
CODUX = "CODUX",
|
|
4502
|
-
/** Bobb - AI Design Creator. */
|
|
4503
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4507
|
+
payments?: Payment[];
|
|
4504
4508
|
/**
|
|
4505
|
-
*
|
|
4506
|
-
*
|
|
4509
|
+
* Record of refunds made to the buyer.
|
|
4510
|
+
* @maxSize 300
|
|
4507
4511
|
*/
|
|
4508
|
-
|
|
4509
|
-
|
|
4510
|
-
|
|
4511
|
-
/**
|
|
4512
|
-
|
|
4513
|
-
/**
|
|
4514
|
-
|
|
4515
|
-
/**
|
|
4516
|
-
|
|
4517
|
-
/** Wix Nano. */
|
|
4518
|
-
NANO = "NANO",
|
|
4519
|
-
/** Base44 headless sites. */
|
|
4520
|
-
BASE44 = "BASE44",
|
|
4521
|
-
/** Wix Channels Sites */
|
|
4522
|
-
CHANNELS = "CHANNELS",
|
|
4523
|
-
/** Nautilus platform. */
|
|
4524
|
-
NAUTILUS = "NAUTILUS",
|
|
4512
|
+
refunds?: Refund[];
|
|
4513
|
+
}
|
|
4514
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
|
|
4515
|
+
/** Regular payment details. */
|
|
4516
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
4517
|
+
/** Gift card payment details. */
|
|
4518
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4519
|
+
/** Membership payment details. */
|
|
4520
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
4525
4521
|
/**
|
|
4526
|
-
*
|
|
4527
|
-
*
|
|
4522
|
+
* Payment ID.
|
|
4523
|
+
* @format GUID
|
|
4524
|
+
* @readonly
|
|
4528
4525
|
*/
|
|
4529
|
-
|
|
4530
|
-
/**
|
|
4531
|
-
|
|
4526
|
+
id?: string | null;
|
|
4527
|
+
/** 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. */
|
|
4528
|
+
createdDate?: Date | null;
|
|
4532
4529
|
/**
|
|
4533
|
-
*
|
|
4534
|
-
*
|
|
4530
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
4531
|
+
* @readonly
|
|
4535
4532
|
*/
|
|
4536
|
-
|
|
4533
|
+
updatedDate?: Date | null;
|
|
4534
|
+
/** Payment amount. */
|
|
4535
|
+
amount?: Price;
|
|
4537
4536
|
/**
|
|
4538
|
-
*
|
|
4539
|
-
*
|
|
4540
|
-
*
|
|
4541
|
-
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
4537
|
+
* Whether refunds for this payment are disabled.
|
|
4538
|
+
* + `true`: This payment is not refundable.
|
|
4539
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
4542
4540
|
*/
|
|
4543
|
-
|
|
4541
|
+
refundDisabled?: boolean;
|
|
4544
4542
|
/**
|
|
4545
|
-
*
|
|
4546
|
-
*
|
|
4543
|
+
* Whether receipt generation is allowed for this payment.
|
|
4544
|
+
* + `true`: This payment supports receipt generation.
|
|
4545
|
+
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
4546
|
+
* @readonly
|
|
4547
4547
|
*/
|
|
4548
|
-
|
|
4549
|
-
|
|
4550
|
-
|
|
4551
|
-
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';
|
|
4552
|
-
/** Site transferred to another user. */
|
|
4553
|
-
interface SiteTransferred {
|
|
4548
|
+
supportReceiptGeneration?: boolean;
|
|
4549
|
+
/** Details about cash rounding applied to this payment, when relevant. */
|
|
4550
|
+
cashRounding?: CashRoundingDetails;
|
|
4554
4551
|
/**
|
|
4555
|
-
*
|
|
4556
|
-
*
|
|
4552
|
+
* Overall payment status.
|
|
4553
|
+
*
|
|
4554
|
+
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
4557
4555
|
*/
|
|
4558
|
-
|
|
4556
|
+
status?: PaymentStatusWithLiterals;
|
|
4559
4557
|
/**
|
|
4560
|
-
*
|
|
4558
|
+
* ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
|
|
4561
4559
|
* @format GUID
|
|
4562
4560
|
*/
|
|
4563
|
-
|
|
4564
|
-
}
|
|
4565
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
4566
|
-
interface SiteDeleted {
|
|
4567
|
-
/** A deletion context. */
|
|
4568
|
-
deleteContext?: DeleteContext;
|
|
4569
|
-
}
|
|
4570
|
-
interface DeleteContext {
|
|
4571
|
-
/** When the meta site was deleted. */
|
|
4572
|
-
dateDeleted?: Date | null;
|
|
4573
|
-
/** A status. */
|
|
4574
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
4575
|
-
/**
|
|
4576
|
-
* A reason (flow).
|
|
4577
|
-
* @maxLength 255
|
|
4578
|
-
*/
|
|
4579
|
-
deleteOrigin?: string;
|
|
4580
|
-
/**
|
|
4581
|
-
* A service that deleted it.
|
|
4582
|
-
* @maxLength 255
|
|
4583
|
-
*/
|
|
4584
|
-
initiatorId?: string | null;
|
|
4561
|
+
chargeCorrelationId?: string | null;
|
|
4585
4562
|
}
|
|
4586
|
-
|
|
4587
|
-
|
|
4588
|
-
|
|
4589
|
-
|
|
4590
|
-
|
|
4591
|
-
|
|
4563
|
+
/** @oneof */
|
|
4564
|
+
interface PaymentPaymentDetailsOneOf {
|
|
4565
|
+
/** Regular payment details. */
|
|
4566
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
4567
|
+
/** Gift card payment details. */
|
|
4568
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4569
|
+
/** Membership payment details. */
|
|
4570
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
4592
4571
|
}
|
|
4593
|
-
/** @
|
|
4594
|
-
|
|
4595
|
-
/** Restoration of the meta site. */
|
|
4596
|
-
interface SiteUndeleted {
|
|
4572
|
+
/** @oneof */
|
|
4573
|
+
interface PaymentReceiptInfoOneOf {
|
|
4597
4574
|
}
|
|
4598
|
-
/**
|
|
4599
|
-
interface
|
|
4575
|
+
/** @oneof */
|
|
4576
|
+
interface PaymentStatusDetailsOneOf {
|
|
4600
4577
|
}
|
|
4601
|
-
interface
|
|
4578
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
4579
|
+
/** Credit card details. */
|
|
4580
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4602
4581
|
/**
|
|
4603
|
-
*
|
|
4604
|
-
* @maxLength
|
|
4605
|
-
* @maxSize 10000
|
|
4582
|
+
* Wix Payments order ID.
|
|
4583
|
+
* @maxLength 100
|
|
4606
4584
|
*/
|
|
4607
|
-
|
|
4608
|
-
}
|
|
4609
|
-
interface SiteMarkedAsTemplate {
|
|
4610
|
-
}
|
|
4611
|
-
interface SiteMarkedAsWixSite {
|
|
4612
|
-
}
|
|
4613
|
-
/**
|
|
4614
|
-
* Represents a service provisioned a site.
|
|
4615
|
-
*
|
|
4616
|
-
* Note on `origin_instance_id`:
|
|
4617
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
4618
|
-
* This is because of the following scenario:
|
|
4619
|
-
*
|
|
4620
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
4621
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
4622
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
4623
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
4624
|
-
* your site remains consistent with what you initially received and does not include any
|
|
4625
|
-
* changes made to the original template afterward.
|
|
4626
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
4627
|
-
*/
|
|
4628
|
-
interface ServiceProvisioned {
|
|
4585
|
+
paymentOrderId?: string | null;
|
|
4629
4586
|
/**
|
|
4630
|
-
*
|
|
4631
|
-
*
|
|
4587
|
+
* Payment gateway's transaction ID.
|
|
4588
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
4589
|
+
* @maxLength 100
|
|
4590
|
+
*/
|
|
4591
|
+
gatewayTransactionId?: string | null;
|
|
4592
|
+
/**
|
|
4593
|
+
* Payment method.
|
|
4594
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
4595
|
+
* Non-exhaustive list of supported values:
|
|
4596
|
+
* + `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`
|
|
4597
|
+
* @maxLength 150
|
|
4598
|
+
* @deprecated Payment method.
|
|
4599
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
4600
|
+
* Non-exhaustive list of supported values:
|
|
4601
|
+
* + `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`
|
|
4602
|
+
* @replacedBy payment_method_name
|
|
4603
|
+
* @targetRemovalDate 2026-07-01
|
|
4632
4604
|
*/
|
|
4633
|
-
|
|
4605
|
+
paymentMethod?: string | null;
|
|
4634
4606
|
/**
|
|
4635
|
-
*
|
|
4636
|
-
* @maxLength
|
|
4607
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
4608
|
+
* @maxLength 100
|
|
4637
4609
|
*/
|
|
4638
|
-
|
|
4610
|
+
providerTransactionId?: string | null;
|
|
4611
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
4612
|
+
offlinePayment?: boolean;
|
|
4639
4613
|
/**
|
|
4640
|
-
*
|
|
4641
|
-
* @
|
|
4614
|
+
* Payment status.
|
|
4615
|
+
* @deprecated Payment status.
|
|
4616
|
+
* @replacedBy payment.status
|
|
4617
|
+
* @targetRemovalDate 2026-11-01
|
|
4642
4618
|
*/
|
|
4643
|
-
|
|
4619
|
+
status?: TransactionStatusWithLiterals;
|
|
4620
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
4621
|
+
savedPaymentMethod?: boolean;
|
|
4622
|
+
/** Authorization details. */
|
|
4623
|
+
authorizationDetails?: AuthorizationDetails;
|
|
4644
4624
|
/**
|
|
4645
|
-
*
|
|
4646
|
-
* @
|
|
4625
|
+
* Record of chargebacks made by the buyer.
|
|
4626
|
+
* @maxSize 6
|
|
4647
4627
|
*/
|
|
4648
|
-
|
|
4628
|
+
chargebacks?: Chargeback[];
|
|
4629
|
+
/** Platform fee amount associated with this payment. */
|
|
4630
|
+
platformFee?: Price;
|
|
4649
4631
|
/**
|
|
4650
|
-
*
|
|
4651
|
-
*
|
|
4632
|
+
* Payment method with buyer and optional owner translations.
|
|
4633
|
+
* Non-exhaustive list of supported values:
|
|
4634
|
+
* + `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`
|
|
4652
4635
|
*/
|
|
4653
|
-
|
|
4636
|
+
paymentMethodName?: PaymentMethodName;
|
|
4654
4637
|
}
|
|
4655
|
-
|
|
4656
|
-
|
|
4657
|
-
|
|
4658
|
-
|
|
4659
|
-
|
|
4660
|
-
|
|
4638
|
+
/** @oneof */
|
|
4639
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
4640
|
+
/** Credit card details. */
|
|
4641
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4642
|
+
}
|
|
4643
|
+
declare enum TransactionStatus {
|
|
4644
|
+
UNDEFINED = "UNDEFINED",
|
|
4645
|
+
APPROVED = "APPROVED",
|
|
4646
|
+
PENDING = "PENDING",
|
|
4647
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
4648
|
+
CANCELED = "CANCELED",
|
|
4649
|
+
DECLINED = "DECLINED",
|
|
4650
|
+
REFUNDED = "REFUNDED",
|
|
4651
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4652
|
+
AUTHORIZED = "AUTHORIZED",
|
|
4653
|
+
VOIDED = "VOIDED"
|
|
4654
|
+
}
|
|
4655
|
+
/** @enumType */
|
|
4656
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
4657
|
+
interface CreditCardPaymentMethodDetails {
|
|
4661
4658
|
/**
|
|
4662
|
-
*
|
|
4663
|
-
* @maxLength
|
|
4659
|
+
* The last 4 digits of the card number.
|
|
4660
|
+
* @maxLength 4
|
|
4664
4661
|
*/
|
|
4665
|
-
|
|
4662
|
+
lastFourDigits?: string | null;
|
|
4666
4663
|
/**
|
|
4667
|
-
*
|
|
4668
|
-
* @maxLength
|
|
4664
|
+
* Card issuer's brand.
|
|
4665
|
+
* @maxLength 100
|
|
4669
4666
|
*/
|
|
4670
|
-
|
|
4667
|
+
brand?: string | null;
|
|
4671
4668
|
}
|
|
4672
|
-
|
|
4673
|
-
interface SiteRenamed {
|
|
4669
|
+
interface AuthorizationDetails {
|
|
4674
4670
|
/**
|
|
4675
|
-
*
|
|
4676
|
-
* @
|
|
4671
|
+
* Whether the authorized payment is of a delayed capture.
|
|
4672
|
+
* @readonly
|
|
4677
4673
|
*/
|
|
4678
|
-
|
|
4674
|
+
delayedCapture?: boolean;
|
|
4675
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4676
|
+
authorizedDate?: Date | null;
|
|
4679
4677
|
/**
|
|
4680
|
-
*
|
|
4681
|
-
*
|
|
4678
|
+
* List of captures associated with payment
|
|
4679
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
4680
|
+
* @maxSize 1
|
|
4682
4681
|
*/
|
|
4683
|
-
|
|
4684
|
-
|
|
4685
|
-
|
|
4686
|
-
|
|
4687
|
-
|
|
4688
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
4689
|
-
*/
|
|
4690
|
-
interface SiteHardDeleted {
|
|
4691
|
-
/** A deletion context. */
|
|
4692
|
-
deleteContext?: DeleteContext;
|
|
4693
|
-
}
|
|
4694
|
-
interface NamespaceChanged {
|
|
4695
|
-
/** A previous namespace. */
|
|
4696
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
4697
|
-
/** A new namespace. */
|
|
4698
|
-
newNamespace?: NamespaceWithLiterals;
|
|
4699
|
-
}
|
|
4700
|
-
/** Assigned Studio editor */
|
|
4701
|
-
interface StudioAssigned {
|
|
4702
|
-
}
|
|
4703
|
-
/** Unassigned Studio editor */
|
|
4704
|
-
interface StudioUnassigned {
|
|
4705
|
-
}
|
|
4706
|
-
/**
|
|
4707
|
-
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
4708
|
-
*
|
|
4709
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
4710
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
4711
|
-
*
|
|
4712
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
4713
|
-
*/
|
|
4714
|
-
interface SiteUrlChanged {
|
|
4682
|
+
captures?: AuthorizationCapture[];
|
|
4683
|
+
/** Void associated with payment */
|
|
4684
|
+
void?: AuthorizationVoid;
|
|
4685
|
+
/** Scheduled action for this transaction */
|
|
4686
|
+
scheduledAction?: V1ScheduledAction;
|
|
4715
4687
|
}
|
|
4716
|
-
|
|
4717
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
4718
|
-
* Consumed by other teams to remove relevant data.
|
|
4719
|
-
*/
|
|
4720
|
-
interface SitePurgedExternally {
|
|
4688
|
+
interface AuthorizationCapture {
|
|
4721
4689
|
/**
|
|
4722
|
-
*
|
|
4723
|
-
* @
|
|
4724
|
-
* @
|
|
4725
|
-
* @targetRemovalDate 2025-04-15
|
|
4690
|
+
* Capture ID.
|
|
4691
|
+
* @format GUID
|
|
4692
|
+
* @readonly
|
|
4726
4693
|
*/
|
|
4727
|
-
|
|
4728
|
-
|
|
4729
|
-
|
|
4730
|
-
|
|
4731
|
-
|
|
4732
|
-
|
|
4733
|
-
|
|
4734
|
-
|
|
4735
|
-
/**
|
|
4736
|
-
|
|
4737
|
-
|
|
4738
|
-
|
|
4739
|
-
interface PicassoUnassigned {
|
|
4740
|
-
}
|
|
4741
|
-
/** Assigned Wixel */
|
|
4742
|
-
interface WixelAssigned {
|
|
4743
|
-
}
|
|
4744
|
-
/** Unassigned Wixel */
|
|
4745
|
-
interface WixelUnassigned {
|
|
4746
|
-
}
|
|
4747
|
-
/** Assigned StudioTwo */
|
|
4748
|
-
interface StudioTwoAssigned {
|
|
4749
|
-
}
|
|
4750
|
-
/** Unassigned StudioTwo */
|
|
4751
|
-
interface StudioTwoUnassigned {
|
|
4752
|
-
}
|
|
4753
|
-
/** Media from user domain is enabled. */
|
|
4754
|
-
interface UserDomainMediaEnabled {
|
|
4755
|
-
}
|
|
4756
|
-
/** Media from user domain is disabled. */
|
|
4757
|
-
interface UserDomainMediaDisabled {
|
|
4758
|
-
}
|
|
4759
|
-
/** Assigned Editorless */
|
|
4760
|
-
interface EditorlessAssigned {
|
|
4761
|
-
}
|
|
4762
|
-
/** Unassigned Editorless */
|
|
4763
|
-
interface EditorlessUnassigned {
|
|
4764
|
-
}
|
|
4765
|
-
interface HasCustomEmailConfigurationsRequest {
|
|
4766
|
-
}
|
|
4767
|
-
interface HasCustomEmailConfigurationsResponse {
|
|
4768
|
-
hasCustomConfigurations?: boolean;
|
|
4769
|
-
}
|
|
4770
|
-
interface AddToAutomationMigrationPopulationRequest {
|
|
4771
|
-
/** When true, sends custom email configurations to automation system via email */
|
|
4772
|
-
sendCustomEmailConfigs?: boolean;
|
|
4773
|
-
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
4774
|
-
origin?: OriginWithLiterals;
|
|
4694
|
+
id?: string | null;
|
|
4695
|
+
/** Status of this capture action */
|
|
4696
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
4697
|
+
/**
|
|
4698
|
+
* Amount of this capture
|
|
4699
|
+
* @immutable
|
|
4700
|
+
*/
|
|
4701
|
+
amount?: Price;
|
|
4702
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4703
|
+
createdDate?: Date | null;
|
|
4704
|
+
/** In case of status is FAILED may contain failure details */
|
|
4705
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
4775
4706
|
}
|
|
4776
|
-
declare enum
|
|
4777
|
-
|
|
4778
|
-
|
|
4707
|
+
declare enum AuthorizationCaptureStatus {
|
|
4708
|
+
/** Capture operation still in progress. */
|
|
4709
|
+
PENDING = "PENDING",
|
|
4710
|
+
/** Capture operation succeeded. */
|
|
4711
|
+
SUCCEEDED = "SUCCEEDED",
|
|
4712
|
+
/** Capture operation failed. */
|
|
4713
|
+
FAILED = "FAILED"
|
|
4779
4714
|
}
|
|
4780
4715
|
/** @enumType */
|
|
4781
|
-
type
|
|
4782
|
-
interface
|
|
4783
|
-
|
|
4784
|
-
|
|
4785
|
-
interface IsInAutomationMigrationPopulationRequest {
|
|
4786
|
-
}
|
|
4787
|
-
interface IsInAutomationMigrationPopulationResponse {
|
|
4788
|
-
inPopulation?: boolean;
|
|
4716
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
4717
|
+
interface AuthorizationActionFailureDetails {
|
|
4718
|
+
/** @maxLength 100 */
|
|
4719
|
+
failureCode?: string;
|
|
4789
4720
|
}
|
|
4790
|
-
interface
|
|
4791
|
-
/**
|
|
4792
|
-
|
|
4793
|
-
|
|
4794
|
-
|
|
4795
|
-
|
|
4796
|
-
|
|
4797
|
-
/**
|
|
4798
|
-
|
|
4799
|
-
/**
|
|
4800
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4801
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
4802
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4803
|
-
*/
|
|
4804
|
-
paymentGatewayOrderId?: string | null;
|
|
4805
|
-
/**
|
|
4806
|
-
* Whether to delay capture of the payment.
|
|
4807
|
-
* Default: false
|
|
4808
|
-
* @deprecated Whether to delay capture of the payment.
|
|
4809
|
-
* Default: false
|
|
4810
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4811
|
-
* @targetRemovalDate 2024-09-30
|
|
4812
|
-
*/
|
|
4813
|
-
delayedCapture?: boolean;
|
|
4814
|
-
/** Delayed capture payment settings */
|
|
4815
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4721
|
+
interface AuthorizationVoid {
|
|
4722
|
+
/** Status of this void action */
|
|
4723
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
4724
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4725
|
+
voidedDate?: Date | null;
|
|
4726
|
+
/** In case of status is FAILED may contain failure details */
|
|
4727
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
4728
|
+
/** Reason of void action */
|
|
4729
|
+
reason?: ReasonWithLiterals;
|
|
4816
4730
|
}
|
|
4817
|
-
|
|
4818
|
-
/**
|
|
4819
|
-
|
|
4820
|
-
|
|
4821
|
-
|
|
4822
|
-
|
|
4823
|
-
|
|
4824
|
-
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4825
|
-
* @format WEB_URL
|
|
4826
|
-
*/
|
|
4827
|
-
cancelUrl?: string | null;
|
|
4828
|
-
/**
|
|
4829
|
-
* URL to redirect buyer in case of failed/rejected transaction
|
|
4830
|
-
* @format WEB_URL
|
|
4831
|
-
*/
|
|
4832
|
-
errorUrl?: string | null;
|
|
4833
|
-
/**
|
|
4834
|
-
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4835
|
-
* @format WEB_URL
|
|
4836
|
-
*/
|
|
4837
|
-
pendingUrl?: string | null;
|
|
4731
|
+
declare enum AuthorizationVoidStatus {
|
|
4732
|
+
/** Void operation still in progress. */
|
|
4733
|
+
PENDING = "PENDING",
|
|
4734
|
+
/** Void operation succeeded. */
|
|
4735
|
+
SUCCEEDED = "SUCCEEDED",
|
|
4736
|
+
/** Void operation failed. */
|
|
4737
|
+
FAILED = "FAILED"
|
|
4838
4738
|
}
|
|
4839
|
-
|
|
4840
|
-
|
|
4841
|
-
|
|
4842
|
-
|
|
4843
|
-
|
|
4739
|
+
/** @enumType */
|
|
4740
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
4741
|
+
/** Reason the authorization was voided. */
|
|
4742
|
+
declare enum Reason {
|
|
4743
|
+
/** Authorization was voided by user. */
|
|
4744
|
+
MANUAL = "MANUAL",
|
|
4745
|
+
/** Authorization passed execution date. */
|
|
4746
|
+
SCHEDULED = "SCHEDULED"
|
|
4844
4747
|
}
|
|
4845
|
-
|
|
4846
|
-
|
|
4748
|
+
/** @enumType */
|
|
4749
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
4750
|
+
interface V1ScheduledAction {
|
|
4751
|
+
/** Type of the action. */
|
|
4752
|
+
actionType?: ActionTypeWithLiterals;
|
|
4753
|
+
/** The date and time of the action. */
|
|
4754
|
+
executionDate?: Date | null;
|
|
4755
|
+
}
|
|
4756
|
+
declare enum ActionType {
|
|
4847
4757
|
VOID = "VOID",
|
|
4848
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
4849
4758
|
CAPTURE = "CAPTURE"
|
|
4850
4759
|
}
|
|
4851
4760
|
/** @enumType */
|
|
4852
|
-
type
|
|
4853
|
-
interface
|
|
4761
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
4762
|
+
interface Chargeback {
|
|
4854
4763
|
/**
|
|
4855
|
-
*
|
|
4856
|
-
* @
|
|
4764
|
+
* Chargeback ID.
|
|
4765
|
+
* @format GUID
|
|
4766
|
+
* @readonly
|
|
4767
|
+
* @immutable
|
|
4857
4768
|
*/
|
|
4858
|
-
|
|
4859
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4860
|
-
unit?: DurationUnitWithLiterals;
|
|
4861
|
-
}
|
|
4862
|
-
declare enum DurationUnit {
|
|
4863
|
-
MINUTES = "MINUTES",
|
|
4864
|
-
HOURS = "HOURS",
|
|
4865
|
-
DAYS = "DAYS"
|
|
4866
|
-
}
|
|
4867
|
-
/** @enumType */
|
|
4868
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4869
|
-
interface PreparePaymentCollectionResponse {
|
|
4870
|
-
/** Payment gateway order id which is associated with given payment */
|
|
4871
|
-
paymentGatewayOrderId?: string;
|
|
4872
|
-
}
|
|
4873
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
4769
|
+
id?: string;
|
|
4874
4770
|
/**
|
|
4875
|
-
*
|
|
4876
|
-
* @
|
|
4877
|
-
* @
|
|
4771
|
+
* 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.
|
|
4772
|
+
* @readonly
|
|
4773
|
+
* @immutable
|
|
4774
|
+
*/
|
|
4775
|
+
createdDate?: Date | null;
|
|
4776
|
+
/**
|
|
4777
|
+
* 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.
|
|
4778
|
+
* @readonly
|
|
4779
|
+
*/
|
|
4780
|
+
updatedDate?: Date | null;
|
|
4781
|
+
/**
|
|
4782
|
+
* Amount.
|
|
4783
|
+
* @readonly
|
|
4784
|
+
* @immutable
|
|
4878
4785
|
*/
|
|
4879
|
-
ecomOrderId: string;
|
|
4880
|
-
}
|
|
4881
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
4882
|
-
/** Payment collectability status */
|
|
4883
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4884
|
-
/** Collectable order amount */
|
|
4885
4786
|
amount?: Price;
|
|
4886
|
-
}
|
|
4887
|
-
declare enum PaymentCollectabilityStatus {
|
|
4888
|
-
UNKNOWN = "UNKNOWN",
|
|
4889
|
-
COLLECTABLE = "COLLECTABLE",
|
|
4890
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4891
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4892
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4893
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4894
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4895
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4896
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4897
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4898
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4899
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
4900
|
-
}
|
|
4901
|
-
/** @enumType */
|
|
4902
|
-
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';
|
|
4903
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
4904
4787
|
/**
|
|
4905
|
-
*
|
|
4906
|
-
* @
|
|
4907
|
-
* @maxLength 100
|
|
4788
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
4789
|
+
* @readonly
|
|
4908
4790
|
*/
|
|
4909
|
-
|
|
4910
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
4911
|
-
amount: Price;
|
|
4912
|
-
}
|
|
4913
|
-
/**
|
|
4914
|
-
* User-defined payment method name.
|
|
4915
|
-
* Allows specifying either a predefined type or a custom name.
|
|
4916
|
-
*/
|
|
4917
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4918
|
-
/** Predefined payment method. */
|
|
4919
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4791
|
+
reversalAmount?: Price;
|
|
4920
4792
|
/**
|
|
4921
|
-
*
|
|
4793
|
+
* Status.
|
|
4922
4794
|
*
|
|
4923
|
-
*
|
|
4924
|
-
* @minLength 1
|
|
4925
|
-
* @maxLength 150
|
|
4795
|
+
* Default: `"APPROVED"`.
|
|
4926
4796
|
*/
|
|
4927
|
-
|
|
4928
|
-
}
|
|
4929
|
-
/** @oneof */
|
|
4930
|
-
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4931
|
-
/** Predefined payment method. */
|
|
4932
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4797
|
+
status?: ChargebackStatusWithLiterals;
|
|
4933
4798
|
/**
|
|
4934
|
-
*
|
|
4935
|
-
*
|
|
4936
|
-
*
|
|
4937
|
-
* @
|
|
4938
|
-
* @maxLength 150
|
|
4799
|
+
* External chargeback ID.
|
|
4800
|
+
* @format GUID
|
|
4801
|
+
* @readonly
|
|
4802
|
+
* @immutable
|
|
4939
4803
|
*/
|
|
4940
|
-
|
|
4804
|
+
externalId?: string | null;
|
|
4941
4805
|
}
|
|
4942
|
-
|
|
4943
|
-
|
|
4944
|
-
|
|
4945
|
-
|
|
4946
|
-
|
|
4947
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4948
|
-
/** Payment by check. */
|
|
4949
|
-
CHECK = "CHECK"
|
|
4806
|
+
declare enum ChargebackStatus {
|
|
4807
|
+
/** Chargeback was approved. */
|
|
4808
|
+
APPROVED = "APPROVED",
|
|
4809
|
+
/** Chargeback was reversed. */
|
|
4810
|
+
REVERSED = "REVERSED"
|
|
4950
4811
|
}
|
|
4951
4812
|
/** @enumType */
|
|
4952
|
-
type
|
|
4953
|
-
interface
|
|
4954
|
-
}
|
|
4955
|
-
interface MarkOrderAsPaidRequest {
|
|
4813
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
4814
|
+
interface PaymentMethodName {
|
|
4956
4815
|
/**
|
|
4957
|
-
*
|
|
4958
|
-
* @
|
|
4959
|
-
* @maxLength 100
|
|
4816
|
+
* Translated payment method name in buyer language.
|
|
4817
|
+
* @maxLength 150
|
|
4960
4818
|
*/
|
|
4961
|
-
|
|
4962
|
-
}
|
|
4963
|
-
interface MarkOrderAsPaidResponse {
|
|
4964
|
-
/** Updated order. */
|
|
4965
|
-
order?: Order;
|
|
4966
|
-
}
|
|
4967
|
-
interface BulkMarkOrdersAsPaidRequest {
|
|
4819
|
+
buyerLanguageName?: string | null;
|
|
4968
4820
|
/**
|
|
4969
|
-
*
|
|
4970
|
-
* @
|
|
4971
|
-
* @maxSize 100
|
|
4972
|
-
* @minLength 1
|
|
4973
|
-
* @maxLength 100
|
|
4821
|
+
* Translated payment method name in site owner language.
|
|
4822
|
+
* @maxLength 150
|
|
4974
4823
|
*/
|
|
4975
|
-
|
|
4976
|
-
}
|
|
4977
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
4824
|
+
siteLanguageName?: string | null;
|
|
4978
4825
|
/**
|
|
4979
|
-
*
|
|
4980
|
-
*
|
|
4826
|
+
* User-provided payment method name.
|
|
4827
|
+
*
|
|
4828
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
4981
4829
|
*/
|
|
4982
|
-
|
|
4983
|
-
/** Bulk action metadata. */
|
|
4984
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4830
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
4985
4831
|
}
|
|
4986
|
-
interface
|
|
4987
|
-
/** Item metadata. */
|
|
4988
|
-
itemMetadata?: ItemMetadata;
|
|
4832
|
+
interface GiftCardPaymentDetails {
|
|
4989
4833
|
/**
|
|
4990
|
-
*
|
|
4991
|
-
*
|
|
4992
|
-
* Returned when `returnFullEntity = true`.
|
|
4834
|
+
* Gift card payment ID.
|
|
4835
|
+
* @maxLength 100
|
|
4993
4836
|
*/
|
|
4994
|
-
|
|
4995
|
-
|
|
4996
|
-
|
|
4997
|
-
|
|
4998
|
-
|
|
4999
|
-
|
|
5000
|
-
|
|
5001
|
-
|
|
5002
|
-
|
|
5003
|
-
|
|
5004
|
-
|
|
5005
|
-
|
|
5006
|
-
|
|
5007
|
-
|
|
5008
|
-
|
|
5009
|
-
|
|
5010
|
-
|
|
5011
|
-
|
|
5012
|
-
|
|
5013
|
-
|
|
5014
|
-
interface BulkActionMetadata {
|
|
5015
|
-
/** Number of items that were successfully processed. */
|
|
5016
|
-
totalSuccesses?: number;
|
|
5017
|
-
/** Number of items that couldn't be processed. */
|
|
5018
|
-
totalFailures?: number;
|
|
5019
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
5020
|
-
undetailedFailures?: number;
|
|
4837
|
+
giftCardPaymentId?: string;
|
|
4838
|
+
/**
|
|
4839
|
+
* ID of the app that created the gift card.
|
|
4840
|
+
* @format GUID
|
|
4841
|
+
*/
|
|
4842
|
+
appId?: string;
|
|
4843
|
+
/**
|
|
4844
|
+
* Whether the gift card is voided.
|
|
4845
|
+
* @readonly
|
|
4846
|
+
* @deprecated Whether the gift card is voided.
|
|
4847
|
+
* @replacedBy payment.status
|
|
4848
|
+
* @targetRemovalDate 2026-11-01
|
|
4849
|
+
*/
|
|
4850
|
+
voided?: boolean;
|
|
4851
|
+
/**
|
|
4852
|
+
* Gift card code with all but the last four characters masked. For example, `************QXY1`.
|
|
4853
|
+
* @maxLength 30
|
|
4854
|
+
* @immutable
|
|
4855
|
+
*/
|
|
4856
|
+
obfuscatedCode?: string | null;
|
|
5021
4857
|
}
|
|
5022
|
-
interface
|
|
4858
|
+
interface MembershipPaymentDetails {
|
|
5023
4859
|
/**
|
|
5024
|
-
*
|
|
4860
|
+
* Membership ID.
|
|
4861
|
+
* @maxLength 200
|
|
4862
|
+
*/
|
|
4863
|
+
membershipId?: string;
|
|
4864
|
+
/**
|
|
4865
|
+
* ID of the line item this membership applies to.
|
|
5025
4866
|
* @minLength 1
|
|
5026
4867
|
* @maxLength 100
|
|
5027
4868
|
*/
|
|
5028
|
-
|
|
5029
|
-
}
|
|
5030
|
-
interface GetRefundabilityStatusResponse {
|
|
4869
|
+
lineItemId?: string;
|
|
5031
4870
|
/**
|
|
5032
|
-
*
|
|
5033
|
-
* @
|
|
4871
|
+
* Payment status.
|
|
4872
|
+
* @deprecated Payment status.
|
|
4873
|
+
* @replacedBy payment.status
|
|
4874
|
+
* @targetRemovalDate 2026-11-01
|
|
5034
4875
|
*/
|
|
5035
|
-
|
|
4876
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
4877
|
+
/** Membership name. */
|
|
4878
|
+
name?: MembershipName;
|
|
5036
4879
|
/**
|
|
5037
|
-
*
|
|
5038
|
-
* @
|
|
4880
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
4881
|
+
* @minLength 1
|
|
4882
|
+
* @maxLength 100
|
|
5039
4883
|
*/
|
|
5040
|
-
|
|
5041
|
-
|
|
5042
|
-
|
|
5043
|
-
|
|
5044
|
-
|
|
5045
|
-
|
|
5046
|
-
|
|
5047
|
-
|
|
5048
|
-
|
|
5049
|
-
/**
|
|
5050
|
-
|
|
5051
|
-
|
|
5052
|
-
|
|
5053
|
-
|
|
5054
|
-
/**
|
|
5055
|
-
|
|
5056
|
-
/** Reason why payment is not refundable. */
|
|
5057
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5058
|
-
/** Reason why payment is only refundable manually. */
|
|
5059
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5060
|
-
}
|
|
5061
|
-
declare enum RefundableStatus {
|
|
5062
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
5063
|
-
MANUAL = "MANUAL",
|
|
5064
|
-
REFUNDABLE = "REFUNDABLE"
|
|
5065
|
-
}
|
|
5066
|
-
/** @enumType */
|
|
5067
|
-
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
5068
|
-
declare enum NonRefundableReason {
|
|
5069
|
-
NONE = "NONE",
|
|
5070
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
5071
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
5072
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
5073
|
-
NOT_PAID = "NOT_PAID",
|
|
5074
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5075
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
5076
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5077
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
5078
|
-
FORBIDDEN = "FORBIDDEN",
|
|
5079
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5080
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5081
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4884
|
+
externalTransactionId?: string | null;
|
|
4885
|
+
/**
|
|
4886
|
+
* Whether the membership is voided.
|
|
4887
|
+
* @readonly
|
|
4888
|
+
* @deprecated Whether the membership is voided.
|
|
4889
|
+
* @replacedBy payment.status
|
|
4890
|
+
* @targetRemovalDate 2026-11-01
|
|
4891
|
+
*/
|
|
4892
|
+
voided?: boolean;
|
|
4893
|
+
/**
|
|
4894
|
+
* ID of the application providing this payment option.
|
|
4895
|
+
* @format GUID
|
|
4896
|
+
*/
|
|
4897
|
+
providerAppId?: string;
|
|
4898
|
+
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
4899
|
+
futureMembership?: FutureMembershipDetails;
|
|
5082
4900
|
}
|
|
5083
|
-
|
|
5084
|
-
|
|
5085
|
-
|
|
5086
|
-
|
|
5087
|
-
|
|
5088
|
-
|
|
5089
|
-
|
|
4901
|
+
declare enum MembershipPaymentStatus {
|
|
4902
|
+
/** Payment was charged. */
|
|
4903
|
+
CHARGED = "CHARGED",
|
|
4904
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
4905
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
4906
|
+
/** Payment is pending. */
|
|
4907
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
4908
|
+
/** Payment was voided. */
|
|
4909
|
+
VOIDED = "VOIDED"
|
|
5090
4910
|
}
|
|
5091
4911
|
/** @enumType */
|
|
5092
|
-
type
|
|
5093
|
-
interface
|
|
4912
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
4913
|
+
interface FutureMembershipDetails {
|
|
5094
4914
|
/**
|
|
5095
|
-
*
|
|
5096
|
-
* @
|
|
5097
|
-
* @maxLength 100
|
|
4915
|
+
* ID of the plan line item in the order from which the membership will be created.
|
|
4916
|
+
* @format GUID
|
|
5098
4917
|
*/
|
|
5099
|
-
|
|
5100
|
-
/**
|
|
5101
|
-
|
|
4918
|
+
lineItemId?: string;
|
|
4919
|
+
/**
|
|
4920
|
+
* ID of the benefit the future membership will grant.
|
|
4921
|
+
* @maxLength 200
|
|
4922
|
+
*/
|
|
4923
|
+
benefitId?: string;
|
|
5102
4924
|
}
|
|
5103
|
-
interface
|
|
4925
|
+
interface WixReceiptInfo {
|
|
5104
4926
|
/**
|
|
5105
|
-
* ID
|
|
4927
|
+
* Receipt ID
|
|
5106
4928
|
* @format GUID
|
|
5107
4929
|
*/
|
|
5108
|
-
|
|
4930
|
+
receiptId?: string;
|
|
5109
4931
|
/**
|
|
5110
|
-
*
|
|
4932
|
+
* Display number of receipt
|
|
5111
4933
|
* @minLength 1
|
|
5112
|
-
* @maxLength
|
|
4934
|
+
* @maxLength 40
|
|
5113
4935
|
*/
|
|
5114
|
-
|
|
5115
|
-
}
|
|
5116
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
5117
|
-
/** ID of the order created in the payment gateway */
|
|
5118
|
-
paymentGatewayOrderId?: string;
|
|
4936
|
+
displayNumber?: string | null;
|
|
5119
4937
|
}
|
|
5120
|
-
interface
|
|
4938
|
+
interface ExternalReceiptInfo {
|
|
5121
4939
|
/**
|
|
5122
|
-
*
|
|
5123
|
-
* @minLength 1
|
|
4940
|
+
* External receipt ID
|
|
5124
4941
|
* @maxLength 100
|
|
5125
4942
|
*/
|
|
5126
|
-
|
|
4943
|
+
receiptId?: string | null;
|
|
5127
4944
|
/**
|
|
5128
|
-
*
|
|
5129
|
-
* but a user which is using the membership on behalf of the a member
|
|
4945
|
+
* ID of the app providing the receipt
|
|
5130
4946
|
* @format GUID
|
|
5131
4947
|
*/
|
|
5132
|
-
|
|
4948
|
+
appId?: string | null;
|
|
5133
4949
|
/**
|
|
5134
|
-
*
|
|
5135
|
-
* @
|
|
5136
|
-
* @
|
|
4950
|
+
* Display number of receipt
|
|
4951
|
+
* @minLength 1
|
|
4952
|
+
* @maxLength 40
|
|
5137
4953
|
*/
|
|
5138
|
-
|
|
4954
|
+
displayNumber?: string | null;
|
|
5139
4955
|
}
|
|
5140
|
-
interface
|
|
4956
|
+
interface CashRoundingDetails {
|
|
5141
4957
|
/**
|
|
5142
|
-
*
|
|
5143
|
-
*
|
|
5144
|
-
*
|
|
4958
|
+
* Payment amount before cash rounding was applied.
|
|
4959
|
+
* When provided, balance and status calculations use this value instead of `amount`
|
|
4960
|
+
* to prevent false overpayment or underpayment due to rounding.
|
|
5145
4961
|
*/
|
|
5146
|
-
|
|
4962
|
+
unroundedAmount?: Price;
|
|
4963
|
+
/**
|
|
4964
|
+
* The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
|
|
4965
|
+
* A positive value indicates the price was rounded up; a negative value indicates a round-down.
|
|
4966
|
+
* @readonly
|
|
4967
|
+
*/
|
|
4968
|
+
roundingAdjustment?: CashRounding;
|
|
4969
|
+
}
|
|
4970
|
+
declare enum PaymentStatus {
|
|
4971
|
+
/** Payment was charged successfully. */
|
|
4972
|
+
APPROVED = "APPROVED",
|
|
4973
|
+
/** Payment is being processed and hasn't been confirmed yet. */
|
|
4974
|
+
PENDING = "PENDING",
|
|
4975
|
+
/** 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. */
|
|
4976
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
4977
|
+
/** Payment was canceled before it was charged. */
|
|
4978
|
+
CANCELED = "CANCELED",
|
|
4979
|
+
/** Payment was declined by the payment provider. */
|
|
4980
|
+
DECLINED = "DECLINED",
|
|
4981
|
+
/** Payment was fully refunded. */
|
|
4982
|
+
REFUNDED = "REFUNDED",
|
|
4983
|
+
/** Part of the payment amount was refunded. */
|
|
4984
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4985
|
+
/** 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. */
|
|
4986
|
+
AUTHORIZED = "AUTHORIZED",
|
|
4987
|
+
/**
|
|
4988
|
+
* Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
|
|
4989
|
+
*
|
|
4990
|
+
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
4991
|
+
*/
|
|
4992
|
+
VOIDED = "VOIDED"
|
|
4993
|
+
}
|
|
4994
|
+
/** @enumType */
|
|
4995
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
4996
|
+
interface CanceledStatusDetails {
|
|
4997
|
+
reason?: CanceledReasonWithLiterals;
|
|
4998
|
+
}
|
|
4999
|
+
declare enum CanceledReason {
|
|
5000
|
+
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
5001
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
5002
|
+
/** Payment was not completed by user and expired. */
|
|
5003
|
+
EXPIRED = "EXPIRED"
|
|
5004
|
+
}
|
|
5005
|
+
/** @enumType */
|
|
5006
|
+
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
5007
|
+
interface DeclinedStatusDetails {
|
|
5008
|
+
reason?: DeclinedReasonWithLiterals;
|
|
5009
|
+
}
|
|
5010
|
+
declare enum DeclinedReason {
|
|
5011
|
+
/** Corresponding charge failed. */
|
|
5012
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5013
|
+
/** Payment details expired. */
|
|
5014
|
+
EXPIRED = "EXPIRED",
|
|
5015
|
+
/** Insufficient funds. */
|
|
5016
|
+
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
5017
|
+
/** Gift card was disabled before charge was attempted. */
|
|
5018
|
+
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
5019
|
+
}
|
|
5020
|
+
/** @enumType */
|
|
5021
|
+
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
5022
|
+
interface VoidedStatusDetails {
|
|
5023
|
+
reason?: VoidedReasonWithLiterals;
|
|
5024
|
+
}
|
|
5025
|
+
declare enum VoidedReason {
|
|
5026
|
+
/** Payment was voided by merchant request. */
|
|
5027
|
+
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
5028
|
+
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
5029
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
5030
|
+
}
|
|
5031
|
+
/** @enumType */
|
|
5032
|
+
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
5033
|
+
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
5034
|
+
}
|
|
5035
|
+
/** @oneof */
|
|
5036
|
+
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
5037
|
+
}
|
|
5038
|
+
interface Refund {
|
|
5147
5039
|
/**
|
|
5148
|
-
* ID
|
|
5040
|
+
* Refund ID.
|
|
5149
5041
|
* @format GUID
|
|
5042
|
+
* @readonly
|
|
5150
5043
|
*/
|
|
5151
|
-
|
|
5152
|
-
/** The name of used membership */
|
|
5153
|
-
membershipName?: MembershipName;
|
|
5154
|
-
/** Additional data about this membership */
|
|
5155
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
5156
|
-
/** Catalog and item reference info. */
|
|
5157
|
-
catalogReference?: CatalogReference;
|
|
5158
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5159
|
-
serviceProperties?: ServiceProperties;
|
|
5044
|
+
id?: string;
|
|
5160
5045
|
/**
|
|
5161
|
-
*
|
|
5162
|
-
*
|
|
5163
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
5164
|
-
* @minLength 1
|
|
5165
|
-
* @maxLength 36
|
|
5046
|
+
* List of transactions.
|
|
5047
|
+
* @maxSize 50
|
|
5166
5048
|
*/
|
|
5167
|
-
|
|
5049
|
+
transactions?: RefundTransaction[];
|
|
5050
|
+
/** Refund business details. */
|
|
5051
|
+
details?: RefundDetails;
|
|
5168
5052
|
/**
|
|
5169
|
-
*
|
|
5170
|
-
* @
|
|
5171
|
-
* @
|
|
5053
|
+
* 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.
|
|
5054
|
+
* @readonly
|
|
5055
|
+
* @immutable
|
|
5172
5056
|
*/
|
|
5173
|
-
|
|
5174
|
-
}
|
|
5175
|
-
interface MembershipName {
|
|
5057
|
+
createdDate?: Date | null;
|
|
5176
5058
|
/**
|
|
5177
|
-
*
|
|
5178
|
-
* @
|
|
5059
|
+
* Aggregated refund summary.
|
|
5060
|
+
* @readonly
|
|
5179
5061
|
*/
|
|
5180
|
-
|
|
5062
|
+
summary?: AggregatedRefundSummary;
|
|
5181
5063
|
/**
|
|
5182
|
-
*
|
|
5183
|
-
* @
|
|
5064
|
+
* ID of the app that initiated this refund.
|
|
5065
|
+
* @format GUID
|
|
5066
|
+
* @readonly
|
|
5067
|
+
* @immutable
|
|
5184
5068
|
*/
|
|
5185
|
-
|
|
5186
|
-
}
|
|
5187
|
-
interface ChargeMembershipsResponse {
|
|
5069
|
+
requestingServiceAppId?: string | null;
|
|
5188
5070
|
}
|
|
5189
|
-
interface
|
|
5071
|
+
interface RefundTransaction {
|
|
5190
5072
|
/**
|
|
5191
|
-
*
|
|
5192
|
-
* @
|
|
5193
|
-
* @
|
|
5073
|
+
* ID of the payment associated with this refund.
|
|
5074
|
+
* @format GUID
|
|
5075
|
+
* @immutable
|
|
5194
5076
|
*/
|
|
5195
|
-
|
|
5077
|
+
paymentId?: string;
|
|
5196
5078
|
/**
|
|
5197
|
-
* Refund
|
|
5198
|
-
* @
|
|
5199
|
-
* @maxSize 1
|
|
5079
|
+
* Refund amount.
|
|
5080
|
+
* @immutable
|
|
5200
5081
|
*/
|
|
5201
|
-
|
|
5202
|
-
/**
|
|
5203
|
-
|
|
5204
|
-
/**
|
|
5205
|
-
|
|
5206
|
-
}
|
|
5207
|
-
interface PaymentRefund {
|
|
5082
|
+
amount?: Price;
|
|
5083
|
+
/** Refund status. */
|
|
5084
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
5085
|
+
/** Optional details of current refund status. */
|
|
5086
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
5208
5087
|
/**
|
|
5209
|
-
*
|
|
5088
|
+
* Payment gateway's refund ID.
|
|
5089
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
5210
5090
|
* @format GUID
|
|
5211
5091
|
*/
|
|
5212
|
-
|
|
5213
|
-
/**
|
|
5214
|
-
|
|
5092
|
+
gatewayRefundId?: string | null;
|
|
5093
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5094
|
+
providerRefundId?: string | null;
|
|
5215
5095
|
/**
|
|
5216
|
-
* Whether refund
|
|
5217
|
-
*
|
|
5218
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5096
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
5097
|
+
* @immutable
|
|
5219
5098
|
*/
|
|
5220
5099
|
externalRefund?: boolean;
|
|
5221
5100
|
}
|
|
5222
|
-
|
|
5223
|
-
|
|
5224
|
-
|
|
5225
|
-
|
|
5226
|
-
|
|
5101
|
+
/** Refund transaction status. */
|
|
5102
|
+
declare enum RefundStatus {
|
|
5103
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
5104
|
+
PENDING = "PENDING",
|
|
5105
|
+
/** Refund transaction succeeded. */
|
|
5106
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5107
|
+
/** Refund transaction failed. */
|
|
5108
|
+
FAILED = "FAILED",
|
|
5109
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
5110
|
+
SCHEDULED = "SCHEDULED",
|
|
5111
|
+
/** Refund was initiated on payment provider side. */
|
|
5112
|
+
STARTED = "STARTED"
|
|
5113
|
+
}
|
|
5114
|
+
/** @enumType */
|
|
5115
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5116
|
+
interface RefundStatusInfo {
|
|
5227
5117
|
/**
|
|
5228
|
-
*
|
|
5118
|
+
* Reason code for the refund's current status.
|
|
5119
|
+
*
|
|
5120
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5121
|
+
* @minLength 1
|
|
5122
|
+
* @maxLength 10
|
|
5123
|
+
*/
|
|
5124
|
+
paymentGatewayReasonCode?: string | null;
|
|
5125
|
+
/**
|
|
5126
|
+
* Free text explanation of current refund status.
|
|
5229
5127
|
* @minLength 1
|
|
5230
5128
|
* @maxLength 1000
|
|
5231
5129
|
*/
|
|
5232
|
-
|
|
5130
|
+
description?: string | null;
|
|
5233
5131
|
}
|
|
5234
|
-
interface
|
|
5235
|
-
/**
|
|
5236
|
-
|
|
5132
|
+
interface AggregatedRefundSummary {
|
|
5133
|
+
/** Total amount requested for refund. */
|
|
5134
|
+
requestedRefund?: Price;
|
|
5135
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5136
|
+
pendingRefund?: Price;
|
|
5137
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5138
|
+
refunded?: Price;
|
|
5139
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5140
|
+
failedRefundAmount?: Price;
|
|
5141
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5142
|
+
pending?: boolean;
|
|
5143
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5144
|
+
breakdown?: RefundItemsBreakdown;
|
|
5145
|
+
}
|
|
5146
|
+
interface RefundItemsBreakdown {
|
|
5237
5147
|
/**
|
|
5238
|
-
*
|
|
5148
|
+
* Refunded line items and the amount refunded for each.
|
|
5239
5149
|
* @maxSize 300
|
|
5240
5150
|
*/
|
|
5241
|
-
|
|
5242
|
-
}
|
|
5243
|
-
declare enum RestockType {
|
|
5244
|
-
NO_ITEMS = "NO_ITEMS",
|
|
5245
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
5246
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
5151
|
+
lineItems?: LineItemRefundSummary[];
|
|
5247
5152
|
}
|
|
5248
|
-
|
|
5249
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5250
|
-
interface RestockItem {
|
|
5153
|
+
interface LineItemRefundSummary {
|
|
5251
5154
|
/**
|
|
5252
|
-
* ID of the line item
|
|
5155
|
+
* ID of the refunded line item.
|
|
5253
5156
|
* @format GUID
|
|
5254
5157
|
*/
|
|
5255
5158
|
lineItemId?: string;
|
|
5256
|
-
/**
|
|
5257
|
-
|
|
5258
|
-
* @min 1
|
|
5259
|
-
* @max 100000
|
|
5260
|
-
*/
|
|
5261
|
-
quantity?: number;
|
|
5262
|
-
}
|
|
5263
|
-
interface TriggerRefundResponse {
|
|
5264
|
-
/** All order's transactions after the refunds were added */
|
|
5265
|
-
orderTransactions?: OrderTransactions;
|
|
5266
|
-
/** Created refund ID */
|
|
5267
|
-
refundId?: string | null;
|
|
5268
|
-
/** Payment ID's that the refund execution had failed for */
|
|
5269
|
-
failedPaymentIds?: ItemMetadata[];
|
|
5159
|
+
/** Total refunded amount for the line item. */
|
|
5160
|
+
totalRefundedAmount?: Price;
|
|
5270
5161
|
}
|
|
5271
|
-
|
|
5272
|
-
* A record of all payments and refunds associated with an order.
|
|
5273
|
-
*
|
|
5274
|
-
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5275
|
-
*/
|
|
5276
|
-
interface OrderTransactions {
|
|
5277
|
-
/**
|
|
5278
|
-
* Order ID.
|
|
5279
|
-
* @format GUID
|
|
5280
|
-
*/
|
|
5281
|
-
orderId?: string;
|
|
5162
|
+
interface CalculateRefundRequest {
|
|
5282
5163
|
/**
|
|
5283
|
-
*
|
|
5284
|
-
* @
|
|
5164
|
+
* Order ID
|
|
5165
|
+
* @minLength 1
|
|
5166
|
+
* @maxLength 100
|
|
5285
5167
|
*/
|
|
5286
|
-
|
|
5168
|
+
ecomOrderId?: string;
|
|
5287
5169
|
/**
|
|
5288
|
-
*
|
|
5170
|
+
* Refunded line items and quantity
|
|
5289
5171
|
* @maxSize 300
|
|
5290
5172
|
*/
|
|
5291
|
-
|
|
5173
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
5174
|
+
/** Should include shipping in refund calculation */
|
|
5175
|
+
refundShipping?: boolean;
|
|
5292
5176
|
}
|
|
5293
|
-
interface
|
|
5294
|
-
/** Regular payment details. */
|
|
5295
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
5296
|
-
/** Gift card payment details. */
|
|
5297
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5298
|
-
/** Membership payment details. */
|
|
5299
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5177
|
+
interface CalculateRefundItemRequest {
|
|
5300
5178
|
/**
|
|
5301
|
-
*
|
|
5179
|
+
* ID of the line item being refunded
|
|
5302
5180
|
* @format GUID
|
|
5303
|
-
* @readonly
|
|
5304
|
-
*/
|
|
5305
|
-
id?: string | null;
|
|
5306
|
-
/** 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. */
|
|
5307
|
-
createdDate?: Date | null;
|
|
5308
|
-
/**
|
|
5309
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5310
|
-
* @readonly
|
|
5311
|
-
*/
|
|
5312
|
-
updatedDate?: Date | null;
|
|
5313
|
-
/** Payment amount. */
|
|
5314
|
-
amount?: Price;
|
|
5315
|
-
/**
|
|
5316
|
-
* Whether refunds for this payment are disabled.
|
|
5317
|
-
* + `true`: This payment is not refundable.
|
|
5318
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5319
|
-
*/
|
|
5320
|
-
refundDisabled?: boolean;
|
|
5321
|
-
/**
|
|
5322
|
-
* Whether receipt generation is allowed for this payment.
|
|
5323
|
-
* + `true`: This payment supports receipt generation.
|
|
5324
|
-
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5325
|
-
* @readonly
|
|
5326
5181
|
*/
|
|
5327
|
-
|
|
5328
|
-
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5329
|
-
cashRounding?: CashRoundingDetails;
|
|
5182
|
+
id?: string;
|
|
5330
5183
|
/**
|
|
5331
|
-
*
|
|
5332
|
-
*
|
|
5333
|
-
*
|
|
5184
|
+
* How much of that line item is being refunded
|
|
5185
|
+
* @min 1
|
|
5186
|
+
* @max 100000
|
|
5334
5187
|
*/
|
|
5335
|
-
|
|
5188
|
+
quantity?: number;
|
|
5189
|
+
}
|
|
5190
|
+
interface CalculateRefundResponse {
|
|
5191
|
+
/** Total refundable amount */
|
|
5192
|
+
total?: Price;
|
|
5193
|
+
/** Tax cost of the order */
|
|
5194
|
+
tax?: Price;
|
|
5195
|
+
/** Discount given for this order */
|
|
5196
|
+
discount?: Price;
|
|
5197
|
+
/** Total cost of the order (without tax) */
|
|
5198
|
+
subtotal?: Price;
|
|
5199
|
+
/** Total shipping cost for order */
|
|
5200
|
+
shipping?: Price;
|
|
5201
|
+
/** Previous refund given on that order */
|
|
5202
|
+
previouslyRefundedAmount?: Price;
|
|
5336
5203
|
/**
|
|
5337
|
-
*
|
|
5338
|
-
* @
|
|
5204
|
+
* The refundable items of that order
|
|
5205
|
+
* @maxSize 300
|
|
5339
5206
|
*/
|
|
5340
|
-
|
|
5341
|
-
}
|
|
5342
|
-
/** @oneof */
|
|
5343
|
-
interface PaymentPaymentDetailsOneOf {
|
|
5344
|
-
/** Regular payment details. */
|
|
5345
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
5346
|
-
/** Gift card payment details. */
|
|
5347
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5348
|
-
/** Membership payment details. */
|
|
5349
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5350
|
-
}
|
|
5351
|
-
/** @oneof */
|
|
5352
|
-
interface PaymentReceiptInfoOneOf {
|
|
5353
|
-
}
|
|
5354
|
-
/** @oneof */
|
|
5355
|
-
interface PaymentStatusDetailsOneOf {
|
|
5207
|
+
items?: CalculateRefundItemResponse[];
|
|
5356
5208
|
}
|
|
5357
|
-
interface
|
|
5358
|
-
/** Credit card details. */
|
|
5359
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5209
|
+
interface CalculateRefundItemResponse {
|
|
5360
5210
|
/**
|
|
5361
|
-
*
|
|
5362
|
-
* @
|
|
5211
|
+
* Line item ID
|
|
5212
|
+
* @format GUID
|
|
5363
5213
|
*/
|
|
5364
|
-
|
|
5214
|
+
id?: string;
|
|
5215
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
5216
|
+
price?: Price;
|
|
5217
|
+
}
|
|
5218
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
5365
5219
|
/**
|
|
5366
|
-
*
|
|
5367
|
-
*
|
|
5220
|
+
* Wix eCommerce order ID
|
|
5221
|
+
* @minLength 1
|
|
5368
5222
|
* @maxLength 100
|
|
5369
5223
|
*/
|
|
5370
|
-
|
|
5224
|
+
ecomOrderId: string;
|
|
5371
5225
|
/**
|
|
5372
|
-
* Payment
|
|
5373
|
-
*
|
|
5374
|
-
*
|
|
5375
|
-
*
|
|
5376
|
-
* @maxLength 150
|
|
5377
|
-
* @deprecated Payment method.
|
|
5378
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5379
|
-
* Non-exhaustive list of supported values:
|
|
5380
|
-
* + `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`
|
|
5381
|
-
* @replacedBy payment_method_name
|
|
5382
|
-
* @targetRemovalDate 2026-07-01
|
|
5226
|
+
* Payment IDs
|
|
5227
|
+
* @minSize 1
|
|
5228
|
+
* @maxSize 100
|
|
5229
|
+
* @format GUID
|
|
5383
5230
|
*/
|
|
5384
|
-
|
|
5231
|
+
paymentIds: string[];
|
|
5232
|
+
}
|
|
5233
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
5234
|
+
/** All order's transactions after the void was triggered */
|
|
5235
|
+
orderTransactions?: OrderTransactions;
|
|
5236
|
+
}
|
|
5237
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
5385
5238
|
/**
|
|
5386
|
-
*
|
|
5239
|
+
* Wix eCommerce order ID
|
|
5240
|
+
* @minLength 1
|
|
5387
5241
|
* @maxLength 100
|
|
5388
5242
|
*/
|
|
5389
|
-
|
|
5390
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5391
|
-
offlinePayment?: boolean;
|
|
5243
|
+
ecomOrderId: string;
|
|
5392
5244
|
/**
|
|
5393
|
-
*
|
|
5394
|
-
* @
|
|
5395
|
-
* @
|
|
5396
|
-
* @targetRemovalDate 2026-11-01
|
|
5245
|
+
* Capture payments information
|
|
5246
|
+
* @minSize 1
|
|
5247
|
+
* @maxSize 100
|
|
5397
5248
|
*/
|
|
5398
|
-
|
|
5399
|
-
|
|
5400
|
-
|
|
5401
|
-
/** Authorization details. */
|
|
5402
|
-
authorizationDetails?: AuthorizationDetails;
|
|
5249
|
+
payments: PaymentCapture[];
|
|
5250
|
+
}
|
|
5251
|
+
interface PaymentCapture {
|
|
5403
5252
|
/**
|
|
5404
|
-
*
|
|
5405
|
-
* @
|
|
5253
|
+
* Payment ID
|
|
5254
|
+
* @format GUID
|
|
5406
5255
|
*/
|
|
5407
|
-
|
|
5408
|
-
/** Platform fee amount associated with this payment. */
|
|
5409
|
-
platformFee?: Price;
|
|
5256
|
+
paymentId?: string | null;
|
|
5410
5257
|
/**
|
|
5411
|
-
*
|
|
5412
|
-
*
|
|
5413
|
-
* + `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`
|
|
5258
|
+
* Capture amount.
|
|
5259
|
+
* If not provided - full authorized amount will be captured.
|
|
5414
5260
|
*/
|
|
5415
|
-
|
|
5416
|
-
}
|
|
5417
|
-
/** @oneof */
|
|
5418
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5419
|
-
/** Credit card details. */
|
|
5420
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5261
|
+
amount?: Price;
|
|
5421
5262
|
}
|
|
5422
|
-
|
|
5423
|
-
|
|
5424
|
-
|
|
5425
|
-
PENDING = "PENDING",
|
|
5426
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5427
|
-
CANCELED = "CANCELED",
|
|
5428
|
-
DECLINED = "DECLINED",
|
|
5429
|
-
REFUNDED = "REFUNDED",
|
|
5430
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5431
|
-
AUTHORIZED = "AUTHORIZED",
|
|
5432
|
-
VOIDED = "VOIDED"
|
|
5263
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
5264
|
+
/** All order's transactions after the capture was triggered */
|
|
5265
|
+
orderTransactions?: OrderTransactions;
|
|
5433
5266
|
}
|
|
5434
|
-
|
|
5435
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5436
|
-
interface CreditCardPaymentMethodDetails {
|
|
5437
|
-
/**
|
|
5438
|
-
* The last 4 digits of the card number.
|
|
5439
|
-
* @maxLength 4
|
|
5440
|
-
*/
|
|
5441
|
-
lastFourDigits?: string | null;
|
|
5267
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
5442
5268
|
/**
|
|
5443
|
-
*
|
|
5269
|
+
* Ecom Order ID.
|
|
5270
|
+
* @minLength 1
|
|
5444
5271
|
* @maxLength 100
|
|
5445
5272
|
*/
|
|
5446
|
-
|
|
5273
|
+
ecomOrderId?: string;
|
|
5274
|
+
/** Amount to be charged */
|
|
5275
|
+
amount?: Price;
|
|
5447
5276
|
}
|
|
5448
|
-
interface
|
|
5449
|
-
/**
|
|
5450
|
-
|
|
5451
|
-
|
|
5452
|
-
|
|
5453
|
-
|
|
5454
|
-
|
|
5455
|
-
|
|
5277
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
5278
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
5279
|
+
paymentGatewayOrderId?: string;
|
|
5280
|
+
}
|
|
5281
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
5282
|
+
/** @format GUID */
|
|
5283
|
+
orderId?: string;
|
|
5284
|
+
}
|
|
5285
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
5286
|
+
}
|
|
5287
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
5456
5288
|
/**
|
|
5457
|
-
*
|
|
5458
|
-
*
|
|
5459
|
-
* @maxSize 1
|
|
5289
|
+
* @minLength 1
|
|
5290
|
+
* @maxLength 100
|
|
5460
5291
|
*/
|
|
5461
|
-
|
|
5462
|
-
/** Void associated with payment */
|
|
5463
|
-
void?: AuthorizationVoid;
|
|
5464
|
-
/** Scheduled action for this transaction */
|
|
5465
|
-
scheduledAction?: V1ScheduledAction;
|
|
5292
|
+
orderId?: string;
|
|
5466
5293
|
}
|
|
5467
|
-
interface
|
|
5294
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
5295
|
+
}
|
|
5296
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
5468
5297
|
/**
|
|
5469
|
-
*
|
|
5470
|
-
* @
|
|
5471
|
-
* @readonly
|
|
5298
|
+
* @minLength 1
|
|
5299
|
+
* @maxLength 100
|
|
5472
5300
|
*/
|
|
5473
|
-
|
|
5474
|
-
|
|
5475
|
-
|
|
5301
|
+
orderId?: string;
|
|
5302
|
+
}
|
|
5303
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
5304
|
+
}
|
|
5305
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
5476
5306
|
/**
|
|
5477
|
-
*
|
|
5478
|
-
* @
|
|
5307
|
+
* IDs of orders to send pickup emails for.
|
|
5308
|
+
* @minSize 1
|
|
5309
|
+
* @maxSize 300
|
|
5479
5310
|
*/
|
|
5480
|
-
|
|
5481
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5482
|
-
createdDate?: Date | null;
|
|
5483
|
-
/** In case of status is FAILED may contain failure details */
|
|
5484
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
5311
|
+
orderIds?: string[];
|
|
5485
5312
|
}
|
|
5486
|
-
|
|
5487
|
-
/** Capture operation still in progress. */
|
|
5488
|
-
PENDING = "PENDING",
|
|
5489
|
-
/** Capture operation succeeded. */
|
|
5490
|
-
SUCCEEDED = "SUCCEEDED",
|
|
5491
|
-
/** Capture operation failed. */
|
|
5492
|
-
FAILED = "FAILED"
|
|
5313
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
5493
5314
|
}
|
|
5494
|
-
|
|
5495
|
-
|
|
5496
|
-
|
|
5497
|
-
|
|
5498
|
-
|
|
5315
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
5316
|
+
/**
|
|
5317
|
+
* @minLength 1
|
|
5318
|
+
* @maxLength 100
|
|
5319
|
+
*/
|
|
5320
|
+
orderId?: string;
|
|
5499
5321
|
}
|
|
5500
|
-
interface
|
|
5501
|
-
/** Status of this void action */
|
|
5502
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
5503
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5504
|
-
voidedDate?: Date | null;
|
|
5505
|
-
/** In case of status is FAILED may contain failure details */
|
|
5506
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
5507
|
-
/** Reason of void action */
|
|
5508
|
-
reason?: ReasonWithLiterals;
|
|
5322
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
5509
5323
|
}
|
|
5510
|
-
|
|
5511
|
-
/**
|
|
5512
|
-
|
|
5513
|
-
|
|
5514
|
-
|
|
5515
|
-
|
|
5516
|
-
|
|
5324
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
5325
|
+
/**
|
|
5326
|
+
* IDs of orders to send pickup emails for.
|
|
5327
|
+
* @minSize 1
|
|
5328
|
+
* @maxSize 300
|
|
5329
|
+
*/
|
|
5330
|
+
orderIds?: string[];
|
|
5517
5331
|
}
|
|
5518
|
-
|
|
5519
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5520
|
-
/** Reason the authorization was voided. */
|
|
5521
|
-
declare enum Reason {
|
|
5522
|
-
/** Authorization was voided by user. */
|
|
5523
|
-
MANUAL = "MANUAL",
|
|
5524
|
-
/** Authorization passed execution date. */
|
|
5525
|
-
SCHEDULED = "SCHEDULED"
|
|
5332
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
5526
5333
|
}
|
|
5527
|
-
|
|
5528
|
-
|
|
5529
|
-
|
|
5530
|
-
|
|
5531
|
-
|
|
5532
|
-
|
|
5533
|
-
executionDate?: Date | null;
|
|
5334
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
5335
|
+
/**
|
|
5336
|
+
* @minLength 1
|
|
5337
|
+
* @maxLength 100
|
|
5338
|
+
*/
|
|
5339
|
+
orderId?: string;
|
|
5534
5340
|
}
|
|
5535
|
-
|
|
5536
|
-
VOID = "VOID",
|
|
5537
|
-
CAPTURE = "CAPTURE"
|
|
5341
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
5538
5342
|
}
|
|
5539
|
-
|
|
5540
|
-
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5541
|
-
interface Chargeback {
|
|
5343
|
+
interface SendCancelRefundEmailRequest {
|
|
5542
5344
|
/**
|
|
5543
|
-
*
|
|
5544
|
-
* @
|
|
5545
|
-
* @
|
|
5546
|
-
* @immutable
|
|
5345
|
+
* The ID of order that is canceled/refunded
|
|
5346
|
+
* @minLength 1
|
|
5347
|
+
* @maxLength 100
|
|
5547
5348
|
*/
|
|
5548
|
-
|
|
5349
|
+
orderId?: string;
|
|
5549
5350
|
/**
|
|
5550
|
-
*
|
|
5551
|
-
* @
|
|
5552
|
-
* @
|
|
5351
|
+
* Personal note added to the email (optional)
|
|
5352
|
+
* @minLength 1
|
|
5353
|
+
* @maxLength 1000
|
|
5553
5354
|
*/
|
|
5554
|
-
|
|
5355
|
+
customMessage?: string | null;
|
|
5356
|
+
/** Refund amount */
|
|
5357
|
+
refundAmount?: Price;
|
|
5555
5358
|
/**
|
|
5556
|
-
*
|
|
5557
|
-
* @
|
|
5359
|
+
* Refund ID. (Optional)
|
|
5360
|
+
* @format GUID
|
|
5558
5361
|
*/
|
|
5559
|
-
|
|
5362
|
+
refundId?: string | null;
|
|
5363
|
+
}
|
|
5364
|
+
interface SendCancelRefundEmailResponse {
|
|
5365
|
+
}
|
|
5366
|
+
interface SendRefundEmailRequest {
|
|
5560
5367
|
/**
|
|
5561
|
-
*
|
|
5562
|
-
* @
|
|
5563
|
-
* @immutable
|
|
5368
|
+
* The ID of order that is refunded
|
|
5369
|
+
* @format GUID
|
|
5564
5370
|
*/
|
|
5565
|
-
|
|
5371
|
+
orderId?: string;
|
|
5566
5372
|
/**
|
|
5567
|
-
*
|
|
5568
|
-
* @
|
|
5373
|
+
* Refund ID
|
|
5374
|
+
* @format GUID
|
|
5569
5375
|
*/
|
|
5570
|
-
|
|
5376
|
+
refundId?: string;
|
|
5571
5377
|
/**
|
|
5572
|
-
*
|
|
5573
|
-
*
|
|
5574
|
-
*
|
|
5378
|
+
* Personal note added to the email (optional)
|
|
5379
|
+
* @minLength 1
|
|
5380
|
+
* @maxLength 1000
|
|
5575
5381
|
*/
|
|
5576
|
-
|
|
5382
|
+
customMessage?: string | null;
|
|
5383
|
+
}
|
|
5384
|
+
interface SendRefundEmailResponse {
|
|
5385
|
+
}
|
|
5386
|
+
interface SendFulfillmentEmailRequest {
|
|
5387
|
+
/** @format GUID */
|
|
5388
|
+
orderId?: string;
|
|
5389
|
+
/** @format GUID */
|
|
5390
|
+
fulfillerId?: string;
|
|
5391
|
+
}
|
|
5392
|
+
interface SendFulfillmentEmailResponse {
|
|
5393
|
+
}
|
|
5394
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
5577
5395
|
/**
|
|
5578
|
-
*
|
|
5579
|
-
* @
|
|
5580
|
-
* @readonly
|
|
5581
|
-
* @immutable
|
|
5396
|
+
* @minLength 1
|
|
5397
|
+
* @maxLength 100
|
|
5582
5398
|
*/
|
|
5583
|
-
|
|
5399
|
+
orderId?: string;
|
|
5584
5400
|
}
|
|
5585
|
-
|
|
5586
|
-
|
|
5587
|
-
|
|
5588
|
-
|
|
5589
|
-
|
|
5401
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
5402
|
+
}
|
|
5403
|
+
interface PreviewEmailByTypeRequest {
|
|
5404
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
5405
|
+
}
|
|
5406
|
+
declare enum PreviewEmailType {
|
|
5407
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
5408
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
5409
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
5410
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
5590
5411
|
}
|
|
5591
5412
|
/** @enumType */
|
|
5592
|
-
type
|
|
5593
|
-
interface
|
|
5413
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
5414
|
+
interface PreviewEmailByTypeResponse {
|
|
5415
|
+
emailPreview?: string;
|
|
5416
|
+
}
|
|
5417
|
+
interface PreviewRefundEmailRequest {
|
|
5594
5418
|
/**
|
|
5595
|
-
*
|
|
5596
|
-
* @maxLength
|
|
5419
|
+
* @minLength 1
|
|
5420
|
+
* @maxLength 100
|
|
5597
5421
|
*/
|
|
5598
|
-
|
|
5422
|
+
orderId?: string;
|
|
5423
|
+
/** Refund amount */
|
|
5424
|
+
refundAmount?: Price;
|
|
5425
|
+
/** Refund business details */
|
|
5426
|
+
details?: RefundDetails;
|
|
5599
5427
|
/**
|
|
5600
|
-
*
|
|
5601
|
-
* @
|
|
5428
|
+
* Personal note added to the email (optional)
|
|
5429
|
+
* @minLength 1
|
|
5430
|
+
* @maxLength 1000
|
|
5602
5431
|
*/
|
|
5603
|
-
|
|
5432
|
+
customMessage?: string | null;
|
|
5604
5433
|
/**
|
|
5605
|
-
*
|
|
5606
|
-
*
|
|
5607
|
-
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5434
|
+
* Refund ID. (Optional)
|
|
5435
|
+
* @format GUID
|
|
5608
5436
|
*/
|
|
5609
|
-
|
|
5437
|
+
refundId?: string | null;
|
|
5610
5438
|
}
|
|
5611
|
-
interface
|
|
5439
|
+
interface PreviewRefundEmailResponse {
|
|
5440
|
+
emailPreview?: string;
|
|
5441
|
+
}
|
|
5442
|
+
interface PreviewCancelEmailRequest {
|
|
5612
5443
|
/**
|
|
5613
|
-
*
|
|
5444
|
+
* @minLength 1
|
|
5614
5445
|
* @maxLength 100
|
|
5615
5446
|
*/
|
|
5616
|
-
|
|
5447
|
+
orderId?: string;
|
|
5617
5448
|
/**
|
|
5618
|
-
*
|
|
5619
|
-
* @
|
|
5449
|
+
* Personal note added to the email (optional)
|
|
5450
|
+
* @minLength 1
|
|
5451
|
+
* @maxLength 1000
|
|
5620
5452
|
*/
|
|
5621
|
-
|
|
5453
|
+
customMessage?: string | null;
|
|
5454
|
+
}
|
|
5455
|
+
interface PreviewCancelEmailResponse {
|
|
5456
|
+
emailPreview?: string;
|
|
5457
|
+
}
|
|
5458
|
+
interface PreviewCancelRefundEmailRequest {
|
|
5622
5459
|
/**
|
|
5623
|
-
*
|
|
5624
|
-
* @
|
|
5625
|
-
* @deprecated Whether the gift card is voided.
|
|
5626
|
-
* @replacedBy payment.status
|
|
5627
|
-
* @targetRemovalDate 2026-11-01
|
|
5460
|
+
* @minLength 1
|
|
5461
|
+
* @maxLength 100
|
|
5628
5462
|
*/
|
|
5629
|
-
|
|
5463
|
+
orderId?: string;
|
|
5630
5464
|
/**
|
|
5631
|
-
*
|
|
5632
|
-
* @
|
|
5633
|
-
* @
|
|
5465
|
+
* Personal note added to the email (optional)
|
|
5466
|
+
* @minLength 1
|
|
5467
|
+
* @maxLength 1000
|
|
5634
5468
|
*/
|
|
5635
|
-
|
|
5469
|
+
customMessage?: string | null;
|
|
5470
|
+
/** Refund amount */
|
|
5471
|
+
refundAmount?: Price;
|
|
5472
|
+
/**
|
|
5473
|
+
* Refund ID. (Optional)
|
|
5474
|
+
* @format GUID
|
|
5475
|
+
*/
|
|
5476
|
+
refundId?: string | null;
|
|
5636
5477
|
}
|
|
5637
|
-
interface
|
|
5478
|
+
interface PreviewCancelRefundEmailResponse {
|
|
5479
|
+
emailPreview?: string;
|
|
5480
|
+
}
|
|
5481
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
5482
|
+
}
|
|
5483
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
5484
|
+
emailPreview?: string;
|
|
5485
|
+
}
|
|
5486
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
5487
|
+
}
|
|
5488
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
5489
|
+
emailPreview?: string;
|
|
5490
|
+
}
|
|
5491
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
5492
|
+
}
|
|
5493
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
5494
|
+
emailPreview?: string;
|
|
5495
|
+
}
|
|
5496
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
5497
|
+
}
|
|
5498
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
5499
|
+
emailPreview?: string;
|
|
5500
|
+
}
|
|
5501
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
5502
|
+
}
|
|
5503
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
5504
|
+
emailPreview?: string;
|
|
5505
|
+
}
|
|
5506
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
5507
|
+
/** Emitted on a meta site creation. */
|
|
5508
|
+
siteCreated?: SiteCreated;
|
|
5509
|
+
/** Emitted on a meta site transfer completion. */
|
|
5510
|
+
siteTransferred?: SiteTransferred;
|
|
5511
|
+
/** Emitted on a meta site deletion. */
|
|
5512
|
+
siteDeleted?: SiteDeleted;
|
|
5513
|
+
/** Emitted on a meta site restoration. */
|
|
5514
|
+
siteUndeleted?: SiteUndeleted;
|
|
5515
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5516
|
+
sitePublished?: SitePublished;
|
|
5517
|
+
/** Emitted on a meta site unpublish. */
|
|
5518
|
+
siteUnpublished?: SiteUnpublished;
|
|
5519
|
+
/** Emitted when meta site is marked as template. */
|
|
5520
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5521
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
5522
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5523
|
+
/** Emitted when an application is provisioned (installed). */
|
|
5524
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
5525
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
5526
|
+
serviceRemoved?: ServiceRemoved;
|
|
5527
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
5528
|
+
siteRenamedPayload?: SiteRenamed;
|
|
5529
|
+
/** Emitted when meta site was permanently deleted. */
|
|
5530
|
+
hardDeleted?: SiteHardDeleted;
|
|
5531
|
+
/** Emitted on a namespace change. */
|
|
5532
|
+
namespaceChanged?: NamespaceChanged;
|
|
5533
|
+
/** Emitted when Studio is attached. */
|
|
5534
|
+
studioAssigned?: StudioAssigned;
|
|
5535
|
+
/** Emitted when Studio is detached. */
|
|
5536
|
+
studioUnassigned?: StudioUnassigned;
|
|
5638
5537
|
/**
|
|
5639
|
-
*
|
|
5640
|
-
*
|
|
5538
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5539
|
+
* the actual URL.
|
|
5540
|
+
*
|
|
5541
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5542
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5641
5543
|
*/
|
|
5642
|
-
|
|
5544
|
+
urlChanged?: SiteUrlChanged;
|
|
5545
|
+
/** Site is marked as PurgedExternally */
|
|
5546
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
5547
|
+
/** Emitted when Odeditor is attached. */
|
|
5548
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
5549
|
+
/** Emitted when Odeditor is detached. */
|
|
5550
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
5551
|
+
/** Emitted when Picasso is attached. */
|
|
5552
|
+
picassoAssigned?: PicassoAssigned;
|
|
5553
|
+
/** Emitted when Picasso is detached. */
|
|
5554
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
5555
|
+
/** Emitted when Wixel is attached. */
|
|
5556
|
+
wixelAssigned?: WixelAssigned;
|
|
5557
|
+
/** Emitted when Wixel is detached. */
|
|
5558
|
+
wixelUnassigned?: WixelUnassigned;
|
|
5559
|
+
/** Emitted when StudioTwo is attached. */
|
|
5560
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
5561
|
+
/** Emitted when StudioTwo is detached. */
|
|
5562
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5563
|
+
/** Emitted when media from user domain is enabled. */
|
|
5564
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5565
|
+
/** Emitted when media from user domain is disabled. */
|
|
5566
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5567
|
+
/** Emitted when Editorless is attached. */
|
|
5568
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
5569
|
+
/** Emitted when Editorless is detached. */
|
|
5570
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
5643
5571
|
/**
|
|
5644
|
-
*
|
|
5645
|
-
* @
|
|
5646
|
-
* @maxLength 100
|
|
5572
|
+
* A meta site id.
|
|
5573
|
+
* @format GUID
|
|
5647
5574
|
*/
|
|
5648
|
-
|
|
5575
|
+
metaSiteId?: string;
|
|
5576
|
+
/** A meta site version. Monotonically increasing. */
|
|
5577
|
+
version?: string;
|
|
5578
|
+
/** A timestamp of the event. */
|
|
5579
|
+
timestamp?: string;
|
|
5649
5580
|
/**
|
|
5650
|
-
*
|
|
5651
|
-
*
|
|
5652
|
-
* @
|
|
5653
|
-
* @targetRemovalDate 2026-11-01
|
|
5581
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
5582
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
5583
|
+
* @maxSize 4000
|
|
5654
5584
|
*/
|
|
5655
|
-
|
|
5656
|
-
|
|
5657
|
-
|
|
5585
|
+
assets?: Asset[];
|
|
5586
|
+
}
|
|
5587
|
+
/** @oneof */
|
|
5588
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
5589
|
+
/** Emitted on a meta site creation. */
|
|
5590
|
+
siteCreated?: SiteCreated;
|
|
5591
|
+
/** Emitted on a meta site transfer completion. */
|
|
5592
|
+
siteTransferred?: SiteTransferred;
|
|
5593
|
+
/** Emitted on a meta site deletion. */
|
|
5594
|
+
siteDeleted?: SiteDeleted;
|
|
5595
|
+
/** Emitted on a meta site restoration. */
|
|
5596
|
+
siteUndeleted?: SiteUndeleted;
|
|
5597
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5598
|
+
sitePublished?: SitePublished;
|
|
5599
|
+
/** Emitted on a meta site unpublish. */
|
|
5600
|
+
siteUnpublished?: SiteUnpublished;
|
|
5601
|
+
/** Emitted when meta site is marked as template. */
|
|
5602
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5603
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
5604
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5605
|
+
/** Emitted when an application is provisioned (installed). */
|
|
5606
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
5607
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
5608
|
+
serviceRemoved?: ServiceRemoved;
|
|
5609
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
5610
|
+
siteRenamedPayload?: SiteRenamed;
|
|
5611
|
+
/** Emitted when meta site was permanently deleted. */
|
|
5612
|
+
hardDeleted?: SiteHardDeleted;
|
|
5613
|
+
/** Emitted on a namespace change. */
|
|
5614
|
+
namespaceChanged?: NamespaceChanged;
|
|
5615
|
+
/** Emitted when Studio is attached. */
|
|
5616
|
+
studioAssigned?: StudioAssigned;
|
|
5617
|
+
/** Emitted when Studio is detached. */
|
|
5618
|
+
studioUnassigned?: StudioUnassigned;
|
|
5658
5619
|
/**
|
|
5659
|
-
*
|
|
5660
|
-
*
|
|
5661
|
-
*
|
|
5620
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5621
|
+
* the actual URL.
|
|
5622
|
+
*
|
|
5623
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5624
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5662
5625
|
*/
|
|
5663
|
-
|
|
5626
|
+
urlChanged?: SiteUrlChanged;
|
|
5627
|
+
/** Site is marked as PurgedExternally */
|
|
5628
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
5629
|
+
/** Emitted when Odeditor is attached. */
|
|
5630
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
5631
|
+
/** Emitted when Odeditor is detached. */
|
|
5632
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
5633
|
+
/** Emitted when Picasso is attached. */
|
|
5634
|
+
picassoAssigned?: PicassoAssigned;
|
|
5635
|
+
/** Emitted when Picasso is detached. */
|
|
5636
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
5637
|
+
/** Emitted when Wixel is attached. */
|
|
5638
|
+
wixelAssigned?: WixelAssigned;
|
|
5639
|
+
/** Emitted when Wixel is detached. */
|
|
5640
|
+
wixelUnassigned?: WixelUnassigned;
|
|
5641
|
+
/** Emitted when StudioTwo is attached. */
|
|
5642
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
5643
|
+
/** Emitted when StudioTwo is detached. */
|
|
5644
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5645
|
+
/** Emitted when media from user domain is enabled. */
|
|
5646
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5647
|
+
/** Emitted when media from user domain is disabled. */
|
|
5648
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5649
|
+
/** Emitted when Editorless is attached. */
|
|
5650
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
5651
|
+
/** Emitted when Editorless is detached. */
|
|
5652
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
5653
|
+
}
|
|
5654
|
+
interface Asset {
|
|
5664
5655
|
/**
|
|
5665
|
-
*
|
|
5666
|
-
* @
|
|
5667
|
-
* @deprecated Whether the membership is voided.
|
|
5668
|
-
* @replacedBy payment.status
|
|
5669
|
-
* @targetRemovalDate 2026-11-01
|
|
5656
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
5657
|
+
* @maxLength 36
|
|
5670
5658
|
*/
|
|
5671
|
-
|
|
5659
|
+
appDefId?: string;
|
|
5672
5660
|
/**
|
|
5673
|
-
*
|
|
5674
|
-
* @
|
|
5661
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
5662
|
+
* @maxLength 200
|
|
5675
5663
|
*/
|
|
5676
|
-
|
|
5677
|
-
/**
|
|
5678
|
-
|
|
5664
|
+
instanceId?: string;
|
|
5665
|
+
/** An application state. */
|
|
5666
|
+
state?: StateWithLiterals;
|
|
5679
5667
|
}
|
|
5680
|
-
declare enum
|
|
5681
|
-
|
|
5682
|
-
|
|
5683
|
-
|
|
5684
|
-
|
|
5685
|
-
|
|
5686
|
-
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5687
|
-
/** Payment was voided. */
|
|
5688
|
-
VOIDED = "VOIDED"
|
|
5668
|
+
declare enum State {
|
|
5669
|
+
UNKNOWN = "UNKNOWN",
|
|
5670
|
+
ENABLED = "ENABLED",
|
|
5671
|
+
DISABLED = "DISABLED",
|
|
5672
|
+
PENDING = "PENDING",
|
|
5673
|
+
DEMO = "DEMO"
|
|
5689
5674
|
}
|
|
5690
5675
|
/** @enumType */
|
|
5691
|
-
type
|
|
5692
|
-
interface
|
|
5676
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
5677
|
+
interface SiteCreated {
|
|
5693
5678
|
/**
|
|
5694
|
-
*
|
|
5695
|
-
* @
|
|
5679
|
+
* A template identifier (empty if not created from a template).
|
|
5680
|
+
* @maxLength 36
|
|
5696
5681
|
*/
|
|
5697
|
-
|
|
5682
|
+
originTemplateId?: string;
|
|
5698
5683
|
/**
|
|
5699
|
-
*
|
|
5700
|
-
* @
|
|
5684
|
+
* An account id of the owner.
|
|
5685
|
+
* @format GUID
|
|
5701
5686
|
*/
|
|
5702
|
-
|
|
5703
|
-
|
|
5704
|
-
|
|
5687
|
+
ownerId?: string;
|
|
5688
|
+
/** A context in which meta site was created. */
|
|
5689
|
+
context?: SiteCreatedContextWithLiterals;
|
|
5705
5690
|
/**
|
|
5706
|
-
*
|
|
5691
|
+
* A meta site id from which this site was created.
|
|
5692
|
+
*
|
|
5693
|
+
* In case of a creation from a template it's a template id.
|
|
5694
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5707
5695
|
* @format GUID
|
|
5708
5696
|
*/
|
|
5709
|
-
|
|
5697
|
+
originMetaSiteId?: string | null;
|
|
5710
5698
|
/**
|
|
5711
|
-
*
|
|
5712
|
-
* @
|
|
5713
|
-
* @maxLength 40
|
|
5699
|
+
* A meta site name (URL slug).
|
|
5700
|
+
* @maxLength 20
|
|
5714
5701
|
*/
|
|
5715
|
-
|
|
5702
|
+
siteName?: string;
|
|
5703
|
+
/** A namespace. */
|
|
5704
|
+
namespace?: NamespaceWithLiterals;
|
|
5716
5705
|
}
|
|
5717
|
-
|
|
5706
|
+
declare enum SiteCreatedContext {
|
|
5707
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
5708
|
+
OTHER = "OTHER",
|
|
5709
|
+
/** A meta site was created from template. */
|
|
5710
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
5711
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
5712
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
5713
|
+
/** A copy of existing meta site. */
|
|
5714
|
+
DUPLICATE = "DUPLICATE",
|
|
5715
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
5716
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
5717
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
5718
|
+
FLASH = "FLASH"
|
|
5719
|
+
}
|
|
5720
|
+
/** @enumType */
|
|
5721
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
5722
|
+
declare enum Namespace {
|
|
5723
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5724
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5725
|
+
WIX = "WIX",
|
|
5726
|
+
/** 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. */
|
|
5727
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
5728
|
+
/** 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. */
|
|
5729
|
+
ALBUMS = "ALBUMS",
|
|
5730
|
+
/** 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. */
|
|
5731
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5732
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5733
|
+
HOTELS = "HOTELS",
|
|
5734
|
+
/** 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. */
|
|
5735
|
+
CLUBS = "CLUBS",
|
|
5736
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5737
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5718
5738
|
/**
|
|
5719
|
-
*
|
|
5720
|
-
*
|
|
5739
|
+
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5740
|
+
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
5721
5741
|
*/
|
|
5722
|
-
|
|
5742
|
+
DEV_SITE = "DEV_SITE",
|
|
5743
|
+
/** 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. */
|
|
5744
|
+
LOGOS = "LOGOS",
|
|
5745
|
+
/** 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. */
|
|
5746
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5747
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5748
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5749
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5750
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5723
5751
|
/**
|
|
5724
|
-
*
|
|
5725
|
-
*
|
|
5752
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
5753
|
+
*
|
|
5754
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5726
5755
|
*/
|
|
5727
|
-
|
|
5756
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
5728
5757
|
/**
|
|
5729
|
-
*
|
|
5730
|
-
*
|
|
5731
|
-
*
|
|
5758
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
5759
|
+
* Will be accessible from Site List and will not have a website app.
|
|
5760
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
5732
5761
|
*/
|
|
5733
|
-
|
|
5734
|
-
|
|
5735
|
-
|
|
5762
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
5763
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
5764
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
5765
|
+
/** It is to be used in the Business First efforts. */
|
|
5766
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5767
|
+
/** Bookings business flow with no site. */
|
|
5768
|
+
ANYWHERE = "ANYWHERE",
|
|
5769
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
5770
|
+
HEADLESS = "HEADLESS",
|
|
5736
5771
|
/**
|
|
5737
|
-
*
|
|
5738
|
-
*
|
|
5739
|
-
* to prevent false overpayment or underpayment due to rounding.
|
|
5772
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
5773
|
+
* The site will be used for account level CSM feature for enterprise
|
|
5740
5774
|
*/
|
|
5741
|
-
|
|
5775
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
5776
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
5777
|
+
RISE = "RISE",
|
|
5742
5778
|
/**
|
|
5743
|
-
*
|
|
5744
|
-
*
|
|
5745
|
-
*
|
|
5779
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
5780
|
+
* There's a blank site behind the scene but it's blank).
|
|
5781
|
+
* The Mobile company will be the owner of this namespace.
|
|
5746
5782
|
*/
|
|
5747
|
-
|
|
5748
|
-
|
|
5749
|
-
|
|
5750
|
-
/** Payment was charged successfully. */
|
|
5751
|
-
APPROVED = "APPROVED",
|
|
5752
|
-
/** Payment is being processed and hasn't been confirmed yet. */
|
|
5753
|
-
PENDING = "PENDING",
|
|
5754
|
-
/** 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. */
|
|
5755
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5756
|
-
/** Payment was canceled before it was charged. */
|
|
5757
|
-
CANCELED = "CANCELED",
|
|
5758
|
-
/** Payment was declined by the payment provider. */
|
|
5759
|
-
DECLINED = "DECLINED",
|
|
5760
|
-
/** Payment was fully refunded. */
|
|
5761
|
-
REFUNDED = "REFUNDED",
|
|
5762
|
-
/** Part of the payment amount was refunded. */
|
|
5763
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5764
|
-
/** 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. */
|
|
5765
|
-
AUTHORIZED = "AUTHORIZED",
|
|
5783
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
5784
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
5785
|
+
NOWNIA = "NOWNIA",
|
|
5766
5786
|
/**
|
|
5767
|
-
*
|
|
5768
|
-
*
|
|
5769
|
-
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
5787
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
5788
|
+
* The Partners company owns this namespace.
|
|
5770
5789
|
*/
|
|
5771
|
-
|
|
5772
|
-
|
|
5773
|
-
|
|
5774
|
-
|
|
5775
|
-
|
|
5776
|
-
reason?: CanceledReasonWithLiterals;
|
|
5777
|
-
}
|
|
5778
|
-
declare enum CanceledReason {
|
|
5779
|
-
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
5780
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
5781
|
-
/** Payment was not completed by user and expired. */
|
|
5782
|
-
EXPIRED = "EXPIRED"
|
|
5783
|
-
}
|
|
5784
|
-
/** @enumType */
|
|
5785
|
-
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
5786
|
-
interface DeclinedStatusDetails {
|
|
5787
|
-
reason?: DeclinedReasonWithLiterals;
|
|
5788
|
-
}
|
|
5789
|
-
declare enum DeclinedReason {
|
|
5790
|
-
/** Corresponding charge failed. */
|
|
5791
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5792
|
-
/** Payment details expired. */
|
|
5793
|
-
EXPIRED = "EXPIRED",
|
|
5794
|
-
/** Insufficient funds. */
|
|
5795
|
-
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
5796
|
-
/** Gift card was disabled before charge was attempted. */
|
|
5797
|
-
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
5798
|
-
}
|
|
5799
|
-
/** @enumType */
|
|
5800
|
-
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
5801
|
-
interface VoidedStatusDetails {
|
|
5802
|
-
reason?: VoidedReasonWithLiterals;
|
|
5803
|
-
}
|
|
5804
|
-
declare enum VoidedReason {
|
|
5805
|
-
/** Payment was voided by merchant request. */
|
|
5806
|
-
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
5807
|
-
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
5808
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
5809
|
-
}
|
|
5810
|
-
/** @enumType */
|
|
5811
|
-
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
5812
|
-
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
5813
|
-
}
|
|
5814
|
-
/** @oneof */
|
|
5815
|
-
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
5816
|
-
}
|
|
5817
|
-
interface Refund {
|
|
5790
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
5791
|
+
/** Codux Headless Sites */
|
|
5792
|
+
CODUX = "CODUX",
|
|
5793
|
+
/** Bobb - AI Design Creator. */
|
|
5794
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
5818
5795
|
/**
|
|
5819
|
-
*
|
|
5820
|
-
*
|
|
5821
|
-
* @readonly
|
|
5796
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
5797
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
5822
5798
|
*/
|
|
5823
|
-
|
|
5799
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
5800
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5801
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
5802
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5803
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
5804
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
5805
|
+
MIMIR = "MIMIR",
|
|
5806
|
+
/** Wix Twins platform. */
|
|
5807
|
+
TWINS = "TWINS",
|
|
5808
|
+
/** Wix Nano. */
|
|
5809
|
+
NANO = "NANO",
|
|
5810
|
+
/** Base44 headless sites. */
|
|
5811
|
+
BASE44 = "BASE44",
|
|
5812
|
+
/** Wix Channels Sites */
|
|
5813
|
+
CHANNELS = "CHANNELS",
|
|
5814
|
+
/** Nautilus platform. */
|
|
5815
|
+
NAUTILUS = "NAUTILUS",
|
|
5824
5816
|
/**
|
|
5825
|
-
*
|
|
5826
|
-
*
|
|
5817
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
5818
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
5827
5819
|
*/
|
|
5828
|
-
|
|
5829
|
-
/**
|
|
5830
|
-
|
|
5820
|
+
SYMPHONY = "SYMPHONY",
|
|
5821
|
+
/** Nautilus platform app. */
|
|
5822
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
5831
5823
|
/**
|
|
5832
|
-
*
|
|
5833
|
-
*
|
|
5834
|
-
* @immutable
|
|
5824
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
5825
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
5835
5826
|
*/
|
|
5836
|
-
|
|
5827
|
+
VIBU = "VIBU",
|
|
5837
5828
|
/**
|
|
5838
|
-
*
|
|
5839
|
-
*
|
|
5829
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
5830
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
5831
|
+
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
5832
|
+
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5840
5833
|
*/
|
|
5841
|
-
|
|
5834
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
|
|
5842
5835
|
/**
|
|
5843
|
-
*
|
|
5844
|
-
*
|
|
5845
|
-
* @readonly
|
|
5846
|
-
* @immutable
|
|
5836
|
+
* Dev-center development sites (com.wixpress.devcenter.dsm).
|
|
5837
|
+
* DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
|
|
5847
5838
|
*/
|
|
5848
|
-
|
|
5839
|
+
DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
|
|
5849
5840
|
}
|
|
5850
|
-
|
|
5841
|
+
/** @enumType */
|
|
5842
|
+
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';
|
|
5843
|
+
/** Site transferred to another user. */
|
|
5844
|
+
interface SiteTransferred {
|
|
5851
5845
|
/**
|
|
5852
|
-
*
|
|
5846
|
+
* A previous owner id (user that transfers meta site).
|
|
5853
5847
|
* @format GUID
|
|
5854
|
-
* @immutable
|
|
5855
5848
|
*/
|
|
5856
|
-
|
|
5849
|
+
oldOwnerId?: string;
|
|
5857
5850
|
/**
|
|
5858
|
-
*
|
|
5859
|
-
* @
|
|
5851
|
+
* A new owner id (user that accepts meta site).
|
|
5852
|
+
* @format GUID
|
|
5860
5853
|
*/
|
|
5861
|
-
|
|
5862
|
-
|
|
5863
|
-
|
|
5864
|
-
|
|
5865
|
-
|
|
5854
|
+
newOwnerId?: string;
|
|
5855
|
+
}
|
|
5856
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
5857
|
+
interface SiteDeleted {
|
|
5858
|
+
/** A deletion context. */
|
|
5859
|
+
deleteContext?: DeleteContext;
|
|
5860
|
+
}
|
|
5861
|
+
interface DeleteContext {
|
|
5862
|
+
/** When the meta site was deleted. */
|
|
5863
|
+
dateDeleted?: Date | null;
|
|
5864
|
+
/** A status. */
|
|
5865
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
5866
5866
|
/**
|
|
5867
|
-
*
|
|
5868
|
-
*
|
|
5869
|
-
* @format GUID
|
|
5867
|
+
* A reason (flow).
|
|
5868
|
+
* @maxLength 255
|
|
5870
5869
|
*/
|
|
5871
|
-
|
|
5872
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5873
|
-
providerRefundId?: string | null;
|
|
5870
|
+
deleteOrigin?: string;
|
|
5874
5871
|
/**
|
|
5875
|
-
*
|
|
5876
|
-
* @
|
|
5872
|
+
* A service that deleted it.
|
|
5873
|
+
* @maxLength 255
|
|
5877
5874
|
*/
|
|
5878
|
-
|
|
5875
|
+
initiatorId?: string | null;
|
|
5879
5876
|
}
|
|
5880
|
-
|
|
5881
|
-
|
|
5882
|
-
|
|
5883
|
-
|
|
5884
|
-
|
|
5885
|
-
|
|
5886
|
-
/** Refund transaction failed. */
|
|
5887
|
-
FAILED = "FAILED",
|
|
5888
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
5889
|
-
SCHEDULED = "SCHEDULED",
|
|
5890
|
-
/** Refund was initiated on payment provider side. */
|
|
5891
|
-
STARTED = "STARTED"
|
|
5877
|
+
declare enum DeleteStatus {
|
|
5878
|
+
UNKNOWN = "UNKNOWN",
|
|
5879
|
+
TRASH = "TRASH",
|
|
5880
|
+
DELETED = "DELETED",
|
|
5881
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
5882
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
5892
5883
|
}
|
|
5893
5884
|
/** @enumType */
|
|
5894
|
-
type
|
|
5895
|
-
|
|
5896
|
-
|
|
5897
|
-
|
|
5898
|
-
|
|
5899
|
-
|
|
5900
|
-
|
|
5901
|
-
|
|
5902
|
-
*/
|
|
5903
|
-
paymentGatewayReasonCode?: string | null;
|
|
5885
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
5886
|
+
/** Restoration of the meta site. */
|
|
5887
|
+
interface SiteUndeleted {
|
|
5888
|
+
}
|
|
5889
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5890
|
+
interface SitePublished {
|
|
5891
|
+
}
|
|
5892
|
+
interface SiteUnpublished {
|
|
5904
5893
|
/**
|
|
5905
|
-
*
|
|
5906
|
-
* @
|
|
5907
|
-
* @
|
|
5894
|
+
* A list of URLs previously associated with the meta site.
|
|
5895
|
+
* @maxLength 4000
|
|
5896
|
+
* @maxSize 10000
|
|
5908
5897
|
*/
|
|
5909
|
-
|
|
5898
|
+
urls?: string[];
|
|
5910
5899
|
}
|
|
5911
|
-
interface
|
|
5912
|
-
/** Total amount requested for refund. */
|
|
5913
|
-
requestedRefund?: Price;
|
|
5914
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5915
|
-
pendingRefund?: Price;
|
|
5916
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5917
|
-
refunded?: Price;
|
|
5918
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5919
|
-
failedRefundAmount?: Price;
|
|
5920
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5921
|
-
pending?: boolean;
|
|
5922
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5923
|
-
breakdown?: RefundItemsBreakdown;
|
|
5900
|
+
interface SiteMarkedAsTemplate {
|
|
5924
5901
|
}
|
|
5925
|
-
interface
|
|
5902
|
+
interface SiteMarkedAsWixSite {
|
|
5903
|
+
}
|
|
5904
|
+
/**
|
|
5905
|
+
* Represents a service provisioned a site.
|
|
5906
|
+
*
|
|
5907
|
+
* Note on `origin_instance_id`:
|
|
5908
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
5909
|
+
* This is because of the following scenario:
|
|
5910
|
+
*
|
|
5911
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
5912
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
5913
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
5914
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
5915
|
+
* your site remains consistent with what you initially received and does not include any
|
|
5916
|
+
* changes made to the original template afterward.
|
|
5917
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
5918
|
+
*/
|
|
5919
|
+
interface ServiceProvisioned {
|
|
5926
5920
|
/**
|
|
5927
|
-
*
|
|
5928
|
-
* @
|
|
5921
|
+
* Either UUID or EmbeddedServiceType.
|
|
5922
|
+
* @maxLength 36
|
|
5929
5923
|
*/
|
|
5930
|
-
|
|
5931
|
-
}
|
|
5932
|
-
interface LineItemRefundSummary {
|
|
5924
|
+
appDefId?: string;
|
|
5933
5925
|
/**
|
|
5934
|
-
*
|
|
5935
|
-
* @
|
|
5926
|
+
* Not only UUID. Something here could be something weird.
|
|
5927
|
+
* @maxLength 36
|
|
5936
5928
|
*/
|
|
5937
|
-
|
|
5938
|
-
/** Total refunded amount for the line item. */
|
|
5939
|
-
totalRefundedAmount?: Price;
|
|
5940
|
-
}
|
|
5941
|
-
interface CalculateRefundRequest {
|
|
5929
|
+
instanceId?: string;
|
|
5942
5930
|
/**
|
|
5943
|
-
*
|
|
5944
|
-
* @
|
|
5945
|
-
* @maxLength 100
|
|
5931
|
+
* An instance id from which this instance is originated.
|
|
5932
|
+
* @maxLength 36
|
|
5946
5933
|
*/
|
|
5947
|
-
|
|
5934
|
+
originInstanceId?: string;
|
|
5948
5935
|
/**
|
|
5949
|
-
*
|
|
5950
|
-
* @
|
|
5936
|
+
* A version.
|
|
5937
|
+
* @maxLength 500
|
|
5951
5938
|
*/
|
|
5952
|
-
|
|
5953
|
-
/** Should include shipping in refund calculation */
|
|
5954
|
-
refundShipping?: boolean;
|
|
5955
|
-
}
|
|
5956
|
-
interface CalculateRefundItemRequest {
|
|
5939
|
+
version?: string | null;
|
|
5957
5940
|
/**
|
|
5958
|
-
*
|
|
5941
|
+
* The origin meta site id
|
|
5959
5942
|
* @format GUID
|
|
5960
5943
|
*/
|
|
5961
|
-
|
|
5944
|
+
originMetaSiteId?: string | null;
|
|
5945
|
+
}
|
|
5946
|
+
interface ServiceRemoved {
|
|
5962
5947
|
/**
|
|
5963
|
-
*
|
|
5964
|
-
* @
|
|
5965
|
-
* @max 100000
|
|
5948
|
+
* Either UUID or EmbeddedServiceType.
|
|
5949
|
+
* @maxLength 36
|
|
5966
5950
|
*/
|
|
5967
|
-
|
|
5968
|
-
}
|
|
5969
|
-
interface CalculateRefundResponse {
|
|
5970
|
-
/** Total refundable amount */
|
|
5971
|
-
total?: Price;
|
|
5972
|
-
/** Tax cost of the order */
|
|
5973
|
-
tax?: Price;
|
|
5974
|
-
/** Discount given for this order */
|
|
5975
|
-
discount?: Price;
|
|
5976
|
-
/** Total cost of the order (without tax) */
|
|
5977
|
-
subtotal?: Price;
|
|
5978
|
-
/** Total shipping cost for order */
|
|
5979
|
-
shipping?: Price;
|
|
5980
|
-
/** Previous refund given on that order */
|
|
5981
|
-
previouslyRefundedAmount?: Price;
|
|
5951
|
+
appDefId?: string;
|
|
5982
5952
|
/**
|
|
5983
|
-
*
|
|
5984
|
-
* @
|
|
5953
|
+
* Not only UUID. Something here could be something weird.
|
|
5954
|
+
* @maxLength 36
|
|
5985
5955
|
*/
|
|
5986
|
-
|
|
5987
|
-
}
|
|
5988
|
-
interface CalculateRefundItemResponse {
|
|
5956
|
+
instanceId?: string;
|
|
5989
5957
|
/**
|
|
5990
|
-
*
|
|
5991
|
-
* @
|
|
5958
|
+
* A version.
|
|
5959
|
+
* @maxLength 500
|
|
5992
5960
|
*/
|
|
5993
|
-
|
|
5994
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
5995
|
-
price?: Price;
|
|
5961
|
+
version?: string | null;
|
|
5996
5962
|
}
|
|
5997
|
-
|
|
5963
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
5964
|
+
interface SiteRenamed {
|
|
5998
5965
|
/**
|
|
5999
|
-
*
|
|
6000
|
-
* @
|
|
6001
|
-
* @maxLength 100
|
|
5966
|
+
* A new meta site name (URL slug).
|
|
5967
|
+
* @maxLength 20
|
|
6002
5968
|
*/
|
|
6003
|
-
|
|
5969
|
+
newSiteName?: string;
|
|
6004
5970
|
/**
|
|
6005
|
-
*
|
|
6006
|
-
* @
|
|
6007
|
-
* @maxSize 100
|
|
6008
|
-
* @format GUID
|
|
5971
|
+
* A previous meta site name (URL slug).
|
|
5972
|
+
* @maxLength 255
|
|
6009
5973
|
*/
|
|
6010
|
-
|
|
5974
|
+
oldSiteName?: string;
|
|
6011
5975
|
}
|
|
6012
|
-
|
|
6013
|
-
|
|
6014
|
-
|
|
5976
|
+
/**
|
|
5977
|
+
* Hard deletion of the meta site.
|
|
5978
|
+
*
|
|
5979
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
5980
|
+
*/
|
|
5981
|
+
interface SiteHardDeleted {
|
|
5982
|
+
/** A deletion context. */
|
|
5983
|
+
deleteContext?: DeleteContext;
|
|
6015
5984
|
}
|
|
6016
|
-
interface
|
|
6017
|
-
/**
|
|
6018
|
-
|
|
6019
|
-
|
|
6020
|
-
|
|
6021
|
-
|
|
6022
|
-
|
|
5985
|
+
interface NamespaceChanged {
|
|
5986
|
+
/** A previous namespace. */
|
|
5987
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
5988
|
+
/** A new namespace. */
|
|
5989
|
+
newNamespace?: NamespaceWithLiterals;
|
|
5990
|
+
}
|
|
5991
|
+
/** Assigned Studio editor */
|
|
5992
|
+
interface StudioAssigned {
|
|
5993
|
+
}
|
|
5994
|
+
/** Unassigned Studio editor */
|
|
5995
|
+
interface StudioUnassigned {
|
|
5996
|
+
}
|
|
5997
|
+
/**
|
|
5998
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
5999
|
+
*
|
|
6000
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
6001
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
6002
|
+
*
|
|
6003
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
6004
|
+
*/
|
|
6005
|
+
interface SiteUrlChanged {
|
|
6006
|
+
}
|
|
6007
|
+
/**
|
|
6008
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
6009
|
+
* Consumed by other teams to remove relevant data.
|
|
6010
|
+
*/
|
|
6011
|
+
interface SitePurgedExternally {
|
|
6023
6012
|
/**
|
|
6024
|
-
*
|
|
6025
|
-
* @minSize 1
|
|
6013
|
+
* @maxLength 2048
|
|
6026
6014
|
* @maxSize 100
|
|
6015
|
+
* @deprecated
|
|
6016
|
+
* @targetRemovalDate 2025-04-15
|
|
6027
6017
|
*/
|
|
6028
|
-
|
|
6018
|
+
appDefId?: string[];
|
|
6029
6019
|
}
|
|
6030
|
-
|
|
6031
|
-
|
|
6032
|
-
* Payment ID
|
|
6033
|
-
* @format GUID
|
|
6034
|
-
*/
|
|
6035
|
-
paymentId?: string | null;
|
|
6036
|
-
/**
|
|
6037
|
-
* Capture amount.
|
|
6038
|
-
* If not provided - full authorized amount will be captured.
|
|
6039
|
-
*/
|
|
6040
|
-
amount?: Price;
|
|
6020
|
+
/** Assigned Odeditor */
|
|
6021
|
+
interface OdeditorAssigned {
|
|
6041
6022
|
}
|
|
6042
|
-
|
|
6043
|
-
|
|
6044
|
-
orderTransactions?: OrderTransactions;
|
|
6023
|
+
/** Unassigned Odeditor */
|
|
6024
|
+
interface OdeditorUnassigned {
|
|
6045
6025
|
}
|
|
6046
|
-
|
|
6047
|
-
|
|
6048
|
-
* Ecom Order ID.
|
|
6049
|
-
* @minLength 1
|
|
6050
|
-
* @maxLength 100
|
|
6051
|
-
*/
|
|
6052
|
-
ecomOrderId?: string;
|
|
6053
|
-
/** Amount to be charged */
|
|
6054
|
-
amount?: Price;
|
|
6026
|
+
/** Assigned Picasso editor */
|
|
6027
|
+
interface PicassoAssigned {
|
|
6055
6028
|
}
|
|
6056
|
-
|
|
6057
|
-
|
|
6058
|
-
paymentGatewayOrderId?: string;
|
|
6029
|
+
/** Unassigned Picasso */
|
|
6030
|
+
interface PicassoUnassigned {
|
|
6059
6031
|
}
|
|
6060
|
-
|
|
6061
|
-
|
|
6062
|
-
metasiteId?: string;
|
|
6063
|
-
/**
|
|
6064
|
-
* @minLength 1
|
|
6065
|
-
* @maxLength 100
|
|
6066
|
-
* @maxSize 100
|
|
6067
|
-
*/
|
|
6068
|
-
orderIds?: string[];
|
|
6032
|
+
/** Assigned Wixel */
|
|
6033
|
+
interface WixelAssigned {
|
|
6069
6034
|
}
|
|
6070
|
-
|
|
6035
|
+
/** Unassigned Wixel */
|
|
6036
|
+
interface WixelUnassigned {
|
|
6071
6037
|
}
|
|
6072
|
-
|
|
6073
|
-
|
|
6074
|
-
|
|
6075
|
-
|
|
6076
|
-
|
|
6077
|
-
|
|
6078
|
-
|
|
6079
|
-
|
|
6038
|
+
/** Assigned StudioTwo */
|
|
6039
|
+
interface StudioTwoAssigned {
|
|
6040
|
+
}
|
|
6041
|
+
/** Unassigned StudioTwo */
|
|
6042
|
+
interface StudioTwoUnassigned {
|
|
6043
|
+
}
|
|
6044
|
+
/** Media from user domain is enabled. */
|
|
6045
|
+
interface UserDomainMediaEnabled {
|
|
6046
|
+
}
|
|
6047
|
+
/** Media from user domain is disabled. */
|
|
6048
|
+
interface UserDomainMediaDisabled {
|
|
6049
|
+
}
|
|
6050
|
+
/** Assigned Editorless */
|
|
6051
|
+
interface EditorlessAssigned {
|
|
6052
|
+
}
|
|
6053
|
+
/** Unassigned Editorless */
|
|
6054
|
+
interface EditorlessUnassigned {
|
|
6055
|
+
}
|
|
6056
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
6057
|
+
}
|
|
6058
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
6059
|
+
hasCustomConfigurations?: boolean;
|
|
6060
|
+
}
|
|
6061
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
6062
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
6063
|
+
sendCustomEmailConfigs?: boolean;
|
|
6064
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
6065
|
+
origin?: OriginWithLiterals;
|
|
6066
|
+
}
|
|
6067
|
+
declare enum Origin {
|
|
6068
|
+
OPT_IN = "OPT_IN",
|
|
6069
|
+
MIGRATION = "MIGRATION"
|
|
6070
|
+
}
|
|
6071
|
+
/** @enumType */
|
|
6072
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
6073
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
6074
|
+
success?: boolean;
|
|
6075
|
+
}
|
|
6076
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
6077
|
+
}
|
|
6078
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
6079
|
+
inPopulation?: boolean;
|
|
6080
6080
|
}
|
|
6081
6081
|
interface DiffmatokyPayload {
|
|
6082
6082
|
left?: string;
|