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