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