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