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