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