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