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