@wix/auto_sdk_ecom_orders 1.0.293 → 1.0.295
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-CvolNFuz.d.ts → ecom-v1-order-orders.universal-DlLhZyNg.d.ts} +1685 -1680
- 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 +1685 -1685
- package/build/cjs/meta.js +80 -80
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-CvolNFuz.d.mts → ecom-v1-order-orders.universal-DlLhZyNg.d.mts} +1685 -1680
- 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 +1685 -1685
- package/build/es/meta.mjs +80 -80
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-02_UWg3x.d.ts → ecom-v1-order-orders.universal-DwXimT2J.d.ts} +1844 -1839
- 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 +1841 -1841
- package/build/internal/es/{ecom-v1-order-orders.universal-02_UWg3x.d.mts → ecom-v1-order-orders.universal-DwXimT2J.d.mts} +1844 -1839
- 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 +1841 -1841
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { eo as ImportOrderRequest$1, I as ImportOrderResponse$1, ep as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eq as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1,
|
|
1
|
+
import { eo as ImportOrderRequest$1, I as ImportOrderResponse$1, ep as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eq as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, eu as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, ey as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, ez as RecordManuallyCollectedPaymentRequest$1, eC as RecordManuallyCollectedPaymentResponse$1, eD as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, eE as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, eJ as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, eM as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, eO as ChargeMembershipsRequest$1, eR as ChargeMembershipsResponse$1, eS as TriggerRefundRequest$1, p as TriggerRefundResponse$1, fz as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fA as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, gU as GetOrderRequest$1, gV as GetOrderResponse$1, h5 as SearchOrdersRequest$1, x as SearchOrdersResponse$1, h9 as CreateOrderRequest$1, hd as CreateOrderResponse$1, he as UpdateOrderRequest$1, hf as UpdateOrderResponse$1, hg as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hL as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ia as AddActivityRequest$1, N as AddActivityResponse$1, ic as AddActivitiesRequest$1, W as AddActivitiesResponse$1, id as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ie as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, il as CancelOrderRequest$1, a0 as CancelOrderResponse$1, im as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iL as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iP as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-DwXimT2J.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -4532,2323 +4532,2323 @@ interface BulkDeleteImportedOrdersResponse {
|
|
|
4532
4532
|
*/
|
|
4533
4533
|
jobId?: string;
|
|
4534
4534
|
}
|
|
4535
|
-
interface
|
|
4535
|
+
interface V1TriggerReindexRequest {
|
|
4536
4536
|
/** @format GUID */
|
|
4537
|
-
|
|
4538
|
-
}
|
|
4539
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
4540
|
-
}
|
|
4541
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
4537
|
+
metasiteId?: string;
|
|
4542
4538
|
/**
|
|
4543
4539
|
* @minLength 1
|
|
4544
4540
|
* @maxLength 100
|
|
4541
|
+
* @maxSize 100
|
|
4545
4542
|
*/
|
|
4546
|
-
|
|
4543
|
+
orderIds?: string[];
|
|
4547
4544
|
}
|
|
4548
|
-
interface
|
|
4545
|
+
interface V1TriggerReindexResponse {
|
|
4549
4546
|
}
|
|
4550
|
-
interface
|
|
4547
|
+
interface V1TriggerReindexOrderRequest {
|
|
4548
|
+
/** @format GUID */
|
|
4549
|
+
metasiteId?: string;
|
|
4551
4550
|
/**
|
|
4552
4551
|
* @minLength 1
|
|
4553
4552
|
* @maxLength 100
|
|
4554
4553
|
*/
|
|
4555
4554
|
orderId?: string;
|
|
4556
4555
|
}
|
|
4557
|
-
interface
|
|
4558
|
-
}
|
|
4559
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
4560
|
-
/**
|
|
4561
|
-
* IDs of orders to send pickup emails for.
|
|
4562
|
-
* @minSize 1
|
|
4563
|
-
* @maxSize 300
|
|
4564
|
-
*/
|
|
4565
|
-
orderIds?: string[];
|
|
4566
|
-
}
|
|
4567
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
4568
|
-
}
|
|
4569
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
4556
|
+
interface PreparePaymentCollectionRequest {
|
|
4570
4557
|
/**
|
|
4558
|
+
* Ecom order ID.
|
|
4571
4559
|
* @minLength 1
|
|
4572
4560
|
* @maxLength 100
|
|
4573
4561
|
*/
|
|
4574
|
-
|
|
4575
|
-
|
|
4576
|
-
|
|
4577
|
-
}
|
|
4578
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
4562
|
+
ecomOrderId: string;
|
|
4563
|
+
/** Amount to collect */
|
|
4564
|
+
amount: Price;
|
|
4579
4565
|
/**
|
|
4580
|
-
*
|
|
4581
|
-
*
|
|
4582
|
-
*
|
|
4566
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4567
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
4568
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4583
4569
|
*/
|
|
4584
|
-
|
|
4585
|
-
}
|
|
4586
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
4587
|
-
}
|
|
4588
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
4570
|
+
paymentGatewayOrderId?: string | null;
|
|
4589
4571
|
/**
|
|
4590
|
-
*
|
|
4591
|
-
*
|
|
4572
|
+
* Whether to delay capture of the payment.
|
|
4573
|
+
* Default: false
|
|
4574
|
+
* @deprecated Whether to delay capture of the payment.
|
|
4575
|
+
* Default: false
|
|
4576
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4577
|
+
* @targetRemovalDate 2024-09-30
|
|
4592
4578
|
*/
|
|
4593
|
-
|
|
4594
|
-
}
|
|
4595
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
4596
|
-
}
|
|
4597
|
-
interface SendCancelRefundEmailRequest {
|
|
4579
|
+
delayedCapture?: boolean;
|
|
4598
4580
|
/**
|
|
4599
|
-
*
|
|
4600
|
-
*
|
|
4601
|
-
* @
|
|
4581
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
4582
|
+
* Default: `true`
|
|
4583
|
+
* @internal
|
|
4602
4584
|
*/
|
|
4603
|
-
|
|
4585
|
+
merchantInitiated?: boolean | null;
|
|
4604
4586
|
/**
|
|
4605
|
-
*
|
|
4606
|
-
* @
|
|
4607
|
-
* @maxLength 1000
|
|
4587
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
4588
|
+
* @internal
|
|
4608
4589
|
*/
|
|
4609
|
-
|
|
4610
|
-
/**
|
|
4611
|
-
|
|
4590
|
+
redirectUrls?: RedirectUrls;
|
|
4591
|
+
/** Delayed capture payment settings */
|
|
4592
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4593
|
+
}
|
|
4594
|
+
interface RedirectUrls {
|
|
4612
4595
|
/**
|
|
4613
|
-
*
|
|
4614
|
-
* @format
|
|
4596
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
4597
|
+
* @format WEB_URL
|
|
4615
4598
|
*/
|
|
4616
|
-
|
|
4617
|
-
}
|
|
4618
|
-
interface SendCancelRefundEmailResponse {
|
|
4619
|
-
}
|
|
4620
|
-
interface SendRefundEmailRequest {
|
|
4599
|
+
successUrl?: string | null;
|
|
4621
4600
|
/**
|
|
4622
|
-
*
|
|
4623
|
-
* @format
|
|
4601
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4602
|
+
* @format WEB_URL
|
|
4624
4603
|
*/
|
|
4625
|
-
|
|
4604
|
+
cancelUrl?: string | null;
|
|
4626
4605
|
/**
|
|
4627
|
-
*
|
|
4628
|
-
* @format
|
|
4606
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
4607
|
+
* @format WEB_URL
|
|
4629
4608
|
*/
|
|
4630
|
-
|
|
4609
|
+
errorUrl?: string | null;
|
|
4631
4610
|
/**
|
|
4632
|
-
*
|
|
4633
|
-
* @
|
|
4634
|
-
* @maxLength 1000
|
|
4611
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4612
|
+
* @format WEB_URL
|
|
4635
4613
|
*/
|
|
4636
|
-
|
|
4637
|
-
}
|
|
4638
|
-
interface SendRefundEmailResponse {
|
|
4614
|
+
pendingUrl?: string | null;
|
|
4639
4615
|
}
|
|
4640
|
-
interface
|
|
4641
|
-
/**
|
|
4642
|
-
|
|
4643
|
-
/**
|
|
4644
|
-
|
|
4616
|
+
interface DelayedCaptureSettings {
|
|
4617
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4618
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
4619
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4620
|
+
delayDuration?: Duration;
|
|
4645
4621
|
}
|
|
4646
|
-
|
|
4622
|
+
declare enum ScheduledAction {
|
|
4623
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
4624
|
+
VOID = "VOID",
|
|
4625
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
4626
|
+
CAPTURE = "CAPTURE"
|
|
4647
4627
|
}
|
|
4648
|
-
|
|
4628
|
+
/** @enumType */
|
|
4629
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4630
|
+
interface Duration {
|
|
4649
4631
|
/**
|
|
4650
|
-
*
|
|
4651
|
-
* @
|
|
4632
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4633
|
+
* @min 1
|
|
4652
4634
|
*/
|
|
4653
|
-
|
|
4654
|
-
|
|
4655
|
-
|
|
4656
|
-
}
|
|
4657
|
-
interface PreviewEmailByTypeRequest {
|
|
4658
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
4635
|
+
count?: number;
|
|
4636
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4637
|
+
unit?: DurationUnitWithLiterals;
|
|
4659
4638
|
}
|
|
4660
|
-
declare enum
|
|
4661
|
-
|
|
4662
|
-
|
|
4663
|
-
|
|
4664
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
4639
|
+
declare enum DurationUnit {
|
|
4640
|
+
MINUTES = "MINUTES",
|
|
4641
|
+
HOURS = "HOURS",
|
|
4642
|
+
DAYS = "DAYS"
|
|
4665
4643
|
}
|
|
4666
4644
|
/** @enumType */
|
|
4667
|
-
type
|
|
4668
|
-
interface
|
|
4669
|
-
|
|
4645
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4646
|
+
interface PreparePaymentCollectionResponse {
|
|
4647
|
+
/** Payment gateway order id which is associated with given payment */
|
|
4648
|
+
paymentGatewayOrderId?: string;
|
|
4670
4649
|
}
|
|
4671
|
-
interface
|
|
4650
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
4672
4651
|
/**
|
|
4652
|
+
* Ecom order ID.
|
|
4673
4653
|
* @minLength 1
|
|
4674
4654
|
* @maxLength 100
|
|
4675
4655
|
*/
|
|
4676
|
-
|
|
4677
|
-
|
|
4678
|
-
|
|
4679
|
-
/**
|
|
4680
|
-
|
|
4656
|
+
ecomOrderId: string;
|
|
4657
|
+
}
|
|
4658
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
4659
|
+
/** Payment collectability status */
|
|
4660
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4661
|
+
/** Collectable order amount */
|
|
4662
|
+
amount?: Price;
|
|
4681
4663
|
/**
|
|
4682
|
-
*
|
|
4683
|
-
* @
|
|
4684
|
-
* @maxLength 1000
|
|
4664
|
+
* Whether authorization supported
|
|
4665
|
+
* @internal
|
|
4685
4666
|
*/
|
|
4686
|
-
|
|
4667
|
+
authorizationSupported?: boolean;
|
|
4687
4668
|
/**
|
|
4688
|
-
*
|
|
4689
|
-
* @
|
|
4669
|
+
* Whether custom amount is supported for payment collection
|
|
4670
|
+
* @internal
|
|
4690
4671
|
*/
|
|
4691
|
-
|
|
4672
|
+
customAmountSupported?: boolean;
|
|
4692
4673
|
}
|
|
4693
|
-
|
|
4694
|
-
|
|
4674
|
+
declare enum PaymentCollectabilityStatus {
|
|
4675
|
+
UNKNOWN = "UNKNOWN",
|
|
4676
|
+
COLLECTABLE = "COLLECTABLE",
|
|
4677
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4678
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4679
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4680
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4681
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4682
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4683
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4684
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4685
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4686
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
4687
|
+
}
|
|
4688
|
+
/** @enumType */
|
|
4689
|
+
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';
|
|
4690
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
4695
4691
|
/**
|
|
4696
|
-
* Order
|
|
4697
|
-
* @
|
|
4692
|
+
* Order ID.
|
|
4693
|
+
* @minLength 1
|
|
4694
|
+
* @maxLength 100
|
|
4698
4695
|
*/
|
|
4699
|
-
|
|
4700
|
-
/**
|
|
4701
|
-
|
|
4696
|
+
orderId: string;
|
|
4697
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
4698
|
+
amount: Price;
|
|
4702
4699
|
/**
|
|
4703
|
-
*
|
|
4704
|
-
*
|
|
4700
|
+
* Payment method name provided by user.
|
|
4701
|
+
*
|
|
4702
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4703
|
+
* @internal
|
|
4705
4704
|
*/
|
|
4706
|
-
|
|
4705
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
4706
|
+
}
|
|
4707
|
+
/**
|
|
4708
|
+
* User-defined payment method name.
|
|
4709
|
+
* Allows specifying either a predefined type or a custom name.
|
|
4710
|
+
*/
|
|
4711
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4712
|
+
/** Predefined payment method. */
|
|
4713
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4707
4714
|
/**
|
|
4708
|
-
*
|
|
4709
|
-
*
|
|
4715
|
+
* Custom payment method name provided by user.
|
|
4716
|
+
*
|
|
4717
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4718
|
+
* @minLength 1
|
|
4719
|
+
* @maxLength 150
|
|
4710
4720
|
*/
|
|
4711
|
-
|
|
4721
|
+
custom?: string | null;
|
|
4722
|
+
}
|
|
4723
|
+
/** @oneof */
|
|
4724
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4725
|
+
/** Predefined payment method. */
|
|
4726
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4712
4727
|
/**
|
|
4713
|
-
*
|
|
4714
|
-
*
|
|
4728
|
+
* Custom payment method name provided by user.
|
|
4729
|
+
*
|
|
4730
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4731
|
+
* @minLength 1
|
|
4732
|
+
* @maxLength 150
|
|
4715
4733
|
*/
|
|
4716
|
-
|
|
4717
|
-
/** Shipping amount that was refunded. */
|
|
4718
|
-
shipping?: ShippingRefund;
|
|
4734
|
+
custom?: string | null;
|
|
4719
4735
|
}
|
|
4720
|
-
|
|
4736
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
4737
|
+
declare enum PredefinedPaymentMethod {
|
|
4738
|
+
/** Cash payment. */
|
|
4739
|
+
CASH = "CASH",
|
|
4740
|
+
/** Bank transfer. */
|
|
4741
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4742
|
+
/** Payment by check. */
|
|
4743
|
+
CHECK = "CHECK"
|
|
4744
|
+
}
|
|
4745
|
+
/** @enumType */
|
|
4746
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4747
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
4748
|
+
}
|
|
4749
|
+
interface MarkOrderAsPaidRequest {
|
|
4721
4750
|
/**
|
|
4722
|
-
*
|
|
4723
|
-
* @
|
|
4751
|
+
* Ecom order ID.
|
|
4752
|
+
* @minLength 1
|
|
4753
|
+
* @maxLength 100
|
|
4724
4754
|
*/
|
|
4725
|
-
|
|
4755
|
+
ecomOrderId: string;
|
|
4726
4756
|
/**
|
|
4727
|
-
*
|
|
4728
|
-
*
|
|
4729
|
-
*
|
|
4757
|
+
* Payment method name provided by user.
|
|
4758
|
+
*
|
|
4759
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4760
|
+
* @internal
|
|
4730
4761
|
*/
|
|
4731
|
-
|
|
4762
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
4732
4763
|
}
|
|
4733
|
-
interface
|
|
4764
|
+
interface MarkOrderAsPaidResponse {
|
|
4765
|
+
/** Updated order. */
|
|
4766
|
+
order?: Order;
|
|
4767
|
+
}
|
|
4768
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
4734
4769
|
/**
|
|
4735
|
-
*
|
|
4736
|
-
* @
|
|
4737
|
-
* @
|
|
4770
|
+
* IDs of orders to mark as paid.
|
|
4771
|
+
* @minSize 1
|
|
4772
|
+
* @maxSize 100
|
|
4773
|
+
* @minLength 1
|
|
4774
|
+
* @maxLength 100
|
|
4738
4775
|
*/
|
|
4739
|
-
|
|
4776
|
+
ecomOrderIds: string[];
|
|
4777
|
+
}
|
|
4778
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
4740
4779
|
/**
|
|
4741
|
-
*
|
|
4742
|
-
*
|
|
4743
|
-
* @max 100000
|
|
4744
|
-
* @immutable
|
|
4780
|
+
* Items updated by the bulk action.
|
|
4781
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
4745
4782
|
*/
|
|
4746
|
-
|
|
4783
|
+
results?: BulkOrderResult[];
|
|
4784
|
+
/** Bulk action metadata. */
|
|
4785
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4747
4786
|
}
|
|
4748
|
-
interface
|
|
4787
|
+
interface BulkOrderResult {
|
|
4788
|
+
/** Item metadata. */
|
|
4789
|
+
itemMetadata?: ItemMetadata;
|
|
4749
4790
|
/**
|
|
4750
|
-
*
|
|
4751
|
-
*
|
|
4752
|
-
*
|
|
4791
|
+
* Updated order.
|
|
4792
|
+
*
|
|
4793
|
+
* Returned when `returnFullEntity = true`.
|
|
4753
4794
|
*/
|
|
4754
|
-
|
|
4795
|
+
item?: Order;
|
|
4796
|
+
}
|
|
4797
|
+
interface ItemMetadata {
|
|
4798
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
4799
|
+
id?: string | null;
|
|
4800
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
4801
|
+
originalIndex?: number;
|
|
4802
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
4803
|
+
success?: boolean;
|
|
4804
|
+
/** Details about the error in case of failure. */
|
|
4805
|
+
error?: ApplicationError;
|
|
4806
|
+
}
|
|
4807
|
+
interface ApplicationError {
|
|
4808
|
+
/** Error code. */
|
|
4809
|
+
code?: string;
|
|
4810
|
+
/** Description of the error. */
|
|
4811
|
+
description?: string;
|
|
4812
|
+
/** Data related to the error. */
|
|
4813
|
+
data?: Record<string, any> | null;
|
|
4814
|
+
}
|
|
4815
|
+
interface BulkActionMetadata {
|
|
4816
|
+
/** Number of items that were successfully processed. */
|
|
4817
|
+
totalSuccesses?: number;
|
|
4818
|
+
/** Number of items that couldn't be processed. */
|
|
4819
|
+
totalFailures?: number;
|
|
4820
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4821
|
+
undetailedFailures?: number;
|
|
4822
|
+
}
|
|
4823
|
+
interface GetRefundabilityStatusRequest {
|
|
4755
4824
|
/**
|
|
4756
|
-
*
|
|
4757
|
-
* @
|
|
4825
|
+
* Order ID.
|
|
4826
|
+
* @minLength 1
|
|
4827
|
+
* @maxLength 100
|
|
4758
4828
|
*/
|
|
4759
|
-
|
|
4829
|
+
ecomOrderId: string;
|
|
4760
4830
|
}
|
|
4761
|
-
interface
|
|
4831
|
+
interface GetRefundabilityStatusResponse {
|
|
4762
4832
|
/**
|
|
4763
|
-
*
|
|
4764
|
-
* @
|
|
4833
|
+
* Refundability details.
|
|
4834
|
+
* @maxSize 300
|
|
4765
4835
|
*/
|
|
4766
|
-
|
|
4836
|
+
refundabilities?: Refundability[];
|
|
4837
|
+
/**
|
|
4838
|
+
* Whether the order supports refunding per item.
|
|
4839
|
+
* @deprecated
|
|
4840
|
+
*/
|
|
4841
|
+
refundablePerItem?: boolean;
|
|
4767
4842
|
}
|
|
4768
|
-
interface
|
|
4769
|
-
|
|
4843
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4844
|
+
/** Reason why payment is not refundable. */
|
|
4845
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4846
|
+
/** Reason why payment is only refundable manually. */
|
|
4847
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4848
|
+
/** Payment ID. */
|
|
4849
|
+
paymentId?: string;
|
|
4850
|
+
/** Payment refundability status. */
|
|
4851
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4852
|
+
/** Link to payment provider dashboard. */
|
|
4853
|
+
providerLink?: string | null;
|
|
4770
4854
|
}
|
|
4771
|
-
|
|
4855
|
+
/** @oneof */
|
|
4856
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4857
|
+
/** Reason why payment is not refundable. */
|
|
4858
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4859
|
+
/** Reason why payment is only refundable manually. */
|
|
4860
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4861
|
+
}
|
|
4862
|
+
declare enum RefundableStatus {
|
|
4863
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4864
|
+
MANUAL = "MANUAL",
|
|
4865
|
+
REFUNDABLE = "REFUNDABLE"
|
|
4866
|
+
}
|
|
4867
|
+
/** @enumType */
|
|
4868
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
4869
|
+
declare enum NonRefundableReason {
|
|
4870
|
+
NONE = "NONE",
|
|
4871
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4872
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4873
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4874
|
+
NOT_PAID = "NOT_PAID",
|
|
4875
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4876
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
4877
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4878
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
4879
|
+
FORBIDDEN = "FORBIDDEN",
|
|
4880
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4881
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4882
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4883
|
+
}
|
|
4884
|
+
/** @enumType */
|
|
4885
|
+
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';
|
|
4886
|
+
declare enum ManuallyRefundableReason {
|
|
4887
|
+
EXPIRED = "EXPIRED",
|
|
4888
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4889
|
+
OFFLINE = "OFFLINE",
|
|
4890
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4891
|
+
}
|
|
4892
|
+
/** @enumType */
|
|
4893
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4894
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
4772
4895
|
/**
|
|
4896
|
+
* Ecom order ID.
|
|
4773
4897
|
* @minLength 1
|
|
4774
4898
|
* @maxLength 100
|
|
4775
4899
|
*/
|
|
4776
|
-
|
|
4900
|
+
ecomOrderId: string;
|
|
4901
|
+
/** Information about the user who initiated the payment. */
|
|
4902
|
+
chargedBy?: ChargedBy;
|
|
4777
4903
|
/**
|
|
4778
|
-
*
|
|
4904
|
+
* Whether to delay capture of the payment.
|
|
4905
|
+
*
|
|
4906
|
+
* Default: false
|
|
4907
|
+
* @internal
|
|
4908
|
+
*/
|
|
4909
|
+
delayedCapture?: boolean;
|
|
4910
|
+
}
|
|
4911
|
+
interface ChargedBy {
|
|
4912
|
+
/**
|
|
4913
|
+
* ID - id of the user who initiated the payment
|
|
4914
|
+
* @format GUID
|
|
4915
|
+
*/
|
|
4916
|
+
id?: string;
|
|
4917
|
+
/**
|
|
4918
|
+
* Full name - name of the user who initiated the payment
|
|
4779
4919
|
* @minLength 1
|
|
4780
|
-
* @maxLength
|
|
4920
|
+
* @maxLength 200
|
|
4781
4921
|
*/
|
|
4782
|
-
|
|
4922
|
+
fullName?: string | null;
|
|
4783
4923
|
}
|
|
4784
|
-
interface
|
|
4785
|
-
|
|
4924
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
4925
|
+
/** ID of the order created in the payment gateway */
|
|
4926
|
+
paymentGatewayOrderId?: string;
|
|
4786
4927
|
}
|
|
4787
|
-
interface
|
|
4928
|
+
interface ChargeMembershipsRequest {
|
|
4788
4929
|
/**
|
|
4930
|
+
* Order ID.
|
|
4789
4931
|
* @minLength 1
|
|
4790
4932
|
* @maxLength 100
|
|
4791
4933
|
*/
|
|
4792
|
-
|
|
4934
|
+
ecomOrderId: string;
|
|
4793
4935
|
/**
|
|
4794
|
-
*
|
|
4936
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4937
|
+
* but a user which is using the membership on behalf of the a member
|
|
4938
|
+
* @format GUID
|
|
4939
|
+
*/
|
|
4940
|
+
memberId: string;
|
|
4941
|
+
/**
|
|
4942
|
+
* List of items to be paid by memberships
|
|
4943
|
+
* @minSize 1
|
|
4944
|
+
* @maxSize 300
|
|
4945
|
+
*/
|
|
4946
|
+
membershipCharges?: MembershipChargeItem[];
|
|
4947
|
+
}
|
|
4948
|
+
interface MembershipChargeItem {
|
|
4949
|
+
/**
|
|
4950
|
+
* The id of used membership
|
|
4795
4951
|
* @minLength 1
|
|
4796
|
-
* @maxLength
|
|
4952
|
+
* @maxLength 100
|
|
4797
4953
|
*/
|
|
4798
|
-
|
|
4799
|
-
/** Refund amount */
|
|
4800
|
-
refundAmount?: Price;
|
|
4954
|
+
membershipId?: string;
|
|
4801
4955
|
/**
|
|
4802
|
-
*
|
|
4956
|
+
* ID of the application providing this payment option
|
|
4803
4957
|
* @format GUID
|
|
4804
4958
|
*/
|
|
4805
|
-
|
|
4806
|
-
|
|
4807
|
-
|
|
4808
|
-
|
|
4809
|
-
|
|
4810
|
-
|
|
4811
|
-
|
|
4812
|
-
|
|
4813
|
-
|
|
4814
|
-
}
|
|
4815
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
4816
|
-
}
|
|
4817
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
4818
|
-
emailPreview?: string;
|
|
4819
|
-
}
|
|
4820
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
4821
|
-
}
|
|
4822
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
4823
|
-
emailPreview?: string;
|
|
4824
|
-
}
|
|
4825
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
4826
|
-
}
|
|
4827
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
4828
|
-
emailPreview?: string;
|
|
4829
|
-
}
|
|
4830
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
4831
|
-
}
|
|
4832
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
4833
|
-
emailPreview?: string;
|
|
4834
|
-
}
|
|
4835
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4836
|
-
/** Emitted on a meta site creation. */
|
|
4837
|
-
siteCreated?: SiteCreated;
|
|
4838
|
-
/** Emitted on a meta site transfer completion. */
|
|
4839
|
-
siteTransferred?: SiteTransferred;
|
|
4840
|
-
/** Emitted on a meta site deletion. */
|
|
4841
|
-
siteDeleted?: SiteDeleted;
|
|
4842
|
-
/** Emitted on a meta site restoration. */
|
|
4843
|
-
siteUndeleted?: SiteUndeleted;
|
|
4844
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4845
|
-
sitePublished?: SitePublished;
|
|
4846
|
-
/** Emitted on a meta site unpublish. */
|
|
4847
|
-
siteUnpublished?: SiteUnpublished;
|
|
4848
|
-
/** Emitted when meta site is marked as template. */
|
|
4849
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4850
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4851
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4852
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4853
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4854
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4855
|
-
serviceRemoved?: ServiceRemoved;
|
|
4856
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4857
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4858
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4859
|
-
hardDeleted?: SiteHardDeleted;
|
|
4860
|
-
/** Emitted on a namespace change. */
|
|
4861
|
-
namespaceChanged?: NamespaceChanged;
|
|
4862
|
-
/** Emitted when Studio is attached. */
|
|
4863
|
-
studioAssigned?: StudioAssigned;
|
|
4864
|
-
/** Emitted when Studio is detached. */
|
|
4865
|
-
studioUnassigned?: StudioUnassigned;
|
|
4866
|
-
/**
|
|
4867
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4868
|
-
* the actual URL.
|
|
4869
|
-
*
|
|
4870
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4871
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4872
|
-
*/
|
|
4873
|
-
urlChanged?: SiteUrlChanged;
|
|
4874
|
-
/** Site is marked as PurgedExternally */
|
|
4875
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4876
|
-
/** Emitted when Odeditor is attached. */
|
|
4877
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4878
|
-
/** Emitted when Odeditor is detached. */
|
|
4879
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4880
|
-
/** Emitted when Picasso is attached. */
|
|
4881
|
-
picassoAssigned?: PicassoAssigned;
|
|
4882
|
-
/** Emitted when Picasso is detached. */
|
|
4883
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4884
|
-
/** Emitted when Wixel is attached. */
|
|
4885
|
-
wixelAssigned?: WixelAssigned;
|
|
4886
|
-
/** Emitted when Wixel is detached. */
|
|
4887
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4888
|
-
/** Emitted when StudioTwo is attached. */
|
|
4889
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4890
|
-
/** Emitted when StudioTwo is detached. */
|
|
4891
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4892
|
-
/** Emitted when media from user domain is enabled. */
|
|
4893
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4894
|
-
/** Emitted when media from user domain is disabled. */
|
|
4895
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4896
|
-
/** Emitted when Editorless is attached. */
|
|
4897
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4898
|
-
/** Emitted when Editorless is detached. */
|
|
4899
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4900
|
-
/**
|
|
4901
|
-
* A meta site id.
|
|
4902
|
-
* @format GUID
|
|
4903
|
-
*/
|
|
4904
|
-
metaSiteId?: string;
|
|
4905
|
-
/** A meta site version. Monotonically increasing. */
|
|
4906
|
-
version?: string;
|
|
4907
|
-
/** A timestamp of the event. */
|
|
4908
|
-
timestamp?: string;
|
|
4909
|
-
/**
|
|
4910
|
-
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
4911
|
-
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
4912
|
-
* @maxSize 4000
|
|
4913
|
-
*/
|
|
4914
|
-
assets?: Asset[];
|
|
4915
|
-
}
|
|
4916
|
-
/** @oneof */
|
|
4917
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4918
|
-
/** Emitted on a meta site creation. */
|
|
4919
|
-
siteCreated?: SiteCreated;
|
|
4920
|
-
/** Emitted on a meta site transfer completion. */
|
|
4921
|
-
siteTransferred?: SiteTransferred;
|
|
4922
|
-
/** Emitted on a meta site deletion. */
|
|
4923
|
-
siteDeleted?: SiteDeleted;
|
|
4924
|
-
/** Emitted on a meta site restoration. */
|
|
4925
|
-
siteUndeleted?: SiteUndeleted;
|
|
4926
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4927
|
-
sitePublished?: SitePublished;
|
|
4928
|
-
/** Emitted on a meta site unpublish. */
|
|
4929
|
-
siteUnpublished?: SiteUnpublished;
|
|
4930
|
-
/** Emitted when meta site is marked as template. */
|
|
4931
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4932
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4933
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4934
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4935
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4936
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4937
|
-
serviceRemoved?: ServiceRemoved;
|
|
4938
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4939
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4940
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4941
|
-
hardDeleted?: SiteHardDeleted;
|
|
4942
|
-
/** Emitted on a namespace change. */
|
|
4943
|
-
namespaceChanged?: NamespaceChanged;
|
|
4944
|
-
/** Emitted when Studio is attached. */
|
|
4945
|
-
studioAssigned?: StudioAssigned;
|
|
4946
|
-
/** Emitted when Studio is detached. */
|
|
4947
|
-
studioUnassigned?: StudioUnassigned;
|
|
4948
|
-
/**
|
|
4949
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4950
|
-
* the actual URL.
|
|
4951
|
-
*
|
|
4952
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4953
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4954
|
-
*/
|
|
4955
|
-
urlChanged?: SiteUrlChanged;
|
|
4956
|
-
/** Site is marked as PurgedExternally */
|
|
4957
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4958
|
-
/** Emitted when Odeditor is attached. */
|
|
4959
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4960
|
-
/** Emitted when Odeditor is detached. */
|
|
4961
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4962
|
-
/** Emitted when Picasso is attached. */
|
|
4963
|
-
picassoAssigned?: PicassoAssigned;
|
|
4964
|
-
/** Emitted when Picasso is detached. */
|
|
4965
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4966
|
-
/** Emitted when Wixel is attached. */
|
|
4967
|
-
wixelAssigned?: WixelAssigned;
|
|
4968
|
-
/** Emitted when Wixel is detached. */
|
|
4969
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4970
|
-
/** Emitted when StudioTwo is attached. */
|
|
4971
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4972
|
-
/** Emitted when StudioTwo is detached. */
|
|
4973
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4974
|
-
/** Emitted when media from user domain is enabled. */
|
|
4975
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4976
|
-
/** Emitted when media from user domain is disabled. */
|
|
4977
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4978
|
-
/** Emitted when Editorless is attached. */
|
|
4979
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4980
|
-
/** Emitted when Editorless is detached. */
|
|
4981
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4982
|
-
}
|
|
4983
|
-
interface Asset {
|
|
4984
|
-
/**
|
|
4985
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
4986
|
-
* @maxLength 36
|
|
4987
|
-
*/
|
|
4988
|
-
appDefId?: string;
|
|
4989
|
-
/**
|
|
4990
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
4991
|
-
* @maxLength 200
|
|
4992
|
-
*/
|
|
4993
|
-
instanceId?: string;
|
|
4994
|
-
/** An application state. */
|
|
4995
|
-
state?: StateWithLiterals;
|
|
4996
|
-
}
|
|
4997
|
-
declare enum State {
|
|
4998
|
-
UNKNOWN = "UNKNOWN",
|
|
4999
|
-
ENABLED = "ENABLED",
|
|
5000
|
-
DISABLED = "DISABLED",
|
|
5001
|
-
PENDING = "PENDING",
|
|
5002
|
-
DEMO = "DEMO"
|
|
5003
|
-
}
|
|
5004
|
-
/** @enumType */
|
|
5005
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
5006
|
-
interface SiteCreated {
|
|
5007
|
-
/**
|
|
5008
|
-
* A template identifier (empty if not created from a template).
|
|
5009
|
-
* @maxLength 36
|
|
5010
|
-
*/
|
|
5011
|
-
originTemplateId?: string;
|
|
5012
|
-
/**
|
|
5013
|
-
* An account id of the owner.
|
|
5014
|
-
* @format GUID
|
|
5015
|
-
*/
|
|
5016
|
-
ownerId?: string;
|
|
5017
|
-
/** A context in which meta site was created. */
|
|
5018
|
-
context?: SiteCreatedContextWithLiterals;
|
|
5019
|
-
/**
|
|
5020
|
-
* A meta site id from which this site was created.
|
|
5021
|
-
*
|
|
5022
|
-
* In case of a creation from a template it's a template id.
|
|
5023
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5024
|
-
* @format GUID
|
|
5025
|
-
*/
|
|
5026
|
-
originMetaSiteId?: string | null;
|
|
5027
|
-
/**
|
|
5028
|
-
* A meta site name (URL slug).
|
|
5029
|
-
* @maxLength 20
|
|
5030
|
-
*/
|
|
5031
|
-
siteName?: string;
|
|
5032
|
-
/** A namespace. */
|
|
5033
|
-
namespace?: NamespaceWithLiterals;
|
|
5034
|
-
}
|
|
5035
|
-
declare enum SiteCreatedContext {
|
|
5036
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
5037
|
-
OTHER = "OTHER",
|
|
5038
|
-
/** A meta site was created from template. */
|
|
5039
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
5040
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
5041
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
5042
|
-
/** A copy of existing meta site. */
|
|
5043
|
-
DUPLICATE = "DUPLICATE",
|
|
5044
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
5045
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
5046
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
5047
|
-
FLASH = "FLASH"
|
|
5048
|
-
}
|
|
5049
|
-
/** @enumType */
|
|
5050
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
5051
|
-
declare enum Namespace {
|
|
5052
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5053
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5054
|
-
WIX = "WIX",
|
|
5055
|
-
/** 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. */
|
|
5056
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
5057
|
-
/** 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. */
|
|
5058
|
-
ALBUMS = "ALBUMS",
|
|
5059
|
-
/** 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. */
|
|
5060
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5061
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5062
|
-
HOTELS = "HOTELS",
|
|
5063
|
-
/** 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. */
|
|
5064
|
-
CLUBS = "CLUBS",
|
|
5065
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5066
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5067
|
-
/**
|
|
5068
|
-
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5069
|
-
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
5070
|
-
*/
|
|
5071
|
-
DEV_SITE = "DEV_SITE",
|
|
5072
|
-
/** 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. */
|
|
5073
|
-
LOGOS = "LOGOS",
|
|
5074
|
-
/** 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. */
|
|
5075
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5076
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5077
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5078
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5079
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5080
|
-
/**
|
|
5081
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
5082
|
-
*
|
|
5083
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5084
|
-
*/
|
|
5085
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
5086
|
-
/**
|
|
5087
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
5088
|
-
* Will be accessible from Site List and will not have a website app.
|
|
5089
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
5090
|
-
*/
|
|
5091
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
5092
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
5093
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
5094
|
-
/** It is to be used in the Business First efforts. */
|
|
5095
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5096
|
-
/** Bookings business flow with no site. */
|
|
5097
|
-
ANYWHERE = "ANYWHERE",
|
|
5098
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
5099
|
-
HEADLESS = "HEADLESS",
|
|
5100
|
-
/**
|
|
5101
|
-
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
5102
|
-
* The site will be used for account level CSM feature for enterprise
|
|
5103
|
-
*/
|
|
5104
|
-
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
5105
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
5106
|
-
RISE = "RISE",
|
|
5107
|
-
/**
|
|
5108
|
-
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
5109
|
-
* There's a blank site behind the scene but it's blank).
|
|
5110
|
-
* The Mobile company will be the owner of this namespace.
|
|
5111
|
-
*/
|
|
5112
|
-
BRANDED_FIRST = "BRANDED_FIRST",
|
|
5113
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
5114
|
-
NOWNIA = "NOWNIA",
|
|
5115
|
-
/**
|
|
5116
|
-
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
5117
|
-
* The Partners company owns this namespace.
|
|
5118
|
-
*/
|
|
5119
|
-
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
5120
|
-
/** Codux Headless Sites */
|
|
5121
|
-
CODUX = "CODUX",
|
|
5122
|
-
/** Bobb - AI Design Creator. */
|
|
5123
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
5124
|
-
/**
|
|
5125
|
-
* Shared Blog Site is a unique single site across Enterprise account,
|
|
5126
|
-
* This site will hold all Blog posts related to the Marketing product.
|
|
5127
|
-
*/
|
|
5128
|
-
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
5129
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5130
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
5131
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5132
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
5133
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
5134
|
-
MIMIR = "MIMIR",
|
|
5135
|
-
/** Wix Twins platform. */
|
|
5136
|
-
TWINS = "TWINS",
|
|
5137
|
-
/** Wix Nano. */
|
|
5138
|
-
NANO = "NANO",
|
|
5139
|
-
/** Base44 headless sites. */
|
|
5140
|
-
BASE44 = "BASE44",
|
|
5141
|
-
/** Wix Channels Sites */
|
|
5142
|
-
CHANNELS = "CHANNELS",
|
|
5143
|
-
/** Nautilus platform. */
|
|
5144
|
-
NAUTILUS = "NAUTILUS",
|
|
5145
|
-
/**
|
|
5146
|
-
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
5147
|
-
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
5148
|
-
*/
|
|
5149
|
-
SYMPHONY = "SYMPHONY",
|
|
5150
|
-
/** Nautilus platform app. */
|
|
5151
|
-
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
5152
|
-
/**
|
|
5153
|
-
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
5154
|
-
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
5155
|
-
*/
|
|
5156
|
-
VIBU = "VIBU",
|
|
5157
|
-
/**
|
|
5158
|
-
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
5159
|
-
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
5160
|
-
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
5161
|
-
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5162
|
-
*/
|
|
5163
|
-
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
|
|
5164
|
-
/**
|
|
5165
|
-
* Dev-center development sites (com.wixpress.devcenter.dsm).
|
|
5166
|
-
* DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
|
|
5167
|
-
*/
|
|
5168
|
-
DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
|
|
5169
|
-
}
|
|
5170
|
-
/** @enumType */
|
|
5171
|
-
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';
|
|
5172
|
-
/** Site transferred to another user. */
|
|
5173
|
-
interface SiteTransferred {
|
|
5174
|
-
/**
|
|
5175
|
-
* A previous owner id (user that transfers meta site).
|
|
5176
|
-
* @format GUID
|
|
5177
|
-
*/
|
|
5178
|
-
oldOwnerId?: string;
|
|
5179
|
-
/**
|
|
5180
|
-
* A new owner id (user that accepts meta site).
|
|
5181
|
-
* @format GUID
|
|
5182
|
-
*/
|
|
5183
|
-
newOwnerId?: string;
|
|
5184
|
-
}
|
|
5185
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
5186
|
-
interface SiteDeleted {
|
|
5187
|
-
/** A deletion context. */
|
|
5188
|
-
deleteContext?: DeleteContext;
|
|
5189
|
-
}
|
|
5190
|
-
interface DeleteContext {
|
|
5191
|
-
/** When the meta site was deleted. */
|
|
5192
|
-
dateDeleted?: Date | null;
|
|
5193
|
-
/** A status. */
|
|
5194
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
5195
|
-
/**
|
|
5196
|
-
* A reason (flow).
|
|
5197
|
-
* @maxLength 255
|
|
5198
|
-
*/
|
|
5199
|
-
deleteOrigin?: string;
|
|
5200
|
-
/**
|
|
5201
|
-
* A service that deleted it.
|
|
5202
|
-
* @maxLength 255
|
|
5203
|
-
*/
|
|
5204
|
-
initiatorId?: string | null;
|
|
5205
|
-
}
|
|
5206
|
-
declare enum DeleteStatus {
|
|
5207
|
-
UNKNOWN = "UNKNOWN",
|
|
5208
|
-
TRASH = "TRASH",
|
|
5209
|
-
DELETED = "DELETED",
|
|
5210
|
-
PENDING_PURGE = "PENDING_PURGE",
|
|
5211
|
-
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
5212
|
-
}
|
|
5213
|
-
/** @enumType */
|
|
5214
|
-
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
5215
|
-
/** Restoration of the meta site. */
|
|
5216
|
-
interface SiteUndeleted {
|
|
5217
|
-
}
|
|
5218
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5219
|
-
interface SitePublished {
|
|
5220
|
-
}
|
|
5221
|
-
interface SiteUnpublished {
|
|
5222
|
-
/**
|
|
5223
|
-
* A list of URLs previously associated with the meta site.
|
|
5224
|
-
* @maxLength 4000
|
|
5225
|
-
* @maxSize 10000
|
|
5226
|
-
*/
|
|
5227
|
-
urls?: string[];
|
|
5228
|
-
}
|
|
5229
|
-
interface SiteMarkedAsTemplate {
|
|
5230
|
-
}
|
|
5231
|
-
interface SiteMarkedAsWixSite {
|
|
5232
|
-
}
|
|
5233
|
-
/**
|
|
5234
|
-
* Represents a service provisioned a site.
|
|
5235
|
-
*
|
|
5236
|
-
* Note on `origin_instance_id`:
|
|
5237
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
5238
|
-
* This is because of the following scenario:
|
|
5239
|
-
*
|
|
5240
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
5241
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
5242
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
5243
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
5244
|
-
* your site remains consistent with what you initially received and does not include any
|
|
5245
|
-
* changes made to the original template afterward.
|
|
5246
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
5247
|
-
*/
|
|
5248
|
-
interface ServiceProvisioned {
|
|
5249
|
-
/**
|
|
5250
|
-
* Either UUID or EmbeddedServiceType.
|
|
5251
|
-
* @maxLength 36
|
|
5252
|
-
*/
|
|
5253
|
-
appDefId?: string;
|
|
5254
|
-
/**
|
|
5255
|
-
* Not only UUID. Something here could be something weird.
|
|
5256
|
-
* @maxLength 36
|
|
5257
|
-
*/
|
|
5258
|
-
instanceId?: string;
|
|
5259
|
-
/**
|
|
5260
|
-
* An instance id from which this instance is originated.
|
|
5261
|
-
* @maxLength 36
|
|
5262
|
-
*/
|
|
5263
|
-
originInstanceId?: string;
|
|
5264
|
-
/**
|
|
5265
|
-
* A version.
|
|
5266
|
-
* @maxLength 500
|
|
5267
|
-
*/
|
|
5268
|
-
version?: string | null;
|
|
5269
|
-
/**
|
|
5270
|
-
* The origin meta site id
|
|
5271
|
-
* @format GUID
|
|
5272
|
-
*/
|
|
5273
|
-
originMetaSiteId?: string | null;
|
|
5274
|
-
}
|
|
5275
|
-
interface ServiceRemoved {
|
|
5276
|
-
/**
|
|
5277
|
-
* Either UUID or EmbeddedServiceType.
|
|
5278
|
-
* @maxLength 36
|
|
5279
|
-
*/
|
|
5280
|
-
appDefId?: string;
|
|
4959
|
+
appId?: string;
|
|
4960
|
+
/** The name of used membership */
|
|
4961
|
+
membershipName?: MembershipName;
|
|
4962
|
+
/** Additional data about this membership */
|
|
4963
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
4964
|
+
/** Catalog and item reference info. */
|
|
4965
|
+
catalogReference?: CatalogReference;
|
|
4966
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4967
|
+
serviceProperties?: ServiceProperties;
|
|
5281
4968
|
/**
|
|
5282
|
-
*
|
|
4969
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
4970
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4971
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4972
|
+
* @minLength 1
|
|
5283
4973
|
* @maxLength 36
|
|
5284
4974
|
*/
|
|
5285
|
-
|
|
4975
|
+
rootCatalogItemId?: string | null;
|
|
5286
4976
|
/**
|
|
5287
|
-
*
|
|
5288
|
-
* @
|
|
4977
|
+
* line item id of Checkout/Order line item
|
|
4978
|
+
* @minLength 1
|
|
4979
|
+
* @maxLength 100
|
|
5289
4980
|
*/
|
|
5290
|
-
|
|
4981
|
+
lineItemId?: string;
|
|
5291
4982
|
}
|
|
5292
|
-
|
|
5293
|
-
interface SiteRenamed {
|
|
5294
|
-
/**
|
|
5295
|
-
* A new meta site name (URL slug).
|
|
5296
|
-
* @maxLength 20
|
|
5297
|
-
*/
|
|
5298
|
-
newSiteName?: string;
|
|
4983
|
+
interface MembershipName {
|
|
5299
4984
|
/**
|
|
5300
|
-
*
|
|
5301
|
-
* @maxLength
|
|
4985
|
+
* Membership name.
|
|
4986
|
+
* @maxLength 100
|
|
5302
4987
|
*/
|
|
5303
|
-
|
|
5304
|
-
}
|
|
5305
|
-
/**
|
|
5306
|
-
* Hard deletion of the meta site.
|
|
5307
|
-
*
|
|
5308
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
5309
|
-
*/
|
|
5310
|
-
interface SiteHardDeleted {
|
|
5311
|
-
/** A deletion context. */
|
|
5312
|
-
deleteContext?: DeleteContext;
|
|
5313
|
-
}
|
|
5314
|
-
interface NamespaceChanged {
|
|
5315
|
-
/** A previous namespace. */
|
|
5316
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
5317
|
-
/** A new namespace. */
|
|
5318
|
-
newNamespace?: NamespaceWithLiterals;
|
|
5319
|
-
}
|
|
5320
|
-
/** Assigned Studio editor */
|
|
5321
|
-
interface StudioAssigned {
|
|
5322
|
-
}
|
|
5323
|
-
/** Unassigned Studio editor */
|
|
5324
|
-
interface StudioUnassigned {
|
|
5325
|
-
}
|
|
5326
|
-
/**
|
|
5327
|
-
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
5328
|
-
*
|
|
5329
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
5330
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
5331
|
-
*
|
|
5332
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
5333
|
-
*/
|
|
5334
|
-
interface SiteUrlChanged {
|
|
5335
|
-
}
|
|
5336
|
-
/**
|
|
5337
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
5338
|
-
* Consumed by other teams to remove relevant data.
|
|
5339
|
-
*/
|
|
5340
|
-
interface SitePurgedExternally {
|
|
4988
|
+
original?: string;
|
|
5341
4989
|
/**
|
|
5342
|
-
*
|
|
5343
|
-
* @
|
|
5344
|
-
* @deprecated
|
|
5345
|
-
* @targetRemovalDate 2025-04-15
|
|
4990
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
4991
|
+
* @maxLength 100
|
|
5346
4992
|
*/
|
|
5347
|
-
|
|
5348
|
-
}
|
|
5349
|
-
/** Assigned Odeditor */
|
|
5350
|
-
interface OdeditorAssigned {
|
|
5351
|
-
}
|
|
5352
|
-
/** Unassigned Odeditor */
|
|
5353
|
-
interface OdeditorUnassigned {
|
|
5354
|
-
}
|
|
5355
|
-
/** Assigned Picasso editor */
|
|
5356
|
-
interface PicassoAssigned {
|
|
5357
|
-
}
|
|
5358
|
-
/** Unassigned Picasso */
|
|
5359
|
-
interface PicassoUnassigned {
|
|
5360
|
-
}
|
|
5361
|
-
/** Assigned Wixel */
|
|
5362
|
-
interface WixelAssigned {
|
|
5363
|
-
}
|
|
5364
|
-
/** Unassigned Wixel */
|
|
5365
|
-
interface WixelUnassigned {
|
|
5366
|
-
}
|
|
5367
|
-
/** Assigned StudioTwo */
|
|
5368
|
-
interface StudioTwoAssigned {
|
|
5369
|
-
}
|
|
5370
|
-
/** Unassigned StudioTwo */
|
|
5371
|
-
interface StudioTwoUnassigned {
|
|
5372
|
-
}
|
|
5373
|
-
/** Media from user domain is enabled. */
|
|
5374
|
-
interface UserDomainMediaEnabled {
|
|
5375
|
-
}
|
|
5376
|
-
/** Media from user domain is disabled. */
|
|
5377
|
-
interface UserDomainMediaDisabled {
|
|
5378
|
-
}
|
|
5379
|
-
/** Assigned Editorless */
|
|
5380
|
-
interface EditorlessAssigned {
|
|
5381
|
-
}
|
|
5382
|
-
/** Unassigned Editorless */
|
|
5383
|
-
interface EditorlessUnassigned {
|
|
5384
|
-
}
|
|
5385
|
-
interface HasCustomEmailConfigurationsRequest {
|
|
5386
|
-
}
|
|
5387
|
-
interface HasCustomEmailConfigurationsResponse {
|
|
5388
|
-
hasCustomConfigurations?: boolean;
|
|
5389
|
-
}
|
|
5390
|
-
interface AddToAutomationMigrationPopulationRequest {
|
|
5391
|
-
/** When true, sends custom email configurations to automation system via email */
|
|
5392
|
-
sendCustomEmailConfigs?: boolean;
|
|
5393
|
-
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
5394
|
-
origin?: OriginWithLiterals;
|
|
5395
|
-
}
|
|
5396
|
-
declare enum Origin {
|
|
5397
|
-
OPT_IN = "OPT_IN",
|
|
5398
|
-
MIGRATION = "MIGRATION"
|
|
5399
|
-
}
|
|
5400
|
-
/** @enumType */
|
|
5401
|
-
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
5402
|
-
interface AddToAutomationMigrationPopulationResponse {
|
|
5403
|
-
success?: boolean;
|
|
5404
|
-
}
|
|
5405
|
-
interface IsInAutomationMigrationPopulationRequest {
|
|
4993
|
+
translated?: string | null;
|
|
5406
4994
|
}
|
|
5407
|
-
interface
|
|
5408
|
-
inPopulation?: boolean;
|
|
4995
|
+
interface ChargeMembershipsResponse {
|
|
5409
4996
|
}
|
|
5410
|
-
interface
|
|
4997
|
+
interface TriggerRefundRequest {
|
|
5411
4998
|
/**
|
|
5412
|
-
*
|
|
4999
|
+
* The order this refund related to
|
|
5413
5000
|
* @minLength 1
|
|
5414
5001
|
* @maxLength 100
|
|
5415
5002
|
*/
|
|
5416
5003
|
ecomOrderId: string;
|
|
5417
|
-
/** Amount to collect */
|
|
5418
|
-
amount: Price;
|
|
5419
5004
|
/**
|
|
5420
|
-
*
|
|
5421
|
-
*
|
|
5422
|
-
*
|
|
5005
|
+
* Refund operations information
|
|
5006
|
+
* @minSize 1
|
|
5007
|
+
* @maxSize 1
|
|
5423
5008
|
*/
|
|
5424
|
-
|
|
5009
|
+
payments: PaymentRefund[];
|
|
5010
|
+
/** Business model of a refund */
|
|
5011
|
+
details?: RefundDetails;
|
|
5012
|
+
/** Side effect details related to refund */
|
|
5013
|
+
sideEffects?: RefundSideEffects;
|
|
5014
|
+
}
|
|
5015
|
+
interface PaymentRefund {
|
|
5425
5016
|
/**
|
|
5426
|
-
*
|
|
5427
|
-
*
|
|
5428
|
-
* @deprecated Whether to delay capture of the payment.
|
|
5429
|
-
* Default: false
|
|
5430
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
5431
|
-
* @targetRemovalDate 2024-09-30
|
|
5017
|
+
* Specific payment within the order to refund
|
|
5018
|
+
* @format GUID
|
|
5432
5019
|
*/
|
|
5433
|
-
|
|
5020
|
+
paymentId?: string;
|
|
5021
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5022
|
+
amount?: Price;
|
|
5434
5023
|
/**
|
|
5435
|
-
*
|
|
5436
|
-
*
|
|
5437
|
-
*
|
|
5024
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5025
|
+
* 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.
|
|
5026
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5438
5027
|
*/
|
|
5439
|
-
|
|
5028
|
+
externalRefund?: boolean;
|
|
5440
5029
|
/**
|
|
5441
|
-
*
|
|
5030
|
+
* Gateway refund id. When param is present, new refund is not created.
|
|
5031
|
+
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
5032
|
+
* and all side effects from request will be executed.
|
|
5442
5033
|
* @internal
|
|
5034
|
+
* @minLength 1
|
|
5035
|
+
* @maxLength 100
|
|
5443
5036
|
*/
|
|
5444
|
-
|
|
5445
|
-
/** Delayed capture payment settings */
|
|
5446
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
5037
|
+
gatewayRefundId?: string | null;
|
|
5447
5038
|
}
|
|
5448
|
-
|
|
5039
|
+
/** Business model of a refund request */
|
|
5040
|
+
interface RefundDetails {
|
|
5449
5041
|
/**
|
|
5450
|
-
*
|
|
5451
|
-
* @
|
|
5042
|
+
* Order line item IDs and quantities that were refunded.
|
|
5043
|
+
* @maxSize 300
|
|
5452
5044
|
*/
|
|
5453
|
-
|
|
5045
|
+
items?: RefundItem[];
|
|
5046
|
+
/** Whether the shipping fee was also refunded. */
|
|
5047
|
+
shippingIncluded?: boolean;
|
|
5454
5048
|
/**
|
|
5455
|
-
*
|
|
5456
|
-
* @
|
|
5049
|
+
* Reason for the refund, provided by customer (optional).
|
|
5050
|
+
* @maxLength 200
|
|
5457
5051
|
*/
|
|
5458
|
-
|
|
5052
|
+
reason?: string | null;
|
|
5459
5053
|
/**
|
|
5460
|
-
*
|
|
5461
|
-
* @
|
|
5054
|
+
* Line items that were refunded.
|
|
5055
|
+
* @maxSize 300
|
|
5462
5056
|
*/
|
|
5463
|
-
|
|
5057
|
+
lineItems?: LineItemRefund[];
|
|
5464
5058
|
/**
|
|
5465
|
-
*
|
|
5466
|
-
* @
|
|
5059
|
+
* Additional fees that were refunded.
|
|
5060
|
+
* @maxSize 100
|
|
5467
5061
|
*/
|
|
5468
|
-
|
|
5062
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
5063
|
+
/** Shipping amount that was refunded. */
|
|
5064
|
+
shipping?: ShippingRefund;
|
|
5469
5065
|
}
|
|
5470
|
-
interface
|
|
5471
|
-
/**
|
|
5472
|
-
|
|
5473
|
-
|
|
5474
|
-
|
|
5066
|
+
interface RefundItem {
|
|
5067
|
+
/**
|
|
5068
|
+
* Line item ID the refunded line item.
|
|
5069
|
+
* @format GUID
|
|
5070
|
+
*/
|
|
5071
|
+
lineItemId?: string;
|
|
5072
|
+
/**
|
|
5073
|
+
* Line item quantity refunded.
|
|
5074
|
+
* @min 1
|
|
5075
|
+
* @max 100000
|
|
5076
|
+
*/
|
|
5077
|
+
quantity?: number;
|
|
5475
5078
|
}
|
|
5476
|
-
|
|
5477
|
-
/**
|
|
5478
|
-
|
|
5479
|
-
|
|
5480
|
-
|
|
5079
|
+
interface LineItemRefund {
|
|
5080
|
+
/**
|
|
5081
|
+
* Line item ID.
|
|
5082
|
+
* @format GUID
|
|
5083
|
+
* @immutable
|
|
5084
|
+
*/
|
|
5085
|
+
lineItemId?: string;
|
|
5086
|
+
/**
|
|
5087
|
+
* Refund quantity.
|
|
5088
|
+
* @min 1
|
|
5089
|
+
* @max 100000
|
|
5090
|
+
* @immutable
|
|
5091
|
+
*/
|
|
5092
|
+
quantity?: number;
|
|
5093
|
+
}
|
|
5094
|
+
interface AdditionalFeeRefund {
|
|
5095
|
+
/**
|
|
5096
|
+
* Additional fee ID.
|
|
5097
|
+
* @format GUID
|
|
5098
|
+
* @immutable
|
|
5099
|
+
*/
|
|
5100
|
+
additionalFeeId?: string;
|
|
5101
|
+
/**
|
|
5102
|
+
* Refund amount.
|
|
5103
|
+
* @immutable
|
|
5104
|
+
*/
|
|
5105
|
+
amount?: Price;
|
|
5106
|
+
}
|
|
5107
|
+
interface ShippingRefund {
|
|
5108
|
+
/**
|
|
5109
|
+
* Refund amount.
|
|
5110
|
+
* @immutable
|
|
5111
|
+
*/
|
|
5112
|
+
amount?: Price;
|
|
5113
|
+
}
|
|
5114
|
+
interface RefundSideEffects {
|
|
5115
|
+
/** Inventory restock details as part of this refund. */
|
|
5116
|
+
restockInfo?: RestockInfo;
|
|
5117
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
5118
|
+
sendOrderRefundedEmail?: boolean;
|
|
5119
|
+
/**
|
|
5120
|
+
* Custom message added to the refund confirmation email.
|
|
5121
|
+
* @minLength 1
|
|
5122
|
+
* @maxLength 1000
|
|
5123
|
+
*/
|
|
5124
|
+
customMessage?: string | null;
|
|
5125
|
+
}
|
|
5126
|
+
interface RestockInfo {
|
|
5127
|
+
/** Restock type. */
|
|
5128
|
+
type?: RestockTypeWithLiterals;
|
|
5129
|
+
/**
|
|
5130
|
+
* Deprecated, use items instead
|
|
5131
|
+
* @internal
|
|
5132
|
+
* @maxSize 300
|
|
5133
|
+
* @deprecated
|
|
5134
|
+
*/
|
|
5135
|
+
lineItemIds?: string[];
|
|
5136
|
+
/**
|
|
5137
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
5138
|
+
* @maxSize 300
|
|
5139
|
+
*/
|
|
5140
|
+
items?: RestockItem[];
|
|
5141
|
+
}
|
|
5142
|
+
declare enum RestockType {
|
|
5143
|
+
NO_ITEMS = "NO_ITEMS",
|
|
5144
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
5145
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
5481
5146
|
}
|
|
5482
5147
|
/** @enumType */
|
|
5483
|
-
type
|
|
5484
|
-
interface
|
|
5148
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5149
|
+
interface RestockItem {
|
|
5485
5150
|
/**
|
|
5486
|
-
*
|
|
5151
|
+
* ID of the line item being restocked.
|
|
5152
|
+
* @format GUID
|
|
5153
|
+
*/
|
|
5154
|
+
lineItemId?: string;
|
|
5155
|
+
/**
|
|
5156
|
+
* Line item quantity being restocked.
|
|
5487
5157
|
* @min 1
|
|
5158
|
+
* @max 100000
|
|
5488
5159
|
*/
|
|
5489
|
-
|
|
5490
|
-
/**
|
|
5491
|
-
|
|
5160
|
+
quantity?: number;
|
|
5161
|
+
/**
|
|
5162
|
+
* Per-location breakdown of restock quantities.
|
|
5163
|
+
* @internal
|
|
5164
|
+
* @maxSize 5
|
|
5165
|
+
*/
|
|
5166
|
+
restockLocations?: RestockLocation[];
|
|
5492
5167
|
}
|
|
5493
|
-
|
|
5494
|
-
|
|
5495
|
-
|
|
5496
|
-
|
|
5168
|
+
interface TriggerRefundResponse {
|
|
5169
|
+
/** All order's transactions after the refunds were added */
|
|
5170
|
+
orderTransactions?: OrderTransactions;
|
|
5171
|
+
/** Created refund ID */
|
|
5172
|
+
refundId?: string | null;
|
|
5173
|
+
/** Payment ID's that the refund execution had failed for */
|
|
5174
|
+
failedPaymentIds?: ItemMetadata[];
|
|
5497
5175
|
}
|
|
5498
|
-
/**
|
|
5499
|
-
|
|
5500
|
-
|
|
5501
|
-
|
|
5502
|
-
|
|
5176
|
+
/**
|
|
5177
|
+
* A record of all payments and refunds associated with an order.
|
|
5178
|
+
*
|
|
5179
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5180
|
+
*/
|
|
5181
|
+
interface OrderTransactions {
|
|
5182
|
+
/**
|
|
5183
|
+
* Order ID.
|
|
5184
|
+
* @format GUID
|
|
5185
|
+
*/
|
|
5186
|
+
orderId?: string;
|
|
5187
|
+
/**
|
|
5188
|
+
* Record of payments made to the merchant.
|
|
5189
|
+
* @maxSize 100
|
|
5190
|
+
*/
|
|
5191
|
+
payments?: Payment[];
|
|
5192
|
+
/**
|
|
5193
|
+
* Record of refunds made to the buyer.
|
|
5194
|
+
* @maxSize 300
|
|
5195
|
+
*/
|
|
5196
|
+
refunds?: Refund[];
|
|
5503
5197
|
}
|
|
5504
|
-
interface
|
|
5198
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
|
|
5199
|
+
/** Regular payment details. */
|
|
5200
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5201
|
+
/** Gift card payment details. */
|
|
5202
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5203
|
+
/** Membership payment details. */
|
|
5204
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5205
|
+
/**
|
|
5206
|
+
* Receipt created by Wix
|
|
5207
|
+
* @internal
|
|
5208
|
+
*/
|
|
5209
|
+
wixReceipt?: WixReceiptInfo;
|
|
5210
|
+
/**
|
|
5211
|
+
* Receipt created by an external system.
|
|
5212
|
+
* @internal
|
|
5213
|
+
*/
|
|
5214
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
5215
|
+
/** @internal */
|
|
5216
|
+
canceled?: CanceledStatusDetails;
|
|
5217
|
+
/** @internal */
|
|
5218
|
+
declined?: DeclinedStatusDetails;
|
|
5219
|
+
/** @internal */
|
|
5220
|
+
voided?: VoidedStatusDetails;
|
|
5221
|
+
/**
|
|
5222
|
+
* Payment ID.
|
|
5223
|
+
* @format GUID
|
|
5224
|
+
* @readonly
|
|
5225
|
+
*/
|
|
5226
|
+
id?: string | null;
|
|
5227
|
+
/** 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. */
|
|
5228
|
+
createdDate?: Date | null;
|
|
5505
5229
|
/**
|
|
5506
|
-
*
|
|
5507
|
-
* @
|
|
5508
|
-
* @maxLength 100
|
|
5230
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5231
|
+
* @readonly
|
|
5509
5232
|
*/
|
|
5510
|
-
|
|
5511
|
-
|
|
5512
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
5513
|
-
/** Payment collectability status */
|
|
5514
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
5515
|
-
/** Collectable order amount */
|
|
5233
|
+
updatedDate?: Date | null;
|
|
5234
|
+
/** Payment amount. */
|
|
5516
5235
|
amount?: Price;
|
|
5517
5236
|
/**
|
|
5518
|
-
* Whether
|
|
5237
|
+
* Whether refunds for this payment are disabled.
|
|
5238
|
+
* + `true`: This payment is not refundable.
|
|
5239
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5240
|
+
*/
|
|
5241
|
+
refundDisabled?: boolean;
|
|
5242
|
+
/**
|
|
5243
|
+
* Whether receipt generation is allowed for this payment.
|
|
5244
|
+
* + `true`: This payment supports receipt generation.
|
|
5245
|
+
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5246
|
+
* @readonly
|
|
5247
|
+
*/
|
|
5248
|
+
supportReceiptGeneration?: boolean;
|
|
5249
|
+
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5250
|
+
cashRounding?: CashRoundingDetails;
|
|
5251
|
+
/**
|
|
5252
|
+
* Overall payment status.
|
|
5253
|
+
*
|
|
5254
|
+
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
5255
|
+
*/
|
|
5256
|
+
status?: PaymentStatusWithLiterals;
|
|
5257
|
+
/**
|
|
5258
|
+
* Detailed payment status information including gateway reason codes and status-specific details.
|
|
5519
5259
|
* @internal
|
|
5520
5260
|
*/
|
|
5521
|
-
|
|
5261
|
+
paymentStatusDetails?: PaymentStatusDetails;
|
|
5522
5262
|
/**
|
|
5523
|
-
*
|
|
5263
|
+
* Location where the payment was processed.
|
|
5524
5264
|
* @internal
|
|
5265
|
+
* @format GUID
|
|
5266
|
+
* @immutable
|
|
5525
5267
|
*/
|
|
5526
|
-
|
|
5268
|
+
locationId?: string | null;
|
|
5269
|
+
/**
|
|
5270
|
+
* ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
|
|
5271
|
+
* @format GUID
|
|
5272
|
+
*/
|
|
5273
|
+
chargeCorrelationId?: string | null;
|
|
5527
5274
|
}
|
|
5528
|
-
|
|
5529
|
-
|
|
5530
|
-
|
|
5531
|
-
|
|
5532
|
-
|
|
5533
|
-
|
|
5534
|
-
|
|
5535
|
-
|
|
5536
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
5537
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
5538
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
5539
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
5540
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
5275
|
+
/** @oneof */
|
|
5276
|
+
interface PaymentPaymentDetailsOneOf {
|
|
5277
|
+
/** Regular payment details. */
|
|
5278
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5279
|
+
/** Gift card payment details. */
|
|
5280
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5281
|
+
/** Membership payment details. */
|
|
5282
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5541
5283
|
}
|
|
5542
|
-
/** @
|
|
5543
|
-
|
|
5544
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
5284
|
+
/** @oneof */
|
|
5285
|
+
interface PaymentReceiptInfoOneOf {
|
|
5545
5286
|
/**
|
|
5546
|
-
*
|
|
5547
|
-
* @
|
|
5548
|
-
* @maxLength 100
|
|
5287
|
+
* Receipt created by Wix
|
|
5288
|
+
* @internal
|
|
5549
5289
|
*/
|
|
5550
|
-
|
|
5551
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
5552
|
-
amount: Price;
|
|
5290
|
+
wixReceipt?: WixReceiptInfo;
|
|
5553
5291
|
/**
|
|
5554
|
-
*
|
|
5555
|
-
*
|
|
5556
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5292
|
+
* Receipt created by an external system.
|
|
5557
5293
|
* @internal
|
|
5558
5294
|
*/
|
|
5559
|
-
|
|
5295
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
5560
5296
|
}
|
|
5561
|
-
/**
|
|
5562
|
-
|
|
5563
|
-
|
|
5564
|
-
|
|
5565
|
-
|
|
5566
|
-
|
|
5567
|
-
|
|
5297
|
+
/** @oneof */
|
|
5298
|
+
interface PaymentStatusDetailsOneOf {
|
|
5299
|
+
/** @internal */
|
|
5300
|
+
canceled?: CanceledStatusDetails;
|
|
5301
|
+
/** @internal */
|
|
5302
|
+
declined?: DeclinedStatusDetails;
|
|
5303
|
+
/** @internal */
|
|
5304
|
+
voided?: VoidedStatusDetails;
|
|
5305
|
+
}
|
|
5306
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5307
|
+
/** Credit card details. */
|
|
5308
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5568
5309
|
/**
|
|
5569
|
-
*
|
|
5570
|
-
*
|
|
5571
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5572
|
-
* @minLength 1
|
|
5573
|
-
* @maxLength 150
|
|
5310
|
+
* Wix Payments order ID.
|
|
5311
|
+
* @maxLength 100
|
|
5574
5312
|
*/
|
|
5575
|
-
|
|
5576
|
-
}
|
|
5577
|
-
/** @oneof */
|
|
5578
|
-
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
5579
|
-
/** Predefined payment method. */
|
|
5580
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5313
|
+
paymentOrderId?: string | null;
|
|
5581
5314
|
/**
|
|
5582
|
-
*
|
|
5583
|
-
*
|
|
5584
|
-
*
|
|
5585
|
-
|
|
5315
|
+
* Payment gateway's transaction ID.
|
|
5316
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
5317
|
+
* @maxLength 100
|
|
5318
|
+
*/
|
|
5319
|
+
gatewayTransactionId?: string | null;
|
|
5320
|
+
/**
|
|
5321
|
+
* Payment method.
|
|
5322
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5323
|
+
* Non-exhaustive list of supported values:
|
|
5324
|
+
* + `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`
|
|
5586
5325
|
* @maxLength 150
|
|
5326
|
+
* @deprecated Payment method.
|
|
5327
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5328
|
+
* Non-exhaustive list of supported values:
|
|
5329
|
+
* + `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`
|
|
5330
|
+
* @replacedBy payment_method_name
|
|
5331
|
+
* @targetRemovalDate 2026-07-01
|
|
5587
5332
|
*/
|
|
5588
|
-
|
|
5589
|
-
}
|
|
5590
|
-
/** Predefined payment method types for offline/manual payments. */
|
|
5591
|
-
declare enum PredefinedPaymentMethod {
|
|
5592
|
-
/** Cash payment. */
|
|
5593
|
-
CASH = "CASH",
|
|
5594
|
-
/** Bank transfer. */
|
|
5595
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
5596
|
-
/** Payment by check. */
|
|
5597
|
-
CHECK = "CHECK"
|
|
5598
|
-
}
|
|
5599
|
-
/** @enumType */
|
|
5600
|
-
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
5601
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
5602
|
-
}
|
|
5603
|
-
interface MarkOrderAsPaidRequest {
|
|
5333
|
+
paymentMethod?: string | null;
|
|
5604
5334
|
/**
|
|
5605
|
-
*
|
|
5606
|
-
* @minLength 1
|
|
5335
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
5607
5336
|
* @maxLength 100
|
|
5608
5337
|
*/
|
|
5609
|
-
|
|
5338
|
+
providerTransactionId?: string | null;
|
|
5339
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5340
|
+
offlinePayment?: boolean;
|
|
5610
5341
|
/**
|
|
5611
|
-
* Payment
|
|
5612
|
-
*
|
|
5613
|
-
*
|
|
5342
|
+
* Payment status.
|
|
5343
|
+
* @deprecated Payment status.
|
|
5344
|
+
* @replacedBy payment.status
|
|
5345
|
+
* @targetRemovalDate 2026-11-01
|
|
5346
|
+
*/
|
|
5347
|
+
status?: TransactionStatusWithLiterals;
|
|
5348
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
5349
|
+
savedPaymentMethod?: boolean;
|
|
5350
|
+
/** Authorization details. */
|
|
5351
|
+
authorizationDetails?: AuthorizationDetails;
|
|
5352
|
+
/**
|
|
5353
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
5614
5354
|
* @internal
|
|
5355
|
+
* @maxLength 300
|
|
5615
5356
|
*/
|
|
5616
|
-
|
|
5617
|
-
}
|
|
5618
|
-
interface MarkOrderAsPaidResponse {
|
|
5619
|
-
/** Updated order. */
|
|
5620
|
-
order?: Order;
|
|
5621
|
-
}
|
|
5622
|
-
interface BulkMarkOrdersAsPaidRequest {
|
|
5357
|
+
paymentProvider?: string | null;
|
|
5623
5358
|
/**
|
|
5624
|
-
*
|
|
5625
|
-
* @
|
|
5626
|
-
* @maxSize 100
|
|
5627
|
-
* @minLength 1
|
|
5628
|
-
* @maxLength 100
|
|
5359
|
+
* Record of chargebacks made by the buyer.
|
|
5360
|
+
* @maxSize 6
|
|
5629
5361
|
*/
|
|
5630
|
-
|
|
5631
|
-
}
|
|
5632
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
5362
|
+
chargebacks?: Chargeback[];
|
|
5633
5363
|
/**
|
|
5634
|
-
*
|
|
5635
|
-
*
|
|
5364
|
+
* Payment method ID.
|
|
5365
|
+
* @internal
|
|
5366
|
+
* @maxLength 36
|
|
5636
5367
|
*/
|
|
5637
|
-
|
|
5638
|
-
/**
|
|
5639
|
-
|
|
5640
|
-
}
|
|
5641
|
-
interface BulkOrderResult {
|
|
5642
|
-
/** Item metadata. */
|
|
5643
|
-
itemMetadata?: ItemMetadata;
|
|
5368
|
+
paymentMethodId?: string | null;
|
|
5369
|
+
/** Platform fee amount associated with this payment. */
|
|
5370
|
+
platformFee?: Price;
|
|
5644
5371
|
/**
|
|
5645
|
-
*
|
|
5646
|
-
*
|
|
5647
|
-
*
|
|
5372
|
+
* Payment method with buyer and optional owner translations.
|
|
5373
|
+
* Non-exhaustive list of supported values:
|
|
5374
|
+
* + `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`
|
|
5648
5375
|
*/
|
|
5649
|
-
|
|
5650
|
-
}
|
|
5651
|
-
interface ItemMetadata {
|
|
5652
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
5653
|
-
id?: string | null;
|
|
5654
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
5655
|
-
originalIndex?: number;
|
|
5656
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
5657
|
-
success?: boolean;
|
|
5658
|
-
/** Details about the error in case of failure. */
|
|
5659
|
-
error?: ApplicationError;
|
|
5376
|
+
paymentMethodName?: PaymentMethodName;
|
|
5660
5377
|
}
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
5665
|
-
description?: string;
|
|
5666
|
-
/** Data related to the error. */
|
|
5667
|
-
data?: Record<string, any> | null;
|
|
5378
|
+
/** @oneof */
|
|
5379
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5380
|
+
/** Credit card details. */
|
|
5381
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5668
5382
|
}
|
|
5669
|
-
|
|
5670
|
-
|
|
5671
|
-
|
|
5672
|
-
|
|
5673
|
-
|
|
5674
|
-
|
|
5675
|
-
|
|
5383
|
+
declare enum TransactionStatus {
|
|
5384
|
+
UNDEFINED = "UNDEFINED",
|
|
5385
|
+
APPROVED = "APPROVED",
|
|
5386
|
+
PENDING = "PENDING",
|
|
5387
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5388
|
+
CANCELED = "CANCELED",
|
|
5389
|
+
DECLINED = "DECLINED",
|
|
5390
|
+
REFUNDED = "REFUNDED",
|
|
5391
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5392
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5393
|
+
VOIDED = "VOIDED"
|
|
5676
5394
|
}
|
|
5677
|
-
|
|
5395
|
+
/** @enumType */
|
|
5396
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5397
|
+
interface CreditCardPaymentMethodDetails {
|
|
5678
5398
|
/**
|
|
5679
|
-
*
|
|
5680
|
-
* @
|
|
5399
|
+
* The last 4 digits of the card number.
|
|
5400
|
+
* @maxLength 4
|
|
5401
|
+
*/
|
|
5402
|
+
lastFourDigits?: string | null;
|
|
5403
|
+
/**
|
|
5404
|
+
* Card issuer's brand.
|
|
5681
5405
|
* @maxLength 100
|
|
5682
5406
|
*/
|
|
5683
|
-
|
|
5407
|
+
brand?: string | null;
|
|
5684
5408
|
}
|
|
5685
|
-
interface
|
|
5409
|
+
interface AuthorizationDetails {
|
|
5686
5410
|
/**
|
|
5687
|
-
*
|
|
5688
|
-
* @
|
|
5411
|
+
* Whether the authorized payment is of a delayed capture.
|
|
5412
|
+
* @readonly
|
|
5689
5413
|
*/
|
|
5690
|
-
|
|
5414
|
+
delayedCapture?: boolean;
|
|
5415
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5416
|
+
authorizedDate?: Date | null;
|
|
5691
5417
|
/**
|
|
5692
|
-
*
|
|
5693
|
-
*
|
|
5418
|
+
* List of captures associated with payment
|
|
5419
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
5420
|
+
* @maxSize 1
|
|
5694
5421
|
*/
|
|
5695
|
-
|
|
5422
|
+
captures?: AuthorizationCapture[];
|
|
5423
|
+
/** Void associated with payment */
|
|
5424
|
+
void?: AuthorizationVoid;
|
|
5425
|
+
/** Scheduled action for this transaction */
|
|
5426
|
+
scheduledAction?: V1ScheduledAction;
|
|
5696
5427
|
}
|
|
5697
|
-
interface
|
|
5698
|
-
/**
|
|
5699
|
-
|
|
5700
|
-
|
|
5701
|
-
|
|
5702
|
-
|
|
5703
|
-
|
|
5704
|
-
/**
|
|
5705
|
-
|
|
5706
|
-
/**
|
|
5707
|
-
|
|
5428
|
+
interface AuthorizationCapture {
|
|
5429
|
+
/**
|
|
5430
|
+
* Capture ID.
|
|
5431
|
+
* @format GUID
|
|
5432
|
+
* @readonly
|
|
5433
|
+
*/
|
|
5434
|
+
id?: string | null;
|
|
5435
|
+
/** Status of this capture action */
|
|
5436
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
5437
|
+
/**
|
|
5438
|
+
* Amount of this capture
|
|
5439
|
+
* @immutable
|
|
5440
|
+
*/
|
|
5441
|
+
amount?: Price;
|
|
5442
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5443
|
+
createdDate?: Date | null;
|
|
5444
|
+
/** In case of status is FAILED may contain failure details */
|
|
5445
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5708
5446
|
}
|
|
5709
|
-
|
|
5710
|
-
|
|
5711
|
-
|
|
5712
|
-
|
|
5713
|
-
|
|
5714
|
-
|
|
5447
|
+
declare enum AuthorizationCaptureStatus {
|
|
5448
|
+
/** Capture operation still in progress. */
|
|
5449
|
+
PENDING = "PENDING",
|
|
5450
|
+
/** Capture operation succeeded. */
|
|
5451
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5452
|
+
/** Capture operation failed. */
|
|
5453
|
+
FAILED = "FAILED"
|
|
5715
5454
|
}
|
|
5716
|
-
|
|
5717
|
-
|
|
5718
|
-
|
|
5719
|
-
|
|
5455
|
+
/** @enumType */
|
|
5456
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5457
|
+
interface AuthorizationActionFailureDetails {
|
|
5458
|
+
/** @maxLength 100 */
|
|
5459
|
+
failureCode?: string;
|
|
5460
|
+
}
|
|
5461
|
+
interface AuthorizationVoid {
|
|
5462
|
+
/** Status of this void action */
|
|
5463
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
5464
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5465
|
+
voidedDate?: Date | null;
|
|
5466
|
+
/** In case of status is FAILED may contain failure details */
|
|
5467
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5468
|
+
/** Reason of void action */
|
|
5469
|
+
reason?: ReasonWithLiterals;
|
|
5470
|
+
}
|
|
5471
|
+
declare enum AuthorizationVoidStatus {
|
|
5472
|
+
/** Void operation still in progress. */
|
|
5473
|
+
PENDING = "PENDING",
|
|
5474
|
+
/** Void operation succeeded. */
|
|
5475
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5476
|
+
/** Void operation failed. */
|
|
5477
|
+
FAILED = "FAILED"
|
|
5720
5478
|
}
|
|
5721
5479
|
/** @enumType */
|
|
5722
|
-
type
|
|
5723
|
-
|
|
5724
|
-
|
|
5725
|
-
|
|
5726
|
-
|
|
5727
|
-
|
|
5728
|
-
|
|
5729
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5730
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
5731
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5732
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
5733
|
-
FORBIDDEN = "FORBIDDEN",
|
|
5734
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5735
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5736
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
5480
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5481
|
+
/** Reason the authorization was voided. */
|
|
5482
|
+
declare enum Reason {
|
|
5483
|
+
/** Authorization was voided by user. */
|
|
5484
|
+
MANUAL = "MANUAL",
|
|
5485
|
+
/** Authorization passed execution date. */
|
|
5486
|
+
SCHEDULED = "SCHEDULED"
|
|
5737
5487
|
}
|
|
5738
5488
|
/** @enumType */
|
|
5739
|
-
type
|
|
5740
|
-
|
|
5741
|
-
|
|
5742
|
-
|
|
5743
|
-
|
|
5744
|
-
|
|
5489
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
5490
|
+
interface V1ScheduledAction {
|
|
5491
|
+
/** Type of the action. */
|
|
5492
|
+
actionType?: ActionTypeWithLiterals;
|
|
5493
|
+
/** The date and time of the action. */
|
|
5494
|
+
executionDate?: Date | null;
|
|
5495
|
+
}
|
|
5496
|
+
declare enum ActionType {
|
|
5497
|
+
VOID = "VOID",
|
|
5498
|
+
CAPTURE = "CAPTURE"
|
|
5745
5499
|
}
|
|
5746
5500
|
/** @enumType */
|
|
5747
|
-
type
|
|
5748
|
-
interface
|
|
5501
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5502
|
+
interface Chargeback {
|
|
5749
5503
|
/**
|
|
5750
|
-
*
|
|
5751
|
-
* @
|
|
5752
|
-
* @
|
|
5504
|
+
* Chargeback ID.
|
|
5505
|
+
* @format GUID
|
|
5506
|
+
* @readonly
|
|
5507
|
+
* @immutable
|
|
5753
5508
|
*/
|
|
5754
|
-
|
|
5755
|
-
/** Information about the user who initiated the payment. */
|
|
5756
|
-
chargedBy?: ChargedBy;
|
|
5509
|
+
id?: string;
|
|
5757
5510
|
/**
|
|
5758
|
-
*
|
|
5511
|
+
* 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.
|
|
5512
|
+
* @readonly
|
|
5513
|
+
* @immutable
|
|
5514
|
+
*/
|
|
5515
|
+
createdDate?: Date | null;
|
|
5516
|
+
/**
|
|
5517
|
+
* 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.
|
|
5518
|
+
* @readonly
|
|
5519
|
+
*/
|
|
5520
|
+
updatedDate?: Date | null;
|
|
5521
|
+
/**
|
|
5522
|
+
* Amount.
|
|
5523
|
+
* @readonly
|
|
5524
|
+
* @immutable
|
|
5525
|
+
*/
|
|
5526
|
+
amount?: Price;
|
|
5527
|
+
/**
|
|
5528
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
5529
|
+
* @readonly
|
|
5530
|
+
*/
|
|
5531
|
+
reversalAmount?: Price;
|
|
5532
|
+
/**
|
|
5533
|
+
* Status.
|
|
5759
5534
|
*
|
|
5760
|
-
* Default:
|
|
5761
|
-
* @internal
|
|
5535
|
+
* Default: `"APPROVED"`.
|
|
5762
5536
|
*/
|
|
5763
|
-
|
|
5764
|
-
}
|
|
5765
|
-
interface ChargedBy {
|
|
5537
|
+
status?: ChargebackStatusWithLiterals;
|
|
5766
5538
|
/**
|
|
5767
|
-
*
|
|
5539
|
+
* External chargeback ID.
|
|
5768
5540
|
* @format GUID
|
|
5541
|
+
* @readonly
|
|
5542
|
+
* @immutable
|
|
5769
5543
|
*/
|
|
5770
|
-
|
|
5544
|
+
externalId?: string | null;
|
|
5545
|
+
}
|
|
5546
|
+
declare enum ChargebackStatus {
|
|
5547
|
+
/** Chargeback was approved. */
|
|
5548
|
+
APPROVED = "APPROVED",
|
|
5549
|
+
/** Chargeback was reversed. */
|
|
5550
|
+
REVERSED = "REVERSED"
|
|
5551
|
+
}
|
|
5552
|
+
/** @enumType */
|
|
5553
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5554
|
+
interface PaymentMethodName {
|
|
5771
5555
|
/**
|
|
5772
|
-
*
|
|
5773
|
-
* @
|
|
5774
|
-
* @maxLength 200
|
|
5556
|
+
* Translated payment method name in buyer language.
|
|
5557
|
+
* @maxLength 150
|
|
5775
5558
|
*/
|
|
5776
|
-
|
|
5777
|
-
|
|
5778
|
-
|
|
5779
|
-
|
|
5780
|
-
|
|
5559
|
+
buyerLanguageName?: string | null;
|
|
5560
|
+
/**
|
|
5561
|
+
* Translated payment method name in site owner language.
|
|
5562
|
+
* @maxLength 150
|
|
5563
|
+
*/
|
|
5564
|
+
siteLanguageName?: string | null;
|
|
5565
|
+
/**
|
|
5566
|
+
* User-provided payment method name.
|
|
5567
|
+
*
|
|
5568
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5569
|
+
*/
|
|
5570
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
5781
5571
|
}
|
|
5782
|
-
interface
|
|
5572
|
+
interface GiftCardPaymentDetails {
|
|
5783
5573
|
/**
|
|
5784
|
-
*
|
|
5785
|
-
* @minLength 1
|
|
5574
|
+
* Gift card payment ID.
|
|
5786
5575
|
* @maxLength 100
|
|
5787
5576
|
*/
|
|
5788
|
-
|
|
5577
|
+
giftCardPaymentId?: string;
|
|
5789
5578
|
/**
|
|
5790
|
-
*
|
|
5791
|
-
*
|
|
5579
|
+
* Gift card ID.
|
|
5580
|
+
* @internal
|
|
5581
|
+
* @deprecated
|
|
5582
|
+
*/
|
|
5583
|
+
giftCardId?: string;
|
|
5584
|
+
/**
|
|
5585
|
+
* ID of the app that created the gift card.
|
|
5792
5586
|
* @format GUID
|
|
5793
5587
|
*/
|
|
5794
|
-
|
|
5588
|
+
appId?: string;
|
|
5589
|
+
/**
|
|
5590
|
+
* Whether the gift card is voided.
|
|
5591
|
+
* @readonly
|
|
5592
|
+
* @deprecated Whether the gift card is voided.
|
|
5593
|
+
* @replacedBy payment.status
|
|
5594
|
+
* @targetRemovalDate 2026-11-01
|
|
5595
|
+
*/
|
|
5596
|
+
voided?: boolean;
|
|
5795
5597
|
/**
|
|
5796
|
-
*
|
|
5797
|
-
* @
|
|
5798
|
-
* @
|
|
5598
|
+
* Gift card code with all but the last four characters masked. For example, `************QXY1`.
|
|
5599
|
+
* @maxLength 30
|
|
5600
|
+
* @immutable
|
|
5799
5601
|
*/
|
|
5800
|
-
|
|
5602
|
+
obfuscatedCode?: string | null;
|
|
5801
5603
|
}
|
|
5802
|
-
interface
|
|
5604
|
+
interface MembershipPaymentDetails {
|
|
5803
5605
|
/**
|
|
5804
|
-
*
|
|
5805
|
-
* @
|
|
5806
|
-
* @maxLength 100
|
|
5606
|
+
* Membership ID.
|
|
5607
|
+
* @maxLength 200
|
|
5807
5608
|
*/
|
|
5808
5609
|
membershipId?: string;
|
|
5809
5610
|
/**
|
|
5810
|
-
* ID of the
|
|
5811
|
-
* @
|
|
5611
|
+
* ID of the line item this membership applies to.
|
|
5612
|
+
* @minLength 1
|
|
5613
|
+
* @maxLength 100
|
|
5812
5614
|
*/
|
|
5813
|
-
|
|
5814
|
-
/** The name of used membership */
|
|
5815
|
-
membershipName?: MembershipName;
|
|
5816
|
-
/** Additional data about this membership */
|
|
5817
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
5818
|
-
/** Catalog and item reference info. */
|
|
5819
|
-
catalogReference?: CatalogReference;
|
|
5820
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5821
|
-
serviceProperties?: ServiceProperties;
|
|
5615
|
+
lineItemId?: string;
|
|
5822
5616
|
/**
|
|
5823
|
-
*
|
|
5824
|
-
*
|
|
5825
|
-
*
|
|
5826
|
-
* @
|
|
5827
|
-
* @maxLength 36
|
|
5617
|
+
* Payment status.
|
|
5618
|
+
* @deprecated Payment status.
|
|
5619
|
+
* @replacedBy payment.status
|
|
5620
|
+
* @targetRemovalDate 2026-11-01
|
|
5828
5621
|
*/
|
|
5829
|
-
|
|
5622
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
5623
|
+
/** Membership name. */
|
|
5624
|
+
name?: MembershipName;
|
|
5830
5625
|
/**
|
|
5831
|
-
*
|
|
5626
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
5832
5627
|
* @minLength 1
|
|
5833
5628
|
* @maxLength 100
|
|
5834
5629
|
*/
|
|
5835
|
-
|
|
5836
|
-
}
|
|
5837
|
-
interface MembershipName {
|
|
5630
|
+
externalTransactionId?: string | null;
|
|
5838
5631
|
/**
|
|
5839
|
-
*
|
|
5840
|
-
* @
|
|
5632
|
+
* Whether the membership is voided.
|
|
5633
|
+
* @readonly
|
|
5634
|
+
* @deprecated Whether the membership is voided.
|
|
5635
|
+
* @replacedBy payment.status
|
|
5636
|
+
* @targetRemovalDate 2026-11-01
|
|
5841
5637
|
*/
|
|
5842
|
-
|
|
5638
|
+
voided?: boolean;
|
|
5843
5639
|
/**
|
|
5844
|
-
*
|
|
5845
|
-
* @
|
|
5640
|
+
* ID of the application providing this payment option.
|
|
5641
|
+
* @format GUID
|
|
5846
5642
|
*/
|
|
5847
|
-
|
|
5643
|
+
providerAppId?: string;
|
|
5644
|
+
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
5645
|
+
futureMembership?: FutureMembershipDetails;
|
|
5848
5646
|
}
|
|
5849
|
-
|
|
5647
|
+
declare enum MembershipPaymentStatus {
|
|
5648
|
+
/** Payment was charged. */
|
|
5649
|
+
CHARGED = "CHARGED",
|
|
5650
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5651
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5652
|
+
/** Payment is pending. */
|
|
5653
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5654
|
+
/** Payment was voided. */
|
|
5655
|
+
VOIDED = "VOIDED"
|
|
5850
5656
|
}
|
|
5851
|
-
|
|
5657
|
+
/** @enumType */
|
|
5658
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
5659
|
+
interface FutureMembershipDetails {
|
|
5852
5660
|
/**
|
|
5853
|
-
*
|
|
5854
|
-
* @
|
|
5855
|
-
* @maxLength 100
|
|
5661
|
+
* ID of the plan line item in the order from which the membership will be created.
|
|
5662
|
+
* @format GUID
|
|
5856
5663
|
*/
|
|
5857
|
-
|
|
5664
|
+
lineItemId?: string;
|
|
5858
5665
|
/**
|
|
5859
|
-
*
|
|
5860
|
-
* @
|
|
5861
|
-
* @maxSize 1
|
|
5666
|
+
* ID of the benefit the future membership will grant.
|
|
5667
|
+
* @maxLength 200
|
|
5862
5668
|
*/
|
|
5863
|
-
|
|
5864
|
-
/** Business model of a refund */
|
|
5865
|
-
details?: RefundDetails;
|
|
5866
|
-
/** Side effect details related to refund */
|
|
5867
|
-
sideEffects?: RefundSideEffects;
|
|
5669
|
+
benefitId?: string;
|
|
5868
5670
|
}
|
|
5869
|
-
interface
|
|
5671
|
+
interface WixReceiptInfo {
|
|
5870
5672
|
/**
|
|
5871
|
-
*
|
|
5673
|
+
* Receipt ID
|
|
5872
5674
|
* @format GUID
|
|
5873
5675
|
*/
|
|
5874
|
-
|
|
5875
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5876
|
-
amount?: Price;
|
|
5877
|
-
/**
|
|
5878
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5879
|
-
* 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.
|
|
5880
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5881
|
-
*/
|
|
5882
|
-
externalRefund?: boolean;
|
|
5676
|
+
receiptId?: string;
|
|
5883
5677
|
/**
|
|
5884
|
-
*
|
|
5885
|
-
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
5886
|
-
* and all side effects from request will be executed.
|
|
5887
|
-
* @internal
|
|
5678
|
+
* Display number of receipt
|
|
5888
5679
|
* @minLength 1
|
|
5889
|
-
* @maxLength
|
|
5680
|
+
* @maxLength 40
|
|
5890
5681
|
*/
|
|
5891
|
-
|
|
5682
|
+
displayNumber?: string | null;
|
|
5892
5683
|
}
|
|
5893
|
-
interface
|
|
5894
|
-
/** Inventory restock details as part of this refund. */
|
|
5895
|
-
restockInfo?: RestockInfo;
|
|
5896
|
-
/** Whether to send a refund confirmation email to the customer. */
|
|
5897
|
-
sendOrderRefundedEmail?: boolean;
|
|
5684
|
+
interface ExternalReceiptInfo {
|
|
5898
5685
|
/**
|
|
5899
|
-
*
|
|
5900
|
-
* @
|
|
5901
|
-
* @maxLength 1000
|
|
5686
|
+
* External receipt ID
|
|
5687
|
+
* @maxLength 100
|
|
5902
5688
|
*/
|
|
5903
|
-
|
|
5904
|
-
}
|
|
5905
|
-
interface RestockInfo {
|
|
5906
|
-
/** Restock type. */
|
|
5907
|
-
type?: RestockTypeWithLiterals;
|
|
5689
|
+
receiptId?: string | null;
|
|
5908
5690
|
/**
|
|
5909
|
-
*
|
|
5910
|
-
* @
|
|
5911
|
-
* @maxSize 300
|
|
5912
|
-
* @deprecated
|
|
5691
|
+
* ID of the app providing the receipt
|
|
5692
|
+
* @format GUID
|
|
5913
5693
|
*/
|
|
5914
|
-
|
|
5694
|
+
appId?: string | null;
|
|
5915
5695
|
/**
|
|
5916
|
-
*
|
|
5917
|
-
* @
|
|
5696
|
+
* Display number of receipt
|
|
5697
|
+
* @minLength 1
|
|
5698
|
+
* @maxLength 40
|
|
5918
5699
|
*/
|
|
5919
|
-
|
|
5920
|
-
}
|
|
5921
|
-
declare enum RestockType {
|
|
5922
|
-
NO_ITEMS = "NO_ITEMS",
|
|
5923
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
5924
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
5700
|
+
displayNumber?: string | null;
|
|
5925
5701
|
}
|
|
5926
|
-
|
|
5927
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5928
|
-
interface RestockItem {
|
|
5702
|
+
interface CashRoundingDetails {
|
|
5929
5703
|
/**
|
|
5930
|
-
*
|
|
5931
|
-
*
|
|
5704
|
+
* Payment amount before cash rounding was applied.
|
|
5705
|
+
* When provided, balance and status calculations use this value instead of `amount`
|
|
5706
|
+
* to prevent false overpayment or underpayment due to rounding.
|
|
5932
5707
|
*/
|
|
5933
|
-
|
|
5708
|
+
unroundedAmount?: Price;
|
|
5934
5709
|
/**
|
|
5935
|
-
*
|
|
5936
|
-
*
|
|
5937
|
-
* @
|
|
5710
|
+
* The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
|
|
5711
|
+
* A positive value indicates the price was rounded up; a negative value indicates a round-down.
|
|
5712
|
+
* @readonly
|
|
5938
5713
|
*/
|
|
5939
|
-
|
|
5714
|
+
roundingAdjustment?: CashRounding;
|
|
5715
|
+
}
|
|
5716
|
+
declare enum PaymentStatus {
|
|
5717
|
+
/** Payment was charged successfully. */
|
|
5718
|
+
APPROVED = "APPROVED",
|
|
5719
|
+
/** Payment is being processed and hasn't been confirmed yet. */
|
|
5720
|
+
PENDING = "PENDING",
|
|
5721
|
+
/** 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. */
|
|
5722
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5723
|
+
/** Payment was canceled before it was charged. */
|
|
5724
|
+
CANCELED = "CANCELED",
|
|
5725
|
+
/** Payment was declined by the payment provider. */
|
|
5726
|
+
DECLINED = "DECLINED",
|
|
5727
|
+
/** Payment was fully refunded. */
|
|
5728
|
+
REFUNDED = "REFUNDED",
|
|
5729
|
+
/** Part of the payment amount was refunded. */
|
|
5730
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5731
|
+
/** 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. */
|
|
5732
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5940
5733
|
/**
|
|
5941
|
-
*
|
|
5942
|
-
*
|
|
5943
|
-
*
|
|
5734
|
+
* Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
|
|
5735
|
+
*
|
|
5736
|
+
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
5944
5737
|
*/
|
|
5945
|
-
|
|
5738
|
+
VOIDED = "VOIDED"
|
|
5946
5739
|
}
|
|
5947
|
-
|
|
5948
|
-
|
|
5949
|
-
|
|
5950
|
-
|
|
5951
|
-
refundId?: string | null;
|
|
5952
|
-
/** Payment ID's that the refund execution had failed for */
|
|
5953
|
-
failedPaymentIds?: ItemMetadata[];
|
|
5740
|
+
/** @enumType */
|
|
5741
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5742
|
+
interface CanceledStatusDetails {
|
|
5743
|
+
reason?: CanceledReasonWithLiterals;
|
|
5954
5744
|
}
|
|
5955
|
-
|
|
5956
|
-
|
|
5957
|
-
|
|
5958
|
-
|
|
5959
|
-
|
|
5960
|
-
|
|
5961
|
-
|
|
5962
|
-
|
|
5963
|
-
|
|
5964
|
-
|
|
5965
|
-
|
|
5966
|
-
|
|
5967
|
-
|
|
5968
|
-
|
|
5969
|
-
|
|
5970
|
-
|
|
5971
|
-
/**
|
|
5972
|
-
|
|
5973
|
-
|
|
5974
|
-
|
|
5975
|
-
refunds?: Refund[];
|
|
5745
|
+
declare enum CanceledReason {
|
|
5746
|
+
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
5747
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
5748
|
+
/** Payment was not completed by user and expired. */
|
|
5749
|
+
EXPIRED = "EXPIRED"
|
|
5750
|
+
}
|
|
5751
|
+
/** @enumType */
|
|
5752
|
+
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
5753
|
+
interface DeclinedStatusDetails {
|
|
5754
|
+
reason?: DeclinedReasonWithLiterals;
|
|
5755
|
+
}
|
|
5756
|
+
declare enum DeclinedReason {
|
|
5757
|
+
/** Corresponding charge failed. */
|
|
5758
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5759
|
+
/** Payment details expired. */
|
|
5760
|
+
EXPIRED = "EXPIRED",
|
|
5761
|
+
/** Insufficient funds. */
|
|
5762
|
+
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
5763
|
+
/** Gift card was disabled before charge was attempted. */
|
|
5764
|
+
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
5976
5765
|
}
|
|
5977
|
-
|
|
5978
|
-
|
|
5979
|
-
|
|
5980
|
-
|
|
5981
|
-
|
|
5982
|
-
|
|
5983
|
-
|
|
5984
|
-
|
|
5985
|
-
|
|
5986
|
-
|
|
5987
|
-
|
|
5988
|
-
|
|
5766
|
+
/** @enumType */
|
|
5767
|
+
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
5768
|
+
interface VoidedStatusDetails {
|
|
5769
|
+
reason?: VoidedReasonWithLiterals;
|
|
5770
|
+
}
|
|
5771
|
+
declare enum VoidedReason {
|
|
5772
|
+
/** Payment was voided by merchant request. */
|
|
5773
|
+
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
5774
|
+
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
5775
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
5776
|
+
}
|
|
5777
|
+
/** @enumType */
|
|
5778
|
+
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
5779
|
+
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
5780
|
+
/** @internal */
|
|
5781
|
+
canceled?: CanceledStatusDetails;
|
|
5782
|
+
/** @internal */
|
|
5783
|
+
declined?: DeclinedStatusDetails;
|
|
5784
|
+
/** @internal */
|
|
5785
|
+
voided?: VoidedStatusDetails;
|
|
5989
5786
|
/**
|
|
5990
|
-
*
|
|
5787
|
+
* Reason code from the payment gateway.
|
|
5991
5788
|
* @internal
|
|
5789
|
+
* @minLength 1
|
|
5790
|
+
* @maxLength 10
|
|
5992
5791
|
*/
|
|
5993
|
-
|
|
5792
|
+
paymentGatewayReasonCode?: string | null;
|
|
5793
|
+
}
|
|
5794
|
+
/** @oneof */
|
|
5795
|
+
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
5994
5796
|
/** @internal */
|
|
5995
5797
|
canceled?: CanceledStatusDetails;
|
|
5996
5798
|
/** @internal */
|
|
5997
5799
|
declined?: DeclinedStatusDetails;
|
|
5998
5800
|
/** @internal */
|
|
5999
5801
|
voided?: VoidedStatusDetails;
|
|
5802
|
+
}
|
|
5803
|
+
interface Refund {
|
|
6000
5804
|
/**
|
|
6001
|
-
*
|
|
5805
|
+
* Refund ID.
|
|
6002
5806
|
* @format GUID
|
|
6003
5807
|
* @readonly
|
|
6004
5808
|
*/
|
|
6005
|
-
id?: string
|
|
6006
|
-
/** 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. */
|
|
6007
|
-
createdDate?: Date | null;
|
|
5809
|
+
id?: string;
|
|
6008
5810
|
/**
|
|
6009
|
-
*
|
|
5811
|
+
* List of transactions.
|
|
5812
|
+
* @maxSize 50
|
|
5813
|
+
*/
|
|
5814
|
+
transactions?: RefundTransaction[];
|
|
5815
|
+
/** Refund business details. */
|
|
5816
|
+
details?: RefundDetails;
|
|
5817
|
+
/**
|
|
5818
|
+
* 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.
|
|
6010
5819
|
* @readonly
|
|
5820
|
+
* @immutable
|
|
6011
5821
|
*/
|
|
6012
|
-
|
|
6013
|
-
/** Payment amount. */
|
|
6014
|
-
amount?: Price;
|
|
5822
|
+
createdDate?: Date | null;
|
|
6015
5823
|
/**
|
|
6016
|
-
*
|
|
6017
|
-
*
|
|
6018
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5824
|
+
* Aggregated refund summary.
|
|
5825
|
+
* @readonly
|
|
6019
5826
|
*/
|
|
6020
|
-
|
|
5827
|
+
summary?: AggregatedRefundSummary;
|
|
6021
5828
|
/**
|
|
6022
|
-
*
|
|
6023
|
-
*
|
|
6024
|
-
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5829
|
+
* ID of the app that initiated this refund.
|
|
5830
|
+
* @format GUID
|
|
6025
5831
|
* @readonly
|
|
5832
|
+
* @immutable
|
|
6026
5833
|
*/
|
|
6027
|
-
|
|
6028
|
-
|
|
6029
|
-
|
|
5834
|
+
requestingServiceAppId?: string | null;
|
|
5835
|
+
}
|
|
5836
|
+
interface RefundTransaction {
|
|
6030
5837
|
/**
|
|
6031
|
-
*
|
|
6032
|
-
*
|
|
6033
|
-
*
|
|
5838
|
+
* ID of the payment associated with this refund.
|
|
5839
|
+
* @format GUID
|
|
5840
|
+
* @immutable
|
|
6034
5841
|
*/
|
|
6035
|
-
|
|
5842
|
+
paymentId?: string;
|
|
6036
5843
|
/**
|
|
6037
|
-
*
|
|
6038
|
-
* @
|
|
5844
|
+
* Refund amount.
|
|
5845
|
+
* @immutable
|
|
6039
5846
|
*/
|
|
6040
|
-
|
|
5847
|
+
amount?: Price;
|
|
5848
|
+
/** Refund status. */
|
|
5849
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
5850
|
+
/** Optional details of current refund status. */
|
|
5851
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
6041
5852
|
/**
|
|
6042
|
-
*
|
|
5853
|
+
* Payment gateway's refund ID.
|
|
5854
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
5855
|
+
* @format GUID
|
|
5856
|
+
*/
|
|
5857
|
+
gatewayRefundId?: string | null;
|
|
5858
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5859
|
+
providerRefundId?: string | null;
|
|
5860
|
+
/**
|
|
5861
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
5862
|
+
* @immutable
|
|
5863
|
+
*/
|
|
5864
|
+
externalRefund?: boolean;
|
|
5865
|
+
/**
|
|
5866
|
+
* Location where the refund was processed.
|
|
6043
5867
|
* @internal
|
|
6044
5868
|
* @format GUID
|
|
6045
5869
|
* @immutable
|
|
6046
5870
|
*/
|
|
6047
5871
|
locationId?: string | null;
|
|
5872
|
+
}
|
|
5873
|
+
/** Refund transaction status. */
|
|
5874
|
+
declare enum RefundStatus {
|
|
5875
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
5876
|
+
PENDING = "PENDING",
|
|
5877
|
+
/** Refund transaction succeeded. */
|
|
5878
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5879
|
+
/** Refund transaction failed. */
|
|
5880
|
+
FAILED = "FAILED",
|
|
5881
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
5882
|
+
SCHEDULED = "SCHEDULED",
|
|
5883
|
+
/** Refund was initiated on payment provider side. */
|
|
5884
|
+
STARTED = "STARTED"
|
|
5885
|
+
}
|
|
5886
|
+
/** @enumType */
|
|
5887
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5888
|
+
interface RefundStatusInfo {
|
|
6048
5889
|
/**
|
|
6049
|
-
*
|
|
5890
|
+
* Reason code for the refund's current status.
|
|
5891
|
+
*
|
|
5892
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5893
|
+
* @minLength 1
|
|
5894
|
+
* @maxLength 10
|
|
5895
|
+
*/
|
|
5896
|
+
paymentGatewayReasonCode?: string | null;
|
|
5897
|
+
/**
|
|
5898
|
+
* Free text explanation of current refund status.
|
|
5899
|
+
* @minLength 1
|
|
5900
|
+
* @maxLength 1000
|
|
5901
|
+
*/
|
|
5902
|
+
description?: string | null;
|
|
5903
|
+
}
|
|
5904
|
+
interface AggregatedRefundSummary {
|
|
5905
|
+
/** Total amount requested for refund. */
|
|
5906
|
+
requestedRefund?: Price;
|
|
5907
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5908
|
+
pendingRefund?: Price;
|
|
5909
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5910
|
+
refunded?: Price;
|
|
5911
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5912
|
+
failedRefundAmount?: Price;
|
|
5913
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5914
|
+
pending?: boolean;
|
|
5915
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5916
|
+
breakdown?: RefundItemsBreakdown;
|
|
5917
|
+
}
|
|
5918
|
+
interface RefundItemsBreakdown {
|
|
5919
|
+
/**
|
|
5920
|
+
* Refunded line items and the amount refunded for each.
|
|
5921
|
+
* @maxSize 300
|
|
5922
|
+
*/
|
|
5923
|
+
lineItems?: LineItemRefundSummary[];
|
|
5924
|
+
}
|
|
5925
|
+
interface LineItemRefundSummary {
|
|
5926
|
+
/**
|
|
5927
|
+
* ID of the refunded line item.
|
|
6050
5928
|
* @format GUID
|
|
6051
5929
|
*/
|
|
6052
|
-
|
|
5930
|
+
lineItemId?: string;
|
|
5931
|
+
/** Total refunded amount for the line item. */
|
|
5932
|
+
totalRefundedAmount?: Price;
|
|
6053
5933
|
}
|
|
6054
|
-
|
|
6055
|
-
|
|
6056
|
-
|
|
6057
|
-
|
|
6058
|
-
|
|
6059
|
-
|
|
6060
|
-
|
|
6061
|
-
|
|
5934
|
+
interface CalculateRefundRequest {
|
|
5935
|
+
/**
|
|
5936
|
+
* Order ID
|
|
5937
|
+
* @minLength 1
|
|
5938
|
+
* @maxLength 100
|
|
5939
|
+
*/
|
|
5940
|
+
ecomOrderId?: string;
|
|
5941
|
+
/**
|
|
5942
|
+
* Refunded line items and quantity
|
|
5943
|
+
* @maxSize 300
|
|
5944
|
+
*/
|
|
5945
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
5946
|
+
/** Should include shipping in refund calculation */
|
|
5947
|
+
refundShipping?: boolean;
|
|
6062
5948
|
}
|
|
6063
|
-
|
|
6064
|
-
interface PaymentReceiptInfoOneOf {
|
|
5949
|
+
interface CalculateRefundItemRequest {
|
|
6065
5950
|
/**
|
|
6066
|
-
*
|
|
6067
|
-
* @
|
|
5951
|
+
* ID of the line item being refunded
|
|
5952
|
+
* @format GUID
|
|
6068
5953
|
*/
|
|
6069
|
-
|
|
5954
|
+
id?: string;
|
|
6070
5955
|
/**
|
|
6071
|
-
*
|
|
6072
|
-
* @
|
|
5956
|
+
* How much of that line item is being refunded
|
|
5957
|
+
* @min 1
|
|
5958
|
+
* @max 100000
|
|
6073
5959
|
*/
|
|
6074
|
-
|
|
5960
|
+
quantity?: number;
|
|
6075
5961
|
}
|
|
6076
|
-
|
|
6077
|
-
|
|
6078
|
-
|
|
6079
|
-
|
|
6080
|
-
|
|
6081
|
-
|
|
6082
|
-
|
|
6083
|
-
|
|
5962
|
+
interface CalculateRefundResponse {
|
|
5963
|
+
/** Total refundable amount */
|
|
5964
|
+
total?: Price;
|
|
5965
|
+
/** Tax cost of the order */
|
|
5966
|
+
tax?: Price;
|
|
5967
|
+
/** Discount given for this order */
|
|
5968
|
+
discount?: Price;
|
|
5969
|
+
/** Total cost of the order (without tax) */
|
|
5970
|
+
subtotal?: Price;
|
|
5971
|
+
/** Total shipping cost for order */
|
|
5972
|
+
shipping?: Price;
|
|
5973
|
+
/** Previous refund given on that order */
|
|
5974
|
+
previouslyRefundedAmount?: Price;
|
|
5975
|
+
/**
|
|
5976
|
+
* The refundable items of that order
|
|
5977
|
+
* @maxSize 300
|
|
5978
|
+
*/
|
|
5979
|
+
items?: CalculateRefundItemResponse[];
|
|
6084
5980
|
}
|
|
6085
|
-
interface
|
|
6086
|
-
/** Credit card details. */
|
|
6087
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5981
|
+
interface CalculateRefundItemResponse {
|
|
6088
5982
|
/**
|
|
6089
|
-
*
|
|
6090
|
-
* @
|
|
5983
|
+
* Line item ID
|
|
5984
|
+
* @format GUID
|
|
6091
5985
|
*/
|
|
6092
|
-
|
|
5986
|
+
id?: string;
|
|
5987
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
5988
|
+
price?: Price;
|
|
5989
|
+
}
|
|
5990
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
6093
5991
|
/**
|
|
6094
|
-
*
|
|
6095
|
-
*
|
|
5992
|
+
* Wix eCommerce order ID
|
|
5993
|
+
* @minLength 1
|
|
6096
5994
|
* @maxLength 100
|
|
6097
5995
|
*/
|
|
6098
|
-
|
|
5996
|
+
ecomOrderId: string;
|
|
6099
5997
|
/**
|
|
6100
|
-
* Payment
|
|
6101
|
-
*
|
|
6102
|
-
*
|
|
6103
|
-
*
|
|
6104
|
-
* @maxLength 150
|
|
6105
|
-
* @deprecated Payment method.
|
|
6106
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
6107
|
-
* Non-exhaustive list of supported values:
|
|
6108
|
-
* + `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`
|
|
6109
|
-
* @replacedBy payment_method_name
|
|
6110
|
-
* @targetRemovalDate 2026-07-01
|
|
5998
|
+
* Payment IDs
|
|
5999
|
+
* @minSize 1
|
|
6000
|
+
* @maxSize 100
|
|
6001
|
+
* @format GUID
|
|
6111
6002
|
*/
|
|
6112
|
-
|
|
6003
|
+
paymentIds: string[];
|
|
6004
|
+
}
|
|
6005
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
6006
|
+
/** All order's transactions after the void was triggered */
|
|
6007
|
+
orderTransactions?: OrderTransactions;
|
|
6008
|
+
}
|
|
6009
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
6113
6010
|
/**
|
|
6114
|
-
*
|
|
6011
|
+
* Wix eCommerce order ID
|
|
6012
|
+
* @minLength 1
|
|
6115
6013
|
* @maxLength 100
|
|
6116
6014
|
*/
|
|
6117
|
-
|
|
6118
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
6119
|
-
offlinePayment?: boolean;
|
|
6120
|
-
/**
|
|
6121
|
-
* Payment status.
|
|
6122
|
-
* @deprecated Payment status.
|
|
6123
|
-
* @replacedBy payment.status
|
|
6124
|
-
* @targetRemovalDate 2026-11-01
|
|
6125
|
-
*/
|
|
6126
|
-
status?: TransactionStatusWithLiterals;
|
|
6127
|
-
/** Whether there is a payment agreement that allows for future charges. */
|
|
6128
|
-
savedPaymentMethod?: boolean;
|
|
6129
|
-
/** Authorization details. */
|
|
6130
|
-
authorizationDetails?: AuthorizationDetails;
|
|
6015
|
+
ecomOrderId: string;
|
|
6131
6016
|
/**
|
|
6132
|
-
*
|
|
6133
|
-
* @
|
|
6134
|
-
* @
|
|
6017
|
+
* Capture payments information
|
|
6018
|
+
* @minSize 1
|
|
6019
|
+
* @maxSize 100
|
|
6135
6020
|
*/
|
|
6136
|
-
|
|
6021
|
+
payments: PaymentCapture[];
|
|
6022
|
+
}
|
|
6023
|
+
interface PaymentCapture {
|
|
6137
6024
|
/**
|
|
6138
|
-
*
|
|
6139
|
-
* @
|
|
6025
|
+
* Payment ID
|
|
6026
|
+
* @format GUID
|
|
6140
6027
|
*/
|
|
6141
|
-
|
|
6028
|
+
paymentId?: string | null;
|
|
6142
6029
|
/**
|
|
6143
|
-
*
|
|
6144
|
-
*
|
|
6145
|
-
* @maxLength 36
|
|
6030
|
+
* Capture amount.
|
|
6031
|
+
* If not provided - full authorized amount will be captured.
|
|
6146
6032
|
*/
|
|
6147
|
-
|
|
6148
|
-
|
|
6149
|
-
|
|
6033
|
+
amount?: Price;
|
|
6034
|
+
}
|
|
6035
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
6036
|
+
/** All order's transactions after the capture was triggered */
|
|
6037
|
+
orderTransactions?: OrderTransactions;
|
|
6038
|
+
}
|
|
6039
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
6150
6040
|
/**
|
|
6151
|
-
*
|
|
6152
|
-
*
|
|
6153
|
-
*
|
|
6041
|
+
* Ecom Order ID.
|
|
6042
|
+
* @minLength 1
|
|
6043
|
+
* @maxLength 100
|
|
6154
6044
|
*/
|
|
6155
|
-
|
|
6045
|
+
ecomOrderId?: string;
|
|
6046
|
+
/** Amount to be charged */
|
|
6047
|
+
amount?: Price;
|
|
6156
6048
|
}
|
|
6157
|
-
|
|
6158
|
-
|
|
6159
|
-
|
|
6160
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
6049
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
6050
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
6051
|
+
paymentGatewayOrderId?: string;
|
|
6161
6052
|
}
|
|
6162
|
-
|
|
6163
|
-
|
|
6164
|
-
|
|
6165
|
-
PENDING = "PENDING",
|
|
6166
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6167
|
-
CANCELED = "CANCELED",
|
|
6168
|
-
DECLINED = "DECLINED",
|
|
6169
|
-
REFUNDED = "REFUNDED",
|
|
6170
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6171
|
-
AUTHORIZED = "AUTHORIZED",
|
|
6172
|
-
VOIDED = "VOIDED"
|
|
6053
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
6054
|
+
/** @format GUID */
|
|
6055
|
+
orderId?: string;
|
|
6173
6056
|
}
|
|
6174
|
-
|
|
6175
|
-
|
|
6176
|
-
interface
|
|
6177
|
-
/**
|
|
6178
|
-
* The last 4 digits of the card number.
|
|
6179
|
-
* @maxLength 4
|
|
6180
|
-
*/
|
|
6181
|
-
lastFourDigits?: string | null;
|
|
6057
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
6058
|
+
}
|
|
6059
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
6182
6060
|
/**
|
|
6183
|
-
*
|
|
6061
|
+
* @minLength 1
|
|
6184
6062
|
* @maxLength 100
|
|
6185
6063
|
*/
|
|
6186
|
-
|
|
6064
|
+
orderId?: string;
|
|
6187
6065
|
}
|
|
6188
|
-
interface
|
|
6189
|
-
/**
|
|
6190
|
-
* Whether the authorized payment is of a delayed capture.
|
|
6191
|
-
* @readonly
|
|
6192
|
-
*/
|
|
6193
|
-
delayedCapture?: boolean;
|
|
6194
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6195
|
-
authorizedDate?: Date | null;
|
|
6196
|
-
/**
|
|
6197
|
-
* List of captures associated with payment
|
|
6198
|
-
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
6199
|
-
* @maxSize 1
|
|
6200
|
-
*/
|
|
6201
|
-
captures?: AuthorizationCapture[];
|
|
6202
|
-
/** Void associated with payment */
|
|
6203
|
-
void?: AuthorizationVoid;
|
|
6204
|
-
/** Scheduled action for this transaction */
|
|
6205
|
-
scheduledAction?: V1ScheduledAction;
|
|
6066
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
6206
6067
|
}
|
|
6207
|
-
interface
|
|
6068
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
6208
6069
|
/**
|
|
6209
|
-
*
|
|
6210
|
-
* @
|
|
6211
|
-
* @readonly
|
|
6070
|
+
* @minLength 1
|
|
6071
|
+
* @maxLength 100
|
|
6212
6072
|
*/
|
|
6213
|
-
|
|
6214
|
-
|
|
6215
|
-
|
|
6073
|
+
orderId?: string;
|
|
6074
|
+
}
|
|
6075
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
6076
|
+
}
|
|
6077
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
6216
6078
|
/**
|
|
6217
|
-
*
|
|
6218
|
-
* @
|
|
6079
|
+
* IDs of orders to send pickup emails for.
|
|
6080
|
+
* @minSize 1
|
|
6081
|
+
* @maxSize 300
|
|
6219
6082
|
*/
|
|
6220
|
-
|
|
6221
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6222
|
-
createdDate?: Date | null;
|
|
6223
|
-
/** In case of status is FAILED may contain failure details */
|
|
6224
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
6083
|
+
orderIds?: string[];
|
|
6225
6084
|
}
|
|
6226
|
-
|
|
6227
|
-
/** Capture operation still in progress. */
|
|
6228
|
-
PENDING = "PENDING",
|
|
6229
|
-
/** Capture operation succeeded. */
|
|
6230
|
-
SUCCEEDED = "SUCCEEDED",
|
|
6231
|
-
/** Capture operation failed. */
|
|
6232
|
-
FAILED = "FAILED"
|
|
6085
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
6233
6086
|
}
|
|
6234
|
-
|
|
6235
|
-
|
|
6236
|
-
|
|
6237
|
-
|
|
6238
|
-
|
|
6087
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
6088
|
+
/**
|
|
6089
|
+
* @minLength 1
|
|
6090
|
+
* @maxLength 100
|
|
6091
|
+
*/
|
|
6092
|
+
orderId?: string;
|
|
6239
6093
|
}
|
|
6240
|
-
interface
|
|
6241
|
-
/** Status of this void action */
|
|
6242
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
6243
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6244
|
-
voidedDate?: Date | null;
|
|
6245
|
-
/** In case of status is FAILED may contain failure details */
|
|
6246
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
6247
|
-
/** Reason of void action */
|
|
6248
|
-
reason?: ReasonWithLiterals;
|
|
6094
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
6249
6095
|
}
|
|
6250
|
-
|
|
6251
|
-
/**
|
|
6252
|
-
|
|
6253
|
-
|
|
6254
|
-
|
|
6255
|
-
|
|
6256
|
-
|
|
6096
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
6097
|
+
/**
|
|
6098
|
+
* IDs of orders to send pickup emails for.
|
|
6099
|
+
* @minSize 1
|
|
6100
|
+
* @maxSize 300
|
|
6101
|
+
*/
|
|
6102
|
+
orderIds?: string[];
|
|
6257
6103
|
}
|
|
6258
|
-
|
|
6259
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
6260
|
-
/** Reason the authorization was voided. */
|
|
6261
|
-
declare enum Reason {
|
|
6262
|
-
/** Authorization was voided by user. */
|
|
6263
|
-
MANUAL = "MANUAL",
|
|
6264
|
-
/** Authorization passed execution date. */
|
|
6265
|
-
SCHEDULED = "SCHEDULED"
|
|
6104
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
6266
6105
|
}
|
|
6267
|
-
|
|
6268
|
-
|
|
6269
|
-
|
|
6270
|
-
|
|
6271
|
-
|
|
6272
|
-
|
|
6273
|
-
executionDate?: Date | null;
|
|
6106
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
6107
|
+
/**
|
|
6108
|
+
* @minLength 1
|
|
6109
|
+
* @maxLength 100
|
|
6110
|
+
*/
|
|
6111
|
+
orderId?: string;
|
|
6274
6112
|
}
|
|
6275
|
-
|
|
6276
|
-
VOID = "VOID",
|
|
6277
|
-
CAPTURE = "CAPTURE"
|
|
6113
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
6278
6114
|
}
|
|
6279
|
-
|
|
6280
|
-
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
6281
|
-
interface Chargeback {
|
|
6115
|
+
interface SendCancelRefundEmailRequest {
|
|
6282
6116
|
/**
|
|
6283
|
-
*
|
|
6284
|
-
* @
|
|
6285
|
-
* @
|
|
6286
|
-
* @immutable
|
|
6117
|
+
* The ID of order that is canceled/refunded
|
|
6118
|
+
* @minLength 1
|
|
6119
|
+
* @maxLength 100
|
|
6287
6120
|
*/
|
|
6288
|
-
|
|
6121
|
+
orderId?: string;
|
|
6289
6122
|
/**
|
|
6290
|
-
*
|
|
6291
|
-
* @
|
|
6292
|
-
* @
|
|
6123
|
+
* Personal note added to the email (optional)
|
|
6124
|
+
* @minLength 1
|
|
6125
|
+
* @maxLength 1000
|
|
6293
6126
|
*/
|
|
6294
|
-
|
|
6127
|
+
customMessage?: string | null;
|
|
6128
|
+
/** Refund amount */
|
|
6129
|
+
refundAmount?: Price;
|
|
6295
6130
|
/**
|
|
6296
|
-
*
|
|
6297
|
-
* @
|
|
6131
|
+
* Refund ID. (Optional)
|
|
6132
|
+
* @format GUID
|
|
6298
6133
|
*/
|
|
6299
|
-
|
|
6134
|
+
refundId?: string | null;
|
|
6135
|
+
}
|
|
6136
|
+
interface SendCancelRefundEmailResponse {
|
|
6137
|
+
}
|
|
6138
|
+
interface SendRefundEmailRequest {
|
|
6300
6139
|
/**
|
|
6301
|
-
*
|
|
6302
|
-
* @
|
|
6303
|
-
* @immutable
|
|
6140
|
+
* The ID of order that is refunded
|
|
6141
|
+
* @format GUID
|
|
6304
6142
|
*/
|
|
6305
|
-
|
|
6143
|
+
orderId?: string;
|
|
6306
6144
|
/**
|
|
6307
|
-
*
|
|
6308
|
-
* @
|
|
6145
|
+
* Refund ID
|
|
6146
|
+
* @format GUID
|
|
6309
6147
|
*/
|
|
6310
|
-
|
|
6148
|
+
refundId?: string;
|
|
6311
6149
|
/**
|
|
6312
|
-
*
|
|
6313
|
-
*
|
|
6314
|
-
*
|
|
6150
|
+
* Personal note added to the email (optional)
|
|
6151
|
+
* @minLength 1
|
|
6152
|
+
* @maxLength 1000
|
|
6315
6153
|
*/
|
|
6316
|
-
|
|
6154
|
+
customMessage?: string | null;
|
|
6155
|
+
}
|
|
6156
|
+
interface SendRefundEmailResponse {
|
|
6157
|
+
}
|
|
6158
|
+
interface SendFulfillmentEmailRequest {
|
|
6159
|
+
/** @format GUID */
|
|
6160
|
+
orderId?: string;
|
|
6161
|
+
/** @format GUID */
|
|
6162
|
+
fulfillerId?: string;
|
|
6163
|
+
}
|
|
6164
|
+
interface SendFulfillmentEmailResponse {
|
|
6165
|
+
}
|
|
6166
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
6317
6167
|
/**
|
|
6318
|
-
*
|
|
6319
|
-
* @
|
|
6320
|
-
* @readonly
|
|
6321
|
-
* @immutable
|
|
6168
|
+
* @minLength 1
|
|
6169
|
+
* @maxLength 100
|
|
6322
6170
|
*/
|
|
6323
|
-
|
|
6171
|
+
orderId?: string;
|
|
6324
6172
|
}
|
|
6325
|
-
|
|
6326
|
-
|
|
6327
|
-
|
|
6328
|
-
|
|
6329
|
-
|
|
6173
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
6174
|
+
}
|
|
6175
|
+
interface PreviewEmailByTypeRequest {
|
|
6176
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
6177
|
+
}
|
|
6178
|
+
declare enum PreviewEmailType {
|
|
6179
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
6180
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
6181
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
6182
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
6330
6183
|
}
|
|
6331
6184
|
/** @enumType */
|
|
6332
|
-
type
|
|
6333
|
-
interface
|
|
6185
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
6186
|
+
interface PreviewEmailByTypeResponse {
|
|
6187
|
+
emailPreview?: string;
|
|
6188
|
+
}
|
|
6189
|
+
interface PreviewRefundEmailRequest {
|
|
6334
6190
|
/**
|
|
6335
|
-
*
|
|
6336
|
-
* @maxLength
|
|
6191
|
+
* @minLength 1
|
|
6192
|
+
* @maxLength 100
|
|
6337
6193
|
*/
|
|
6338
|
-
|
|
6194
|
+
orderId?: string;
|
|
6195
|
+
/** Refund amount */
|
|
6196
|
+
refundAmount?: Price;
|
|
6197
|
+
/** Refund business details */
|
|
6198
|
+
details?: RefundDetails;
|
|
6339
6199
|
/**
|
|
6340
|
-
*
|
|
6341
|
-
* @
|
|
6200
|
+
* Personal note added to the email (optional)
|
|
6201
|
+
* @minLength 1
|
|
6202
|
+
* @maxLength 1000
|
|
6342
6203
|
*/
|
|
6343
|
-
|
|
6204
|
+
customMessage?: string | null;
|
|
6344
6205
|
/**
|
|
6345
|
-
*
|
|
6346
|
-
*
|
|
6347
|
-
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
6206
|
+
* Refund ID. (Optional)
|
|
6207
|
+
* @format GUID
|
|
6348
6208
|
*/
|
|
6349
|
-
|
|
6209
|
+
refundId?: string | null;
|
|
6350
6210
|
}
|
|
6351
|
-
interface
|
|
6211
|
+
interface PreviewRefundEmailResponse {
|
|
6212
|
+
emailPreview?: string;
|
|
6213
|
+
}
|
|
6214
|
+
interface PreviewCancelEmailRequest {
|
|
6352
6215
|
/**
|
|
6353
|
-
*
|
|
6216
|
+
* @minLength 1
|
|
6354
6217
|
* @maxLength 100
|
|
6355
6218
|
*/
|
|
6356
|
-
|
|
6219
|
+
orderId?: string;
|
|
6357
6220
|
/**
|
|
6358
|
-
*
|
|
6359
|
-
* @
|
|
6360
|
-
* @
|
|
6221
|
+
* Personal note added to the email (optional)
|
|
6222
|
+
* @minLength 1
|
|
6223
|
+
* @maxLength 1000
|
|
6361
6224
|
*/
|
|
6362
|
-
|
|
6225
|
+
customMessage?: string | null;
|
|
6226
|
+
}
|
|
6227
|
+
interface PreviewCancelEmailResponse {
|
|
6228
|
+
emailPreview?: string;
|
|
6229
|
+
}
|
|
6230
|
+
interface PreviewCancelRefundEmailRequest {
|
|
6363
6231
|
/**
|
|
6364
|
-
*
|
|
6365
|
-
* @
|
|
6232
|
+
* @minLength 1
|
|
6233
|
+
* @maxLength 100
|
|
6366
6234
|
*/
|
|
6367
|
-
|
|
6235
|
+
orderId?: string;
|
|
6368
6236
|
/**
|
|
6369
|
-
*
|
|
6370
|
-
* @
|
|
6371
|
-
* @
|
|
6372
|
-
* @replacedBy payment.status
|
|
6373
|
-
* @targetRemovalDate 2026-11-01
|
|
6237
|
+
* Personal note added to the email (optional)
|
|
6238
|
+
* @minLength 1
|
|
6239
|
+
* @maxLength 1000
|
|
6374
6240
|
*/
|
|
6375
|
-
|
|
6241
|
+
customMessage?: string | null;
|
|
6242
|
+
/** Refund amount */
|
|
6243
|
+
refundAmount?: Price;
|
|
6376
6244
|
/**
|
|
6377
|
-
*
|
|
6378
|
-
* @
|
|
6379
|
-
* @immutable
|
|
6245
|
+
* Refund ID. (Optional)
|
|
6246
|
+
* @format GUID
|
|
6380
6247
|
*/
|
|
6381
|
-
|
|
6248
|
+
refundId?: string | null;
|
|
6382
6249
|
}
|
|
6383
|
-
interface
|
|
6250
|
+
interface PreviewCancelRefundEmailResponse {
|
|
6251
|
+
emailPreview?: string;
|
|
6252
|
+
}
|
|
6253
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
6254
|
+
}
|
|
6255
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
6256
|
+
emailPreview?: string;
|
|
6257
|
+
}
|
|
6258
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
6259
|
+
}
|
|
6260
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
6261
|
+
emailPreview?: string;
|
|
6262
|
+
}
|
|
6263
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
6264
|
+
}
|
|
6265
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
6266
|
+
emailPreview?: string;
|
|
6267
|
+
}
|
|
6268
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
6269
|
+
}
|
|
6270
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
6271
|
+
emailPreview?: string;
|
|
6272
|
+
}
|
|
6273
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
6274
|
+
}
|
|
6275
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
6276
|
+
emailPreview?: string;
|
|
6277
|
+
}
|
|
6278
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
6279
|
+
/** Emitted on a meta site creation. */
|
|
6280
|
+
siteCreated?: SiteCreated;
|
|
6281
|
+
/** Emitted on a meta site transfer completion. */
|
|
6282
|
+
siteTransferred?: SiteTransferred;
|
|
6283
|
+
/** Emitted on a meta site deletion. */
|
|
6284
|
+
siteDeleted?: SiteDeleted;
|
|
6285
|
+
/** Emitted on a meta site restoration. */
|
|
6286
|
+
siteUndeleted?: SiteUndeleted;
|
|
6287
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
6288
|
+
sitePublished?: SitePublished;
|
|
6289
|
+
/** Emitted on a meta site unpublish. */
|
|
6290
|
+
siteUnpublished?: SiteUnpublished;
|
|
6291
|
+
/** Emitted when meta site is marked as template. */
|
|
6292
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6293
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
6294
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6295
|
+
/** Emitted when an application is provisioned (installed). */
|
|
6296
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
6297
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
6298
|
+
serviceRemoved?: ServiceRemoved;
|
|
6299
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
6300
|
+
siteRenamedPayload?: SiteRenamed;
|
|
6301
|
+
/** Emitted when meta site was permanently deleted. */
|
|
6302
|
+
hardDeleted?: SiteHardDeleted;
|
|
6303
|
+
/** Emitted on a namespace change. */
|
|
6304
|
+
namespaceChanged?: NamespaceChanged;
|
|
6305
|
+
/** Emitted when Studio is attached. */
|
|
6306
|
+
studioAssigned?: StudioAssigned;
|
|
6307
|
+
/** Emitted when Studio is detached. */
|
|
6308
|
+
studioUnassigned?: StudioUnassigned;
|
|
6384
6309
|
/**
|
|
6385
|
-
*
|
|
6386
|
-
*
|
|
6310
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
6311
|
+
* the actual URL.
|
|
6312
|
+
*
|
|
6313
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6314
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6387
6315
|
*/
|
|
6388
|
-
|
|
6316
|
+
urlChanged?: SiteUrlChanged;
|
|
6317
|
+
/** Site is marked as PurgedExternally */
|
|
6318
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
6319
|
+
/** Emitted when Odeditor is attached. */
|
|
6320
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
6321
|
+
/** Emitted when Odeditor is detached. */
|
|
6322
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
6323
|
+
/** Emitted when Picasso is attached. */
|
|
6324
|
+
picassoAssigned?: PicassoAssigned;
|
|
6325
|
+
/** Emitted when Picasso is detached. */
|
|
6326
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
6327
|
+
/** Emitted when Wixel is attached. */
|
|
6328
|
+
wixelAssigned?: WixelAssigned;
|
|
6329
|
+
/** Emitted when Wixel is detached. */
|
|
6330
|
+
wixelUnassigned?: WixelUnassigned;
|
|
6331
|
+
/** Emitted when StudioTwo is attached. */
|
|
6332
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
6333
|
+
/** Emitted when StudioTwo is detached. */
|
|
6334
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6335
|
+
/** Emitted when media from user domain is enabled. */
|
|
6336
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6337
|
+
/** Emitted when media from user domain is disabled. */
|
|
6338
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6339
|
+
/** Emitted when Editorless is attached. */
|
|
6340
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
6341
|
+
/** Emitted when Editorless is detached. */
|
|
6342
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
6389
6343
|
/**
|
|
6390
|
-
*
|
|
6391
|
-
* @
|
|
6392
|
-
* @maxLength 100
|
|
6344
|
+
* A meta site id.
|
|
6345
|
+
* @format GUID
|
|
6393
6346
|
*/
|
|
6394
|
-
|
|
6347
|
+
metaSiteId?: string;
|
|
6348
|
+
/** A meta site version. Monotonically increasing. */
|
|
6349
|
+
version?: string;
|
|
6350
|
+
/** A timestamp of the event. */
|
|
6351
|
+
timestamp?: string;
|
|
6395
6352
|
/**
|
|
6396
|
-
*
|
|
6397
|
-
*
|
|
6398
|
-
* @
|
|
6399
|
-
* @targetRemovalDate 2026-11-01
|
|
6353
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
6354
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
6355
|
+
* @maxSize 4000
|
|
6400
6356
|
*/
|
|
6401
|
-
|
|
6402
|
-
|
|
6403
|
-
|
|
6357
|
+
assets?: Asset[];
|
|
6358
|
+
}
|
|
6359
|
+
/** @oneof */
|
|
6360
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
6361
|
+
/** Emitted on a meta site creation. */
|
|
6362
|
+
siteCreated?: SiteCreated;
|
|
6363
|
+
/** Emitted on a meta site transfer completion. */
|
|
6364
|
+
siteTransferred?: SiteTransferred;
|
|
6365
|
+
/** Emitted on a meta site deletion. */
|
|
6366
|
+
siteDeleted?: SiteDeleted;
|
|
6367
|
+
/** Emitted on a meta site restoration. */
|
|
6368
|
+
siteUndeleted?: SiteUndeleted;
|
|
6369
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
6370
|
+
sitePublished?: SitePublished;
|
|
6371
|
+
/** Emitted on a meta site unpublish. */
|
|
6372
|
+
siteUnpublished?: SiteUnpublished;
|
|
6373
|
+
/** Emitted when meta site is marked as template. */
|
|
6374
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6375
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
6376
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6377
|
+
/** Emitted when an application is provisioned (installed). */
|
|
6378
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
6379
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
6380
|
+
serviceRemoved?: ServiceRemoved;
|
|
6381
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
6382
|
+
siteRenamedPayload?: SiteRenamed;
|
|
6383
|
+
/** Emitted when meta site was permanently deleted. */
|
|
6384
|
+
hardDeleted?: SiteHardDeleted;
|
|
6385
|
+
/** Emitted on a namespace change. */
|
|
6386
|
+
namespaceChanged?: NamespaceChanged;
|
|
6387
|
+
/** Emitted when Studio is attached. */
|
|
6388
|
+
studioAssigned?: StudioAssigned;
|
|
6389
|
+
/** Emitted when Studio is detached. */
|
|
6390
|
+
studioUnassigned?: StudioUnassigned;
|
|
6404
6391
|
/**
|
|
6405
|
-
*
|
|
6406
|
-
*
|
|
6407
|
-
*
|
|
6392
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
6393
|
+
* the actual URL.
|
|
6394
|
+
*
|
|
6395
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6396
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6408
6397
|
*/
|
|
6409
|
-
|
|
6398
|
+
urlChanged?: SiteUrlChanged;
|
|
6399
|
+
/** Site is marked as PurgedExternally */
|
|
6400
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
6401
|
+
/** Emitted when Odeditor is attached. */
|
|
6402
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
6403
|
+
/** Emitted when Odeditor is detached. */
|
|
6404
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
6405
|
+
/** Emitted when Picasso is attached. */
|
|
6406
|
+
picassoAssigned?: PicassoAssigned;
|
|
6407
|
+
/** Emitted when Picasso is detached. */
|
|
6408
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
6409
|
+
/** Emitted when Wixel is attached. */
|
|
6410
|
+
wixelAssigned?: WixelAssigned;
|
|
6411
|
+
/** Emitted when Wixel is detached. */
|
|
6412
|
+
wixelUnassigned?: WixelUnassigned;
|
|
6413
|
+
/** Emitted when StudioTwo is attached. */
|
|
6414
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
6415
|
+
/** Emitted when StudioTwo is detached. */
|
|
6416
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6417
|
+
/** Emitted when media from user domain is enabled. */
|
|
6418
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6419
|
+
/** Emitted when media from user domain is disabled. */
|
|
6420
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6421
|
+
/** Emitted when Editorless is attached. */
|
|
6422
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
6423
|
+
/** Emitted when Editorless is detached. */
|
|
6424
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
6425
|
+
}
|
|
6426
|
+
interface Asset {
|
|
6410
6427
|
/**
|
|
6411
|
-
*
|
|
6412
|
-
* @
|
|
6413
|
-
* @deprecated Whether the membership is voided.
|
|
6414
|
-
* @replacedBy payment.status
|
|
6415
|
-
* @targetRemovalDate 2026-11-01
|
|
6428
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
6429
|
+
* @maxLength 36
|
|
6416
6430
|
*/
|
|
6417
|
-
|
|
6431
|
+
appDefId?: string;
|
|
6418
6432
|
/**
|
|
6419
|
-
*
|
|
6420
|
-
* @
|
|
6433
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
6434
|
+
* @maxLength 200
|
|
6421
6435
|
*/
|
|
6422
|
-
|
|
6423
|
-
/**
|
|
6424
|
-
|
|
6436
|
+
instanceId?: string;
|
|
6437
|
+
/** An application state. */
|
|
6438
|
+
state?: StateWithLiterals;
|
|
6425
6439
|
}
|
|
6426
|
-
declare enum
|
|
6427
|
-
|
|
6428
|
-
|
|
6429
|
-
|
|
6430
|
-
|
|
6431
|
-
|
|
6432
|
-
CHARGE_PENDING = "CHARGE_PENDING",
|
|
6433
|
-
/** Payment was voided. */
|
|
6434
|
-
VOIDED = "VOIDED"
|
|
6440
|
+
declare enum State {
|
|
6441
|
+
UNKNOWN = "UNKNOWN",
|
|
6442
|
+
ENABLED = "ENABLED",
|
|
6443
|
+
DISABLED = "DISABLED",
|
|
6444
|
+
PENDING = "PENDING",
|
|
6445
|
+
DEMO = "DEMO"
|
|
6435
6446
|
}
|
|
6436
6447
|
/** @enumType */
|
|
6437
|
-
type
|
|
6438
|
-
interface
|
|
6448
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
6449
|
+
interface SiteCreated {
|
|
6439
6450
|
/**
|
|
6440
|
-
*
|
|
6441
|
-
* @
|
|
6451
|
+
* A template identifier (empty if not created from a template).
|
|
6452
|
+
* @maxLength 36
|
|
6442
6453
|
*/
|
|
6443
|
-
|
|
6454
|
+
originTemplateId?: string;
|
|
6444
6455
|
/**
|
|
6445
|
-
*
|
|
6446
|
-
* @
|
|
6456
|
+
* An account id of the owner.
|
|
6457
|
+
* @format GUID
|
|
6447
6458
|
*/
|
|
6448
|
-
|
|
6449
|
-
|
|
6450
|
-
|
|
6459
|
+
ownerId?: string;
|
|
6460
|
+
/** A context in which meta site was created. */
|
|
6461
|
+
context?: SiteCreatedContextWithLiterals;
|
|
6451
6462
|
/**
|
|
6452
|
-
*
|
|
6463
|
+
* A meta site id from which this site was created.
|
|
6464
|
+
*
|
|
6465
|
+
* In case of a creation from a template it's a template id.
|
|
6466
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
6453
6467
|
* @format GUID
|
|
6454
6468
|
*/
|
|
6455
|
-
|
|
6469
|
+
originMetaSiteId?: string | null;
|
|
6456
6470
|
/**
|
|
6457
|
-
*
|
|
6458
|
-
* @
|
|
6459
|
-
* @maxLength 40
|
|
6471
|
+
* A meta site name (URL slug).
|
|
6472
|
+
* @maxLength 20
|
|
6460
6473
|
*/
|
|
6461
|
-
|
|
6474
|
+
siteName?: string;
|
|
6475
|
+
/** A namespace. */
|
|
6476
|
+
namespace?: NamespaceWithLiterals;
|
|
6462
6477
|
}
|
|
6463
|
-
|
|
6464
|
-
/**
|
|
6465
|
-
|
|
6466
|
-
|
|
6467
|
-
|
|
6468
|
-
|
|
6478
|
+
declare enum SiteCreatedContext {
|
|
6479
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
6480
|
+
OTHER = "OTHER",
|
|
6481
|
+
/** A meta site was created from template. */
|
|
6482
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
6483
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
6484
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
6485
|
+
/** A copy of existing meta site. */
|
|
6486
|
+
DUPLICATE = "DUPLICATE",
|
|
6487
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
6488
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
6489
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
6490
|
+
FLASH = "FLASH"
|
|
6491
|
+
}
|
|
6492
|
+
/** @enumType */
|
|
6493
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
6494
|
+
declare enum Namespace {
|
|
6495
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
6496
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
6497
|
+
WIX = "WIX",
|
|
6498
|
+
/** 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. */
|
|
6499
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
6500
|
+
/** 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. */
|
|
6501
|
+
ALBUMS = "ALBUMS",
|
|
6502
|
+
/** 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. */
|
|
6503
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
6504
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6505
|
+
HOTELS = "HOTELS",
|
|
6506
|
+
/** 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. */
|
|
6507
|
+
CLUBS = "CLUBS",
|
|
6508
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6509
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
6469
6510
|
/**
|
|
6470
|
-
*
|
|
6471
|
-
*
|
|
6511
|
+
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
6512
|
+
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
6472
6513
|
*/
|
|
6473
|
-
|
|
6514
|
+
DEV_SITE = "DEV_SITE",
|
|
6515
|
+
/** 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. */
|
|
6516
|
+
LOGOS = "LOGOS",
|
|
6517
|
+
/** 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. */
|
|
6518
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
6519
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6520
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
6521
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6522
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
6474
6523
|
/**
|
|
6475
|
-
*
|
|
6476
|
-
*
|
|
6477
|
-
*
|
|
6524
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
6525
|
+
*
|
|
6526
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
6478
6527
|
*/
|
|
6479
|
-
|
|
6480
|
-
}
|
|
6481
|
-
interface CashRoundingDetails {
|
|
6528
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
6482
6529
|
/**
|
|
6483
|
-
*
|
|
6484
|
-
*
|
|
6485
|
-
*
|
|
6530
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
6531
|
+
* Will be accessible from Site List and will not have a website app.
|
|
6532
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
6486
6533
|
*/
|
|
6487
|
-
|
|
6534
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
6535
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
6536
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
6537
|
+
/** It is to be used in the Business First efforts. */
|
|
6538
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
6539
|
+
/** Bookings business flow with no site. */
|
|
6540
|
+
ANYWHERE = "ANYWHERE",
|
|
6541
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
6542
|
+
HEADLESS = "HEADLESS",
|
|
6488
6543
|
/**
|
|
6489
|
-
*
|
|
6490
|
-
*
|
|
6491
|
-
* @readonly
|
|
6544
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
6545
|
+
* The site will be used for account level CSM feature for enterprise
|
|
6492
6546
|
*/
|
|
6493
|
-
|
|
6494
|
-
|
|
6495
|
-
|
|
6496
|
-
/** Payment was charged successfully. */
|
|
6497
|
-
APPROVED = "APPROVED",
|
|
6498
|
-
/** Payment is being processed and hasn't been confirmed yet. */
|
|
6499
|
-
PENDING = "PENDING",
|
|
6500
|
-
/** 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. */
|
|
6501
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6502
|
-
/** Payment was canceled before it was charged. */
|
|
6503
|
-
CANCELED = "CANCELED",
|
|
6504
|
-
/** Payment was declined by the payment provider. */
|
|
6505
|
-
DECLINED = "DECLINED",
|
|
6506
|
-
/** Payment was fully refunded. */
|
|
6507
|
-
REFUNDED = "REFUNDED",
|
|
6508
|
-
/** Part of the payment amount was refunded. */
|
|
6509
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6510
|
-
/** 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. */
|
|
6511
|
-
AUTHORIZED = "AUTHORIZED",
|
|
6547
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
6548
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
6549
|
+
RISE = "RISE",
|
|
6512
6550
|
/**
|
|
6513
|
-
*
|
|
6514
|
-
*
|
|
6515
|
-
*
|
|
6551
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
6552
|
+
* There's a blank site behind the scene but it's blank).
|
|
6553
|
+
* The Mobile company will be the owner of this namespace.
|
|
6516
6554
|
*/
|
|
6517
|
-
|
|
6518
|
-
|
|
6519
|
-
|
|
6520
|
-
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
6521
|
-
interface CanceledStatusDetails {
|
|
6522
|
-
reason?: CanceledReasonWithLiterals;
|
|
6523
|
-
}
|
|
6524
|
-
declare enum CanceledReason {
|
|
6525
|
-
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
6526
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
6527
|
-
/** Payment was not completed by user and expired. */
|
|
6528
|
-
EXPIRED = "EXPIRED"
|
|
6529
|
-
}
|
|
6530
|
-
/** @enumType */
|
|
6531
|
-
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
6532
|
-
interface DeclinedStatusDetails {
|
|
6533
|
-
reason?: DeclinedReasonWithLiterals;
|
|
6534
|
-
}
|
|
6535
|
-
declare enum DeclinedReason {
|
|
6536
|
-
/** Corresponding charge failed. */
|
|
6537
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6538
|
-
/** Payment details expired. */
|
|
6539
|
-
EXPIRED = "EXPIRED",
|
|
6540
|
-
/** Insufficient funds. */
|
|
6541
|
-
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
6542
|
-
/** Gift card was disabled before charge was attempted. */
|
|
6543
|
-
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
6544
|
-
}
|
|
6545
|
-
/** @enumType */
|
|
6546
|
-
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
6547
|
-
interface VoidedStatusDetails {
|
|
6548
|
-
reason?: VoidedReasonWithLiterals;
|
|
6549
|
-
}
|
|
6550
|
-
declare enum VoidedReason {
|
|
6551
|
-
/** Payment was voided by merchant request. */
|
|
6552
|
-
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
6553
|
-
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
6554
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
6555
|
-
}
|
|
6556
|
-
/** @enumType */
|
|
6557
|
-
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
6558
|
-
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
6559
|
-
/** @internal */
|
|
6560
|
-
canceled?: CanceledStatusDetails;
|
|
6561
|
-
/** @internal */
|
|
6562
|
-
declined?: DeclinedStatusDetails;
|
|
6563
|
-
/** @internal */
|
|
6564
|
-
voided?: VoidedStatusDetails;
|
|
6555
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
6556
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
6557
|
+
NOWNIA = "NOWNIA",
|
|
6565
6558
|
/**
|
|
6566
|
-
*
|
|
6567
|
-
*
|
|
6568
|
-
* @minLength 1
|
|
6569
|
-
* @maxLength 10
|
|
6559
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
6560
|
+
* The Partners company owns this namespace.
|
|
6570
6561
|
*/
|
|
6571
|
-
|
|
6572
|
-
|
|
6573
|
-
|
|
6574
|
-
|
|
6575
|
-
|
|
6576
|
-
canceled?: CanceledStatusDetails;
|
|
6577
|
-
/** @internal */
|
|
6578
|
-
declined?: DeclinedStatusDetails;
|
|
6579
|
-
/** @internal */
|
|
6580
|
-
voided?: VoidedStatusDetails;
|
|
6581
|
-
}
|
|
6582
|
-
interface Refund {
|
|
6562
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
6563
|
+
/** Codux Headless Sites */
|
|
6564
|
+
CODUX = "CODUX",
|
|
6565
|
+
/** Bobb - AI Design Creator. */
|
|
6566
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
6583
6567
|
/**
|
|
6584
|
-
*
|
|
6585
|
-
*
|
|
6586
|
-
* @readonly
|
|
6568
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
6569
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
6587
6570
|
*/
|
|
6588
|
-
|
|
6571
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
6572
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6573
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
6574
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6575
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
6576
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
6577
|
+
MIMIR = "MIMIR",
|
|
6578
|
+
/** Wix Twins platform. */
|
|
6579
|
+
TWINS = "TWINS",
|
|
6580
|
+
/** Wix Nano. */
|
|
6581
|
+
NANO = "NANO",
|
|
6582
|
+
/** Base44 headless sites. */
|
|
6583
|
+
BASE44 = "BASE44",
|
|
6584
|
+
/** Wix Channels Sites */
|
|
6585
|
+
CHANNELS = "CHANNELS",
|
|
6586
|
+
/** Nautilus platform. */
|
|
6587
|
+
NAUTILUS = "NAUTILUS",
|
|
6589
6588
|
/**
|
|
6590
|
-
*
|
|
6591
|
-
*
|
|
6589
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
6590
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
6592
6591
|
*/
|
|
6593
|
-
|
|
6594
|
-
/**
|
|
6595
|
-
|
|
6592
|
+
SYMPHONY = "SYMPHONY",
|
|
6593
|
+
/** Nautilus platform app. */
|
|
6594
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
6596
6595
|
/**
|
|
6597
|
-
*
|
|
6598
|
-
*
|
|
6599
|
-
* @immutable
|
|
6596
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
6597
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
6600
6598
|
*/
|
|
6601
|
-
|
|
6599
|
+
VIBU = "VIBU",
|
|
6602
6600
|
/**
|
|
6603
|
-
*
|
|
6604
|
-
*
|
|
6601
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
6602
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
6603
|
+
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
6604
|
+
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
6605
6605
|
*/
|
|
6606
|
-
|
|
6606
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
|
|
6607
6607
|
/**
|
|
6608
|
-
*
|
|
6609
|
-
*
|
|
6610
|
-
* @readonly
|
|
6611
|
-
* @immutable
|
|
6608
|
+
* Dev-center development sites (com.wixpress.devcenter.dsm).
|
|
6609
|
+
* DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
|
|
6612
6610
|
*/
|
|
6613
|
-
|
|
6611
|
+
DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
|
|
6614
6612
|
}
|
|
6615
|
-
|
|
6613
|
+
/** @enumType */
|
|
6614
|
+
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';
|
|
6615
|
+
/** Site transferred to another user. */
|
|
6616
|
+
interface SiteTransferred {
|
|
6616
6617
|
/**
|
|
6617
|
-
*
|
|
6618
|
+
* A previous owner id (user that transfers meta site).
|
|
6618
6619
|
* @format GUID
|
|
6619
|
-
* @immutable
|
|
6620
|
-
*/
|
|
6621
|
-
paymentId?: string;
|
|
6622
|
-
/**
|
|
6623
|
-
* Refund amount.
|
|
6624
|
-
* @immutable
|
|
6625
6620
|
*/
|
|
6626
|
-
|
|
6627
|
-
/** Refund status. */
|
|
6628
|
-
refundStatus?: RefundStatusWithLiterals;
|
|
6629
|
-
/** Optional details of current refund status. */
|
|
6630
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
6621
|
+
oldOwnerId?: string;
|
|
6631
6622
|
/**
|
|
6632
|
-
*
|
|
6633
|
-
* This field is only returned when the value of `external_refund` is `false`.
|
|
6623
|
+
* A new owner id (user that accepts meta site).
|
|
6634
6624
|
* @format GUID
|
|
6635
6625
|
*/
|
|
6636
|
-
|
|
6637
|
-
|
|
6638
|
-
|
|
6626
|
+
newOwnerId?: string;
|
|
6627
|
+
}
|
|
6628
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
6629
|
+
interface SiteDeleted {
|
|
6630
|
+
/** A deletion context. */
|
|
6631
|
+
deleteContext?: DeleteContext;
|
|
6632
|
+
}
|
|
6633
|
+
interface DeleteContext {
|
|
6634
|
+
/** When the meta site was deleted. */
|
|
6635
|
+
dateDeleted?: Date | null;
|
|
6636
|
+
/** A status. */
|
|
6637
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
6639
6638
|
/**
|
|
6640
|
-
*
|
|
6641
|
-
* @
|
|
6639
|
+
* A reason (flow).
|
|
6640
|
+
* @maxLength 255
|
|
6642
6641
|
*/
|
|
6643
|
-
|
|
6642
|
+
deleteOrigin?: string;
|
|
6644
6643
|
/**
|
|
6645
|
-
*
|
|
6646
|
-
* @
|
|
6647
|
-
* @format GUID
|
|
6648
|
-
* @immutable
|
|
6644
|
+
* A service that deleted it.
|
|
6645
|
+
* @maxLength 255
|
|
6649
6646
|
*/
|
|
6650
|
-
|
|
6647
|
+
initiatorId?: string | null;
|
|
6651
6648
|
}
|
|
6652
|
-
|
|
6653
|
-
|
|
6654
|
-
|
|
6655
|
-
|
|
6656
|
-
|
|
6657
|
-
|
|
6658
|
-
/** Refund transaction failed. */
|
|
6659
|
-
FAILED = "FAILED",
|
|
6660
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
6661
|
-
SCHEDULED = "SCHEDULED",
|
|
6662
|
-
/** Refund was initiated on payment provider side. */
|
|
6663
|
-
STARTED = "STARTED"
|
|
6649
|
+
declare enum DeleteStatus {
|
|
6650
|
+
UNKNOWN = "UNKNOWN",
|
|
6651
|
+
TRASH = "TRASH",
|
|
6652
|
+
DELETED = "DELETED",
|
|
6653
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
6654
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
6664
6655
|
}
|
|
6665
6656
|
/** @enumType */
|
|
6666
|
-
type
|
|
6667
|
-
|
|
6668
|
-
|
|
6669
|
-
|
|
6670
|
-
|
|
6671
|
-
|
|
6672
|
-
|
|
6673
|
-
|
|
6674
|
-
*/
|
|
6675
|
-
paymentGatewayReasonCode?: string | null;
|
|
6657
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
6658
|
+
/** Restoration of the meta site. */
|
|
6659
|
+
interface SiteUndeleted {
|
|
6660
|
+
}
|
|
6661
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
6662
|
+
interface SitePublished {
|
|
6663
|
+
}
|
|
6664
|
+
interface SiteUnpublished {
|
|
6676
6665
|
/**
|
|
6677
|
-
*
|
|
6678
|
-
* @
|
|
6679
|
-
* @
|
|
6666
|
+
* A list of URLs previously associated with the meta site.
|
|
6667
|
+
* @maxLength 4000
|
|
6668
|
+
* @maxSize 10000
|
|
6680
6669
|
*/
|
|
6681
|
-
|
|
6670
|
+
urls?: string[];
|
|
6682
6671
|
}
|
|
6683
|
-
interface
|
|
6684
|
-
/** Total amount requested for refund. */
|
|
6685
|
-
requestedRefund?: Price;
|
|
6686
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
6687
|
-
pendingRefund?: Price;
|
|
6688
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
6689
|
-
refunded?: Price;
|
|
6690
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
6691
|
-
failedRefundAmount?: Price;
|
|
6692
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
6693
|
-
pending?: boolean;
|
|
6694
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
6695
|
-
breakdown?: RefundItemsBreakdown;
|
|
6672
|
+
interface SiteMarkedAsTemplate {
|
|
6696
6673
|
}
|
|
6697
|
-
interface
|
|
6674
|
+
interface SiteMarkedAsWixSite {
|
|
6675
|
+
}
|
|
6676
|
+
/**
|
|
6677
|
+
* Represents a service provisioned a site.
|
|
6678
|
+
*
|
|
6679
|
+
* Note on `origin_instance_id`:
|
|
6680
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
6681
|
+
* This is because of the following scenario:
|
|
6682
|
+
*
|
|
6683
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
6684
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
6685
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
6686
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
6687
|
+
* your site remains consistent with what you initially received and does not include any
|
|
6688
|
+
* changes made to the original template afterward.
|
|
6689
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
6690
|
+
*/
|
|
6691
|
+
interface ServiceProvisioned {
|
|
6698
6692
|
/**
|
|
6699
|
-
*
|
|
6700
|
-
* @
|
|
6693
|
+
* Either UUID or EmbeddedServiceType.
|
|
6694
|
+
* @maxLength 36
|
|
6701
6695
|
*/
|
|
6702
|
-
|
|
6703
|
-
}
|
|
6704
|
-
interface LineItemRefundSummary {
|
|
6696
|
+
appDefId?: string;
|
|
6705
6697
|
/**
|
|
6706
|
-
*
|
|
6707
|
-
* @
|
|
6698
|
+
* Not only UUID. Something here could be something weird.
|
|
6699
|
+
* @maxLength 36
|
|
6708
6700
|
*/
|
|
6709
|
-
|
|
6710
|
-
/** Total refunded amount for the line item. */
|
|
6711
|
-
totalRefundedAmount?: Price;
|
|
6712
|
-
}
|
|
6713
|
-
interface CalculateRefundRequest {
|
|
6701
|
+
instanceId?: string;
|
|
6714
6702
|
/**
|
|
6715
|
-
*
|
|
6716
|
-
* @
|
|
6717
|
-
* @maxLength 100
|
|
6703
|
+
* An instance id from which this instance is originated.
|
|
6704
|
+
* @maxLength 36
|
|
6718
6705
|
*/
|
|
6719
|
-
|
|
6706
|
+
originInstanceId?: string;
|
|
6720
6707
|
/**
|
|
6721
|
-
*
|
|
6722
|
-
* @
|
|
6708
|
+
* A version.
|
|
6709
|
+
* @maxLength 500
|
|
6723
6710
|
*/
|
|
6724
|
-
|
|
6725
|
-
/** Should include shipping in refund calculation */
|
|
6726
|
-
refundShipping?: boolean;
|
|
6727
|
-
}
|
|
6728
|
-
interface CalculateRefundItemRequest {
|
|
6711
|
+
version?: string | null;
|
|
6729
6712
|
/**
|
|
6730
|
-
*
|
|
6713
|
+
* The origin meta site id
|
|
6731
6714
|
* @format GUID
|
|
6732
6715
|
*/
|
|
6733
|
-
|
|
6716
|
+
originMetaSiteId?: string | null;
|
|
6717
|
+
}
|
|
6718
|
+
interface ServiceRemoved {
|
|
6734
6719
|
/**
|
|
6735
|
-
*
|
|
6736
|
-
* @
|
|
6737
|
-
* @max 100000
|
|
6720
|
+
* Either UUID or EmbeddedServiceType.
|
|
6721
|
+
* @maxLength 36
|
|
6738
6722
|
*/
|
|
6739
|
-
|
|
6740
|
-
}
|
|
6741
|
-
interface CalculateRefundResponse {
|
|
6742
|
-
/** Total refundable amount */
|
|
6743
|
-
total?: Price;
|
|
6744
|
-
/** Tax cost of the order */
|
|
6745
|
-
tax?: Price;
|
|
6746
|
-
/** Discount given for this order */
|
|
6747
|
-
discount?: Price;
|
|
6748
|
-
/** Total cost of the order (without tax) */
|
|
6749
|
-
subtotal?: Price;
|
|
6750
|
-
/** Total shipping cost for order */
|
|
6751
|
-
shipping?: Price;
|
|
6752
|
-
/** Previous refund given on that order */
|
|
6753
|
-
previouslyRefundedAmount?: Price;
|
|
6723
|
+
appDefId?: string;
|
|
6754
6724
|
/**
|
|
6755
|
-
*
|
|
6756
|
-
* @
|
|
6725
|
+
* Not only UUID. Something here could be something weird.
|
|
6726
|
+
* @maxLength 36
|
|
6757
6727
|
*/
|
|
6758
|
-
|
|
6759
|
-
}
|
|
6760
|
-
interface CalculateRefundItemResponse {
|
|
6728
|
+
instanceId?: string;
|
|
6761
6729
|
/**
|
|
6762
|
-
*
|
|
6763
|
-
* @
|
|
6730
|
+
* A version.
|
|
6731
|
+
* @maxLength 500
|
|
6764
6732
|
*/
|
|
6765
|
-
|
|
6766
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
6767
|
-
price?: Price;
|
|
6733
|
+
version?: string | null;
|
|
6768
6734
|
}
|
|
6769
|
-
|
|
6735
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
6736
|
+
interface SiteRenamed {
|
|
6770
6737
|
/**
|
|
6771
|
-
*
|
|
6772
|
-
* @
|
|
6773
|
-
* @maxLength 100
|
|
6738
|
+
* A new meta site name (URL slug).
|
|
6739
|
+
* @maxLength 20
|
|
6774
6740
|
*/
|
|
6775
|
-
|
|
6741
|
+
newSiteName?: string;
|
|
6776
6742
|
/**
|
|
6777
|
-
*
|
|
6778
|
-
* @
|
|
6779
|
-
* @maxSize 100
|
|
6780
|
-
* @format GUID
|
|
6743
|
+
* A previous meta site name (URL slug).
|
|
6744
|
+
* @maxLength 255
|
|
6781
6745
|
*/
|
|
6782
|
-
|
|
6746
|
+
oldSiteName?: string;
|
|
6783
6747
|
}
|
|
6784
|
-
|
|
6785
|
-
|
|
6786
|
-
|
|
6748
|
+
/**
|
|
6749
|
+
* Hard deletion of the meta site.
|
|
6750
|
+
*
|
|
6751
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
6752
|
+
*/
|
|
6753
|
+
interface SiteHardDeleted {
|
|
6754
|
+
/** A deletion context. */
|
|
6755
|
+
deleteContext?: DeleteContext;
|
|
6787
6756
|
}
|
|
6788
|
-
interface
|
|
6789
|
-
/**
|
|
6790
|
-
|
|
6791
|
-
|
|
6792
|
-
|
|
6793
|
-
|
|
6794
|
-
|
|
6757
|
+
interface NamespaceChanged {
|
|
6758
|
+
/** A previous namespace. */
|
|
6759
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
6760
|
+
/** A new namespace. */
|
|
6761
|
+
newNamespace?: NamespaceWithLiterals;
|
|
6762
|
+
}
|
|
6763
|
+
/** Assigned Studio editor */
|
|
6764
|
+
interface StudioAssigned {
|
|
6765
|
+
}
|
|
6766
|
+
/** Unassigned Studio editor */
|
|
6767
|
+
interface StudioUnassigned {
|
|
6768
|
+
}
|
|
6769
|
+
/**
|
|
6770
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
6771
|
+
*
|
|
6772
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
6773
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
6774
|
+
*
|
|
6775
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
6776
|
+
*/
|
|
6777
|
+
interface SiteUrlChanged {
|
|
6778
|
+
}
|
|
6779
|
+
/**
|
|
6780
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
6781
|
+
* Consumed by other teams to remove relevant data.
|
|
6782
|
+
*/
|
|
6783
|
+
interface SitePurgedExternally {
|
|
6795
6784
|
/**
|
|
6796
|
-
*
|
|
6797
|
-
* @minSize 1
|
|
6785
|
+
* @maxLength 2048
|
|
6798
6786
|
* @maxSize 100
|
|
6787
|
+
* @deprecated
|
|
6788
|
+
* @targetRemovalDate 2025-04-15
|
|
6799
6789
|
*/
|
|
6800
|
-
|
|
6790
|
+
appDefId?: string[];
|
|
6801
6791
|
}
|
|
6802
|
-
|
|
6803
|
-
|
|
6804
|
-
* Payment ID
|
|
6805
|
-
* @format GUID
|
|
6806
|
-
*/
|
|
6807
|
-
paymentId?: string | null;
|
|
6808
|
-
/**
|
|
6809
|
-
* Capture amount.
|
|
6810
|
-
* If not provided - full authorized amount will be captured.
|
|
6811
|
-
*/
|
|
6812
|
-
amount?: Price;
|
|
6792
|
+
/** Assigned Odeditor */
|
|
6793
|
+
interface OdeditorAssigned {
|
|
6813
6794
|
}
|
|
6814
|
-
|
|
6815
|
-
|
|
6816
|
-
orderTransactions?: OrderTransactions;
|
|
6795
|
+
/** Unassigned Odeditor */
|
|
6796
|
+
interface OdeditorUnassigned {
|
|
6817
6797
|
}
|
|
6818
|
-
|
|
6819
|
-
|
|
6820
|
-
* Ecom Order ID.
|
|
6821
|
-
* @minLength 1
|
|
6822
|
-
* @maxLength 100
|
|
6823
|
-
*/
|
|
6824
|
-
ecomOrderId?: string;
|
|
6825
|
-
/** Amount to be charged */
|
|
6826
|
-
amount?: Price;
|
|
6798
|
+
/** Assigned Picasso editor */
|
|
6799
|
+
interface PicassoAssigned {
|
|
6827
6800
|
}
|
|
6828
|
-
|
|
6829
|
-
|
|
6830
|
-
paymentGatewayOrderId?: string;
|
|
6801
|
+
/** Unassigned Picasso */
|
|
6802
|
+
interface PicassoUnassigned {
|
|
6831
6803
|
}
|
|
6832
|
-
|
|
6833
|
-
|
|
6834
|
-
metasiteId?: string;
|
|
6835
|
-
/**
|
|
6836
|
-
* @minLength 1
|
|
6837
|
-
* @maxLength 100
|
|
6838
|
-
* @maxSize 100
|
|
6839
|
-
*/
|
|
6840
|
-
orderIds?: string[];
|
|
6804
|
+
/** Assigned Wixel */
|
|
6805
|
+
interface WixelAssigned {
|
|
6841
6806
|
}
|
|
6842
|
-
|
|
6807
|
+
/** Unassigned Wixel */
|
|
6808
|
+
interface WixelUnassigned {
|
|
6843
6809
|
}
|
|
6844
|
-
|
|
6845
|
-
|
|
6846
|
-
|
|
6847
|
-
|
|
6848
|
-
|
|
6849
|
-
|
|
6850
|
-
|
|
6851
|
-
|
|
6810
|
+
/** Assigned StudioTwo */
|
|
6811
|
+
interface StudioTwoAssigned {
|
|
6812
|
+
}
|
|
6813
|
+
/** Unassigned StudioTwo */
|
|
6814
|
+
interface StudioTwoUnassigned {
|
|
6815
|
+
}
|
|
6816
|
+
/** Media from user domain is enabled. */
|
|
6817
|
+
interface UserDomainMediaEnabled {
|
|
6818
|
+
}
|
|
6819
|
+
/** Media from user domain is disabled. */
|
|
6820
|
+
interface UserDomainMediaDisabled {
|
|
6821
|
+
}
|
|
6822
|
+
/** Assigned Editorless */
|
|
6823
|
+
interface EditorlessAssigned {
|
|
6824
|
+
}
|
|
6825
|
+
/** Unassigned Editorless */
|
|
6826
|
+
interface EditorlessUnassigned {
|
|
6827
|
+
}
|
|
6828
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
6829
|
+
}
|
|
6830
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
6831
|
+
hasCustomConfigurations?: boolean;
|
|
6832
|
+
}
|
|
6833
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
6834
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
6835
|
+
sendCustomEmailConfigs?: boolean;
|
|
6836
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
6837
|
+
origin?: OriginWithLiterals;
|
|
6838
|
+
}
|
|
6839
|
+
declare enum Origin {
|
|
6840
|
+
OPT_IN = "OPT_IN",
|
|
6841
|
+
MIGRATION = "MIGRATION"
|
|
6842
|
+
}
|
|
6843
|
+
/** @enumType */
|
|
6844
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
6845
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
6846
|
+
success?: boolean;
|
|
6847
|
+
}
|
|
6848
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
6849
|
+
}
|
|
6850
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
6851
|
+
inPopulation?: boolean;
|
|
6852
6852
|
}
|
|
6853
6853
|
interface DiffmatokyPayload {
|
|
6854
6854
|
left?: string;
|