@wix/auto_sdk_ecom_orders 1.0.279 → 1.0.281
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-CYkv7meU.d.ts → ecom-v1-order-orders.universal-CRdLHWV5.d.ts} +1637 -1639
- 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 +1638 -1638
- package/build/cjs/meta.js +79 -79
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-CYkv7meU.d.mts → ecom-v1-order-orders.universal-CRdLHWV5.d.mts} +1637 -1639
- 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 +1638 -1638
- package/build/es/meta.mjs +79 -79
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-NjFLhvro.d.ts → ecom-v1-order-orders.universal-l9fropDd.d.ts} +1792 -1794
- 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 +1792 -1792
- 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-NjFLhvro.d.mts → ecom-v1-order-orders.universal-l9fropDd.d.mts} +1792 -1794
- 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 +1792 -1792
- package/build/internal/es/meta.mjs +79 -79
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1254,6 +1254,25 @@ interface ItemModifier {
|
|
|
1254
1254
|
/** The price of the modifier. */
|
|
1255
1255
|
price?: Price;
|
|
1256
1256
|
}
|
|
1257
|
+
interface ServiceProperties {
|
|
1258
|
+
/**
|
|
1259
|
+
* 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.
|
|
1260
|
+
* For example, the start time of a class.
|
|
1261
|
+
*/
|
|
1262
|
+
scheduledDate?: Date | null;
|
|
1263
|
+
/**
|
|
1264
|
+
* 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.
|
|
1265
|
+
* @min 1
|
|
1266
|
+
* @max 10000
|
|
1267
|
+
*/
|
|
1268
|
+
numberOfParticipants?: number | null;
|
|
1269
|
+
/**
|
|
1270
|
+
* 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.
|
|
1271
|
+
* For example, the date and time a class will end.
|
|
1272
|
+
* @internal
|
|
1273
|
+
*/
|
|
1274
|
+
endDate?: Date | null;
|
|
1275
|
+
}
|
|
1257
1276
|
/** Buyer information. */
|
|
1258
1277
|
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1259
1278
|
/**
|
|
@@ -4387,1564 +4406,1243 @@ interface BulkDeleteImportedOrdersResponse {
|
|
|
4387
4406
|
*/
|
|
4388
4407
|
jobId?: string;
|
|
4389
4408
|
}
|
|
4390
|
-
interface
|
|
4409
|
+
interface V1TriggerReindexRequest {
|
|
4391
4410
|
/** @format GUID */
|
|
4392
|
-
|
|
4393
|
-
}
|
|
4394
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
4395
|
-
}
|
|
4396
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
4411
|
+
metasiteId?: string;
|
|
4397
4412
|
/**
|
|
4398
4413
|
* @minLength 1
|
|
4399
4414
|
* @maxLength 100
|
|
4415
|
+
* @maxSize 100
|
|
4400
4416
|
*/
|
|
4401
|
-
|
|
4417
|
+
orderIds?: string[];
|
|
4402
4418
|
}
|
|
4403
|
-
interface
|
|
4419
|
+
interface V1TriggerReindexResponse {
|
|
4404
4420
|
}
|
|
4405
|
-
interface
|
|
4421
|
+
interface V1TriggerReindexOrderRequest {
|
|
4422
|
+
/** @format GUID */
|
|
4423
|
+
metasiteId?: string;
|
|
4406
4424
|
/**
|
|
4407
4425
|
* @minLength 1
|
|
4408
4426
|
* @maxLength 100
|
|
4409
4427
|
*/
|
|
4410
4428
|
orderId?: string;
|
|
4411
4429
|
}
|
|
4412
|
-
interface
|
|
4413
|
-
}
|
|
4414
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
4415
|
-
/**
|
|
4416
|
-
* IDs of orders to send pickup emails for.
|
|
4417
|
-
* @minSize 1
|
|
4418
|
-
* @maxSize 300
|
|
4419
|
-
*/
|
|
4420
|
-
orderIds?: string[];
|
|
4421
|
-
}
|
|
4422
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
4423
|
-
}
|
|
4424
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
4430
|
+
interface PreparePaymentCollectionRequest {
|
|
4425
4431
|
/**
|
|
4432
|
+
* Ecom order ID.
|
|
4426
4433
|
* @minLength 1
|
|
4427
4434
|
* @maxLength 100
|
|
4428
4435
|
*/
|
|
4429
|
-
|
|
4430
|
-
|
|
4431
|
-
|
|
4432
|
-
}
|
|
4433
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
4436
|
+
ecomOrderId: string;
|
|
4437
|
+
/** Amount to collect */
|
|
4438
|
+
amount: Price;
|
|
4434
4439
|
/**
|
|
4435
|
-
*
|
|
4436
|
-
*
|
|
4437
|
-
*
|
|
4440
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4441
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
4442
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4438
4443
|
*/
|
|
4439
|
-
|
|
4440
|
-
}
|
|
4441
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
4442
|
-
}
|
|
4443
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
4444
|
+
paymentGatewayOrderId?: string | null;
|
|
4444
4445
|
/**
|
|
4445
|
-
*
|
|
4446
|
-
*
|
|
4446
|
+
* Whether to delay capture of the payment.
|
|
4447
|
+
* Default: false
|
|
4448
|
+
* @deprecated Whether to delay capture of the payment.
|
|
4449
|
+
* Default: false
|
|
4450
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4451
|
+
* @targetRemovalDate 2024-09-30
|
|
4447
4452
|
*/
|
|
4448
|
-
|
|
4449
|
-
}
|
|
4450
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
4451
|
-
}
|
|
4452
|
-
interface SendCancelRefundEmailRequest {
|
|
4453
|
+
delayedCapture?: boolean;
|
|
4453
4454
|
/**
|
|
4454
|
-
*
|
|
4455
|
-
*
|
|
4456
|
-
* @
|
|
4455
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
4456
|
+
* Default: `true`
|
|
4457
|
+
* @internal
|
|
4457
4458
|
*/
|
|
4458
|
-
|
|
4459
|
+
merchantInitiated?: boolean | null;
|
|
4459
4460
|
/**
|
|
4460
|
-
*
|
|
4461
|
-
* @
|
|
4462
|
-
* @maxLength 1000
|
|
4461
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
4462
|
+
* @internal
|
|
4463
4463
|
*/
|
|
4464
|
-
|
|
4465
|
-
/**
|
|
4466
|
-
|
|
4464
|
+
redirectUrls?: RedirectUrls;
|
|
4465
|
+
/** Delayed capture payment settings */
|
|
4466
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4467
|
+
}
|
|
4468
|
+
interface RedirectUrls {
|
|
4467
4469
|
/**
|
|
4468
|
-
*
|
|
4469
|
-
* @format
|
|
4470
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
4471
|
+
* @format WEB_URL
|
|
4470
4472
|
*/
|
|
4471
|
-
|
|
4472
|
-
}
|
|
4473
|
-
interface SendCancelRefundEmailResponse {
|
|
4474
|
-
}
|
|
4475
|
-
interface SendRefundEmailRequest {
|
|
4473
|
+
successUrl?: string | null;
|
|
4476
4474
|
/**
|
|
4477
|
-
*
|
|
4478
|
-
* @format
|
|
4475
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4476
|
+
* @format WEB_URL
|
|
4479
4477
|
*/
|
|
4480
|
-
|
|
4478
|
+
cancelUrl?: string | null;
|
|
4481
4479
|
/**
|
|
4482
|
-
*
|
|
4483
|
-
* @format
|
|
4480
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
4481
|
+
* @format WEB_URL
|
|
4484
4482
|
*/
|
|
4485
|
-
|
|
4483
|
+
errorUrl?: string | null;
|
|
4486
4484
|
/**
|
|
4487
|
-
*
|
|
4488
|
-
* @
|
|
4489
|
-
* @maxLength 1000
|
|
4485
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4486
|
+
* @format WEB_URL
|
|
4490
4487
|
*/
|
|
4491
|
-
|
|
4492
|
-
}
|
|
4493
|
-
interface SendRefundEmailResponse {
|
|
4488
|
+
pendingUrl?: string | null;
|
|
4494
4489
|
}
|
|
4495
|
-
interface
|
|
4496
|
-
/**
|
|
4497
|
-
|
|
4498
|
-
/**
|
|
4499
|
-
|
|
4490
|
+
interface DelayedCaptureSettings {
|
|
4491
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4492
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
4493
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4494
|
+
delayDuration?: Duration;
|
|
4500
4495
|
}
|
|
4501
|
-
|
|
4496
|
+
declare enum ScheduledAction {
|
|
4497
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
4498
|
+
VOID = "VOID",
|
|
4499
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
4500
|
+
CAPTURE = "CAPTURE"
|
|
4502
4501
|
}
|
|
4503
|
-
|
|
4502
|
+
/** @enumType */
|
|
4503
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4504
|
+
interface Duration {
|
|
4504
4505
|
/**
|
|
4505
|
-
*
|
|
4506
|
-
* @
|
|
4506
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4507
|
+
* @min 1
|
|
4507
4508
|
*/
|
|
4508
|
-
|
|
4509
|
-
|
|
4510
|
-
|
|
4511
|
-
}
|
|
4512
|
-
interface PreviewEmailByTypeRequest {
|
|
4513
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
4509
|
+
count?: number;
|
|
4510
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4511
|
+
unit?: DurationUnitWithLiterals;
|
|
4514
4512
|
}
|
|
4515
|
-
declare enum
|
|
4516
|
-
|
|
4517
|
-
|
|
4518
|
-
|
|
4519
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
4513
|
+
declare enum DurationUnit {
|
|
4514
|
+
MINUTES = "MINUTES",
|
|
4515
|
+
HOURS = "HOURS",
|
|
4516
|
+
DAYS = "DAYS"
|
|
4520
4517
|
}
|
|
4521
4518
|
/** @enumType */
|
|
4522
|
-
type
|
|
4523
|
-
interface
|
|
4524
|
-
|
|
4519
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4520
|
+
interface PreparePaymentCollectionResponse {
|
|
4521
|
+
/** Payment gateway order id which is associated with given payment */
|
|
4522
|
+
paymentGatewayOrderId?: string;
|
|
4525
4523
|
}
|
|
4526
|
-
interface
|
|
4524
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
4527
4525
|
/**
|
|
4526
|
+
* Ecom order ID.
|
|
4528
4527
|
* @minLength 1
|
|
4529
4528
|
* @maxLength 100
|
|
4530
4529
|
*/
|
|
4531
|
-
|
|
4532
|
-
|
|
4533
|
-
|
|
4534
|
-
/**
|
|
4535
|
-
|
|
4530
|
+
ecomOrderId: string;
|
|
4531
|
+
}
|
|
4532
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
4533
|
+
/** Payment collectability status */
|
|
4534
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4535
|
+
/** Collectable order amount */
|
|
4536
|
+
amount?: Price;
|
|
4536
4537
|
/**
|
|
4537
|
-
*
|
|
4538
|
-
* @
|
|
4539
|
-
* @maxLength 1000
|
|
4538
|
+
* Whether authorization supported
|
|
4539
|
+
* @internal
|
|
4540
4540
|
*/
|
|
4541
|
-
|
|
4541
|
+
authorizationSupported?: boolean;
|
|
4542
4542
|
/**
|
|
4543
|
-
*
|
|
4544
|
-
* @
|
|
4543
|
+
* Whether custom amount is supported for payment collection
|
|
4544
|
+
* @internal
|
|
4545
4545
|
*/
|
|
4546
|
-
|
|
4546
|
+
customAmountSupported?: boolean;
|
|
4547
4547
|
}
|
|
4548
|
-
|
|
4549
|
-
|
|
4550
|
-
|
|
4551
|
-
|
|
4552
|
-
|
|
4553
|
-
|
|
4554
|
-
|
|
4555
|
-
|
|
4556
|
-
|
|
4548
|
+
declare enum PaymentCollectabilityStatus {
|
|
4549
|
+
UNKNOWN = "UNKNOWN",
|
|
4550
|
+
COLLECTABLE = "COLLECTABLE",
|
|
4551
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4552
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4553
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4554
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4555
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4556
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4557
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4558
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4559
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4560
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
4561
|
+
}
|
|
4562
|
+
/** @enumType */
|
|
4563
|
+
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';
|
|
4564
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
4557
4565
|
/**
|
|
4558
|
-
*
|
|
4559
|
-
* @
|
|
4566
|
+
* Order ID.
|
|
4567
|
+
* @minLength 1
|
|
4568
|
+
* @maxLength 100
|
|
4560
4569
|
*/
|
|
4561
|
-
|
|
4570
|
+
orderId: string;
|
|
4571
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
4572
|
+
amount: Price;
|
|
4562
4573
|
/**
|
|
4563
|
-
*
|
|
4564
|
-
*
|
|
4574
|
+
* Payment method name provided by user.
|
|
4575
|
+
*
|
|
4576
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4577
|
+
* @internal
|
|
4565
4578
|
*/
|
|
4566
|
-
|
|
4567
|
-
/**
|
|
4568
|
-
* Additional fees that were refunded.
|
|
4569
|
-
* @maxSize 100
|
|
4570
|
-
*/
|
|
4571
|
-
additionalFees?: AdditionalFeeRefund[];
|
|
4572
|
-
/** Shipping amount that was refunded. */
|
|
4573
|
-
shipping?: ShippingRefund;
|
|
4579
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
4574
4580
|
}
|
|
4575
|
-
|
|
4581
|
+
/**
|
|
4582
|
+
* User-defined payment method name.
|
|
4583
|
+
* Allows specifying either a predefined type or a custom name.
|
|
4584
|
+
*/
|
|
4585
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4586
|
+
/** Predefined payment method. */
|
|
4587
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4576
4588
|
/**
|
|
4577
|
-
*
|
|
4578
|
-
*
|
|
4589
|
+
* Custom payment method name provided by user.
|
|
4590
|
+
*
|
|
4591
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4592
|
+
* @minLength 1
|
|
4593
|
+
* @maxLength 150
|
|
4579
4594
|
*/
|
|
4580
|
-
|
|
4595
|
+
custom?: string | null;
|
|
4596
|
+
}
|
|
4597
|
+
/** @oneof */
|
|
4598
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4599
|
+
/** Predefined payment method. */
|
|
4600
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4581
4601
|
/**
|
|
4582
|
-
*
|
|
4583
|
-
*
|
|
4584
|
-
*
|
|
4602
|
+
* Custom payment method name provided by user.
|
|
4603
|
+
*
|
|
4604
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4605
|
+
* @minLength 1
|
|
4606
|
+
* @maxLength 150
|
|
4585
4607
|
*/
|
|
4586
|
-
|
|
4608
|
+
custom?: string | null;
|
|
4587
4609
|
}
|
|
4588
|
-
|
|
4610
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
4611
|
+
declare enum PredefinedPaymentMethod {
|
|
4612
|
+
/** Cash payment. */
|
|
4613
|
+
CASH = "CASH",
|
|
4614
|
+
/** Bank transfer. */
|
|
4615
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4616
|
+
/** Payment by check. */
|
|
4617
|
+
CHECK = "CHECK"
|
|
4618
|
+
}
|
|
4619
|
+
/** @enumType */
|
|
4620
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4621
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
4622
|
+
}
|
|
4623
|
+
interface MarkOrderAsPaidRequest {
|
|
4589
4624
|
/**
|
|
4590
|
-
*
|
|
4591
|
-
* @
|
|
4592
|
-
* @
|
|
4625
|
+
* Ecom order ID.
|
|
4626
|
+
* @minLength 1
|
|
4627
|
+
* @maxLength 100
|
|
4593
4628
|
*/
|
|
4594
|
-
|
|
4629
|
+
ecomOrderId: string;
|
|
4595
4630
|
/**
|
|
4596
|
-
*
|
|
4597
|
-
*
|
|
4598
|
-
*
|
|
4599
|
-
* @
|
|
4631
|
+
* Payment method name provided by user.
|
|
4632
|
+
*
|
|
4633
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4634
|
+
* @internal
|
|
4600
4635
|
*/
|
|
4601
|
-
|
|
4636
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
4602
4637
|
}
|
|
4603
|
-
interface
|
|
4638
|
+
interface MarkOrderAsPaidResponse {
|
|
4639
|
+
/** Updated order. */
|
|
4640
|
+
order?: Order;
|
|
4641
|
+
}
|
|
4642
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
4604
4643
|
/**
|
|
4605
|
-
*
|
|
4606
|
-
* @
|
|
4607
|
-
* @
|
|
4644
|
+
* IDs of orders to mark as paid.
|
|
4645
|
+
* @minSize 1
|
|
4646
|
+
* @maxSize 100
|
|
4647
|
+
* @minLength 1
|
|
4648
|
+
* @maxLength 100
|
|
4608
4649
|
*/
|
|
4609
|
-
|
|
4650
|
+
ecomOrderIds: string[];
|
|
4651
|
+
}
|
|
4652
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
4610
4653
|
/**
|
|
4611
|
-
*
|
|
4612
|
-
*
|
|
4654
|
+
* Items updated by the bulk action.
|
|
4655
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
4613
4656
|
*/
|
|
4614
|
-
|
|
4657
|
+
results?: BulkOrderResult[];
|
|
4658
|
+
/** Bulk action metadata. */
|
|
4659
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4615
4660
|
}
|
|
4616
|
-
interface
|
|
4661
|
+
interface BulkOrderResult {
|
|
4662
|
+
/** Item metadata. */
|
|
4663
|
+
itemMetadata?: ItemMetadata;
|
|
4617
4664
|
/**
|
|
4618
|
-
*
|
|
4619
|
-
*
|
|
4665
|
+
* Updated order.
|
|
4666
|
+
*
|
|
4667
|
+
* Returned when `returnFullEntity = true`.
|
|
4620
4668
|
*/
|
|
4621
|
-
|
|
4669
|
+
item?: Order;
|
|
4622
4670
|
}
|
|
4623
|
-
interface
|
|
4624
|
-
|
|
4671
|
+
interface ItemMetadata {
|
|
4672
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
4673
|
+
_id?: string | null;
|
|
4674
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
4675
|
+
originalIndex?: number;
|
|
4676
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
4677
|
+
success?: boolean;
|
|
4678
|
+
/** Details about the error in case of failure. */
|
|
4679
|
+
error?: ApplicationError;
|
|
4625
4680
|
}
|
|
4626
|
-
interface
|
|
4681
|
+
interface ApplicationError {
|
|
4682
|
+
/** Error code. */
|
|
4683
|
+
code?: string;
|
|
4684
|
+
/** Description of the error. */
|
|
4685
|
+
description?: string;
|
|
4686
|
+
/** Data related to the error. */
|
|
4687
|
+
data?: Record<string, any> | null;
|
|
4688
|
+
}
|
|
4689
|
+
interface BulkActionMetadata {
|
|
4690
|
+
/** Number of items that were successfully processed. */
|
|
4691
|
+
totalSuccesses?: number;
|
|
4692
|
+
/** Number of items that couldn't be processed. */
|
|
4693
|
+
totalFailures?: number;
|
|
4694
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4695
|
+
undetailedFailures?: number;
|
|
4696
|
+
}
|
|
4697
|
+
interface GetRefundabilityStatusRequest {
|
|
4627
4698
|
/**
|
|
4699
|
+
* Order ID.
|
|
4628
4700
|
* @minLength 1
|
|
4629
4701
|
* @maxLength 100
|
|
4630
4702
|
*/
|
|
4631
|
-
|
|
4703
|
+
ecomOrderId: string;
|
|
4704
|
+
}
|
|
4705
|
+
interface GetRefundabilityStatusResponse {
|
|
4632
4706
|
/**
|
|
4633
|
-
*
|
|
4634
|
-
* @
|
|
4635
|
-
* @maxLength 1000
|
|
4707
|
+
* Refundability details.
|
|
4708
|
+
* @maxSize 300
|
|
4636
4709
|
*/
|
|
4637
|
-
|
|
4710
|
+
refundabilities?: Refundability[];
|
|
4711
|
+
/**
|
|
4712
|
+
* Whether the order supports refunding per item.
|
|
4713
|
+
* @deprecated
|
|
4714
|
+
*/
|
|
4715
|
+
refundablePerItem?: boolean;
|
|
4638
4716
|
}
|
|
4639
|
-
interface
|
|
4640
|
-
|
|
4717
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4718
|
+
/** Reason why payment is not refundable. */
|
|
4719
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4720
|
+
/** Reason why payment is only refundable manually. */
|
|
4721
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4722
|
+
/** Payment ID. */
|
|
4723
|
+
paymentId?: string;
|
|
4724
|
+
/** Payment refundability status. */
|
|
4725
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4726
|
+
/** Link to payment provider dashboard. */
|
|
4727
|
+
providerLink?: string | null;
|
|
4641
4728
|
}
|
|
4642
|
-
|
|
4729
|
+
/** @oneof */
|
|
4730
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4731
|
+
/** Reason why payment is not refundable. */
|
|
4732
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4733
|
+
/** Reason why payment is only refundable manually. */
|
|
4734
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4735
|
+
}
|
|
4736
|
+
declare enum RefundableStatus {
|
|
4737
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4738
|
+
MANUAL = "MANUAL",
|
|
4739
|
+
REFUNDABLE = "REFUNDABLE"
|
|
4740
|
+
}
|
|
4741
|
+
/** @enumType */
|
|
4742
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
4743
|
+
declare enum NonRefundableReason {
|
|
4744
|
+
NONE = "NONE",
|
|
4745
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4746
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4747
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4748
|
+
NOT_PAID = "NOT_PAID",
|
|
4749
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4750
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
4751
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4752
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
4753
|
+
FORBIDDEN = "FORBIDDEN",
|
|
4754
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4755
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4756
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4757
|
+
}
|
|
4758
|
+
/** @enumType */
|
|
4759
|
+
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';
|
|
4760
|
+
declare enum ManuallyRefundableReason {
|
|
4761
|
+
EXPIRED = "EXPIRED",
|
|
4762
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4763
|
+
OFFLINE = "OFFLINE",
|
|
4764
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4765
|
+
}
|
|
4766
|
+
/** @enumType */
|
|
4767
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4768
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
4643
4769
|
/**
|
|
4770
|
+
* Ecom order ID.
|
|
4644
4771
|
* @minLength 1
|
|
4645
4772
|
* @maxLength 100
|
|
4646
4773
|
*/
|
|
4647
|
-
|
|
4774
|
+
ecomOrderId: string;
|
|
4775
|
+
/** Information about the user who initiated the payment. */
|
|
4776
|
+
chargedBy?: ChargedBy;
|
|
4648
4777
|
/**
|
|
4649
|
-
*
|
|
4650
|
-
*
|
|
4651
|
-
*
|
|
4778
|
+
* Whether to delay capture of the payment.
|
|
4779
|
+
*
|
|
4780
|
+
* Default: false
|
|
4781
|
+
* @internal
|
|
4652
4782
|
*/
|
|
4653
|
-
|
|
4654
|
-
|
|
4655
|
-
|
|
4783
|
+
delayedCapture?: boolean;
|
|
4784
|
+
}
|
|
4785
|
+
interface ChargedBy {
|
|
4656
4786
|
/**
|
|
4657
|
-
*
|
|
4787
|
+
* ID - id of the user who initiated the payment
|
|
4658
4788
|
* @format GUID
|
|
4659
4789
|
*/
|
|
4660
|
-
|
|
4661
|
-
|
|
4662
|
-
|
|
4663
|
-
|
|
4664
|
-
|
|
4665
|
-
|
|
4666
|
-
|
|
4667
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
4668
|
-
emailPreview?: string;
|
|
4669
|
-
}
|
|
4670
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
4671
|
-
}
|
|
4672
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
4673
|
-
emailPreview?: string;
|
|
4790
|
+
_id?: string;
|
|
4791
|
+
/**
|
|
4792
|
+
* Full name - name of the user who initiated the payment
|
|
4793
|
+
* @minLength 1
|
|
4794
|
+
* @maxLength 200
|
|
4795
|
+
*/
|
|
4796
|
+
fullName?: string | null;
|
|
4674
4797
|
}
|
|
4675
|
-
interface
|
|
4798
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
4799
|
+
/** ID of the order created in the payment gateway */
|
|
4800
|
+
paymentGatewayOrderId?: string;
|
|
4676
4801
|
}
|
|
4677
|
-
interface
|
|
4678
|
-
emailPreview?: string;
|
|
4679
|
-
}
|
|
4680
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
4681
|
-
}
|
|
4682
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
4683
|
-
emailPreview?: string;
|
|
4684
|
-
}
|
|
4685
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
4686
|
-
}
|
|
4687
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
4688
|
-
emailPreview?: string;
|
|
4689
|
-
}
|
|
4690
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4691
|
-
/** Emitted on a meta site creation. */
|
|
4692
|
-
siteCreated?: SiteCreated;
|
|
4693
|
-
/** Emitted on a meta site transfer completion. */
|
|
4694
|
-
siteTransferred?: SiteTransferred;
|
|
4695
|
-
/** Emitted on a meta site deletion. */
|
|
4696
|
-
siteDeleted?: SiteDeleted;
|
|
4697
|
-
/** Emitted on a meta site restoration. */
|
|
4698
|
-
siteUndeleted?: SiteUndeleted;
|
|
4699
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4700
|
-
sitePublished?: SitePublished;
|
|
4701
|
-
/** Emitted on a meta site unpublish. */
|
|
4702
|
-
siteUnpublished?: SiteUnpublished;
|
|
4703
|
-
/** Emitted when meta site is marked as template. */
|
|
4704
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4705
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4706
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4707
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4708
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4709
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4710
|
-
serviceRemoved?: ServiceRemoved;
|
|
4711
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4712
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4713
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4714
|
-
hardDeleted?: SiteHardDeleted;
|
|
4715
|
-
/** Emitted on a namespace change. */
|
|
4716
|
-
namespaceChanged?: NamespaceChanged;
|
|
4717
|
-
/** Emitted when Studio is attached. */
|
|
4718
|
-
studioAssigned?: StudioAssigned;
|
|
4719
|
-
/** Emitted when Studio is detached. */
|
|
4720
|
-
studioUnassigned?: StudioUnassigned;
|
|
4802
|
+
interface ChargeMembershipsRequest {
|
|
4721
4803
|
/**
|
|
4722
|
-
*
|
|
4723
|
-
*
|
|
4724
|
-
*
|
|
4725
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4726
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4804
|
+
* Order ID.
|
|
4805
|
+
* @minLength 1
|
|
4806
|
+
* @maxLength 100
|
|
4727
4807
|
*/
|
|
4728
|
-
|
|
4729
|
-
/** Site is marked as PurgedExternally */
|
|
4730
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4731
|
-
/** Emitted when Odeditor is attached. */
|
|
4732
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4733
|
-
/** Emitted when Odeditor is detached. */
|
|
4734
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4735
|
-
/** Emitted when Picasso is attached. */
|
|
4736
|
-
picassoAssigned?: PicassoAssigned;
|
|
4737
|
-
/** Emitted when Picasso is detached. */
|
|
4738
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4739
|
-
/** Emitted when Wixel is attached. */
|
|
4740
|
-
wixelAssigned?: WixelAssigned;
|
|
4741
|
-
/** Emitted when Wixel is detached. */
|
|
4742
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4743
|
-
/** Emitted when StudioTwo is attached. */
|
|
4744
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4745
|
-
/** Emitted when StudioTwo is detached. */
|
|
4746
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4747
|
-
/** Emitted when media from user domain is enabled. */
|
|
4748
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4749
|
-
/** Emitted when media from user domain is disabled. */
|
|
4750
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4751
|
-
/** Emitted when Editorless is attached. */
|
|
4752
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4753
|
-
/** Emitted when Editorless is detached. */
|
|
4754
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4808
|
+
ecomOrderId: string;
|
|
4755
4809
|
/**
|
|
4756
|
-
*
|
|
4810
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4811
|
+
* but a user which is using the membership on behalf of the a member
|
|
4757
4812
|
* @format GUID
|
|
4758
4813
|
*/
|
|
4759
|
-
|
|
4760
|
-
/** A meta site version. Monotonically increasing. */
|
|
4761
|
-
version?: string;
|
|
4762
|
-
/** A timestamp of the event. */
|
|
4763
|
-
timestamp?: string;
|
|
4814
|
+
memberId: string;
|
|
4764
4815
|
/**
|
|
4765
|
-
*
|
|
4766
|
-
*
|
|
4767
|
-
* @maxSize
|
|
4816
|
+
* List of items to be paid by memberships
|
|
4817
|
+
* @minSize 1
|
|
4818
|
+
* @maxSize 300
|
|
4768
4819
|
*/
|
|
4769
|
-
|
|
4820
|
+
membershipCharges?: MembershipChargeItem[];
|
|
4770
4821
|
}
|
|
4771
|
-
|
|
4772
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4773
|
-
/** Emitted on a meta site creation. */
|
|
4774
|
-
siteCreated?: SiteCreated;
|
|
4775
|
-
/** Emitted on a meta site transfer completion. */
|
|
4776
|
-
siteTransferred?: SiteTransferred;
|
|
4777
|
-
/** Emitted on a meta site deletion. */
|
|
4778
|
-
siteDeleted?: SiteDeleted;
|
|
4779
|
-
/** Emitted on a meta site restoration. */
|
|
4780
|
-
siteUndeleted?: SiteUndeleted;
|
|
4781
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4782
|
-
sitePublished?: SitePublished;
|
|
4783
|
-
/** Emitted on a meta site unpublish. */
|
|
4784
|
-
siteUnpublished?: SiteUnpublished;
|
|
4785
|
-
/** Emitted when meta site is marked as template. */
|
|
4786
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4787
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4788
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4789
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4790
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4791
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4792
|
-
serviceRemoved?: ServiceRemoved;
|
|
4793
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4794
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4795
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4796
|
-
hardDeleted?: SiteHardDeleted;
|
|
4797
|
-
/** Emitted on a namespace change. */
|
|
4798
|
-
namespaceChanged?: NamespaceChanged;
|
|
4799
|
-
/** Emitted when Studio is attached. */
|
|
4800
|
-
studioAssigned?: StudioAssigned;
|
|
4801
|
-
/** Emitted when Studio is detached. */
|
|
4802
|
-
studioUnassigned?: StudioUnassigned;
|
|
4822
|
+
interface MembershipChargeItem {
|
|
4803
4823
|
/**
|
|
4804
|
-
*
|
|
4805
|
-
*
|
|
4806
|
-
*
|
|
4807
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4808
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4824
|
+
* The id of used membership
|
|
4825
|
+
* @minLength 1
|
|
4826
|
+
* @maxLength 100
|
|
4809
4827
|
*/
|
|
4810
|
-
|
|
4811
|
-
/** Site is marked as PurgedExternally */
|
|
4812
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4813
|
-
/** Emitted when Odeditor is attached. */
|
|
4814
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4815
|
-
/** Emitted when Odeditor is detached. */
|
|
4816
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4817
|
-
/** Emitted when Picasso is attached. */
|
|
4818
|
-
picassoAssigned?: PicassoAssigned;
|
|
4819
|
-
/** Emitted when Picasso is detached. */
|
|
4820
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4821
|
-
/** Emitted when Wixel is attached. */
|
|
4822
|
-
wixelAssigned?: WixelAssigned;
|
|
4823
|
-
/** Emitted when Wixel is detached. */
|
|
4824
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4825
|
-
/** Emitted when StudioTwo is attached. */
|
|
4826
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4827
|
-
/** Emitted when StudioTwo is detached. */
|
|
4828
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4829
|
-
/** Emitted when media from user domain is enabled. */
|
|
4830
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4831
|
-
/** Emitted when media from user domain is disabled. */
|
|
4832
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4833
|
-
/** Emitted when Editorless is attached. */
|
|
4834
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4835
|
-
/** Emitted when Editorless is detached. */
|
|
4836
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4837
|
-
}
|
|
4838
|
-
interface Asset {
|
|
4828
|
+
membershipId?: string;
|
|
4839
4829
|
/**
|
|
4840
|
-
*
|
|
4830
|
+
* ID of the application providing this payment option
|
|
4831
|
+
* @format GUID
|
|
4832
|
+
*/
|
|
4833
|
+
appId?: string;
|
|
4834
|
+
/** The name of used membership */
|
|
4835
|
+
membershipName?: MembershipName;
|
|
4836
|
+
/** Additional data about this membership */
|
|
4837
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
4838
|
+
/** Catalog and item reference info. */
|
|
4839
|
+
catalogReference?: CatalogReference;
|
|
4840
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4841
|
+
serviceProperties?: ServiceProperties;
|
|
4842
|
+
/**
|
|
4843
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
4844
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4845
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4846
|
+
* @minLength 1
|
|
4841
4847
|
* @maxLength 36
|
|
4842
4848
|
*/
|
|
4843
|
-
|
|
4849
|
+
rootCatalogItemId?: string | null;
|
|
4844
4850
|
/**
|
|
4845
|
-
*
|
|
4846
|
-
* @
|
|
4851
|
+
* line item id of Checkout/Order line item
|
|
4852
|
+
* @minLength 1
|
|
4853
|
+
* @maxLength 100
|
|
4847
4854
|
*/
|
|
4848
|
-
|
|
4849
|
-
/** An application state. */
|
|
4850
|
-
state?: StateWithLiterals;
|
|
4855
|
+
lineItemId?: string;
|
|
4851
4856
|
}
|
|
4852
|
-
|
|
4853
|
-
|
|
4854
|
-
|
|
4855
|
-
|
|
4856
|
-
|
|
4857
|
-
|
|
4857
|
+
interface MembershipName {
|
|
4858
|
+
/**
|
|
4859
|
+
* Membership name.
|
|
4860
|
+
* @maxLength 100
|
|
4861
|
+
*/
|
|
4862
|
+
original?: string;
|
|
4863
|
+
/**
|
|
4864
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
4865
|
+
* @maxLength 100
|
|
4866
|
+
*/
|
|
4867
|
+
translated?: string | null;
|
|
4858
4868
|
}
|
|
4859
|
-
|
|
4860
|
-
|
|
4861
|
-
interface
|
|
4869
|
+
interface ChargeMembershipsResponse {
|
|
4870
|
+
}
|
|
4871
|
+
interface TriggerRefundRequest {
|
|
4862
4872
|
/**
|
|
4863
|
-
*
|
|
4864
|
-
* @
|
|
4873
|
+
* The order this refund related to
|
|
4874
|
+
* @minLength 1
|
|
4875
|
+
* @maxLength 100
|
|
4865
4876
|
*/
|
|
4866
|
-
|
|
4877
|
+
ecomOrderId: string;
|
|
4867
4878
|
/**
|
|
4868
|
-
*
|
|
4869
|
-
* @
|
|
4879
|
+
* Refund operations information
|
|
4880
|
+
* @minSize 1
|
|
4881
|
+
* @maxSize 1
|
|
4870
4882
|
*/
|
|
4871
|
-
|
|
4872
|
-
/**
|
|
4873
|
-
|
|
4883
|
+
payments: PaymentRefund[];
|
|
4884
|
+
/** Business model of a refund */
|
|
4885
|
+
details?: RefundDetails;
|
|
4886
|
+
/** Side effect details related to refund */
|
|
4887
|
+
sideEffects?: RefundSideEffects;
|
|
4888
|
+
}
|
|
4889
|
+
interface PaymentRefund {
|
|
4874
4890
|
/**
|
|
4875
|
-
*
|
|
4876
|
-
*
|
|
4877
|
-
* In case of a creation from a template it's a template id.
|
|
4878
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
4891
|
+
* Specific payment within the order to refund
|
|
4879
4892
|
* @format GUID
|
|
4880
4893
|
*/
|
|
4881
|
-
|
|
4894
|
+
paymentId?: string;
|
|
4895
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
4896
|
+
amount?: Price;
|
|
4882
4897
|
/**
|
|
4883
|
-
*
|
|
4884
|
-
*
|
|
4898
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
4899
|
+
* 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.
|
|
4900
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
4885
4901
|
*/
|
|
4886
|
-
|
|
4887
|
-
/** A namespace. */
|
|
4888
|
-
namespace?: NamespaceWithLiterals;
|
|
4889
|
-
}
|
|
4890
|
-
declare enum SiteCreatedContext {
|
|
4891
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
4892
|
-
OTHER = "OTHER",
|
|
4893
|
-
/** A meta site was created from template. */
|
|
4894
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
4895
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
4896
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
4897
|
-
/** A copy of existing meta site. */
|
|
4898
|
-
DUPLICATE = "DUPLICATE",
|
|
4899
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
4900
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
4901
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
4902
|
-
FLASH = "FLASH"
|
|
4903
|
-
}
|
|
4904
|
-
/** @enumType */
|
|
4905
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
4906
|
-
declare enum Namespace {
|
|
4907
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4908
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4909
|
-
WIX = "WIX",
|
|
4910
|
-
/** 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. */
|
|
4911
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
4912
|
-
/** 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. */
|
|
4913
|
-
ALBUMS = "ALBUMS",
|
|
4914
|
-
/** 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. */
|
|
4915
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4916
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4917
|
-
HOTELS = "HOTELS",
|
|
4918
|
-
/** 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. */
|
|
4919
|
-
CLUBS = "CLUBS",
|
|
4920
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4921
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4922
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4923
|
-
DEV_SITE = "DEV_SITE",
|
|
4924
|
-
/** 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. */
|
|
4925
|
-
LOGOS = "LOGOS",
|
|
4926
|
-
/** 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. */
|
|
4927
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4928
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4929
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4930
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4931
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4902
|
+
externalRefund?: boolean;
|
|
4932
4903
|
/**
|
|
4933
|
-
*
|
|
4934
|
-
*
|
|
4935
|
-
*
|
|
4904
|
+
* Gateway refund id. When param is present, new refund is not created.
|
|
4905
|
+
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
4906
|
+
* and all side effects from request will be executed.
|
|
4907
|
+
* @internal
|
|
4908
|
+
* @minLength 1
|
|
4909
|
+
* @maxLength 100
|
|
4936
4910
|
*/
|
|
4937
|
-
|
|
4911
|
+
gatewayRefundId?: string | null;
|
|
4912
|
+
}
|
|
4913
|
+
/** Business model of a refund request */
|
|
4914
|
+
interface RefundDetails {
|
|
4938
4915
|
/**
|
|
4939
|
-
*
|
|
4940
|
-
*
|
|
4941
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4916
|
+
* Order line item IDs and quantities that were refunded.
|
|
4917
|
+
* @maxSize 300
|
|
4942
4918
|
*/
|
|
4943
|
-
|
|
4944
|
-
/**
|
|
4945
|
-
|
|
4946
|
-
/** It is to be used in the Business First efforts. */
|
|
4947
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4948
|
-
/** Bookings business flow with no site. */
|
|
4949
|
-
ANYWHERE = "ANYWHERE",
|
|
4950
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
4951
|
-
HEADLESS = "HEADLESS",
|
|
4919
|
+
items?: RefundItem[];
|
|
4920
|
+
/** Whether the shipping fee was also refunded. */
|
|
4921
|
+
shippingIncluded?: boolean;
|
|
4952
4922
|
/**
|
|
4953
|
-
*
|
|
4954
|
-
*
|
|
4923
|
+
* Reason for the refund, provided by customer (optional).
|
|
4924
|
+
* @maxLength 200
|
|
4955
4925
|
*/
|
|
4956
|
-
|
|
4957
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
4958
|
-
RISE = "RISE",
|
|
4926
|
+
reason?: string | null;
|
|
4959
4927
|
/**
|
|
4960
|
-
*
|
|
4961
|
-
*
|
|
4962
|
-
* The Mobile company will be the owner of this namespace.
|
|
4928
|
+
* Line items that were refunded.
|
|
4929
|
+
* @maxSize 300
|
|
4963
4930
|
*/
|
|
4964
|
-
|
|
4965
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
4966
|
-
NOWNIA = "NOWNIA",
|
|
4931
|
+
lineItems?: LineItemRefund[];
|
|
4967
4932
|
/**
|
|
4968
|
-
*
|
|
4969
|
-
*
|
|
4933
|
+
* Additional fees that were refunded.
|
|
4934
|
+
* @maxSize 100
|
|
4970
4935
|
*/
|
|
4971
|
-
|
|
4972
|
-
/**
|
|
4973
|
-
|
|
4974
|
-
|
|
4975
|
-
|
|
4936
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
4937
|
+
/** Shipping amount that was refunded. */
|
|
4938
|
+
shipping?: ShippingRefund;
|
|
4939
|
+
}
|
|
4940
|
+
interface RefundItem {
|
|
4976
4941
|
/**
|
|
4977
|
-
*
|
|
4978
|
-
*
|
|
4942
|
+
* Line item ID the refunded line item.
|
|
4943
|
+
* @format GUID
|
|
4979
4944
|
*/
|
|
4980
|
-
|
|
4981
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4982
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
4983
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4984
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
4985
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4986
|
-
MIMIR = "MIMIR",
|
|
4987
|
-
/** Wix Twins platform. */
|
|
4988
|
-
TWINS = "TWINS",
|
|
4989
|
-
/** Wix Nano. */
|
|
4990
|
-
NANO = "NANO",
|
|
4991
|
-
/** Base44 headless sites. */
|
|
4992
|
-
BASE44 = "BASE44",
|
|
4993
|
-
/** Wix Channels Sites */
|
|
4994
|
-
CHANNELS = "CHANNELS",
|
|
4995
|
-
/** Nautilus platform. */
|
|
4996
|
-
NAUTILUS = "NAUTILUS",
|
|
4945
|
+
lineItemId?: string;
|
|
4997
4946
|
/**
|
|
4998
|
-
*
|
|
4999
|
-
*
|
|
4947
|
+
* Line item quantity refunded.
|
|
4948
|
+
* @min 1
|
|
4949
|
+
* @max 100000
|
|
5000
4950
|
*/
|
|
5001
|
-
|
|
5002
|
-
|
|
5003
|
-
|
|
4951
|
+
quantity?: number;
|
|
4952
|
+
}
|
|
4953
|
+
interface LineItemRefund {
|
|
5004
4954
|
/**
|
|
5005
|
-
*
|
|
5006
|
-
*
|
|
4955
|
+
* Line item ID.
|
|
4956
|
+
* @format GUID
|
|
4957
|
+
* @immutable
|
|
5007
4958
|
*/
|
|
5008
|
-
|
|
4959
|
+
lineItemId?: string;
|
|
5009
4960
|
/**
|
|
5010
|
-
*
|
|
5011
|
-
*
|
|
5012
|
-
*
|
|
5013
|
-
*
|
|
4961
|
+
* Refund quantity.
|
|
4962
|
+
* @min 1
|
|
4963
|
+
* @max 100000
|
|
4964
|
+
* @immutable
|
|
5014
4965
|
*/
|
|
5015
|
-
|
|
4966
|
+
quantity?: number;
|
|
5016
4967
|
}
|
|
5017
|
-
|
|
5018
|
-
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';
|
|
5019
|
-
/** Site transferred to another user. */
|
|
5020
|
-
interface SiteTransferred {
|
|
4968
|
+
interface AdditionalFeeRefund {
|
|
5021
4969
|
/**
|
|
5022
|
-
*
|
|
4970
|
+
* Additional fee ID.
|
|
5023
4971
|
* @format GUID
|
|
4972
|
+
* @immutable
|
|
5024
4973
|
*/
|
|
5025
|
-
|
|
4974
|
+
additionalFeeId?: string;
|
|
5026
4975
|
/**
|
|
5027
|
-
*
|
|
5028
|
-
* @
|
|
4976
|
+
* Refund amount.
|
|
4977
|
+
* @immutable
|
|
5029
4978
|
*/
|
|
5030
|
-
|
|
4979
|
+
amount?: Price;
|
|
5031
4980
|
}
|
|
5032
|
-
|
|
5033
|
-
|
|
5034
|
-
|
|
5035
|
-
|
|
4981
|
+
interface ShippingRefund {
|
|
4982
|
+
/**
|
|
4983
|
+
* Refund amount.
|
|
4984
|
+
* @immutable
|
|
4985
|
+
*/
|
|
4986
|
+
amount?: Price;
|
|
5036
4987
|
}
|
|
5037
|
-
interface
|
|
5038
|
-
/**
|
|
5039
|
-
|
|
5040
|
-
/**
|
|
5041
|
-
|
|
4988
|
+
interface RefundSideEffects {
|
|
4989
|
+
/** Inventory restock details as part of this refund. */
|
|
4990
|
+
restockInfo?: RestockInfo;
|
|
4991
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
4992
|
+
sendOrderRefundedEmail?: boolean;
|
|
5042
4993
|
/**
|
|
5043
|
-
*
|
|
5044
|
-
* @
|
|
4994
|
+
* Custom message added to the refund confirmation email.
|
|
4995
|
+
* @minLength 1
|
|
4996
|
+
* @maxLength 1000
|
|
5045
4997
|
*/
|
|
5046
|
-
|
|
4998
|
+
customMessage?: string | null;
|
|
4999
|
+
}
|
|
5000
|
+
interface RestockInfo {
|
|
5001
|
+
/** Restock type. */
|
|
5002
|
+
type?: RestockTypeWithLiterals;
|
|
5047
5003
|
/**
|
|
5048
|
-
*
|
|
5049
|
-
* @
|
|
5004
|
+
* Deprecated, use items instead
|
|
5005
|
+
* @internal
|
|
5006
|
+
* @maxSize 300
|
|
5007
|
+
* @deprecated
|
|
5050
5008
|
*/
|
|
5051
|
-
|
|
5009
|
+
lineItemIds?: string[];
|
|
5010
|
+
/**
|
|
5011
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
5012
|
+
* @maxSize 300
|
|
5013
|
+
*/
|
|
5014
|
+
items?: RestockItem[];
|
|
5052
5015
|
}
|
|
5053
|
-
declare enum
|
|
5054
|
-
|
|
5055
|
-
|
|
5056
|
-
|
|
5057
|
-
PENDING_PURGE = "PENDING_PURGE",
|
|
5058
|
-
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
5016
|
+
declare enum RestockType {
|
|
5017
|
+
NO_ITEMS = "NO_ITEMS",
|
|
5018
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
5019
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
5059
5020
|
}
|
|
5060
5021
|
/** @enumType */
|
|
5061
|
-
type
|
|
5062
|
-
|
|
5063
|
-
interface SiteUndeleted {
|
|
5064
|
-
}
|
|
5065
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5066
|
-
interface SitePublished {
|
|
5067
|
-
}
|
|
5068
|
-
interface SiteUnpublished {
|
|
5022
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5023
|
+
interface RestockItem {
|
|
5069
5024
|
/**
|
|
5070
|
-
*
|
|
5071
|
-
* @
|
|
5072
|
-
* @maxSize 10000
|
|
5025
|
+
* ID of the line item being restocked.
|
|
5026
|
+
* @format GUID
|
|
5073
5027
|
*/
|
|
5074
|
-
|
|
5075
|
-
}
|
|
5076
|
-
interface SiteMarkedAsTemplate {
|
|
5077
|
-
}
|
|
5078
|
-
interface SiteMarkedAsWixSite {
|
|
5079
|
-
}
|
|
5080
|
-
/**
|
|
5081
|
-
* Represents a service provisioned a site.
|
|
5082
|
-
*
|
|
5083
|
-
* Note on `origin_instance_id`:
|
|
5084
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
5085
|
-
* This is because of the following scenario:
|
|
5086
|
-
*
|
|
5087
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
5088
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
5089
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
5090
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
5091
|
-
* your site remains consistent with what you initially received and does not include any
|
|
5092
|
-
* changes made to the original template afterward.
|
|
5093
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
5094
|
-
*/
|
|
5095
|
-
interface ServiceProvisioned {
|
|
5028
|
+
lineItemId?: string;
|
|
5096
5029
|
/**
|
|
5097
|
-
*
|
|
5098
|
-
* @
|
|
5030
|
+
* Line item quantity being restocked.
|
|
5031
|
+
* @min 1
|
|
5032
|
+
* @max 100000
|
|
5099
5033
|
*/
|
|
5100
|
-
|
|
5034
|
+
quantity?: number;
|
|
5101
5035
|
/**
|
|
5102
|
-
*
|
|
5103
|
-
* @
|
|
5036
|
+
* Per-location breakdown of restock quantities.
|
|
5037
|
+
* @internal
|
|
5038
|
+
* @maxSize 5
|
|
5104
5039
|
*/
|
|
5105
|
-
|
|
5040
|
+
restockLocations?: RestockLocation[];
|
|
5041
|
+
}
|
|
5042
|
+
interface TriggerRefundResponse {
|
|
5043
|
+
/** All order's transactions after the refunds were added */
|
|
5044
|
+
orderTransactions?: OrderTransactions;
|
|
5045
|
+
/** Created refund ID */
|
|
5046
|
+
refundId?: string | null;
|
|
5047
|
+
/** Payment ID's that the refund execution had failed for */
|
|
5048
|
+
failedPaymentIds?: ItemMetadata[];
|
|
5049
|
+
}
|
|
5050
|
+
/**
|
|
5051
|
+
* A record of all payments and refunds associated with an order.
|
|
5052
|
+
*
|
|
5053
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5054
|
+
*/
|
|
5055
|
+
interface OrderTransactions {
|
|
5106
5056
|
/**
|
|
5107
|
-
*
|
|
5108
|
-
* @
|
|
5057
|
+
* Order ID.
|
|
5058
|
+
* @format GUID
|
|
5109
5059
|
*/
|
|
5110
|
-
|
|
5060
|
+
orderId?: string;
|
|
5111
5061
|
/**
|
|
5112
|
-
*
|
|
5113
|
-
* @
|
|
5062
|
+
* Record of payments made to the merchant.
|
|
5063
|
+
* @maxSize 100
|
|
5114
5064
|
*/
|
|
5115
|
-
|
|
5065
|
+
payments?: Payment[];
|
|
5116
5066
|
/**
|
|
5117
|
-
*
|
|
5118
|
-
* @
|
|
5067
|
+
* Record of refunds made to the buyer.
|
|
5068
|
+
* @maxSize 300
|
|
5119
5069
|
*/
|
|
5120
|
-
|
|
5070
|
+
refunds?: Refund[];
|
|
5121
5071
|
}
|
|
5122
|
-
interface
|
|
5072
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
|
|
5073
|
+
/** Regular payment details. */
|
|
5074
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5075
|
+
/** Gift card payment details. */
|
|
5076
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5123
5077
|
/**
|
|
5124
|
-
*
|
|
5125
|
-
* @
|
|
5078
|
+
* Membership payment details.
|
|
5079
|
+
* @internal
|
|
5126
5080
|
*/
|
|
5127
|
-
|
|
5081
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5128
5082
|
/**
|
|
5129
|
-
*
|
|
5130
|
-
* @
|
|
5083
|
+
* Receipt created by Wix
|
|
5084
|
+
* @internal
|
|
5131
5085
|
*/
|
|
5132
|
-
|
|
5086
|
+
wixReceipt?: WixReceiptInfo;
|
|
5133
5087
|
/**
|
|
5134
|
-
*
|
|
5135
|
-
* @
|
|
5088
|
+
* Receipt created by an external system.
|
|
5089
|
+
* @internal
|
|
5136
5090
|
*/
|
|
5137
|
-
|
|
5138
|
-
|
|
5139
|
-
|
|
5140
|
-
|
|
5091
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
5092
|
+
/** @internal */
|
|
5093
|
+
canceled?: CanceledStatusDetails;
|
|
5094
|
+
/** @internal */
|
|
5095
|
+
declined?: DeclinedStatusDetails;
|
|
5096
|
+
/** @internal */
|
|
5097
|
+
voided?: VoidedStatusDetails;
|
|
5141
5098
|
/**
|
|
5142
|
-
*
|
|
5143
|
-
* @
|
|
5099
|
+
* Payment ID.
|
|
5100
|
+
* @format GUID
|
|
5101
|
+
* @readonly
|
|
5144
5102
|
*/
|
|
5145
|
-
|
|
5103
|
+
_id?: string | null;
|
|
5104
|
+
/** 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. */
|
|
5105
|
+
_createdDate?: Date | null;
|
|
5146
5106
|
/**
|
|
5147
|
-
*
|
|
5148
|
-
* @
|
|
5107
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5108
|
+
* @readonly
|
|
5149
5109
|
*/
|
|
5150
|
-
|
|
5151
|
-
|
|
5152
|
-
|
|
5153
|
-
* Hard deletion of the meta site.
|
|
5154
|
-
*
|
|
5155
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
5156
|
-
*/
|
|
5157
|
-
interface SiteHardDeleted {
|
|
5158
|
-
/** A deletion context. */
|
|
5159
|
-
deleteContext?: DeleteContext;
|
|
5160
|
-
}
|
|
5161
|
-
interface NamespaceChanged {
|
|
5162
|
-
/** A previous namespace. */
|
|
5163
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
5164
|
-
/** A new namespace. */
|
|
5165
|
-
newNamespace?: NamespaceWithLiterals;
|
|
5166
|
-
}
|
|
5167
|
-
/** Assigned Studio editor */
|
|
5168
|
-
interface StudioAssigned {
|
|
5169
|
-
}
|
|
5170
|
-
/** Unassigned Studio editor */
|
|
5171
|
-
interface StudioUnassigned {
|
|
5172
|
-
}
|
|
5173
|
-
/**
|
|
5174
|
-
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
5175
|
-
*
|
|
5176
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
5177
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
5178
|
-
*
|
|
5179
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
5180
|
-
*/
|
|
5181
|
-
interface SiteUrlChanged {
|
|
5182
|
-
}
|
|
5183
|
-
/**
|
|
5184
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
5185
|
-
* Consumed by other teams to remove relevant data.
|
|
5186
|
-
*/
|
|
5187
|
-
interface SitePurgedExternally {
|
|
5110
|
+
_updatedDate?: Date | null;
|
|
5111
|
+
/** Payment amount. */
|
|
5112
|
+
amount?: Price;
|
|
5188
5113
|
/**
|
|
5189
|
-
*
|
|
5190
|
-
*
|
|
5191
|
-
*
|
|
5192
|
-
* @targetRemovalDate 2025-04-15
|
|
5114
|
+
* Whether refunds for this payment are disabled.
|
|
5115
|
+
* + `true`: This payment is not refundable.
|
|
5116
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5193
5117
|
*/
|
|
5194
|
-
|
|
5195
|
-
}
|
|
5196
|
-
/** Assigned Odeditor */
|
|
5197
|
-
interface OdeditorAssigned {
|
|
5198
|
-
}
|
|
5199
|
-
/** Unassigned Odeditor */
|
|
5200
|
-
interface OdeditorUnassigned {
|
|
5201
|
-
}
|
|
5202
|
-
/** Assigned Picasso editor */
|
|
5203
|
-
interface PicassoAssigned {
|
|
5204
|
-
}
|
|
5205
|
-
/** Unassigned Picasso */
|
|
5206
|
-
interface PicassoUnassigned {
|
|
5207
|
-
}
|
|
5208
|
-
/** Assigned Wixel */
|
|
5209
|
-
interface WixelAssigned {
|
|
5210
|
-
}
|
|
5211
|
-
/** Unassigned Wixel */
|
|
5212
|
-
interface WixelUnassigned {
|
|
5213
|
-
}
|
|
5214
|
-
/** Assigned StudioTwo */
|
|
5215
|
-
interface StudioTwoAssigned {
|
|
5216
|
-
}
|
|
5217
|
-
/** Unassigned StudioTwo */
|
|
5218
|
-
interface StudioTwoUnassigned {
|
|
5219
|
-
}
|
|
5220
|
-
/** Media from user domain is enabled. */
|
|
5221
|
-
interface UserDomainMediaEnabled {
|
|
5222
|
-
}
|
|
5223
|
-
/** Media from user domain is disabled. */
|
|
5224
|
-
interface UserDomainMediaDisabled {
|
|
5225
|
-
}
|
|
5226
|
-
/** Assigned Editorless */
|
|
5227
|
-
interface EditorlessAssigned {
|
|
5228
|
-
}
|
|
5229
|
-
/** Unassigned Editorless */
|
|
5230
|
-
interface EditorlessUnassigned {
|
|
5231
|
-
}
|
|
5232
|
-
interface HasCustomEmailConfigurationsRequest {
|
|
5233
|
-
}
|
|
5234
|
-
interface HasCustomEmailConfigurationsResponse {
|
|
5235
|
-
hasCustomConfigurations?: boolean;
|
|
5236
|
-
}
|
|
5237
|
-
interface AddToAutomationMigrationPopulationRequest {
|
|
5238
|
-
/** When true, sends custom email configurations to automation system via email */
|
|
5239
|
-
sendCustomEmailConfigs?: boolean;
|
|
5240
|
-
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
5241
|
-
origin?: OriginWithLiterals;
|
|
5242
|
-
}
|
|
5243
|
-
declare enum Origin {
|
|
5244
|
-
OPT_IN = "OPT_IN",
|
|
5245
|
-
MIGRATION = "MIGRATION"
|
|
5246
|
-
}
|
|
5247
|
-
/** @enumType */
|
|
5248
|
-
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
5249
|
-
interface AddToAutomationMigrationPopulationResponse {
|
|
5250
|
-
success?: boolean;
|
|
5251
|
-
}
|
|
5252
|
-
interface IsInAutomationMigrationPopulationRequest {
|
|
5253
|
-
}
|
|
5254
|
-
interface IsInAutomationMigrationPopulationResponse {
|
|
5255
|
-
inPopulation?: boolean;
|
|
5256
|
-
}
|
|
5257
|
-
interface PreparePaymentCollectionRequest {
|
|
5118
|
+
refundDisabled?: boolean;
|
|
5258
5119
|
/**
|
|
5259
|
-
*
|
|
5260
|
-
*
|
|
5261
|
-
*
|
|
5120
|
+
* Whether receipt generation for this payment are allowed.
|
|
5121
|
+
* + `true`: This payment supports receipt generation.
|
|
5122
|
+
* + `false`: This payment not supports receipt generation, or receipt already generated
|
|
5123
|
+
* @internal
|
|
5124
|
+
* @readonly
|
|
5262
5125
|
*/
|
|
5263
|
-
|
|
5264
|
-
/**
|
|
5265
|
-
|
|
5126
|
+
supportReceiptGeneration?: boolean;
|
|
5127
|
+
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5128
|
+
cashRounding?: CashRoundingDetails;
|
|
5129
|
+
/** @internal */
|
|
5130
|
+
status?: PaymentStatusWithLiterals;
|
|
5266
5131
|
/**
|
|
5267
|
-
*
|
|
5268
|
-
*
|
|
5269
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
5132
|
+
* Detailed payment status information including gateway reason codes and status-specific details.
|
|
5133
|
+
* @internal
|
|
5270
5134
|
*/
|
|
5271
|
-
|
|
5135
|
+
paymentStatusDetails?: PaymentStatusDetails;
|
|
5272
5136
|
/**
|
|
5273
|
-
*
|
|
5274
|
-
*
|
|
5275
|
-
* @
|
|
5276
|
-
*
|
|
5277
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
5278
|
-
* @targetRemovalDate 2024-09-30
|
|
5137
|
+
* Location where the payment was processed.
|
|
5138
|
+
* @internal
|
|
5139
|
+
* @format GUID
|
|
5140
|
+
* @immutable
|
|
5279
5141
|
*/
|
|
5280
|
-
|
|
5142
|
+
locationId?: string | null;
|
|
5281
5143
|
/**
|
|
5282
|
-
*
|
|
5283
|
-
* Default: `true`
|
|
5144
|
+
* ID linking this payment to the charge request that created it.
|
|
5284
5145
|
* @internal
|
|
5146
|
+
* @format GUID
|
|
5285
5147
|
*/
|
|
5286
|
-
|
|
5148
|
+
chargeCorrelationId?: string | null;
|
|
5149
|
+
}
|
|
5150
|
+
/** @oneof */
|
|
5151
|
+
interface PaymentPaymentDetailsOneOf {
|
|
5152
|
+
/** Regular payment details. */
|
|
5153
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5154
|
+
/** Gift card payment details. */
|
|
5155
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5287
5156
|
/**
|
|
5288
|
-
*
|
|
5157
|
+
* Membership payment details.
|
|
5289
5158
|
* @internal
|
|
5290
5159
|
*/
|
|
5291
|
-
|
|
5292
|
-
/** Delayed capture payment settings */
|
|
5293
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
5160
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5294
5161
|
}
|
|
5295
|
-
|
|
5296
|
-
|
|
5297
|
-
* URL to redirect buyer in case of approved (successful) transaction
|
|
5298
|
-
* @format WEB_URL
|
|
5299
|
-
*/
|
|
5300
|
-
successUrl?: string | null;
|
|
5301
|
-
/**
|
|
5302
|
-
* URL to redirect buyer in case of buyer canceled the transaction
|
|
5303
|
-
* @format WEB_URL
|
|
5304
|
-
*/
|
|
5305
|
-
cancelUrl?: string | null;
|
|
5162
|
+
/** @oneof */
|
|
5163
|
+
interface PaymentReceiptInfoOneOf {
|
|
5306
5164
|
/**
|
|
5307
|
-
*
|
|
5308
|
-
* @
|
|
5165
|
+
* Receipt created by Wix
|
|
5166
|
+
* @internal
|
|
5309
5167
|
*/
|
|
5310
|
-
|
|
5168
|
+
wixReceipt?: WixReceiptInfo;
|
|
5311
5169
|
/**
|
|
5312
|
-
*
|
|
5313
|
-
* @
|
|
5170
|
+
* Receipt created by an external system.
|
|
5171
|
+
* @internal
|
|
5314
5172
|
*/
|
|
5315
|
-
|
|
5316
|
-
}
|
|
5317
|
-
interface DelayedCaptureSettings {
|
|
5318
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
5319
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
5320
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
5321
|
-
delayDuration?: Duration;
|
|
5173
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
5322
5174
|
}
|
|
5323
|
-
|
|
5324
|
-
|
|
5325
|
-
|
|
5326
|
-
|
|
5327
|
-
|
|
5175
|
+
/** @oneof */
|
|
5176
|
+
interface PaymentStatusDetailsOneOf {
|
|
5177
|
+
/** @internal */
|
|
5178
|
+
canceled?: CanceledStatusDetails;
|
|
5179
|
+
/** @internal */
|
|
5180
|
+
declined?: DeclinedStatusDetails;
|
|
5181
|
+
/** @internal */
|
|
5182
|
+
voided?: VoidedStatusDetails;
|
|
5328
5183
|
}
|
|
5329
|
-
|
|
5330
|
-
|
|
5331
|
-
|
|
5184
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5185
|
+
/** Credit card details. */
|
|
5186
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5332
5187
|
/**
|
|
5333
|
-
*
|
|
5334
|
-
* @
|
|
5188
|
+
* Wix Payments order ID.
|
|
5189
|
+
* @maxLength 100
|
|
5335
5190
|
*/
|
|
5336
|
-
|
|
5337
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
5338
|
-
unit?: DurationUnitWithLiterals;
|
|
5339
|
-
}
|
|
5340
|
-
declare enum DurationUnit {
|
|
5341
|
-
MINUTES = "MINUTES",
|
|
5342
|
-
HOURS = "HOURS",
|
|
5343
|
-
DAYS = "DAYS"
|
|
5344
|
-
}
|
|
5345
|
-
/** @enumType */
|
|
5346
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
5347
|
-
interface PreparePaymentCollectionResponse {
|
|
5348
|
-
/** Payment gateway order id which is associated with given payment */
|
|
5349
|
-
paymentGatewayOrderId?: string;
|
|
5350
|
-
}
|
|
5351
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
5191
|
+
paymentOrderId?: string | null;
|
|
5352
5192
|
/**
|
|
5353
|
-
*
|
|
5354
|
-
*
|
|
5193
|
+
* Payment gateway's transaction ID.
|
|
5194
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
5355
5195
|
* @maxLength 100
|
|
5356
5196
|
*/
|
|
5357
|
-
|
|
5358
|
-
}
|
|
5359
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
5360
|
-
/** Payment collectability status */
|
|
5361
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
5362
|
-
/** Collectable order amount */
|
|
5363
|
-
amount?: Price;
|
|
5197
|
+
gatewayTransactionId?: string | null;
|
|
5364
5198
|
/**
|
|
5365
|
-
*
|
|
5366
|
-
*
|
|
5199
|
+
* Payment method.
|
|
5200
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5201
|
+
* Non-exhaustive list of supported values:
|
|
5202
|
+
* + `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`
|
|
5203
|
+
* @maxLength 150
|
|
5204
|
+
* @deprecated Payment method.
|
|
5205
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5206
|
+
* Non-exhaustive list of supported values:
|
|
5207
|
+
* + `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`
|
|
5208
|
+
* @replacedBy payment_method_name
|
|
5209
|
+
* @targetRemovalDate 2026-07-01
|
|
5367
5210
|
*/
|
|
5368
|
-
|
|
5211
|
+
paymentMethod?: string | null;
|
|
5369
5212
|
/**
|
|
5370
|
-
*
|
|
5213
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
5214
|
+
* @maxLength 100
|
|
5215
|
+
*/
|
|
5216
|
+
providerTransactionId?: string | null;
|
|
5217
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5218
|
+
offlinePayment?: boolean;
|
|
5219
|
+
/** Payment status. */
|
|
5220
|
+
status?: TransactionStatusWithLiterals;
|
|
5221
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
5222
|
+
savedPaymentMethod?: boolean;
|
|
5223
|
+
/** Authorization details. */
|
|
5224
|
+
authorizationDetails?: AuthorizationDetails;
|
|
5225
|
+
/**
|
|
5226
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
5371
5227
|
* @internal
|
|
5228
|
+
* @maxLength 300
|
|
5372
5229
|
*/
|
|
5373
|
-
|
|
5374
|
-
}
|
|
5375
|
-
declare enum PaymentCollectabilityStatus {
|
|
5376
|
-
UNKNOWN = "UNKNOWN",
|
|
5377
|
-
COLLECTABLE = "COLLECTABLE",
|
|
5378
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
5379
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
5380
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
5381
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
5382
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
5383
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
5384
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
5385
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
5386
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
5387
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
5388
|
-
}
|
|
5389
|
-
/** @enumType */
|
|
5390
|
-
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';
|
|
5391
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
5230
|
+
paymentProvider?: string | null;
|
|
5392
5231
|
/**
|
|
5393
|
-
*
|
|
5394
|
-
* @
|
|
5395
|
-
* @maxLength 100
|
|
5232
|
+
* Record of chargebacks made by the buyer.
|
|
5233
|
+
* @maxSize 6
|
|
5396
5234
|
*/
|
|
5397
|
-
|
|
5398
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
5399
|
-
amount: Price;
|
|
5235
|
+
chargebacks?: Chargeback[];
|
|
5400
5236
|
/**
|
|
5401
|
-
* Payment method
|
|
5402
|
-
*
|
|
5403
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5237
|
+
* Payment method ID.
|
|
5404
5238
|
* @internal
|
|
5239
|
+
* @maxLength 36
|
|
5405
5240
|
*/
|
|
5406
|
-
|
|
5407
|
-
|
|
5408
|
-
|
|
5409
|
-
* User-defined payment method name.
|
|
5410
|
-
* Allows specifying either a predefined type or a custom name.
|
|
5411
|
-
*/
|
|
5412
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
5413
|
-
/** Predefined payment method. */
|
|
5414
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5241
|
+
paymentMethodId?: string | null;
|
|
5242
|
+
/** Platform fee amount associated with this payment. */
|
|
5243
|
+
platformFee?: Price;
|
|
5415
5244
|
/**
|
|
5416
|
-
*
|
|
5417
|
-
*
|
|
5418
|
-
*
|
|
5419
|
-
* @minLength 1
|
|
5420
|
-
* @maxLength 150
|
|
5245
|
+
* Payment method with buyer and optional owner translations.
|
|
5246
|
+
* Non-exhaustive list of supported values:
|
|
5247
|
+
* + `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`
|
|
5421
5248
|
*/
|
|
5422
|
-
|
|
5249
|
+
paymentMethodName?: PaymentMethodName;
|
|
5423
5250
|
}
|
|
5424
5251
|
/** @oneof */
|
|
5425
|
-
interface
|
|
5426
|
-
/**
|
|
5427
|
-
|
|
5428
|
-
/**
|
|
5429
|
-
* Custom payment method name provided by user.
|
|
5430
|
-
*
|
|
5431
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5432
|
-
* @minLength 1
|
|
5433
|
-
* @maxLength 150
|
|
5434
|
-
*/
|
|
5435
|
-
custom?: string | null;
|
|
5252
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5253
|
+
/** Credit card details. */
|
|
5254
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5436
5255
|
}
|
|
5437
|
-
|
|
5438
|
-
|
|
5439
|
-
|
|
5440
|
-
|
|
5441
|
-
|
|
5442
|
-
|
|
5443
|
-
|
|
5444
|
-
|
|
5256
|
+
declare enum TransactionStatus {
|
|
5257
|
+
UNDEFINED = "UNDEFINED",
|
|
5258
|
+
APPROVED = "APPROVED",
|
|
5259
|
+
PENDING = "PENDING",
|
|
5260
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5261
|
+
CANCELED = "CANCELED",
|
|
5262
|
+
DECLINED = "DECLINED",
|
|
5263
|
+
REFUNDED = "REFUNDED",
|
|
5264
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5265
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5266
|
+
VOIDED = "VOIDED"
|
|
5445
5267
|
}
|
|
5446
5268
|
/** @enumType */
|
|
5447
|
-
type
|
|
5448
|
-
interface
|
|
5449
|
-
}
|
|
5450
|
-
interface MarkOrderAsPaidRequest {
|
|
5451
|
-
/**
|
|
5452
|
-
* Ecom order ID.
|
|
5453
|
-
* @minLength 1
|
|
5454
|
-
* @maxLength 100
|
|
5455
|
-
*/
|
|
5456
|
-
ecomOrderId: string;
|
|
5269
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5270
|
+
interface CreditCardPaymentMethodDetails {
|
|
5457
5271
|
/**
|
|
5458
|
-
*
|
|
5459
|
-
*
|
|
5460
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5461
|
-
* @internal
|
|
5272
|
+
* The last 4 digits of the card number.
|
|
5273
|
+
* @maxLength 4
|
|
5462
5274
|
*/
|
|
5463
|
-
|
|
5464
|
-
}
|
|
5465
|
-
interface MarkOrderAsPaidResponse {
|
|
5466
|
-
/** Updated order. */
|
|
5467
|
-
order?: Order;
|
|
5468
|
-
}
|
|
5469
|
-
interface BulkMarkOrdersAsPaidRequest {
|
|
5275
|
+
lastFourDigits?: string | null;
|
|
5470
5276
|
/**
|
|
5471
|
-
*
|
|
5472
|
-
* @minSize 1
|
|
5473
|
-
* @maxSize 100
|
|
5474
|
-
* @minLength 1
|
|
5277
|
+
* Card issuer's brand.
|
|
5475
5278
|
* @maxLength 100
|
|
5476
5279
|
*/
|
|
5477
|
-
|
|
5280
|
+
brand?: string | null;
|
|
5478
5281
|
}
|
|
5479
|
-
interface
|
|
5282
|
+
interface AuthorizationDetails {
|
|
5480
5283
|
/**
|
|
5481
|
-
*
|
|
5482
|
-
*
|
|
5483
|
-
*/
|
|
5484
|
-
results?: BulkOrderResult[];
|
|
5485
|
-
/** Bulk action metadata. */
|
|
5486
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
5487
|
-
}
|
|
5488
|
-
interface BulkOrderResult {
|
|
5489
|
-
/** Item metadata. */
|
|
5490
|
-
itemMetadata?: ItemMetadata;
|
|
5491
|
-
/**
|
|
5492
|
-
* Updated order.
|
|
5493
|
-
*
|
|
5494
|
-
* Returned when `returnFullEntity = true`.
|
|
5284
|
+
* Whether the authorized payment is of a delayed capture.
|
|
5285
|
+
* @readonly
|
|
5495
5286
|
*/
|
|
5496
|
-
|
|
5497
|
-
|
|
5498
|
-
|
|
5499
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
5500
|
-
_id?: string | null;
|
|
5501
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
5502
|
-
originalIndex?: number;
|
|
5503
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
5504
|
-
success?: boolean;
|
|
5505
|
-
/** Details about the error in case of failure. */
|
|
5506
|
-
error?: ApplicationError;
|
|
5507
|
-
}
|
|
5508
|
-
interface ApplicationError {
|
|
5509
|
-
/** Error code. */
|
|
5510
|
-
code?: string;
|
|
5511
|
-
/** Description of the error. */
|
|
5512
|
-
description?: string;
|
|
5513
|
-
/** Data related to the error. */
|
|
5514
|
-
data?: Record<string, any> | null;
|
|
5515
|
-
}
|
|
5516
|
-
interface BulkActionMetadata {
|
|
5517
|
-
/** Number of items that were successfully processed. */
|
|
5518
|
-
totalSuccesses?: number;
|
|
5519
|
-
/** Number of items that couldn't be processed. */
|
|
5520
|
-
totalFailures?: number;
|
|
5521
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
5522
|
-
undetailedFailures?: number;
|
|
5523
|
-
}
|
|
5524
|
-
interface GetRefundabilityStatusRequest {
|
|
5287
|
+
delayedCapture?: boolean;
|
|
5288
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5289
|
+
authorizedDate?: Date | null;
|
|
5525
5290
|
/**
|
|
5526
|
-
*
|
|
5527
|
-
*
|
|
5528
|
-
* @
|
|
5291
|
+
* List of captures associated with payment
|
|
5292
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
5293
|
+
* @maxSize 1
|
|
5529
5294
|
*/
|
|
5530
|
-
|
|
5295
|
+
captures?: AuthorizationCapture[];
|
|
5296
|
+
/** Void associated with payment */
|
|
5297
|
+
void?: AuthorizationVoid;
|
|
5298
|
+
/** Scheduled action for this transaction */
|
|
5299
|
+
scheduledAction?: V1ScheduledAction;
|
|
5531
5300
|
}
|
|
5532
|
-
interface
|
|
5301
|
+
interface AuthorizationCapture {
|
|
5533
5302
|
/**
|
|
5534
|
-
*
|
|
5535
|
-
* @
|
|
5303
|
+
* Capture ID.
|
|
5304
|
+
* @format GUID
|
|
5305
|
+
* @readonly
|
|
5536
5306
|
*/
|
|
5537
|
-
|
|
5307
|
+
_id?: string | null;
|
|
5308
|
+
/** Status of this capture action */
|
|
5309
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
5538
5310
|
/**
|
|
5539
|
-
*
|
|
5540
|
-
* @
|
|
5311
|
+
* Amount of this capture
|
|
5312
|
+
* @immutable
|
|
5541
5313
|
*/
|
|
5542
|
-
|
|
5314
|
+
amount?: Price;
|
|
5315
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5316
|
+
_createdDate?: Date | null;
|
|
5317
|
+
/** In case of status is FAILED may contain failure details */
|
|
5318
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5543
5319
|
}
|
|
5544
|
-
|
|
5545
|
-
/**
|
|
5546
|
-
|
|
5547
|
-
/**
|
|
5548
|
-
|
|
5549
|
-
/**
|
|
5550
|
-
|
|
5551
|
-
/** Payment refundability status. */
|
|
5552
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
5553
|
-
/** Link to payment provider dashboard. */
|
|
5554
|
-
providerLink?: string | null;
|
|
5320
|
+
declare enum AuthorizationCaptureStatus {
|
|
5321
|
+
/** Capture operation still in progress. */
|
|
5322
|
+
PENDING = "PENDING",
|
|
5323
|
+
/** Capture operation succeeded. */
|
|
5324
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5325
|
+
/** Capture operation failed. */
|
|
5326
|
+
FAILED = "FAILED"
|
|
5555
5327
|
}
|
|
5556
|
-
/** @
|
|
5557
|
-
|
|
5558
|
-
|
|
5559
|
-
|
|
5560
|
-
|
|
5561
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5328
|
+
/** @enumType */
|
|
5329
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5330
|
+
interface AuthorizationActionFailureDetails {
|
|
5331
|
+
/** @maxLength 100 */
|
|
5332
|
+
failureCode?: string;
|
|
5562
5333
|
}
|
|
5563
|
-
|
|
5564
|
-
|
|
5565
|
-
|
|
5566
|
-
|
|
5334
|
+
interface AuthorizationVoid {
|
|
5335
|
+
/** Status of this void action */
|
|
5336
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
5337
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5338
|
+
voidedDate?: Date | null;
|
|
5339
|
+
/** In case of status is FAILED may contain failure details */
|
|
5340
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5341
|
+
/** Reason of void action */
|
|
5342
|
+
reason?: ReasonWithLiterals;
|
|
5343
|
+
}
|
|
5344
|
+
declare enum AuthorizationVoidStatus {
|
|
5345
|
+
/** Void operation still in progress. */
|
|
5346
|
+
PENDING = "PENDING",
|
|
5347
|
+
/** Void operation succeeded. */
|
|
5348
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5349
|
+
/** Void operation failed. */
|
|
5350
|
+
FAILED = "FAILED"
|
|
5567
5351
|
}
|
|
5568
5352
|
/** @enumType */
|
|
5569
|
-
type
|
|
5570
|
-
|
|
5571
|
-
|
|
5572
|
-
|
|
5573
|
-
|
|
5574
|
-
|
|
5575
|
-
|
|
5576
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5577
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
5578
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5579
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
5580
|
-
FORBIDDEN = "FORBIDDEN",
|
|
5581
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5582
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5583
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
5353
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5354
|
+
/** Reason the authorization was voided. */
|
|
5355
|
+
declare enum Reason {
|
|
5356
|
+
/** Authorization was voided by user. */
|
|
5357
|
+
MANUAL = "MANUAL",
|
|
5358
|
+
/** Authorization passed execution date. */
|
|
5359
|
+
SCHEDULED = "SCHEDULED"
|
|
5584
5360
|
}
|
|
5585
5361
|
/** @enumType */
|
|
5586
|
-
type
|
|
5587
|
-
|
|
5588
|
-
|
|
5589
|
-
|
|
5590
|
-
|
|
5591
|
-
|
|
5362
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
5363
|
+
interface V1ScheduledAction {
|
|
5364
|
+
/** Type of the action. */
|
|
5365
|
+
actionType?: ActionTypeWithLiterals;
|
|
5366
|
+
/** The date and time of the action. */
|
|
5367
|
+
executionDate?: Date | null;
|
|
5368
|
+
}
|
|
5369
|
+
declare enum ActionType {
|
|
5370
|
+
VOID = "VOID",
|
|
5371
|
+
CAPTURE = "CAPTURE"
|
|
5592
5372
|
}
|
|
5593
5373
|
/** @enumType */
|
|
5594
|
-
type
|
|
5595
|
-
interface
|
|
5374
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5375
|
+
interface Chargeback {
|
|
5596
5376
|
/**
|
|
5597
|
-
*
|
|
5598
|
-
* @
|
|
5599
|
-
* @
|
|
5377
|
+
* Chargeback ID.
|
|
5378
|
+
* @format GUID
|
|
5379
|
+
* @readonly
|
|
5380
|
+
* @immutable
|
|
5600
5381
|
*/
|
|
5601
|
-
|
|
5602
|
-
/** Information about the user who initiated the payment. */
|
|
5603
|
-
chargedBy?: ChargedBy;
|
|
5382
|
+
_id?: string;
|
|
5604
5383
|
/**
|
|
5605
|
-
*
|
|
5606
|
-
*
|
|
5607
|
-
*
|
|
5608
|
-
* @internal
|
|
5384
|
+
* 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.
|
|
5385
|
+
* @readonly
|
|
5386
|
+
* @immutable
|
|
5609
5387
|
*/
|
|
5610
|
-
|
|
5611
|
-
}
|
|
5612
|
-
interface ChargedBy {
|
|
5388
|
+
_createdDate?: Date | null;
|
|
5613
5389
|
/**
|
|
5614
|
-
*
|
|
5615
|
-
* @
|
|
5390
|
+
* 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.
|
|
5391
|
+
* @readonly
|
|
5616
5392
|
*/
|
|
5617
|
-
|
|
5393
|
+
_updatedDate?: Date | null;
|
|
5618
5394
|
/**
|
|
5619
|
-
*
|
|
5620
|
-
* @
|
|
5621
|
-
* @
|
|
5395
|
+
* Amount.
|
|
5396
|
+
* @readonly
|
|
5397
|
+
* @immutable
|
|
5622
5398
|
*/
|
|
5623
|
-
|
|
5624
|
-
}
|
|
5625
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
5626
|
-
/** ID of the order created in the payment gateway */
|
|
5627
|
-
paymentGatewayOrderId?: string;
|
|
5628
|
-
}
|
|
5629
|
-
interface ChargeMembershipsRequest {
|
|
5399
|
+
amount?: Price;
|
|
5630
5400
|
/**
|
|
5631
|
-
*
|
|
5632
|
-
* @
|
|
5633
|
-
* @maxLength 100
|
|
5401
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
5402
|
+
* @readonly
|
|
5634
5403
|
*/
|
|
5635
|
-
|
|
5404
|
+
reversalAmount?: Price;
|
|
5636
5405
|
/**
|
|
5637
|
-
*
|
|
5638
|
-
*
|
|
5639
|
-
*
|
|
5406
|
+
* Status.
|
|
5407
|
+
*
|
|
5408
|
+
* Default: `"APPROVED"`.
|
|
5640
5409
|
*/
|
|
5641
|
-
|
|
5410
|
+
status?: ChargebackStatusWithLiterals;
|
|
5642
5411
|
/**
|
|
5643
|
-
*
|
|
5644
|
-
* @
|
|
5645
|
-
* @
|
|
5412
|
+
* External chargeback ID.
|
|
5413
|
+
* @format GUID
|
|
5414
|
+
* @readonly
|
|
5415
|
+
* @immutable
|
|
5646
5416
|
*/
|
|
5647
|
-
|
|
5417
|
+
externalId?: string | null;
|
|
5648
5418
|
}
|
|
5649
|
-
|
|
5419
|
+
declare enum ChargebackStatus {
|
|
5420
|
+
/** Chargeback was approved. */
|
|
5421
|
+
APPROVED = "APPROVED",
|
|
5422
|
+
/** Chargeback was reversed. */
|
|
5423
|
+
REVERSED = "REVERSED"
|
|
5424
|
+
}
|
|
5425
|
+
/** @enumType */
|
|
5426
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5427
|
+
interface PaymentMethodName {
|
|
5650
5428
|
/**
|
|
5651
|
-
*
|
|
5652
|
-
* @
|
|
5653
|
-
* @maxLength 100
|
|
5429
|
+
* Translated payment method name in buyer language.
|
|
5430
|
+
* @maxLength 150
|
|
5654
5431
|
*/
|
|
5655
|
-
|
|
5432
|
+
buyerLanguageName?: string | null;
|
|
5656
5433
|
/**
|
|
5657
|
-
*
|
|
5658
|
-
* @
|
|
5659
|
-
*/
|
|
5660
|
-
appId?: string;
|
|
5661
|
-
/** The name of used membership */
|
|
5662
|
-
membershipName?: MembershipName;
|
|
5663
|
-
/** Additional data about this membership */
|
|
5664
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
5665
|
-
/** Catalog and item reference info. */
|
|
5666
|
-
catalogReference?: CatalogReference;
|
|
5667
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5668
|
-
serviceProperties?: ServiceProperties;
|
|
5669
|
-
/**
|
|
5670
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
5671
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
5672
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
5673
|
-
* @minLength 1
|
|
5674
|
-
* @maxLength 36
|
|
5434
|
+
* Translated payment method name in site owner language.
|
|
5435
|
+
* @maxLength 150
|
|
5675
5436
|
*/
|
|
5676
|
-
|
|
5437
|
+
siteLanguageName?: string | null;
|
|
5677
5438
|
/**
|
|
5678
|
-
*
|
|
5679
|
-
*
|
|
5680
|
-
*
|
|
5439
|
+
* User-provided payment method name.
|
|
5440
|
+
*
|
|
5441
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5681
5442
|
*/
|
|
5682
|
-
|
|
5443
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
5683
5444
|
}
|
|
5684
|
-
interface
|
|
5445
|
+
interface GiftCardPaymentDetails {
|
|
5685
5446
|
/**
|
|
5686
|
-
*
|
|
5447
|
+
* Gift card payment ID.
|
|
5687
5448
|
* @maxLength 100
|
|
5688
5449
|
*/
|
|
5689
|
-
|
|
5450
|
+
giftCardPaymentId?: string;
|
|
5690
5451
|
/**
|
|
5691
|
-
*
|
|
5692
|
-
* @
|
|
5452
|
+
* Gift card ID.
|
|
5453
|
+
* @internal
|
|
5454
|
+
* @deprecated
|
|
5693
5455
|
*/
|
|
5694
|
-
|
|
5695
|
-
}
|
|
5696
|
-
interface ServiceProperties {
|
|
5456
|
+
giftCardId?: string;
|
|
5697
5457
|
/**
|
|
5698
|
-
*
|
|
5699
|
-
*
|
|
5458
|
+
* ID of the app that created the gift card.
|
|
5459
|
+
* @format GUID
|
|
5700
5460
|
*/
|
|
5701
|
-
|
|
5461
|
+
appId?: string;
|
|
5702
5462
|
/**
|
|
5703
|
-
*
|
|
5704
|
-
* @
|
|
5705
|
-
* @max 10000
|
|
5463
|
+
* Whether the gift card is voided.
|
|
5464
|
+
* @readonly
|
|
5706
5465
|
*/
|
|
5707
|
-
|
|
5466
|
+
voided?: boolean;
|
|
5708
5467
|
/**
|
|
5709
|
-
*
|
|
5710
|
-
* For example, the date and time a class will end.
|
|
5468
|
+
* Gift card obfuscated code.
|
|
5711
5469
|
* @internal
|
|
5470
|
+
* @maxLength 30
|
|
5471
|
+
* @immutable
|
|
5712
5472
|
*/
|
|
5713
|
-
|
|
5714
|
-
}
|
|
5715
|
-
interface ChargeMembershipsResponse {
|
|
5473
|
+
obfuscatedCode?: string | null;
|
|
5716
5474
|
}
|
|
5717
|
-
interface
|
|
5475
|
+
interface MembershipPaymentDetails {
|
|
5718
5476
|
/**
|
|
5719
|
-
*
|
|
5720
|
-
* @minLength 1
|
|
5477
|
+
* Membership ID.
|
|
5721
5478
|
* @maxLength 100
|
|
5722
5479
|
*/
|
|
5723
|
-
|
|
5724
|
-
/**
|
|
5725
|
-
* Refund operations information
|
|
5726
|
-
* @minSize 1
|
|
5727
|
-
* @maxSize 1
|
|
5728
|
-
*/
|
|
5729
|
-
payments: PaymentRefund[];
|
|
5730
|
-
/** Business model of a refund */
|
|
5731
|
-
details?: RefundDetails;
|
|
5732
|
-
/** Side effect details related to refund */
|
|
5733
|
-
sideEffects?: RefundSideEffects;
|
|
5734
|
-
}
|
|
5735
|
-
interface PaymentRefund {
|
|
5736
|
-
/**
|
|
5737
|
-
* Specific payment within the order to refund
|
|
5738
|
-
* @format GUID
|
|
5739
|
-
*/
|
|
5740
|
-
paymentId?: string;
|
|
5741
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5742
|
-
amount?: Price;
|
|
5743
|
-
/**
|
|
5744
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5745
|
-
* 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.
|
|
5746
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5747
|
-
*/
|
|
5748
|
-
externalRefund?: boolean;
|
|
5480
|
+
membershipId?: string;
|
|
5749
5481
|
/**
|
|
5750
|
-
*
|
|
5751
|
-
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
5752
|
-
* and all side effects from request will be executed.
|
|
5753
|
-
* @internal
|
|
5482
|
+
* ID of the line item this membership applies to.
|
|
5754
5483
|
* @minLength 1
|
|
5755
5484
|
* @maxLength 100
|
|
5756
5485
|
*/
|
|
5757
|
-
|
|
5758
|
-
|
|
5759
|
-
|
|
5760
|
-
/**
|
|
5761
|
-
|
|
5762
|
-
/** Whether to send a refund confirmation email to the customer. */
|
|
5763
|
-
sendOrderRefundedEmail?: boolean;
|
|
5486
|
+
lineItemId?: string;
|
|
5487
|
+
/** Payment status. */
|
|
5488
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
5489
|
+
/** Membership name. */
|
|
5490
|
+
name?: MembershipName;
|
|
5764
5491
|
/**
|
|
5765
|
-
*
|
|
5492
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
5766
5493
|
* @minLength 1
|
|
5767
|
-
* @maxLength
|
|
5494
|
+
* @maxLength 100
|
|
5768
5495
|
*/
|
|
5769
|
-
|
|
5770
|
-
}
|
|
5771
|
-
interface RestockInfo {
|
|
5772
|
-
/** Restock type. */
|
|
5773
|
-
type?: RestockTypeWithLiterals;
|
|
5496
|
+
externalTransactionId?: string | null;
|
|
5774
5497
|
/**
|
|
5775
|
-
*
|
|
5776
|
-
* @
|
|
5777
|
-
* @maxSize 300
|
|
5778
|
-
* @deprecated
|
|
5498
|
+
* Whether the membership is voided.
|
|
5499
|
+
* @readonly
|
|
5779
5500
|
*/
|
|
5780
|
-
|
|
5501
|
+
voided?: boolean;
|
|
5781
5502
|
/**
|
|
5782
|
-
*
|
|
5783
|
-
* @
|
|
5503
|
+
* ID of the application providing this payment option.
|
|
5504
|
+
* @format GUID
|
|
5784
5505
|
*/
|
|
5785
|
-
|
|
5506
|
+
providerAppId?: string;
|
|
5507
|
+
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
5508
|
+
futureMembership?: FutureMembershipDetails;
|
|
5786
5509
|
}
|
|
5787
|
-
declare enum
|
|
5788
|
-
|
|
5789
|
-
|
|
5790
|
-
|
|
5510
|
+
declare enum MembershipPaymentStatus {
|
|
5511
|
+
/** Payment was charged. */
|
|
5512
|
+
CHARGED = "CHARGED",
|
|
5513
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5514
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5515
|
+
/** Payment is pending. */
|
|
5516
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5517
|
+
/** Payment was voided. */
|
|
5518
|
+
VOIDED = "VOIDED"
|
|
5791
5519
|
}
|
|
5792
5520
|
/** @enumType */
|
|
5793
|
-
type
|
|
5794
|
-
interface
|
|
5521
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
5522
|
+
interface FutureMembershipDetails {
|
|
5795
5523
|
/**
|
|
5796
|
-
* ID of the line item
|
|
5524
|
+
* ID of the plan line item in the order from which the membership will be created.
|
|
5797
5525
|
* @format GUID
|
|
5798
5526
|
*/
|
|
5799
5527
|
lineItemId?: string;
|
|
5800
5528
|
/**
|
|
5801
|
-
*
|
|
5802
|
-
* @
|
|
5803
|
-
* @max 100000
|
|
5804
|
-
*/
|
|
5805
|
-
quantity?: number;
|
|
5806
|
-
/**
|
|
5807
|
-
* Per-location breakdown of restock quantities.
|
|
5808
|
-
* @internal
|
|
5809
|
-
* @maxSize 5
|
|
5529
|
+
* ID of the benefit the future membership will grant.
|
|
5530
|
+
* @maxLength 200
|
|
5810
5531
|
*/
|
|
5811
|
-
|
|
5812
|
-
}
|
|
5813
|
-
interface TriggerRefundResponse {
|
|
5814
|
-
/** All order's transactions after the refunds were added */
|
|
5815
|
-
orderTransactions?: OrderTransactions;
|
|
5816
|
-
/** Created refund ID */
|
|
5817
|
-
refundId?: string | null;
|
|
5818
|
-
/** Payment ID's that the refund execution had failed for */
|
|
5819
|
-
failedPaymentIds?: ItemMetadata[];
|
|
5532
|
+
benefitId?: string;
|
|
5820
5533
|
}
|
|
5821
|
-
|
|
5822
|
-
* A record of all payments and refunds associated with an order.
|
|
5823
|
-
*
|
|
5824
|
-
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5825
|
-
*/
|
|
5826
|
-
interface OrderTransactions {
|
|
5534
|
+
interface WixReceiptInfo {
|
|
5827
5535
|
/**
|
|
5828
|
-
*
|
|
5536
|
+
* Receipt ID
|
|
5829
5537
|
* @format GUID
|
|
5830
5538
|
*/
|
|
5831
|
-
|
|
5832
|
-
/**
|
|
5833
|
-
* Record of payments made to the merchant.
|
|
5834
|
-
* @maxSize 100
|
|
5835
|
-
*/
|
|
5836
|
-
payments?: Payment[];
|
|
5539
|
+
receiptId?: string;
|
|
5837
5540
|
/**
|
|
5838
|
-
*
|
|
5839
|
-
* @
|
|
5541
|
+
* Display number of receipt
|
|
5542
|
+
* @minLength 1
|
|
5543
|
+
* @maxLength 40
|
|
5840
5544
|
*/
|
|
5841
|
-
|
|
5545
|
+
displayNumber?: string | null;
|
|
5842
5546
|
}
|
|
5843
|
-
interface
|
|
5844
|
-
/** Regular payment details. */
|
|
5845
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
5846
|
-
/** Gift card payment details. */
|
|
5847
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5547
|
+
interface ExternalReceiptInfo {
|
|
5848
5548
|
/**
|
|
5849
|
-
*
|
|
5850
|
-
* @
|
|
5549
|
+
* External receipt ID
|
|
5550
|
+
* @maxLength 100
|
|
5851
5551
|
*/
|
|
5852
|
-
|
|
5552
|
+
receiptId?: string | null;
|
|
5853
5553
|
/**
|
|
5854
|
-
*
|
|
5855
|
-
* @
|
|
5554
|
+
* ID of the app providing the receipt
|
|
5555
|
+
* @format GUID
|
|
5856
5556
|
*/
|
|
5857
|
-
|
|
5557
|
+
appId?: string | null;
|
|
5858
5558
|
/**
|
|
5859
|
-
*
|
|
5860
|
-
* @
|
|
5559
|
+
* Display number of receipt
|
|
5560
|
+
* @minLength 1
|
|
5561
|
+
* @maxLength 40
|
|
5861
5562
|
*/
|
|
5862
|
-
|
|
5863
|
-
|
|
5864
|
-
|
|
5865
|
-
/** @internal */
|
|
5866
|
-
declined?: DeclinedStatusDetails;
|
|
5867
|
-
/** @internal */
|
|
5868
|
-
voided?: VoidedStatusDetails;
|
|
5563
|
+
displayNumber?: string | null;
|
|
5564
|
+
}
|
|
5565
|
+
interface CashRoundingDetails {
|
|
5869
5566
|
/**
|
|
5870
|
-
* Payment
|
|
5871
|
-
*
|
|
5872
|
-
*
|
|
5567
|
+
* Payment amount before cash rounding was applied.
|
|
5568
|
+
* When provided, balance and status calculations use this value instead of `amount`
|
|
5569
|
+
* to prevent false overpayment or underpayment due to rounding.
|
|
5873
5570
|
*/
|
|
5874
|
-
|
|
5875
|
-
/** 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. */
|
|
5876
|
-
_createdDate?: Date | null;
|
|
5571
|
+
unroundedAmount?: Price;
|
|
5877
5572
|
/**
|
|
5878
|
-
*
|
|
5573
|
+
* The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
|
|
5574
|
+
* A positive value indicates the price was rounded up; a negative value indicates a round-down.
|
|
5879
5575
|
* @readonly
|
|
5880
5576
|
*/
|
|
5881
|
-
|
|
5882
|
-
/** Payment amount. */
|
|
5883
|
-
amount?: Price;
|
|
5884
|
-
/**
|
|
5885
|
-
* Whether refunds for this payment are disabled.
|
|
5886
|
-
* + `true`: This payment is not refundable.
|
|
5887
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5888
|
-
*/
|
|
5889
|
-
refundDisabled?: boolean;
|
|
5890
|
-
/**
|
|
5891
|
-
* Whether receipt generation for this payment are allowed.
|
|
5892
|
-
* + `true`: This payment supports receipt generation.
|
|
5893
|
-
* + `false`: This payment not supports receipt generation, or receipt already generated
|
|
5894
|
-
* @internal
|
|
5895
|
-
* @readonly
|
|
5896
|
-
*/
|
|
5897
|
-
supportReceiptGeneration?: boolean;
|
|
5898
|
-
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5899
|
-
cashRounding?: CashRoundingDetails;
|
|
5900
|
-
/** @internal */
|
|
5901
|
-
status?: PaymentStatusWithLiterals;
|
|
5902
|
-
/**
|
|
5903
|
-
* Detailed payment status information including gateway reason codes and status-specific details.
|
|
5904
|
-
* @internal
|
|
5905
|
-
*/
|
|
5906
|
-
paymentStatusDetails?: PaymentStatusDetails;
|
|
5907
|
-
/**
|
|
5908
|
-
* Location where the payment was processed.
|
|
5909
|
-
* @internal
|
|
5910
|
-
* @format GUID
|
|
5911
|
-
* @immutable
|
|
5912
|
-
*/
|
|
5913
|
-
locationId?: string | null;
|
|
5914
|
-
/**
|
|
5915
|
-
* ID linking this payment to the charge request that created it.
|
|
5916
|
-
* @internal
|
|
5917
|
-
* @format GUID
|
|
5918
|
-
*/
|
|
5919
|
-
chargeCorrelationId?: string | null;
|
|
5577
|
+
roundingAdjustment?: CashRounding;
|
|
5920
5578
|
}
|
|
5921
|
-
|
|
5922
|
-
|
|
5923
|
-
|
|
5924
|
-
|
|
5925
|
-
|
|
5926
|
-
|
|
5927
|
-
|
|
5928
|
-
|
|
5929
|
-
|
|
5930
|
-
|
|
5931
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5579
|
+
declare enum PaymentStatus {
|
|
5580
|
+
APPROVED = "APPROVED",
|
|
5581
|
+
PENDING = "PENDING",
|
|
5582
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5583
|
+
CANCELED = "CANCELED",
|
|
5584
|
+
DECLINED = "DECLINED",
|
|
5585
|
+
REFUNDED = "REFUNDED",
|
|
5586
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5587
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5588
|
+
VOIDED = "VOIDED"
|
|
5932
5589
|
}
|
|
5933
|
-
/** @
|
|
5934
|
-
|
|
5935
|
-
|
|
5936
|
-
|
|
5937
|
-
|
|
5938
|
-
|
|
5939
|
-
|
|
5590
|
+
/** @enumType */
|
|
5591
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5592
|
+
interface CanceledStatusDetails {
|
|
5593
|
+
reason?: CanceledReasonWithLiterals;
|
|
5594
|
+
}
|
|
5595
|
+
declare enum CanceledReason {
|
|
5596
|
+
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
5597
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
5598
|
+
/** Payment was not completed by user and expired. */
|
|
5599
|
+
EXPIRED = "EXPIRED"
|
|
5600
|
+
}
|
|
5601
|
+
/** @enumType */
|
|
5602
|
+
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
5603
|
+
interface DeclinedStatusDetails {
|
|
5604
|
+
reason?: DeclinedReasonWithLiterals;
|
|
5605
|
+
}
|
|
5606
|
+
declare enum DeclinedReason {
|
|
5607
|
+
/** Corresponding charge failed. */
|
|
5608
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5609
|
+
/** Payment details expired. */
|
|
5610
|
+
EXPIRED = "EXPIRED",
|
|
5611
|
+
/** Insufficient funds. */
|
|
5612
|
+
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
5613
|
+
/** Gift card was disabled before charge was attempted. */
|
|
5614
|
+
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
5615
|
+
}
|
|
5616
|
+
/** @enumType */
|
|
5617
|
+
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
5618
|
+
interface VoidedStatusDetails {
|
|
5619
|
+
reason?: VoidedReasonWithLiterals;
|
|
5620
|
+
}
|
|
5621
|
+
declare enum VoidedReason {
|
|
5622
|
+
/** Payment was voided by merchant request. */
|
|
5623
|
+
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
5624
|
+
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
5625
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
5626
|
+
}
|
|
5627
|
+
/** @enumType */
|
|
5628
|
+
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
5629
|
+
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
5630
|
+
/** @internal */
|
|
5631
|
+
canceled?: CanceledStatusDetails;
|
|
5632
|
+
/** @internal */
|
|
5633
|
+
declined?: DeclinedStatusDetails;
|
|
5634
|
+
/** @internal */
|
|
5635
|
+
voided?: VoidedStatusDetails;
|
|
5940
5636
|
/**
|
|
5941
|
-
*
|
|
5637
|
+
* Reason code from the payment gateway.
|
|
5942
5638
|
* @internal
|
|
5639
|
+
* @minLength 1
|
|
5640
|
+
* @maxLength 10
|
|
5943
5641
|
*/
|
|
5944
|
-
|
|
5642
|
+
paymentGatewayReasonCode?: string | null;
|
|
5945
5643
|
}
|
|
5946
5644
|
/** @oneof */
|
|
5947
|
-
interface
|
|
5645
|
+
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
5948
5646
|
/** @internal */
|
|
5949
5647
|
canceled?: CanceledStatusDetails;
|
|
5950
5648
|
/** @internal */
|
|
@@ -5952,745 +5650,1047 @@ interface PaymentStatusDetailsOneOf {
|
|
|
5952
5650
|
/** @internal */
|
|
5953
5651
|
voided?: VoidedStatusDetails;
|
|
5954
5652
|
}
|
|
5955
|
-
interface
|
|
5956
|
-
/** Credit card details. */
|
|
5957
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5653
|
+
interface Refund {
|
|
5958
5654
|
/**
|
|
5959
|
-
*
|
|
5960
|
-
* @
|
|
5655
|
+
* Refund ID.
|
|
5656
|
+
* @format GUID
|
|
5657
|
+
* @readonly
|
|
5961
5658
|
*/
|
|
5962
|
-
|
|
5659
|
+
_id?: string;
|
|
5963
5660
|
/**
|
|
5964
|
-
*
|
|
5965
|
-
*
|
|
5966
|
-
* @maxLength 100
|
|
5661
|
+
* List of transactions.
|
|
5662
|
+
* @maxSize 50
|
|
5967
5663
|
*/
|
|
5968
|
-
|
|
5664
|
+
transactions?: RefundTransaction[];
|
|
5665
|
+
/** Refund business details. */
|
|
5666
|
+
details?: RefundDetails;
|
|
5969
5667
|
/**
|
|
5970
|
-
*
|
|
5971
|
-
*
|
|
5972
|
-
*
|
|
5973
|
-
* + `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`
|
|
5974
|
-
* @maxLength 150
|
|
5975
|
-
* @deprecated Payment method.
|
|
5976
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5977
|
-
* Non-exhaustive list of supported values:
|
|
5978
|
-
* + `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`
|
|
5979
|
-
* @replacedBy payment_method_name
|
|
5980
|
-
* @targetRemovalDate 2026-07-01
|
|
5668
|
+
* 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.
|
|
5669
|
+
* @readonly
|
|
5670
|
+
* @immutable
|
|
5981
5671
|
*/
|
|
5982
|
-
|
|
5672
|
+
_createdDate?: Date | null;
|
|
5983
5673
|
/**
|
|
5984
|
-
*
|
|
5985
|
-
* @
|
|
5674
|
+
* Aggregated refund summary.
|
|
5675
|
+
* @readonly
|
|
5986
5676
|
*/
|
|
5987
|
-
|
|
5988
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5989
|
-
offlinePayment?: boolean;
|
|
5990
|
-
/** Payment status. */
|
|
5991
|
-
status?: TransactionStatusWithLiterals;
|
|
5992
|
-
/** Whether there is a payment agreement that allows for future charges. */
|
|
5993
|
-
savedPaymentMethod?: boolean;
|
|
5994
|
-
/** Authorization details. */
|
|
5995
|
-
authorizationDetails?: AuthorizationDetails;
|
|
5677
|
+
summary?: AggregatedRefundSummary;
|
|
5996
5678
|
/**
|
|
5997
|
-
*
|
|
5998
|
-
* @
|
|
5999
|
-
* @
|
|
5679
|
+
* ID of the app that initiated this refund.
|
|
5680
|
+
* @format GUID
|
|
5681
|
+
* @readonly
|
|
5682
|
+
* @immutable
|
|
6000
5683
|
*/
|
|
6001
|
-
|
|
5684
|
+
requestingServiceAppId?: string | null;
|
|
5685
|
+
}
|
|
5686
|
+
interface RefundTransaction {
|
|
6002
5687
|
/**
|
|
6003
|
-
*
|
|
6004
|
-
* @
|
|
5688
|
+
* ID of the payment associated with this refund.
|
|
5689
|
+
* @format GUID
|
|
5690
|
+
* @immutable
|
|
6005
5691
|
*/
|
|
6006
|
-
|
|
5692
|
+
paymentId?: string;
|
|
6007
5693
|
/**
|
|
6008
|
-
*
|
|
6009
|
-
* @
|
|
6010
|
-
* @maxLength 36
|
|
5694
|
+
* Refund amount.
|
|
5695
|
+
* @immutable
|
|
6011
5696
|
*/
|
|
6012
|
-
|
|
6013
|
-
/**
|
|
6014
|
-
|
|
5697
|
+
amount?: Price;
|
|
5698
|
+
/** Refund status. */
|
|
5699
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
5700
|
+
/** Optional details of current refund status. */
|
|
5701
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
6015
5702
|
/**
|
|
6016
|
-
* Payment
|
|
6017
|
-
*
|
|
6018
|
-
*
|
|
5703
|
+
* Payment gateway's refund ID.
|
|
5704
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
5705
|
+
* @format GUID
|
|
6019
5706
|
*/
|
|
6020
|
-
|
|
6021
|
-
|
|
6022
|
-
|
|
6023
|
-
|
|
6024
|
-
|
|
6025
|
-
|
|
5707
|
+
gatewayRefundId?: string | null;
|
|
5708
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5709
|
+
providerRefundId?: string | null;
|
|
5710
|
+
/**
|
|
5711
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
5712
|
+
* @immutable
|
|
5713
|
+
*/
|
|
5714
|
+
externalRefund?: boolean;
|
|
5715
|
+
/**
|
|
5716
|
+
* Location where the refund was processed.
|
|
5717
|
+
* @internal
|
|
5718
|
+
* @format GUID
|
|
5719
|
+
* @immutable
|
|
5720
|
+
*/
|
|
5721
|
+
locationId?: string | null;
|
|
6026
5722
|
}
|
|
6027
|
-
|
|
6028
|
-
|
|
6029
|
-
|
|
5723
|
+
/** Refund transaction status. */
|
|
5724
|
+
declare enum RefundStatus {
|
|
5725
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
6030
5726
|
PENDING = "PENDING",
|
|
6031
|
-
|
|
6032
|
-
|
|
6033
|
-
|
|
6034
|
-
|
|
6035
|
-
|
|
6036
|
-
|
|
6037
|
-
|
|
5727
|
+
/** Refund transaction succeeded. */
|
|
5728
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5729
|
+
/** Refund transaction failed. */
|
|
5730
|
+
FAILED = "FAILED",
|
|
5731
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
5732
|
+
SCHEDULED = "SCHEDULED",
|
|
5733
|
+
/** Refund was initiated on payment provider side. */
|
|
5734
|
+
STARTED = "STARTED"
|
|
6038
5735
|
}
|
|
6039
5736
|
/** @enumType */
|
|
6040
|
-
type
|
|
6041
|
-
interface
|
|
5737
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5738
|
+
interface RefundStatusInfo {
|
|
6042
5739
|
/**
|
|
6043
|
-
*
|
|
6044
|
-
*
|
|
5740
|
+
* Reason code for the refund's current status.
|
|
5741
|
+
*
|
|
5742
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5743
|
+
* @minLength 1
|
|
5744
|
+
* @maxLength 10
|
|
6045
5745
|
*/
|
|
6046
|
-
|
|
5746
|
+
paymentGatewayReasonCode?: string | null;
|
|
6047
5747
|
/**
|
|
6048
|
-
*
|
|
6049
|
-
* @
|
|
5748
|
+
* Free text explanation of current refund status.
|
|
5749
|
+
* @minLength 1
|
|
5750
|
+
* @maxLength 1000
|
|
6050
5751
|
*/
|
|
6051
|
-
|
|
5752
|
+
description?: string | null;
|
|
6052
5753
|
}
|
|
6053
|
-
interface
|
|
5754
|
+
interface AggregatedRefundSummary {
|
|
5755
|
+
/** Total amount requested for refund. */
|
|
5756
|
+
requestedRefund?: Price;
|
|
5757
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5758
|
+
pendingRefund?: Price;
|
|
5759
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5760
|
+
refunded?: Price;
|
|
5761
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5762
|
+
failedRefundAmount?: Price;
|
|
5763
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5764
|
+
pending?: boolean;
|
|
5765
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5766
|
+
breakdown?: RefundItemsBreakdown;
|
|
5767
|
+
}
|
|
5768
|
+
interface RefundItemsBreakdown {
|
|
6054
5769
|
/**
|
|
6055
|
-
*
|
|
6056
|
-
* @
|
|
5770
|
+
* Refunded line items and the amount refunded for each.
|
|
5771
|
+
* @maxSize 300
|
|
6057
5772
|
*/
|
|
6058
|
-
|
|
6059
|
-
|
|
6060
|
-
|
|
5773
|
+
lineItems?: LineItemRefundSummary[];
|
|
5774
|
+
}
|
|
5775
|
+
interface LineItemRefundSummary {
|
|
6061
5776
|
/**
|
|
6062
|
-
*
|
|
6063
|
-
*
|
|
6064
|
-
* @maxSize 1
|
|
5777
|
+
* ID of the refunded line item.
|
|
5778
|
+
* @format GUID
|
|
6065
5779
|
*/
|
|
6066
|
-
|
|
6067
|
-
/**
|
|
6068
|
-
|
|
6069
|
-
/** Scheduled action for this transaction */
|
|
6070
|
-
scheduledAction?: V1ScheduledAction;
|
|
5780
|
+
lineItemId?: string;
|
|
5781
|
+
/** Total refunded amount for the line item. */
|
|
5782
|
+
totalRefundedAmount?: Price;
|
|
6071
5783
|
}
|
|
6072
|
-
interface
|
|
5784
|
+
interface CalculateRefundRequest {
|
|
6073
5785
|
/**
|
|
6074
|
-
*
|
|
6075
|
-
* @
|
|
6076
|
-
* @
|
|
5786
|
+
* Order ID
|
|
5787
|
+
* @minLength 1
|
|
5788
|
+
* @maxLength 100
|
|
6077
5789
|
*/
|
|
6078
|
-
|
|
6079
|
-
/** Status of this capture action */
|
|
6080
|
-
status?: AuthorizationCaptureStatusWithLiterals;
|
|
5790
|
+
ecomOrderId?: string;
|
|
6081
5791
|
/**
|
|
6082
|
-
*
|
|
6083
|
-
* @
|
|
5792
|
+
* Refunded line items and quantity
|
|
5793
|
+
* @maxSize 300
|
|
6084
5794
|
*/
|
|
6085
|
-
|
|
6086
|
-
/**
|
|
6087
|
-
|
|
6088
|
-
/** In case of status is FAILED may contain failure details */
|
|
6089
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
6090
|
-
}
|
|
6091
|
-
declare enum AuthorizationCaptureStatus {
|
|
6092
|
-
/** Capture operation still in progress. */
|
|
6093
|
-
PENDING = "PENDING",
|
|
6094
|
-
/** Capture operation succeeded. */
|
|
6095
|
-
SUCCEEDED = "SUCCEEDED",
|
|
6096
|
-
/** Capture operation failed. */
|
|
6097
|
-
FAILED = "FAILED"
|
|
6098
|
-
}
|
|
6099
|
-
/** @enumType */
|
|
6100
|
-
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
6101
|
-
interface AuthorizationActionFailureDetails {
|
|
6102
|
-
/** @maxLength 100 */
|
|
6103
|
-
failureCode?: string;
|
|
6104
|
-
}
|
|
6105
|
-
interface AuthorizationVoid {
|
|
6106
|
-
/** Status of this void action */
|
|
6107
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
6108
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6109
|
-
voidedDate?: Date | null;
|
|
6110
|
-
/** In case of status is FAILED may contain failure details */
|
|
6111
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
6112
|
-
/** Reason of void action */
|
|
6113
|
-
reason?: ReasonWithLiterals;
|
|
6114
|
-
}
|
|
6115
|
-
declare enum AuthorizationVoidStatus {
|
|
6116
|
-
/** Void operation still in progress. */
|
|
6117
|
-
PENDING = "PENDING",
|
|
6118
|
-
/** Void operation succeeded. */
|
|
6119
|
-
SUCCEEDED = "SUCCEEDED",
|
|
6120
|
-
/** Void operation failed. */
|
|
6121
|
-
FAILED = "FAILED"
|
|
6122
|
-
}
|
|
6123
|
-
/** @enumType */
|
|
6124
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
6125
|
-
/** Reason the authorization was voided. */
|
|
6126
|
-
declare enum Reason {
|
|
6127
|
-
/** Authorization was voided by user. */
|
|
6128
|
-
MANUAL = "MANUAL",
|
|
6129
|
-
/** Authorization passed execution date. */
|
|
6130
|
-
SCHEDULED = "SCHEDULED"
|
|
6131
|
-
}
|
|
6132
|
-
/** @enumType */
|
|
6133
|
-
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
6134
|
-
interface V1ScheduledAction {
|
|
6135
|
-
/** Type of the action. */
|
|
6136
|
-
actionType?: ActionTypeWithLiterals;
|
|
6137
|
-
/** The date and time of the action. */
|
|
6138
|
-
executionDate?: Date | null;
|
|
6139
|
-
}
|
|
6140
|
-
declare enum ActionType {
|
|
6141
|
-
VOID = "VOID",
|
|
6142
|
-
CAPTURE = "CAPTURE"
|
|
5795
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
5796
|
+
/** Should include shipping in refund calculation */
|
|
5797
|
+
refundShipping?: boolean;
|
|
6143
5798
|
}
|
|
6144
|
-
|
|
6145
|
-
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
6146
|
-
interface Chargeback {
|
|
5799
|
+
interface CalculateRefundItemRequest {
|
|
6147
5800
|
/**
|
|
6148
|
-
*
|
|
5801
|
+
* ID of the line item being refunded
|
|
6149
5802
|
* @format GUID
|
|
6150
|
-
* @readonly
|
|
6151
|
-
* @immutable
|
|
6152
5803
|
*/
|
|
6153
5804
|
_id?: string;
|
|
6154
5805
|
/**
|
|
6155
|
-
*
|
|
6156
|
-
* @
|
|
6157
|
-
* @
|
|
6158
|
-
*/
|
|
6159
|
-
_createdDate?: Date | null;
|
|
6160
|
-
/**
|
|
6161
|
-
* 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.
|
|
6162
|
-
* @readonly
|
|
6163
|
-
*/
|
|
6164
|
-
_updatedDate?: Date | null;
|
|
6165
|
-
/**
|
|
6166
|
-
* Amount.
|
|
6167
|
-
* @readonly
|
|
6168
|
-
* @immutable
|
|
6169
|
-
*/
|
|
6170
|
-
amount?: Price;
|
|
6171
|
-
/**
|
|
6172
|
-
* Reversal amount. Present only when status is REVERSED.
|
|
6173
|
-
* @readonly
|
|
5806
|
+
* How much of that line item is being refunded
|
|
5807
|
+
* @min 1
|
|
5808
|
+
* @max 100000
|
|
6174
5809
|
*/
|
|
6175
|
-
|
|
5810
|
+
quantity?: number;
|
|
5811
|
+
}
|
|
5812
|
+
interface CalculateRefundResponse {
|
|
5813
|
+
/** Total refundable amount */
|
|
5814
|
+
total?: Price;
|
|
5815
|
+
/** Tax cost of the order */
|
|
5816
|
+
tax?: Price;
|
|
5817
|
+
/** Discount given for this order */
|
|
5818
|
+
discount?: Price;
|
|
5819
|
+
/** Total cost of the order (without tax) */
|
|
5820
|
+
subtotal?: Price;
|
|
5821
|
+
/** Total shipping cost for order */
|
|
5822
|
+
shipping?: Price;
|
|
5823
|
+
/** Previous refund given on that order */
|
|
5824
|
+
previouslyRefundedAmount?: Price;
|
|
6176
5825
|
/**
|
|
6177
|
-
*
|
|
6178
|
-
*
|
|
6179
|
-
* Default: `"APPROVED"`.
|
|
5826
|
+
* The refundable items of that order
|
|
5827
|
+
* @maxSize 300
|
|
6180
5828
|
*/
|
|
6181
|
-
|
|
5829
|
+
items?: CalculateRefundItemResponse[];
|
|
5830
|
+
}
|
|
5831
|
+
interface CalculateRefundItemResponse {
|
|
6182
5832
|
/**
|
|
6183
|
-
*
|
|
5833
|
+
* Line item ID
|
|
6184
5834
|
* @format GUID
|
|
6185
|
-
* @readonly
|
|
6186
|
-
* @immutable
|
|
6187
5835
|
*/
|
|
6188
|
-
|
|
6189
|
-
|
|
6190
|
-
|
|
6191
|
-
/** Chargeback was approved. */
|
|
6192
|
-
APPROVED = "APPROVED",
|
|
6193
|
-
/** Chargeback was reversed. */
|
|
6194
|
-
REVERSED = "REVERSED"
|
|
5836
|
+
_id?: string;
|
|
5837
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
5838
|
+
price?: Price;
|
|
6195
5839
|
}
|
|
6196
|
-
|
|
6197
|
-
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
6198
|
-
interface PaymentMethodName {
|
|
6199
|
-
/**
|
|
6200
|
-
* Translated payment method name in buyer language.
|
|
6201
|
-
* @maxLength 150
|
|
6202
|
-
*/
|
|
6203
|
-
buyerLanguageName?: string | null;
|
|
5840
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
6204
5841
|
/**
|
|
6205
|
-
*
|
|
6206
|
-
* @
|
|
5842
|
+
* Wix eCommerce order ID
|
|
5843
|
+
* @minLength 1
|
|
5844
|
+
* @maxLength 100
|
|
6207
5845
|
*/
|
|
6208
|
-
|
|
5846
|
+
ecomOrderId: string;
|
|
6209
5847
|
/**
|
|
6210
|
-
*
|
|
6211
|
-
*
|
|
6212
|
-
*
|
|
5848
|
+
* Payment IDs
|
|
5849
|
+
* @minSize 1
|
|
5850
|
+
* @maxSize 100
|
|
5851
|
+
* @format GUID
|
|
6213
5852
|
*/
|
|
6214
|
-
|
|
5853
|
+
paymentIds: string[];
|
|
6215
5854
|
}
|
|
6216
|
-
interface
|
|
5855
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
5856
|
+
/** All order's transactions after the void was triggered */
|
|
5857
|
+
orderTransactions?: OrderTransactions;
|
|
5858
|
+
}
|
|
5859
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
6217
5860
|
/**
|
|
6218
|
-
*
|
|
5861
|
+
* Wix eCommerce order ID
|
|
5862
|
+
* @minLength 1
|
|
6219
5863
|
* @maxLength 100
|
|
6220
5864
|
*/
|
|
6221
|
-
|
|
5865
|
+
ecomOrderId: string;
|
|
6222
5866
|
/**
|
|
6223
|
-
*
|
|
6224
|
-
* @
|
|
6225
|
-
* @
|
|
5867
|
+
* Capture payments information
|
|
5868
|
+
* @minSize 1
|
|
5869
|
+
* @maxSize 100
|
|
6226
5870
|
*/
|
|
6227
|
-
|
|
5871
|
+
payments: PaymentCapture[];
|
|
5872
|
+
}
|
|
5873
|
+
interface PaymentCapture {
|
|
6228
5874
|
/**
|
|
6229
|
-
* ID
|
|
5875
|
+
* Payment ID
|
|
6230
5876
|
* @format GUID
|
|
6231
5877
|
*/
|
|
6232
|
-
|
|
6233
|
-
/**
|
|
6234
|
-
* Whether the gift card is voided.
|
|
6235
|
-
* @readonly
|
|
6236
|
-
*/
|
|
6237
|
-
voided?: boolean;
|
|
5878
|
+
paymentId?: string | null;
|
|
6238
5879
|
/**
|
|
6239
|
-
*
|
|
6240
|
-
*
|
|
6241
|
-
* @maxLength 30
|
|
6242
|
-
* @immutable
|
|
5880
|
+
* Capture amount.
|
|
5881
|
+
* If not provided - full authorized amount will be captured.
|
|
6243
5882
|
*/
|
|
6244
|
-
|
|
5883
|
+
amount?: Price;
|
|
6245
5884
|
}
|
|
6246
|
-
interface
|
|
5885
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
5886
|
+
/** All order's transactions after the capture was triggered */
|
|
5887
|
+
orderTransactions?: OrderTransactions;
|
|
5888
|
+
}
|
|
5889
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
6247
5890
|
/**
|
|
6248
|
-
*
|
|
5891
|
+
* Ecom Order ID.
|
|
5892
|
+
* @minLength 1
|
|
6249
5893
|
* @maxLength 100
|
|
6250
5894
|
*/
|
|
6251
|
-
|
|
5895
|
+
ecomOrderId?: string;
|
|
5896
|
+
/** Amount to be charged */
|
|
5897
|
+
amount?: Price;
|
|
5898
|
+
}
|
|
5899
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
5900
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
5901
|
+
paymentGatewayOrderId?: string;
|
|
5902
|
+
}
|
|
5903
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
5904
|
+
/** @format GUID */
|
|
5905
|
+
orderId?: string;
|
|
5906
|
+
}
|
|
5907
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
5908
|
+
}
|
|
5909
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
6252
5910
|
/**
|
|
6253
|
-
* ID of the line item this membership applies to.
|
|
6254
5911
|
* @minLength 1
|
|
6255
5912
|
* @maxLength 100
|
|
6256
5913
|
*/
|
|
6257
|
-
|
|
6258
|
-
|
|
6259
|
-
|
|
6260
|
-
|
|
6261
|
-
|
|
5914
|
+
orderId?: string;
|
|
5915
|
+
}
|
|
5916
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
5917
|
+
}
|
|
5918
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
6262
5919
|
/**
|
|
6263
|
-
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
6264
5920
|
* @minLength 1
|
|
6265
5921
|
* @maxLength 100
|
|
6266
5922
|
*/
|
|
6267
|
-
|
|
5923
|
+
orderId?: string;
|
|
5924
|
+
}
|
|
5925
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
5926
|
+
}
|
|
5927
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
6268
5928
|
/**
|
|
6269
|
-
*
|
|
6270
|
-
* @
|
|
5929
|
+
* IDs of orders to send pickup emails for.
|
|
5930
|
+
* @minSize 1
|
|
5931
|
+
* @maxSize 300
|
|
6271
5932
|
*/
|
|
6272
|
-
|
|
5933
|
+
orderIds?: string[];
|
|
5934
|
+
}
|
|
5935
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
5936
|
+
}
|
|
5937
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
6273
5938
|
/**
|
|
6274
|
-
*
|
|
6275
|
-
* @
|
|
5939
|
+
* @minLength 1
|
|
5940
|
+
* @maxLength 100
|
|
6276
5941
|
*/
|
|
6277
|
-
|
|
6278
|
-
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
6279
|
-
futureMembership?: FutureMembershipDetails;
|
|
5942
|
+
orderId?: string;
|
|
6280
5943
|
}
|
|
6281
|
-
|
|
6282
|
-
/** Payment was charged. */
|
|
6283
|
-
CHARGED = "CHARGED",
|
|
6284
|
-
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
6285
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6286
|
-
/** Payment is pending. */
|
|
6287
|
-
CHARGE_PENDING = "CHARGE_PENDING",
|
|
6288
|
-
/** Payment was voided. */
|
|
6289
|
-
VOIDED = "VOIDED"
|
|
5944
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
6290
5945
|
}
|
|
6291
|
-
|
|
6292
|
-
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
6293
|
-
interface FutureMembershipDetails {
|
|
5946
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
6294
5947
|
/**
|
|
6295
|
-
*
|
|
6296
|
-
* @
|
|
5948
|
+
* IDs of orders to send pickup emails for.
|
|
5949
|
+
* @minSize 1
|
|
5950
|
+
* @maxSize 300
|
|
6297
5951
|
*/
|
|
6298
|
-
|
|
5952
|
+
orderIds?: string[];
|
|
5953
|
+
}
|
|
5954
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
5955
|
+
}
|
|
5956
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
6299
5957
|
/**
|
|
6300
|
-
*
|
|
6301
|
-
* @maxLength
|
|
5958
|
+
* @minLength 1
|
|
5959
|
+
* @maxLength 100
|
|
6302
5960
|
*/
|
|
6303
|
-
|
|
5961
|
+
orderId?: string;
|
|
6304
5962
|
}
|
|
6305
|
-
interface
|
|
5963
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
5964
|
+
}
|
|
5965
|
+
interface SendCancelRefundEmailRequest {
|
|
6306
5966
|
/**
|
|
6307
|
-
*
|
|
5967
|
+
* The ID of order that is canceled/refunded
|
|
5968
|
+
* @minLength 1
|
|
5969
|
+
* @maxLength 100
|
|
5970
|
+
*/
|
|
5971
|
+
orderId?: string;
|
|
5972
|
+
/**
|
|
5973
|
+
* Personal note added to the email (optional)
|
|
5974
|
+
* @minLength 1
|
|
5975
|
+
* @maxLength 1000
|
|
5976
|
+
*/
|
|
5977
|
+
customMessage?: string | null;
|
|
5978
|
+
/** Refund amount */
|
|
5979
|
+
refundAmount?: Price;
|
|
5980
|
+
/**
|
|
5981
|
+
* Refund ID. (Optional)
|
|
6308
5982
|
* @format GUID
|
|
6309
5983
|
*/
|
|
6310
|
-
|
|
5984
|
+
refundId?: string | null;
|
|
5985
|
+
}
|
|
5986
|
+
interface SendCancelRefundEmailResponse {
|
|
5987
|
+
}
|
|
5988
|
+
interface SendRefundEmailRequest {
|
|
6311
5989
|
/**
|
|
6312
|
-
*
|
|
5990
|
+
* The ID of order that is refunded
|
|
5991
|
+
* @format GUID
|
|
5992
|
+
*/
|
|
5993
|
+
orderId?: string;
|
|
5994
|
+
/**
|
|
5995
|
+
* Refund ID
|
|
5996
|
+
* @format GUID
|
|
5997
|
+
*/
|
|
5998
|
+
refundId?: string;
|
|
5999
|
+
/**
|
|
6000
|
+
* Personal note added to the email (optional)
|
|
6313
6001
|
* @minLength 1
|
|
6314
|
-
* @maxLength
|
|
6002
|
+
* @maxLength 1000
|
|
6315
6003
|
*/
|
|
6316
|
-
|
|
6004
|
+
customMessage?: string | null;
|
|
6317
6005
|
}
|
|
6318
|
-
interface
|
|
6006
|
+
interface SendRefundEmailResponse {
|
|
6007
|
+
}
|
|
6008
|
+
interface SendFulfillmentEmailRequest {
|
|
6009
|
+
/** @format GUID */
|
|
6010
|
+
orderId?: string;
|
|
6011
|
+
/** @format GUID */
|
|
6012
|
+
fulfillerId?: string;
|
|
6013
|
+
}
|
|
6014
|
+
interface SendFulfillmentEmailResponse {
|
|
6015
|
+
}
|
|
6016
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
6319
6017
|
/**
|
|
6320
|
-
*
|
|
6018
|
+
* @minLength 1
|
|
6321
6019
|
* @maxLength 100
|
|
6322
6020
|
*/
|
|
6323
|
-
|
|
6021
|
+
orderId?: string;
|
|
6022
|
+
}
|
|
6023
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
6024
|
+
}
|
|
6025
|
+
interface PreviewEmailByTypeRequest {
|
|
6026
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
6027
|
+
}
|
|
6028
|
+
declare enum PreviewEmailType {
|
|
6029
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
6030
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
6031
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
6032
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
6033
|
+
}
|
|
6034
|
+
/** @enumType */
|
|
6035
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
6036
|
+
interface PreviewEmailByTypeResponse {
|
|
6037
|
+
emailPreview?: string;
|
|
6038
|
+
}
|
|
6039
|
+
interface PreviewRefundEmailRequest {
|
|
6324
6040
|
/**
|
|
6325
|
-
*
|
|
6041
|
+
* @minLength 1
|
|
6042
|
+
* @maxLength 100
|
|
6043
|
+
*/
|
|
6044
|
+
orderId?: string;
|
|
6045
|
+
/** Refund amount */
|
|
6046
|
+
refundAmount?: Price;
|
|
6047
|
+
/** Refund business details */
|
|
6048
|
+
details?: RefundDetails;
|
|
6049
|
+
/**
|
|
6050
|
+
* Personal note added to the email (optional)
|
|
6051
|
+
* @minLength 1
|
|
6052
|
+
* @maxLength 1000
|
|
6053
|
+
*/
|
|
6054
|
+
customMessage?: string | null;
|
|
6055
|
+
/**
|
|
6056
|
+
* Refund ID. (Optional)
|
|
6326
6057
|
* @format GUID
|
|
6327
6058
|
*/
|
|
6328
|
-
|
|
6059
|
+
refundId?: string | null;
|
|
6060
|
+
}
|
|
6061
|
+
interface PreviewRefundEmailResponse {
|
|
6062
|
+
emailPreview?: string;
|
|
6063
|
+
}
|
|
6064
|
+
interface PreviewCancelEmailRequest {
|
|
6329
6065
|
/**
|
|
6330
|
-
* Display number of receipt
|
|
6331
6066
|
* @minLength 1
|
|
6332
|
-
* @maxLength
|
|
6067
|
+
* @maxLength 100
|
|
6333
6068
|
*/
|
|
6334
|
-
|
|
6069
|
+
orderId?: string;
|
|
6070
|
+
/**
|
|
6071
|
+
* Personal note added to the email (optional)
|
|
6072
|
+
* @minLength 1
|
|
6073
|
+
* @maxLength 1000
|
|
6074
|
+
*/
|
|
6075
|
+
customMessage?: string | null;
|
|
6335
6076
|
}
|
|
6336
|
-
interface
|
|
6077
|
+
interface PreviewCancelEmailResponse {
|
|
6078
|
+
emailPreview?: string;
|
|
6079
|
+
}
|
|
6080
|
+
interface PreviewCancelRefundEmailRequest {
|
|
6337
6081
|
/**
|
|
6338
|
-
*
|
|
6339
|
-
*
|
|
6340
|
-
* to prevent false overpayment or underpayment due to rounding.
|
|
6082
|
+
* @minLength 1
|
|
6083
|
+
* @maxLength 100
|
|
6341
6084
|
*/
|
|
6342
|
-
|
|
6085
|
+
orderId?: string;
|
|
6343
6086
|
/**
|
|
6344
|
-
*
|
|
6345
|
-
*
|
|
6346
|
-
* @
|
|
6087
|
+
* Personal note added to the email (optional)
|
|
6088
|
+
* @minLength 1
|
|
6089
|
+
* @maxLength 1000
|
|
6347
6090
|
*/
|
|
6348
|
-
|
|
6091
|
+
customMessage?: string | null;
|
|
6092
|
+
/** Refund amount */
|
|
6093
|
+
refundAmount?: Price;
|
|
6094
|
+
/**
|
|
6095
|
+
* Refund ID. (Optional)
|
|
6096
|
+
* @format GUID
|
|
6097
|
+
*/
|
|
6098
|
+
refundId?: string | null;
|
|
6349
6099
|
}
|
|
6350
|
-
|
|
6351
|
-
|
|
6352
|
-
PENDING = "PENDING",
|
|
6353
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6354
|
-
CANCELED = "CANCELED",
|
|
6355
|
-
DECLINED = "DECLINED",
|
|
6356
|
-
REFUNDED = "REFUNDED",
|
|
6357
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6358
|
-
AUTHORIZED = "AUTHORIZED",
|
|
6359
|
-
VOIDED = "VOIDED"
|
|
6100
|
+
interface PreviewCancelRefundEmailResponse {
|
|
6101
|
+
emailPreview?: string;
|
|
6360
6102
|
}
|
|
6361
|
-
|
|
6362
|
-
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
6363
|
-
interface CanceledStatusDetails {
|
|
6364
|
-
reason?: CanceledReasonWithLiterals;
|
|
6103
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
6365
6104
|
}
|
|
6366
|
-
|
|
6367
|
-
|
|
6368
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
6369
|
-
/** Payment was not completed by user and expired. */
|
|
6370
|
-
EXPIRED = "EXPIRED"
|
|
6105
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
6106
|
+
emailPreview?: string;
|
|
6371
6107
|
}
|
|
6372
|
-
|
|
6373
|
-
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
6374
|
-
interface DeclinedStatusDetails {
|
|
6375
|
-
reason?: DeclinedReasonWithLiterals;
|
|
6108
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
6376
6109
|
}
|
|
6377
|
-
|
|
6378
|
-
|
|
6379
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6380
|
-
/** Payment details expired. */
|
|
6381
|
-
EXPIRED = "EXPIRED",
|
|
6382
|
-
/** Insufficient funds. */
|
|
6383
|
-
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
6384
|
-
/** Gift card was disabled before charge was attempted. */
|
|
6385
|
-
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
6110
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
6111
|
+
emailPreview?: string;
|
|
6386
6112
|
}
|
|
6387
|
-
|
|
6388
|
-
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
6389
|
-
interface VoidedStatusDetails {
|
|
6390
|
-
reason?: VoidedReasonWithLiterals;
|
|
6113
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
6391
6114
|
}
|
|
6392
|
-
|
|
6393
|
-
|
|
6394
|
-
|
|
6395
|
-
|
|
6396
|
-
|
|
6115
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
6116
|
+
emailPreview?: string;
|
|
6117
|
+
}
|
|
6118
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
6119
|
+
}
|
|
6120
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
6121
|
+
emailPreview?: string;
|
|
6122
|
+
}
|
|
6123
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
6124
|
+
}
|
|
6125
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
6126
|
+
emailPreview?: string;
|
|
6127
|
+
}
|
|
6128
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
6129
|
+
/** Emitted on a meta site creation. */
|
|
6130
|
+
siteCreated?: SiteCreated;
|
|
6131
|
+
/** Emitted on a meta site transfer completion. */
|
|
6132
|
+
siteTransferred?: SiteTransferred;
|
|
6133
|
+
/** Emitted on a meta site deletion. */
|
|
6134
|
+
siteDeleted?: SiteDeleted;
|
|
6135
|
+
/** Emitted on a meta site restoration. */
|
|
6136
|
+
siteUndeleted?: SiteUndeleted;
|
|
6137
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
6138
|
+
sitePublished?: SitePublished;
|
|
6139
|
+
/** Emitted on a meta site unpublish. */
|
|
6140
|
+
siteUnpublished?: SiteUnpublished;
|
|
6141
|
+
/** Emitted when meta site is marked as template. */
|
|
6142
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6143
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
6144
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6145
|
+
/** Emitted when an application is provisioned (installed). */
|
|
6146
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
6147
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
6148
|
+
serviceRemoved?: ServiceRemoved;
|
|
6149
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
6150
|
+
siteRenamedPayload?: SiteRenamed;
|
|
6151
|
+
/** Emitted when meta site was permanently deleted. */
|
|
6152
|
+
hardDeleted?: SiteHardDeleted;
|
|
6153
|
+
/** Emitted on a namespace change. */
|
|
6154
|
+
namespaceChanged?: NamespaceChanged;
|
|
6155
|
+
/** Emitted when Studio is attached. */
|
|
6156
|
+
studioAssigned?: StudioAssigned;
|
|
6157
|
+
/** Emitted when Studio is detached. */
|
|
6158
|
+
studioUnassigned?: StudioUnassigned;
|
|
6159
|
+
/**
|
|
6160
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
6161
|
+
* the actual URL.
|
|
6162
|
+
*
|
|
6163
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6164
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6165
|
+
*/
|
|
6166
|
+
urlChanged?: SiteUrlChanged;
|
|
6167
|
+
/** Site is marked as PurgedExternally */
|
|
6168
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
6169
|
+
/** Emitted when Odeditor is attached. */
|
|
6170
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
6171
|
+
/** Emitted when Odeditor is detached. */
|
|
6172
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
6173
|
+
/** Emitted when Picasso is attached. */
|
|
6174
|
+
picassoAssigned?: PicassoAssigned;
|
|
6175
|
+
/** Emitted when Picasso is detached. */
|
|
6176
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
6177
|
+
/** Emitted when Wixel is attached. */
|
|
6178
|
+
wixelAssigned?: WixelAssigned;
|
|
6179
|
+
/** Emitted when Wixel is detached. */
|
|
6180
|
+
wixelUnassigned?: WixelUnassigned;
|
|
6181
|
+
/** Emitted when StudioTwo is attached. */
|
|
6182
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
6183
|
+
/** Emitted when StudioTwo is detached. */
|
|
6184
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6185
|
+
/** Emitted when media from user domain is enabled. */
|
|
6186
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6187
|
+
/** Emitted when media from user domain is disabled. */
|
|
6188
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6189
|
+
/** Emitted when Editorless is attached. */
|
|
6190
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
6191
|
+
/** Emitted when Editorless is detached. */
|
|
6192
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
6193
|
+
/**
|
|
6194
|
+
* A meta site id.
|
|
6195
|
+
* @format GUID
|
|
6196
|
+
*/
|
|
6197
|
+
metaSiteId?: string;
|
|
6198
|
+
/** A meta site version. Monotonically increasing. */
|
|
6199
|
+
version?: string;
|
|
6200
|
+
/** A timestamp of the event. */
|
|
6201
|
+
timestamp?: string;
|
|
6202
|
+
/**
|
|
6203
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
6204
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
6205
|
+
* @maxSize 4000
|
|
6206
|
+
*/
|
|
6207
|
+
assets?: Asset[];
|
|
6208
|
+
}
|
|
6209
|
+
/** @oneof */
|
|
6210
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
6211
|
+
/** Emitted on a meta site creation. */
|
|
6212
|
+
siteCreated?: SiteCreated;
|
|
6213
|
+
/** Emitted on a meta site transfer completion. */
|
|
6214
|
+
siteTransferred?: SiteTransferred;
|
|
6215
|
+
/** Emitted on a meta site deletion. */
|
|
6216
|
+
siteDeleted?: SiteDeleted;
|
|
6217
|
+
/** Emitted on a meta site restoration. */
|
|
6218
|
+
siteUndeleted?: SiteUndeleted;
|
|
6219
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
6220
|
+
sitePublished?: SitePublished;
|
|
6221
|
+
/** Emitted on a meta site unpublish. */
|
|
6222
|
+
siteUnpublished?: SiteUnpublished;
|
|
6223
|
+
/** Emitted when meta site is marked as template. */
|
|
6224
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6225
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
6226
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6227
|
+
/** Emitted when an application is provisioned (installed). */
|
|
6228
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
6229
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
6230
|
+
serviceRemoved?: ServiceRemoved;
|
|
6231
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
6232
|
+
siteRenamedPayload?: SiteRenamed;
|
|
6233
|
+
/** Emitted when meta site was permanently deleted. */
|
|
6234
|
+
hardDeleted?: SiteHardDeleted;
|
|
6235
|
+
/** Emitted on a namespace change. */
|
|
6236
|
+
namespaceChanged?: NamespaceChanged;
|
|
6237
|
+
/** Emitted when Studio is attached. */
|
|
6238
|
+
studioAssigned?: StudioAssigned;
|
|
6239
|
+
/** Emitted when Studio is detached. */
|
|
6240
|
+
studioUnassigned?: StudioUnassigned;
|
|
6241
|
+
/**
|
|
6242
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
6243
|
+
* the actual URL.
|
|
6244
|
+
*
|
|
6245
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6246
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6247
|
+
*/
|
|
6248
|
+
urlChanged?: SiteUrlChanged;
|
|
6249
|
+
/** Site is marked as PurgedExternally */
|
|
6250
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
6251
|
+
/** Emitted when Odeditor is attached. */
|
|
6252
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
6253
|
+
/** Emitted when Odeditor is detached. */
|
|
6254
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
6255
|
+
/** Emitted when Picasso is attached. */
|
|
6256
|
+
picassoAssigned?: PicassoAssigned;
|
|
6257
|
+
/** Emitted when Picasso is detached. */
|
|
6258
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
6259
|
+
/** Emitted when Wixel is attached. */
|
|
6260
|
+
wixelAssigned?: WixelAssigned;
|
|
6261
|
+
/** Emitted when Wixel is detached. */
|
|
6262
|
+
wixelUnassigned?: WixelUnassigned;
|
|
6263
|
+
/** Emitted when StudioTwo is attached. */
|
|
6264
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
6265
|
+
/** Emitted when StudioTwo is detached. */
|
|
6266
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6267
|
+
/** Emitted when media from user domain is enabled. */
|
|
6268
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6269
|
+
/** Emitted when media from user domain is disabled. */
|
|
6270
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6271
|
+
/** Emitted when Editorless is attached. */
|
|
6272
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
6273
|
+
/** Emitted when Editorless is detached. */
|
|
6274
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
6275
|
+
}
|
|
6276
|
+
interface Asset {
|
|
6277
|
+
/**
|
|
6278
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
6279
|
+
* @maxLength 36
|
|
6280
|
+
*/
|
|
6281
|
+
appDefId?: string;
|
|
6282
|
+
/**
|
|
6283
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
6284
|
+
* @maxLength 200
|
|
6285
|
+
*/
|
|
6286
|
+
instanceId?: string;
|
|
6287
|
+
/** An application state. */
|
|
6288
|
+
state?: StateWithLiterals;
|
|
6289
|
+
}
|
|
6290
|
+
declare enum State {
|
|
6291
|
+
UNKNOWN = "UNKNOWN",
|
|
6292
|
+
ENABLED = "ENABLED",
|
|
6293
|
+
DISABLED = "DISABLED",
|
|
6294
|
+
PENDING = "PENDING",
|
|
6295
|
+
DEMO = "DEMO"
|
|
6397
6296
|
}
|
|
6398
6297
|
/** @enumType */
|
|
6399
|
-
type
|
|
6400
|
-
interface
|
|
6401
|
-
/**
|
|
6402
|
-
|
|
6403
|
-
|
|
6404
|
-
|
|
6405
|
-
|
|
6406
|
-
|
|
6298
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
6299
|
+
interface SiteCreated {
|
|
6300
|
+
/**
|
|
6301
|
+
* A template identifier (empty if not created from a template).
|
|
6302
|
+
* @maxLength 36
|
|
6303
|
+
*/
|
|
6304
|
+
originTemplateId?: string;
|
|
6305
|
+
/**
|
|
6306
|
+
* An account id of the owner.
|
|
6307
|
+
* @format GUID
|
|
6308
|
+
*/
|
|
6309
|
+
ownerId?: string;
|
|
6310
|
+
/** A context in which meta site was created. */
|
|
6311
|
+
context?: SiteCreatedContextWithLiterals;
|
|
6312
|
+
/**
|
|
6313
|
+
* A meta site id from which this site was created.
|
|
6314
|
+
*
|
|
6315
|
+
* In case of a creation from a template it's a template id.
|
|
6316
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
6317
|
+
* @format GUID
|
|
6318
|
+
*/
|
|
6319
|
+
originMetaSiteId?: string | null;
|
|
6320
|
+
/**
|
|
6321
|
+
* A meta site name (URL slug).
|
|
6322
|
+
* @maxLength 20
|
|
6323
|
+
*/
|
|
6324
|
+
siteName?: string;
|
|
6325
|
+
/** A namespace. */
|
|
6326
|
+
namespace?: NamespaceWithLiterals;
|
|
6327
|
+
}
|
|
6328
|
+
declare enum SiteCreatedContext {
|
|
6329
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
6330
|
+
OTHER = "OTHER",
|
|
6331
|
+
/** A meta site was created from template. */
|
|
6332
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
6333
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
6334
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
6335
|
+
/** A copy of existing meta site. */
|
|
6336
|
+
DUPLICATE = "DUPLICATE",
|
|
6337
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
6338
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
6339
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
6340
|
+
FLASH = "FLASH"
|
|
6341
|
+
}
|
|
6342
|
+
/** @enumType */
|
|
6343
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
6344
|
+
declare enum Namespace {
|
|
6345
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
6346
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
6347
|
+
WIX = "WIX",
|
|
6348
|
+
/** 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. */
|
|
6349
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
6350
|
+
/** 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. */
|
|
6351
|
+
ALBUMS = "ALBUMS",
|
|
6352
|
+
/** 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. */
|
|
6353
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
6354
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6355
|
+
HOTELS = "HOTELS",
|
|
6356
|
+
/** 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. */
|
|
6357
|
+
CLUBS = "CLUBS",
|
|
6358
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6359
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
6360
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6361
|
+
DEV_SITE = "DEV_SITE",
|
|
6362
|
+
/** 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. */
|
|
6363
|
+
LOGOS = "LOGOS",
|
|
6364
|
+
/** 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. */
|
|
6365
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
6366
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6367
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
6368
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6369
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
6407
6370
|
/**
|
|
6408
|
-
*
|
|
6409
|
-
*
|
|
6410
|
-
*
|
|
6411
|
-
* @maxLength 10
|
|
6371
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
6372
|
+
*
|
|
6373
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
6412
6374
|
*/
|
|
6413
|
-
|
|
6414
|
-
}
|
|
6415
|
-
/** @oneof */
|
|
6416
|
-
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
6417
|
-
/** @internal */
|
|
6418
|
-
canceled?: CanceledStatusDetails;
|
|
6419
|
-
/** @internal */
|
|
6420
|
-
declined?: DeclinedStatusDetails;
|
|
6421
|
-
/** @internal */
|
|
6422
|
-
voided?: VoidedStatusDetails;
|
|
6423
|
-
}
|
|
6424
|
-
interface Refund {
|
|
6375
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
6425
6376
|
/**
|
|
6426
|
-
*
|
|
6427
|
-
*
|
|
6428
|
-
*
|
|
6377
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
6378
|
+
* Will be accessible from Site List and will not have a website app.
|
|
6379
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
6429
6380
|
*/
|
|
6430
|
-
|
|
6381
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
6382
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
6383
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
6384
|
+
/** It is to be used in the Business First efforts. */
|
|
6385
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
6386
|
+
/** Bookings business flow with no site. */
|
|
6387
|
+
ANYWHERE = "ANYWHERE",
|
|
6388
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
6389
|
+
HEADLESS = "HEADLESS",
|
|
6431
6390
|
/**
|
|
6432
|
-
*
|
|
6433
|
-
*
|
|
6391
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
6392
|
+
* The site will be used for account level CSM feature for enterprise
|
|
6434
6393
|
*/
|
|
6435
|
-
|
|
6436
|
-
/**
|
|
6437
|
-
|
|
6394
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
6395
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
6396
|
+
RISE = "RISE",
|
|
6438
6397
|
/**
|
|
6439
|
-
*
|
|
6440
|
-
*
|
|
6441
|
-
*
|
|
6398
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
6399
|
+
* There's a blank site behind the scene but it's blank).
|
|
6400
|
+
* The Mobile company will be the owner of this namespace.
|
|
6442
6401
|
*/
|
|
6443
|
-
|
|
6402
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
6403
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
6404
|
+
NOWNIA = "NOWNIA",
|
|
6444
6405
|
/**
|
|
6445
|
-
*
|
|
6446
|
-
*
|
|
6406
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
6407
|
+
* The Partners company owns this namespace.
|
|
6447
6408
|
*/
|
|
6448
|
-
|
|
6409
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
6410
|
+
/** Codux Headless Sites */
|
|
6411
|
+
CODUX = "CODUX",
|
|
6412
|
+
/** Bobb - AI Design Creator. */
|
|
6413
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
6449
6414
|
/**
|
|
6450
|
-
*
|
|
6451
|
-
*
|
|
6452
|
-
* @readonly
|
|
6453
|
-
* @immutable
|
|
6415
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
6416
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
6454
6417
|
*/
|
|
6455
|
-
|
|
6456
|
-
|
|
6457
|
-
|
|
6418
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
6419
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6420
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
6421
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6422
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
6423
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
6424
|
+
MIMIR = "MIMIR",
|
|
6425
|
+
/** Wix Twins platform. */
|
|
6426
|
+
TWINS = "TWINS",
|
|
6427
|
+
/** Wix Nano. */
|
|
6428
|
+
NANO = "NANO",
|
|
6429
|
+
/** Base44 headless sites. */
|
|
6430
|
+
BASE44 = "BASE44",
|
|
6431
|
+
/** Wix Channels Sites */
|
|
6432
|
+
CHANNELS = "CHANNELS",
|
|
6433
|
+
/** Nautilus platform. */
|
|
6434
|
+
NAUTILUS = "NAUTILUS",
|
|
6458
6435
|
/**
|
|
6459
|
-
*
|
|
6460
|
-
*
|
|
6461
|
-
* @immutable
|
|
6436
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
6437
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
6462
6438
|
*/
|
|
6463
|
-
|
|
6439
|
+
SYMPHONY = "SYMPHONY",
|
|
6440
|
+
/** Nautilus platform app. */
|
|
6441
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
6464
6442
|
/**
|
|
6465
|
-
*
|
|
6466
|
-
*
|
|
6443
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
6444
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
6467
6445
|
*/
|
|
6468
|
-
|
|
6469
|
-
/** Refund status. */
|
|
6470
|
-
refundStatus?: RefundStatusWithLiterals;
|
|
6471
|
-
/** Optional details of current refund status. */
|
|
6472
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
6446
|
+
VIBU = "VIBU",
|
|
6473
6447
|
/**
|
|
6474
|
-
*
|
|
6475
|
-
*
|
|
6476
|
-
*
|
|
6448
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
6449
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
6450
|
+
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
6451
|
+
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
6477
6452
|
*/
|
|
6478
|
-
|
|
6479
|
-
|
|
6480
|
-
|
|
6453
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT"
|
|
6454
|
+
}
|
|
6455
|
+
/** @enumType */
|
|
6456
|
+
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';
|
|
6457
|
+
/** Site transferred to another user. */
|
|
6458
|
+
interface SiteTransferred {
|
|
6481
6459
|
/**
|
|
6482
|
-
*
|
|
6483
|
-
* @
|
|
6460
|
+
* A previous owner id (user that transfers meta site).
|
|
6461
|
+
* @format GUID
|
|
6484
6462
|
*/
|
|
6485
|
-
|
|
6463
|
+
oldOwnerId?: string;
|
|
6486
6464
|
/**
|
|
6487
|
-
*
|
|
6488
|
-
* @internal
|
|
6465
|
+
* A new owner id (user that accepts meta site).
|
|
6489
6466
|
* @format GUID
|
|
6490
|
-
* @immutable
|
|
6491
6467
|
*/
|
|
6492
|
-
|
|
6468
|
+
newOwnerId?: string;
|
|
6493
6469
|
}
|
|
6494
|
-
/**
|
|
6495
|
-
|
|
6496
|
-
/**
|
|
6497
|
-
|
|
6498
|
-
/** Refund transaction succeeded. */
|
|
6499
|
-
SUCCEEDED = "SUCCEEDED",
|
|
6500
|
-
/** Refund transaction failed. */
|
|
6501
|
-
FAILED = "FAILED",
|
|
6502
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
6503
|
-
SCHEDULED = "SCHEDULED",
|
|
6504
|
-
/** Refund was initiated on payment provider side. */
|
|
6505
|
-
STARTED = "STARTED"
|
|
6470
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
6471
|
+
interface SiteDeleted {
|
|
6472
|
+
/** A deletion context. */
|
|
6473
|
+
deleteContext?: DeleteContext;
|
|
6506
6474
|
}
|
|
6507
|
-
|
|
6508
|
-
|
|
6509
|
-
|
|
6475
|
+
interface DeleteContext {
|
|
6476
|
+
/** When the meta site was deleted. */
|
|
6477
|
+
dateDeleted?: Date | null;
|
|
6478
|
+
/** A status. */
|
|
6479
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
6510
6480
|
/**
|
|
6511
|
-
*
|
|
6512
|
-
*
|
|
6513
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
6514
|
-
* @minLength 1
|
|
6515
|
-
* @maxLength 10
|
|
6481
|
+
* A reason (flow).
|
|
6482
|
+
* @maxLength 255
|
|
6516
6483
|
*/
|
|
6517
|
-
|
|
6484
|
+
deleteOrigin?: string;
|
|
6518
6485
|
/**
|
|
6519
|
-
*
|
|
6520
|
-
* @
|
|
6521
|
-
* @maxLength 1000
|
|
6486
|
+
* A service that deleted it.
|
|
6487
|
+
* @maxLength 255
|
|
6522
6488
|
*/
|
|
6523
|
-
|
|
6489
|
+
initiatorId?: string | null;
|
|
6524
6490
|
}
|
|
6525
|
-
|
|
6526
|
-
|
|
6527
|
-
|
|
6528
|
-
|
|
6529
|
-
|
|
6530
|
-
|
|
6531
|
-
refunded?: Price;
|
|
6532
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
6533
|
-
failedRefundAmount?: Price;
|
|
6534
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
6535
|
-
pending?: boolean;
|
|
6536
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
6537
|
-
breakdown?: RefundItemsBreakdown;
|
|
6491
|
+
declare enum DeleteStatus {
|
|
6492
|
+
UNKNOWN = "UNKNOWN",
|
|
6493
|
+
TRASH = "TRASH",
|
|
6494
|
+
DELETED = "DELETED",
|
|
6495
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
6496
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
6538
6497
|
}
|
|
6539
|
-
|
|
6498
|
+
/** @enumType */
|
|
6499
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
6500
|
+
/** Restoration of the meta site. */
|
|
6501
|
+
interface SiteUndeleted {
|
|
6502
|
+
}
|
|
6503
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
6504
|
+
interface SitePublished {
|
|
6505
|
+
}
|
|
6506
|
+
interface SiteUnpublished {
|
|
6507
|
+
/**
|
|
6508
|
+
* A list of URLs previously associated with the meta site.
|
|
6509
|
+
* @maxLength 4000
|
|
6510
|
+
* @maxSize 10000
|
|
6511
|
+
*/
|
|
6512
|
+
urls?: string[];
|
|
6513
|
+
}
|
|
6514
|
+
interface SiteMarkedAsTemplate {
|
|
6515
|
+
}
|
|
6516
|
+
interface SiteMarkedAsWixSite {
|
|
6517
|
+
}
|
|
6518
|
+
/**
|
|
6519
|
+
* Represents a service provisioned a site.
|
|
6520
|
+
*
|
|
6521
|
+
* Note on `origin_instance_id`:
|
|
6522
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
6523
|
+
* This is because of the following scenario:
|
|
6524
|
+
*
|
|
6525
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
6526
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
6527
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
6528
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
6529
|
+
* your site remains consistent with what you initially received and does not include any
|
|
6530
|
+
* changes made to the original template afterward.
|
|
6531
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
6532
|
+
*/
|
|
6533
|
+
interface ServiceProvisioned {
|
|
6540
6534
|
/**
|
|
6541
|
-
*
|
|
6542
|
-
* @
|
|
6535
|
+
* Either UUID or EmbeddedServiceType.
|
|
6536
|
+
* @maxLength 36
|
|
6543
6537
|
*/
|
|
6544
|
-
|
|
6545
|
-
}
|
|
6546
|
-
interface LineItemRefundSummary {
|
|
6538
|
+
appDefId?: string;
|
|
6547
6539
|
/**
|
|
6548
|
-
*
|
|
6549
|
-
* @
|
|
6540
|
+
* Not only UUID. Something here could be something weird.
|
|
6541
|
+
* @maxLength 36
|
|
6550
6542
|
*/
|
|
6551
|
-
|
|
6552
|
-
/** Total refunded amount for the line item. */
|
|
6553
|
-
totalRefundedAmount?: Price;
|
|
6554
|
-
}
|
|
6555
|
-
interface CalculateRefundRequest {
|
|
6543
|
+
instanceId?: string;
|
|
6556
6544
|
/**
|
|
6557
|
-
*
|
|
6558
|
-
* @
|
|
6559
|
-
* @maxLength 100
|
|
6545
|
+
* An instance id from which this instance is originated.
|
|
6546
|
+
* @maxLength 36
|
|
6560
6547
|
*/
|
|
6561
|
-
|
|
6548
|
+
originInstanceId?: string;
|
|
6562
6549
|
/**
|
|
6563
|
-
*
|
|
6564
|
-
* @
|
|
6550
|
+
* A version.
|
|
6551
|
+
* @maxLength 500
|
|
6565
6552
|
*/
|
|
6566
|
-
|
|
6567
|
-
/** Should include shipping in refund calculation */
|
|
6568
|
-
refundShipping?: boolean;
|
|
6569
|
-
}
|
|
6570
|
-
interface CalculateRefundItemRequest {
|
|
6553
|
+
version?: string | null;
|
|
6571
6554
|
/**
|
|
6572
|
-
*
|
|
6555
|
+
* The origin meta site id
|
|
6573
6556
|
* @format GUID
|
|
6574
6557
|
*/
|
|
6575
|
-
|
|
6558
|
+
originMetaSiteId?: string | null;
|
|
6559
|
+
}
|
|
6560
|
+
interface ServiceRemoved {
|
|
6576
6561
|
/**
|
|
6577
|
-
*
|
|
6578
|
-
* @
|
|
6579
|
-
* @max 100000
|
|
6562
|
+
* Either UUID or EmbeddedServiceType.
|
|
6563
|
+
* @maxLength 36
|
|
6580
6564
|
*/
|
|
6581
|
-
|
|
6582
|
-
}
|
|
6583
|
-
interface CalculateRefundResponse {
|
|
6584
|
-
/** Total refundable amount */
|
|
6585
|
-
total?: Price;
|
|
6586
|
-
/** Tax cost of the order */
|
|
6587
|
-
tax?: Price;
|
|
6588
|
-
/** Discount given for this order */
|
|
6589
|
-
discount?: Price;
|
|
6590
|
-
/** Total cost of the order (without tax) */
|
|
6591
|
-
subtotal?: Price;
|
|
6592
|
-
/** Total shipping cost for order */
|
|
6593
|
-
shipping?: Price;
|
|
6594
|
-
/** Previous refund given on that order */
|
|
6595
|
-
previouslyRefundedAmount?: Price;
|
|
6565
|
+
appDefId?: string;
|
|
6596
6566
|
/**
|
|
6597
|
-
*
|
|
6598
|
-
* @
|
|
6567
|
+
* Not only UUID. Something here could be something weird.
|
|
6568
|
+
* @maxLength 36
|
|
6599
6569
|
*/
|
|
6600
|
-
|
|
6601
|
-
}
|
|
6602
|
-
interface CalculateRefundItemResponse {
|
|
6570
|
+
instanceId?: string;
|
|
6603
6571
|
/**
|
|
6604
|
-
*
|
|
6605
|
-
* @
|
|
6572
|
+
* A version.
|
|
6573
|
+
* @maxLength 500
|
|
6606
6574
|
*/
|
|
6607
|
-
|
|
6608
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
6609
|
-
price?: Price;
|
|
6575
|
+
version?: string | null;
|
|
6610
6576
|
}
|
|
6611
|
-
|
|
6577
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
6578
|
+
interface SiteRenamed {
|
|
6612
6579
|
/**
|
|
6613
|
-
*
|
|
6614
|
-
* @
|
|
6615
|
-
* @maxLength 100
|
|
6580
|
+
* A new meta site name (URL slug).
|
|
6581
|
+
* @maxLength 20
|
|
6616
6582
|
*/
|
|
6617
|
-
|
|
6583
|
+
newSiteName?: string;
|
|
6618
6584
|
/**
|
|
6619
|
-
*
|
|
6620
|
-
* @
|
|
6621
|
-
* @maxSize 100
|
|
6622
|
-
* @format GUID
|
|
6585
|
+
* A previous meta site name (URL slug).
|
|
6586
|
+
* @maxLength 255
|
|
6623
6587
|
*/
|
|
6624
|
-
|
|
6588
|
+
oldSiteName?: string;
|
|
6625
6589
|
}
|
|
6626
|
-
|
|
6627
|
-
|
|
6628
|
-
|
|
6590
|
+
/**
|
|
6591
|
+
* Hard deletion of the meta site.
|
|
6592
|
+
*
|
|
6593
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
6594
|
+
*/
|
|
6595
|
+
interface SiteHardDeleted {
|
|
6596
|
+
/** A deletion context. */
|
|
6597
|
+
deleteContext?: DeleteContext;
|
|
6629
6598
|
}
|
|
6630
|
-
interface
|
|
6631
|
-
/**
|
|
6632
|
-
|
|
6633
|
-
|
|
6634
|
-
|
|
6635
|
-
|
|
6636
|
-
|
|
6599
|
+
interface NamespaceChanged {
|
|
6600
|
+
/** A previous namespace. */
|
|
6601
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
6602
|
+
/** A new namespace. */
|
|
6603
|
+
newNamespace?: NamespaceWithLiterals;
|
|
6604
|
+
}
|
|
6605
|
+
/** Assigned Studio editor */
|
|
6606
|
+
interface StudioAssigned {
|
|
6607
|
+
}
|
|
6608
|
+
/** Unassigned Studio editor */
|
|
6609
|
+
interface StudioUnassigned {
|
|
6610
|
+
}
|
|
6611
|
+
/**
|
|
6612
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
6613
|
+
*
|
|
6614
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
6615
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
6616
|
+
*
|
|
6617
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
6618
|
+
*/
|
|
6619
|
+
interface SiteUrlChanged {
|
|
6620
|
+
}
|
|
6621
|
+
/**
|
|
6622
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
6623
|
+
* Consumed by other teams to remove relevant data.
|
|
6624
|
+
*/
|
|
6625
|
+
interface SitePurgedExternally {
|
|
6637
6626
|
/**
|
|
6638
|
-
*
|
|
6639
|
-
* @minSize 1
|
|
6627
|
+
* @maxLength 2048
|
|
6640
6628
|
* @maxSize 100
|
|
6629
|
+
* @deprecated
|
|
6630
|
+
* @targetRemovalDate 2025-04-15
|
|
6641
6631
|
*/
|
|
6642
|
-
|
|
6632
|
+
appDefId?: string[];
|
|
6643
6633
|
}
|
|
6644
|
-
|
|
6645
|
-
|
|
6646
|
-
* Payment ID
|
|
6647
|
-
* @format GUID
|
|
6648
|
-
*/
|
|
6649
|
-
paymentId?: string | null;
|
|
6650
|
-
/**
|
|
6651
|
-
* Capture amount.
|
|
6652
|
-
* If not provided - full authorized amount will be captured.
|
|
6653
|
-
*/
|
|
6654
|
-
amount?: Price;
|
|
6634
|
+
/** Assigned Odeditor */
|
|
6635
|
+
interface OdeditorAssigned {
|
|
6655
6636
|
}
|
|
6656
|
-
|
|
6657
|
-
|
|
6658
|
-
orderTransactions?: OrderTransactions;
|
|
6637
|
+
/** Unassigned Odeditor */
|
|
6638
|
+
interface OdeditorUnassigned {
|
|
6659
6639
|
}
|
|
6660
|
-
|
|
6661
|
-
|
|
6662
|
-
* Ecom Order ID.
|
|
6663
|
-
* @minLength 1
|
|
6664
|
-
* @maxLength 100
|
|
6665
|
-
*/
|
|
6666
|
-
ecomOrderId?: string;
|
|
6667
|
-
/** Amount to be charged */
|
|
6668
|
-
amount?: Price;
|
|
6640
|
+
/** Assigned Picasso editor */
|
|
6641
|
+
interface PicassoAssigned {
|
|
6669
6642
|
}
|
|
6670
|
-
|
|
6671
|
-
|
|
6672
|
-
paymentGatewayOrderId?: string;
|
|
6643
|
+
/** Unassigned Picasso */
|
|
6644
|
+
interface PicassoUnassigned {
|
|
6673
6645
|
}
|
|
6674
|
-
|
|
6675
|
-
|
|
6676
|
-
metasiteId?: string;
|
|
6677
|
-
/**
|
|
6678
|
-
* @minLength 1
|
|
6679
|
-
* @maxLength 100
|
|
6680
|
-
* @maxSize 100
|
|
6681
|
-
*/
|
|
6682
|
-
orderIds?: string[];
|
|
6646
|
+
/** Assigned Wixel */
|
|
6647
|
+
interface WixelAssigned {
|
|
6683
6648
|
}
|
|
6684
|
-
|
|
6649
|
+
/** Unassigned Wixel */
|
|
6650
|
+
interface WixelUnassigned {
|
|
6685
6651
|
}
|
|
6686
|
-
|
|
6687
|
-
|
|
6688
|
-
|
|
6689
|
-
|
|
6690
|
-
|
|
6691
|
-
|
|
6692
|
-
|
|
6693
|
-
|
|
6652
|
+
/** Assigned StudioTwo */
|
|
6653
|
+
interface StudioTwoAssigned {
|
|
6654
|
+
}
|
|
6655
|
+
/** Unassigned StudioTwo */
|
|
6656
|
+
interface StudioTwoUnassigned {
|
|
6657
|
+
}
|
|
6658
|
+
/** Media from user domain is enabled. */
|
|
6659
|
+
interface UserDomainMediaEnabled {
|
|
6660
|
+
}
|
|
6661
|
+
/** Media from user domain is disabled. */
|
|
6662
|
+
interface UserDomainMediaDisabled {
|
|
6663
|
+
}
|
|
6664
|
+
/** Assigned Editorless */
|
|
6665
|
+
interface EditorlessAssigned {
|
|
6666
|
+
}
|
|
6667
|
+
/** Unassigned Editorless */
|
|
6668
|
+
interface EditorlessUnassigned {
|
|
6669
|
+
}
|
|
6670
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
6671
|
+
}
|
|
6672
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
6673
|
+
hasCustomConfigurations?: boolean;
|
|
6674
|
+
}
|
|
6675
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
6676
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
6677
|
+
sendCustomEmailConfigs?: boolean;
|
|
6678
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
6679
|
+
origin?: OriginWithLiterals;
|
|
6680
|
+
}
|
|
6681
|
+
declare enum Origin {
|
|
6682
|
+
OPT_IN = "OPT_IN",
|
|
6683
|
+
MIGRATION = "MIGRATION"
|
|
6684
|
+
}
|
|
6685
|
+
/** @enumType */
|
|
6686
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
6687
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
6688
|
+
success?: boolean;
|
|
6689
|
+
}
|
|
6690
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
6691
|
+
}
|
|
6692
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
6693
|
+
inPopulation?: boolean;
|
|
6694
6694
|
}
|
|
6695
6695
|
interface DiffmatokyPayload {
|
|
6696
6696
|
left?: string;
|
|
@@ -9008,7 +9008,6 @@ interface OrderCommittedEnvelope {
|
|
|
9008
9008
|
* @webhook
|
|
9009
9009
|
* @eventType wix.ecom.v1.order_committed
|
|
9010
9010
|
* @slug committed
|
|
9011
|
-
* @documentationMaturity preview
|
|
9012
9011
|
*/
|
|
9013
9012
|
declare function onOrderCommitted(handler: (event: OrderCommittedEnvelope) => void | Promise<void>): void;
|
|
9014
9013
|
interface OrderCreatedEnvelope {
|
|
@@ -9077,7 +9076,6 @@ interface OrderFulfilledEnvelope {
|
|
|
9077
9076
|
* @webhook
|
|
9078
9077
|
* @eventType wix.ecom.v1.order_fulfilled
|
|
9079
9078
|
* @slug fulfilled
|
|
9080
|
-
* @documentationMaturity preview
|
|
9081
9079
|
*/
|
|
9082
9080
|
declare function onOrderFulfilled(handler: (event: OrderFulfilledEnvelope) => void | Promise<void>): void;
|
|
9083
9081
|
interface OrderImportedEnvelope {
|
|
@@ -10515,4 +10513,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
10515
10513
|
unassignTags?: TagsTags;
|
|
10516
10514
|
}
|
|
10517
10515
|
|
|
10518
|
-
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 SpecificItemsCouponBehaviorWithLiterals 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 AccountInfoMetadata as jA, type OrderSearchSpec as jB, utils as jC, type DescriptionLineTypeWithLiterals as jD, type DimensionsUnitWithLiterals as jE, type ItemTypePresetWithLiterals as jF, type PaymentOptionTypeWithLiterals as jG, type JurisdictionTypeWithLiterals as jH, type SubscriptionFrequencyWithLiterals as jI, type ProductPeriodAlignmentWithLiterals as jJ, type AdjustmentTypeWithLiterals as jK, type TaxableAddressTypeWithLiterals as jL, type MeasurementUnitWithLiterals as jM, type PaymentStatusEnumPaymentStatusWithLiterals as jN, type FulfillmentStatusWithLiterals as jO, type WeightUnitWithLiterals as jP, type VatTypeWithLiterals as jQ, type PickupMethodWithLiterals as jR, type DiscountTypeWithLiterals as jS, type DiscountReasonWithLiterals as jT, type LineItemQuantityChangeTypeWithLiterals as jU, type ActivityTypeWithLiterals as jV, type OrderActivityTypeEnumActivityTypeWithLiterals as jW, type AttributionSourceWithLiterals as jX, type ChannelTypeWithLiterals as jY, type AdditionalFeeSourceWithLiterals as jZ, type OrderActionTypeWithLiterals as j_, type Subdivision as ja, type StandardDetails as jb, type ShippingContactDetails as jc, type InvoiceDates as jd, type LineItems as je, type LineItem as jf, type BigDecimalWrapper as jg, type LineItemTax as jh, type Source as ji, type LineItemMetaData as jj, type Locale as jk, type TotalPrice as jl, type ItemizedFee as jm, type Discount as jn, type DiscountOneDiscountTypeOneOf as jo, type CalculatedTaxes as jp, type CalculatedTax as jq, type Payments as jr, type InvoicesPayment as js, type MetaData as jt, type InvoiceDynamicPriceTotals as ju, type CustomFieldValue as jv, type Value as jw, type Deposit as jx, type BaseEventMetadata as jy, type EventMetadata as jz, type GetRefundabilityStatusResponse as k, captureAuthorizedPayments as k$, type ChargeTypeWithLiterals as k0, type VersioningModeWithLiterals as k1, type DeltaPaymentOptionTypeWithLiterals as k2, type InventoryActionWithLiterals as k3, type WebhookIdentityTypeWithLiterals as k4, type PreviewEmailTypeWithLiterals as k5, type StateWithLiterals as k6, type SiteCreatedContextWithLiterals as k7, type NamespaceWithLiterals as k8, type DeleteStatusWithLiterals as k9, type CustomFieldGroupWithLiterals as kA, type ValueTypeWithLiterals as kB, type DepositTypeWithLiterals as kC, type InvoiceStatusWithLiterals as kD, type CommonSearchWithEntityContext as kE, onOrderApproved as kF, onOrderCanceled as kG, onOrderCommitted as kH, onOrderCreated as kI, onOrderFulfilled as kJ, onOrderImported as kK, onOrderImportedOrderDeleted as kL, onOrderPaymentStatusUpdated as kM, onOrderUpdated as kN, importOrder as kO, setOrderNumberCounter as kP, bulkDeleteImportedOrders as kQ, preparePaymentCollection as kR, getPaymentCollectabilityStatus as kS, recordManuallyCollectedPayment as kT, paymentCollectionMarkOrderAsPaid as kU, paymentCollectionBulkMarkOrdersAsPaid as kV, getRefundabilityStatus as kW, paymentCollectionCreatePaymentGatewayOrder as kX, chargeMemberships as kY, triggerRefund as kZ, voidAuthorizedPayments as k_, type OriginWithLiterals as ka, type ScheduledActionWithLiterals as kb, type DurationUnitWithLiterals as kc, type PaymentCollectabilityStatusWithLiterals as kd, type PredefinedPaymentMethodWithLiterals as ke, type RefundableStatusWithLiterals as kf, type NonRefundableReasonWithLiterals as kg, type ManuallyRefundableReasonWithLiterals as kh, type RestockTypeWithLiterals as ki, type TransactionStatusWithLiterals as kj, type AuthorizationCaptureStatusWithLiterals as kk, type AuthorizationVoidStatusWithLiterals as kl, type ReasonWithLiterals as km, type ActionTypeWithLiterals as kn, type ChargebackStatusWithLiterals as ko, type MembershipPaymentStatusWithLiterals as kp, type PaymentStatusWithLiterals as kq, type CanceledReasonWithLiterals as kr, type DeclinedReasonWithLiterals as ks, type VoidedReasonWithLiterals as kt, type RefundStatusWithLiterals as ku, type SortOrderWithLiterals as kv, type OrderApprovalStrategyWithLiterals as kw, type PlacementWithLiterals as kx, type SubdivisionTypeWithLiterals as ky, type SourceTypeWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, getOrder as l0, createOrder as l1, updateOrder as l2, bulkUpdateOrders as l3, updateOrderLineItem as l4, addActivity as l5, addActivities as l6, updateActivity as l7, deleteActivity as l8, cancelOrder as l9, updateOrderStatus as la, aggregateOrders as lb, bulkUpdateOrderTags as lc, 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 };
|
|
10516
|
+
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 Address 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 ServiceProperties as bV, type BuyerInfo as bW, type BuyerInfoIdOneOf as bX, type CurrencyConversionDetails as bY, type PriceSummary as bZ, type AddressWithContact 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 PaymentPending as c$, type StreetAddress as c0, type AddressLocation as c1, type FullAddressContactDetails as c2, type VatId as c3, type V1ShippingInformation as c4, type DeliveryLogistics as c5, type DeliveryLogisticsAddressOneOf as c6, type PickupDetails as c7, type PickupAddress as c8, type DeliveryTimeSlot as c9, type LineItemChanges as cA, type LineItemQuantityChange as cB, type LineItemPriceChange as cC, type LineItemProductNameChange as cD, type LineItemDescriptionLineChange as cE, type LineItemModifiersChange as cF, type ManagedLineItem as cG, type ManagedDiscount as cH, type TranslatedValue as cI, type LineItemAmount as cJ, type ManagedAdditionalFee as cK, type TotalPriceChange as cL, type ShippingInformationChange as cM, type ShippingInformation as cN, type SavedPaymentMethod as cO, type AuthorizedPaymentCreated as cP, type AuthorizedPaymentCaptured as cQ, type AuthorizedPaymentVoided as cR, type RefundInitiated as cS, type RefundedPayment as cT, type RefundedPaymentKindOneOf as cU, type RegularPaymentRefund as cV, type GiftCardPaymentRefund as cW, type MembershipPaymentRefund as cX, type PaymentRefunded as cY, type PaymentRefundFailed as cZ, type RefundedAsStoreCredit as c_, type ShippingPrice as ca, type ShippingRegion as cb, type TaxSummary as cc, type OrderTaxInfo as cd, type OrderTaxBreakdown as ce, type AppliedDiscount as cf, type AppliedDiscountDiscountSourceOneOf as cg, type Coupon as ch, type MerchantDiscount as ci, type MerchantDiscountMerchantDiscountReasonOneOf as cj, type DiscountRule as ck, type DiscountRuleName as cl, type LineItemDiscount as cm, type ItemCombination as cn, type ItemCombinationLineItem as co, type Activity as cp, type ActivityContentOneOf as cq, type CustomActivity as cr, type MerchantComment as cs, type OrderRefunded as ct, type OrderCreatedFromExchange as cu, type NewExchangeOrderCreated as cv, type LineItemExchangeData as cw, type DraftOrderChangesApplied as cx, type OrderChange as cy, type OrderChangeValueOneOf as cz, type PreparePaymentCollectionOptions as d, type OrderLineItemChangedDetails as d$, type PaymentPendingPaymentDetailsOneOf as d0, type RegularPayment as d1, type RegularPaymentPaymentMethodDetailsOneOf as d2, type CreditCardDetails as d3, type PaymentCanceled as d4, type PaymentCanceledPaymentDetailsOneOf as d5, type PaymentDeclined as d6, type PaymentDeclinedPaymentDetailsOneOf as d7, type ReceiptCreated as d8, type ReceiptCreatedReceiptInfoOneOf as d9, type PlatformFeeSummary as dA, type PlatformFee as dB, type UpdateInternalDocumentsEvent as dC, type UpdateInternalDocumentsEventOperationOneOf as dD, type InternalDocument as dE, type InternalDocumentUpdateOperation as dF, type DeleteByIdsOperation as dG, type DeleteByFilterOperation as dH, type InternalDocumentUpdateByFilterOperation as dI, type InternalUpdateExistingOperation as dJ, type VersionedDocumentUpdateOperation as dK, type VersionedDeleteByIdsOperation as dL, type VersionedDocumentId as dM, type OrderApproved as dN, type OrdersExperiments as dO, type OrderRejectedEventOrderRejected as dP, type OrderItemsRestocked as dQ, type V1RestockItem as dR, type OrderImported as dS, type ImportedOrderDeleted as dT, type PaymentStatusUpdated as dU, type FulfillmentStatusUpdated as dV, type OrderCanceledEventOrderCanceled as dW, type OrderDeltasCommitted as dX, type CommittedDiffs as dY, type CommittedDiffsShippingUpdateInfoOneOf as dZ, type ItemChangedDetails as d_, type WixReceipt as da, type ExternalReceipt as db, type ReceiptSent as dc, type ReceiptSentReceiptInfoOneOf as dd, type ChargebackCreated as de, type ChargebackReversed as df, type CreatedBy as dg, type CreatedByStringOneOf as dh, type ChannelInfo as di, type CustomField as dj, type BalanceSummary as dk, type Balance as dl, type CashRounding as dm, type AdditionalFee as dn, type FulfillmentStatusesAggregate as dp, type Tags as dq, type TagList as dr, type Location as ds, type OrderSettings as dt, type OrderSettingsAllowedActionsOneOf as du, type OrderSettingsEditableByOneOf as dv, type CustomAllowedActions as dw, type OwnerApps as dx, type FormInfo as dy, type FormIdentifier as dz, type PreparePaymentCollectionResponse as e, type Payment as e$, type LineItemDelta as e0, type LineItemDeltaDeltaOneOf as e1, type AppliedDiscountDelta as e2, type AppliedDiscountDeltaDeltaOneOf as e3, type AdditionalFeeDelta as e4, type AdditionalFeeDeltaDeltaOneOf as e5, type DraftOrderCommitSettings as e6, type InventoryUpdateDetails as e7, type TriggerReindexRequest as e8, type TriggerReindexResponse as e9, type UserDefinedPaymentMethodNameKindOneOf as eA, type RecordManuallyCollectedPaymentResponse as eB, type MarkOrderAsPaidRequest as eC, type BulkMarkOrdersAsPaidRequest as eD, type BulkOrderResult as eE, type ItemMetadata as eF, type ApplicationError as eG, type BulkActionMetadata as eH, type GetRefundabilityStatusRequest as eI, type Refundability as eJ, type RefundabilityAdditionalRefundabilityInfoOneOf as eK, type CreatePaymentGatewayOrderRequest as eL, type ChargedBy as eM, type ChargeMembershipsRequest as eN, type MembershipChargeItem as eO, type MembershipName 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 DomainEvent as ea, type DomainEventBodyOneOf as eb, type EntityCreatedEvent as ec, type RestoreInfo as ed, type EntityUpdatedEvent as ee, type EntityDeletedEvent as ef, type ActionEvent as eg, type Empty as eh, type TriggerReindexOrderRequest as ei, type MessageEnvelope as ej, type IdentificationData as ek, type IdentificationDataIdOneOf as el, type AccountInfo as em, type ImportOrderRequest as en, type SetOrderNumberCounterRequest as eo, type BulkDeleteImportedOrdersRequest as ep, type V1TriggerReindexRequest as eq, type V1TriggerReindexResponse as er, type V1TriggerReindexOrderRequest as es, type PreparePaymentCollectionRequest as et, type RedirectUrls as eu, type DelayedCaptureSettings as ev, type Duration as ew, type GetPaymentCollectabilityStatusRequest as ex, type RecordManuallyCollectedPaymentRequest as ey, type UserDefinedPaymentMethodName 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 SpecificItemsCouponBehaviorWithLiterals 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 AccountInfoMetadata as jA, type OrderSearchSpec as jB, utils as jC, type DescriptionLineTypeWithLiterals as jD, type DimensionsUnitWithLiterals as jE, type ItemTypePresetWithLiterals as jF, type PaymentOptionTypeWithLiterals as jG, type JurisdictionTypeWithLiterals as jH, type SubscriptionFrequencyWithLiterals as jI, type ProductPeriodAlignmentWithLiterals as jJ, type AdjustmentTypeWithLiterals as jK, type TaxableAddressTypeWithLiterals as jL, type MeasurementUnitWithLiterals as jM, type PaymentStatusEnumPaymentStatusWithLiterals as jN, type FulfillmentStatusWithLiterals as jO, type WeightUnitWithLiterals as jP, type VatTypeWithLiterals as jQ, type PickupMethodWithLiterals as jR, type DiscountTypeWithLiterals as jS, type DiscountReasonWithLiterals as jT, type LineItemQuantityChangeTypeWithLiterals as jU, type ActivityTypeWithLiterals as jV, type OrderActivityTypeEnumActivityTypeWithLiterals as jW, type AttributionSourceWithLiterals as jX, type ChannelTypeWithLiterals as jY, type AdditionalFeeSourceWithLiterals as jZ, type OrderActionTypeWithLiterals as j_, type Subdivision as ja, type StandardDetails as jb, type ShippingContactDetails as jc, type InvoiceDates as jd, type LineItems as je, type LineItem as jf, type BigDecimalWrapper as jg, type LineItemTax as jh, type Source as ji, type LineItemMetaData as jj, type Locale as jk, type TotalPrice as jl, type ItemizedFee as jm, type Discount as jn, type DiscountOneDiscountTypeOneOf as jo, type CalculatedTaxes as jp, type CalculatedTax as jq, type Payments as jr, type InvoicesPayment as js, type MetaData as jt, type InvoiceDynamicPriceTotals as ju, type CustomFieldValue as jv, type Value as jw, type Deposit as jx, type BaseEventMetadata as jy, type EventMetadata as jz, type GetRefundabilityStatusResponse as k, captureAuthorizedPayments as k$, type ChargeTypeWithLiterals as k0, type VersioningModeWithLiterals as k1, type DeltaPaymentOptionTypeWithLiterals as k2, type InventoryActionWithLiterals as k3, type WebhookIdentityTypeWithLiterals as k4, type ScheduledActionWithLiterals as k5, type DurationUnitWithLiterals as k6, type PaymentCollectabilityStatusWithLiterals as k7, type PredefinedPaymentMethodWithLiterals as k8, type RefundableStatusWithLiterals as k9, type CustomFieldGroupWithLiterals as kA, type ValueTypeWithLiterals as kB, type DepositTypeWithLiterals as kC, type InvoiceStatusWithLiterals as kD, type CommonSearchWithEntityContext as kE, onOrderApproved as kF, onOrderCanceled as kG, onOrderCommitted as kH, onOrderCreated as kI, onOrderFulfilled as kJ, onOrderImported as kK, onOrderImportedOrderDeleted as kL, onOrderPaymentStatusUpdated as kM, onOrderUpdated as kN, importOrder as kO, setOrderNumberCounter as kP, bulkDeleteImportedOrders as kQ, preparePaymentCollection as kR, getPaymentCollectabilityStatus as kS, recordManuallyCollectedPayment as kT, paymentCollectionMarkOrderAsPaid as kU, paymentCollectionBulkMarkOrdersAsPaid as kV, getRefundabilityStatus as kW, paymentCollectionCreatePaymentGatewayOrder as kX, chargeMemberships as kY, triggerRefund as kZ, voidAuthorizedPayments as k_, type NonRefundableReasonWithLiterals as ka, type ManuallyRefundableReasonWithLiterals as kb, type RestockTypeWithLiterals as kc, type TransactionStatusWithLiterals as kd, type AuthorizationCaptureStatusWithLiterals as ke, type AuthorizationVoidStatusWithLiterals as kf, type ReasonWithLiterals as kg, type ActionTypeWithLiterals as kh, type ChargebackStatusWithLiterals as ki, type MembershipPaymentStatusWithLiterals as kj, type PaymentStatusWithLiterals as kk, type CanceledReasonWithLiterals as kl, type DeclinedReasonWithLiterals as km, type VoidedReasonWithLiterals as kn, type RefundStatusWithLiterals as ko, type PreviewEmailTypeWithLiterals as kp, type StateWithLiterals as kq, type SiteCreatedContextWithLiterals as kr, type NamespaceWithLiterals as ks, type DeleteStatusWithLiterals as kt, type OriginWithLiterals as ku, type SortOrderWithLiterals as kv, type OrderApprovalStrategyWithLiterals as kw, type PlacementWithLiterals as kx, type SubdivisionTypeWithLiterals as ky, type SourceTypeWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, getOrder as l0, createOrder as l1, updateOrder as l2, bulkUpdateOrders as l3, updateOrderLineItem as l4, addActivity as l5, addActivities as l6, updateActivity as l7, deleteActivity as l8, cancelOrder as l9, updateOrderStatus as la, aggregateOrders as lb, bulkUpdateOrderTags as lc, 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 };
|