@wix/auto_sdk_ecom_orders 1.0.321 → 1.0.323

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