@wix/auto_sdk_ecom_orders 1.0.289 → 1.0.291

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