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