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