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