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