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