@wix/auto_sdk_ecom_orders 1.0.314 → 1.0.316

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