@wix/auto_sdk_ecom_orders 1.0.318 → 1.0.319

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-cwJXByV0.d.ts → ecom-v1-order-orders.universal-DkuT45RM.d.ts} +1694 -1684
  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 +1694 -1684
  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-cwJXByV0.d.mts → ecom-v1-order-orders.universal-DkuT45RM.d.mts} +1694 -1684
  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 +1694 -1684
  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-CaNCF4JV.d.ts → ecom-v1-order-orders.universal-CaKWoBtD.d.ts} +1830 -1820
  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 +1830 -1820
  25. package/build/internal/es/{ecom-v1-order-orders.universal-CaNCF4JV.d.mts → ecom-v1-order-orders.universal-CaKWoBtD.d.mts} +1830 -1820
  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 +1830 -1820
  29. package/package.json +2 -2
@@ -909,10 +909,16 @@ interface DigitalFile {
909
909
  interface SubscriptionInfo {
910
910
  /**
911
911
  * Subscription ID.
912
+ *
913
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
914
+ * To retrieve the subscription contract, call [Get Subscription Contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/subscription-contracts/get-subscription-contract).
912
915
  * @format GUID
913
916
  */
914
917
  _id?: string | null;
915
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
918
+ /**
919
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
920
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
921
+ */
916
922
  cycleNumber?: number;
917
923
  /**
918
924
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -988,7 +994,7 @@ interface SubscriptionDescription {
988
994
  translated?: string | null;
989
995
  }
990
996
  interface SubscriptionSettings {
991
- /** Frequency of recurring payment. */
997
+ /** Frequency unit of the billing cycle. */
992
998
  frequency?: SubscriptionFrequencyWithLiterals;
993
999
  /**
994
1000
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -996,16 +1002,20 @@ interface SubscriptionSettings {
996
1002
  * @max 3650
997
1003
  */
998
1004
  interval?: number | null;
999
- /** Whether subscription is renewed automatically at the end of each period. */
1005
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
1000
1006
  autoRenewal?: boolean;
1001
1007
  /**
1002
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1008
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
1003
1009
  * @min 1
1004
1010
  */
1005
1011
  billingCycles?: number | null;
1006
- /** Whether to allow the customer to cancel the subscription. */
1012
+ /** Whether the buyer can cancel the subscription. */
1007
1013
  enableCustomerCancellation?: boolean;
1008
- /** Period until first cycle starts. If None => no free trial */
1014
+ /**
1015
+ * Free trial period before the first billing cycle starts.
1016
+ *
1017
+ * Returned only when the subscription has a free trial.
1018
+ */
1009
1019
  freeTrialPeriod?: FreeTrialPeriod;
1010
1020
  /**
1011
1021
  * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
@@ -1034,7 +1044,7 @@ declare enum SubscriptionFrequency {
1034
1044
  /** @enumType */
1035
1045
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1036
1046
  interface FreeTrialPeriod {
1037
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
1047
+ /** Frequency unit of the free trial period. */
1038
1048
  frequency?: SubscriptionFrequencyWithLiterals;
1039
1049
  /**
1040
1050
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -4681,2328 +4691,2328 @@ interface BulkDeleteImportedOrdersResponse {
4681
4691
  */
4682
4692
  jobId?: string;
4683
4693
  }
4684
- interface V1TriggerReindexRequest {
4694
+ interface SendBuyerConfirmationEmailRequest {
4685
4695
  /** @format GUID */
4686
- metasiteId?: string;
4696
+ orderId?: string;
4697
+ }
4698
+ interface SendBuyerConfirmationEmailResponse {
4699
+ }
4700
+ interface SendBuyerPaymentsReceivedEmailRequest {
4687
4701
  /**
4688
4702
  * @minLength 1
4689
4703
  * @maxLength 100
4690
- * @maxSize 100
4691
4704
  */
4692
- orderIds?: string[];
4705
+ orderId?: string;
4693
4706
  }
4694
- interface V1TriggerReindexResponse {
4707
+ interface SendBuyerPaymentsReceivedEmailResponse {
4695
4708
  }
4696
- interface V1TriggerReindexOrderRequest {
4697
- /** @format GUID */
4698
- metasiteId?: string;
4709
+ interface SendBuyerPickupConfirmationEmailRequest {
4699
4710
  /**
4700
4711
  * @minLength 1
4701
4712
  * @maxLength 100
4702
4713
  */
4703
4714
  orderId?: string;
4704
4715
  }
4705
- interface PreparePaymentCollectionRequest {
4716
+ interface SendBuyerPickupConfirmationEmailResponse {
4717
+ }
4718
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4719
+ /**
4720
+ * IDs of orders to send pickup emails for.
4721
+ * @minSize 1
4722
+ * @maxSize 300
4723
+ */
4724
+ orderIds?: string[];
4725
+ }
4726
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4727
+ }
4728
+ interface SendBuyerShippingConfirmationEmailRequest {
4706
4729
  /**
4707
- * Ecom order ID.
4708
4730
  * @minLength 1
4709
4731
  * @maxLength 100
4710
4732
  */
4711
- ecomOrderId: string;
4712
- /** Amount to collect */
4713
- amount: Price;
4733
+ orderId?: string;
4734
+ }
4735
+ interface SendBuyerShippingConfirmationEmailResponse {
4736
+ }
4737
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4714
4738
  /**
4715
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4716
- * Existing payment gateway order will be updated with a new amount.
4717
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4739
+ * IDs of orders to send pickup emails for.
4740
+ * @minSize 1
4741
+ * @maxSize 300
4718
4742
  */
4719
- paymentGatewayOrderId?: string | null;
4743
+ orderIds?: string[];
4744
+ }
4745
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4746
+ }
4747
+ interface SendMerchantOrderReceivedNotificationRequest {
4720
4748
  /**
4721
- * Whether to delay capture of the payment.
4722
- * Default: false
4723
- * @deprecated Whether to delay capture of the payment.
4724
- * Default: false
4725
- * @replacedBy delayed_capture_settings.scheduled_action
4726
- * @targetRemovalDate 2024-09-30
4749
+ * @minLength 1
4750
+ * @maxLength 100
4727
4751
  */
4728
- delayedCapture?: boolean;
4752
+ orderId?: string;
4753
+ }
4754
+ interface SendMerchantOrderReceivedNotificationResponse {
4755
+ }
4756
+ interface SendCancelRefundEmailRequest {
4729
4757
  /**
4730
- * Specifies whether payment collection is initiated by Merchant or User of User
4731
- * Default: `true`
4732
- * @internal
4758
+ * The ID of order that is canceled/refunded
4759
+ * @minLength 1
4760
+ * @maxLength 100
4733
4761
  */
4734
- merchantInitiated?: boolean | null;
4762
+ orderId?: string;
4735
4763
  /**
4736
- * Redirect urls which are used to return buyer to third party system.
4737
- * @internal
4764
+ * Personal note added to the email (optional)
4765
+ * @minLength 1
4766
+ * @maxLength 1000
4738
4767
  */
4739
- redirectUrls?: RedirectUrls;
4740
- /** Delayed capture payment settings */
4741
- delayedCaptureSettings?: DelayedCaptureSettings;
4742
- }
4743
- interface RedirectUrls {
4768
+ customMessage?: string | null;
4769
+ /** Refund amount */
4770
+ refundAmount?: Price;
4744
4771
  /**
4745
- * URL to redirect buyer in case of approved (successful) transaction
4746
- * @format WEB_URL
4772
+ * Refund ID. (Optional)
4773
+ * @format GUID
4747
4774
  */
4748
- successUrl?: string | null;
4775
+ refundId?: string | null;
4776
+ }
4777
+ interface SendCancelRefundEmailResponse {
4778
+ }
4779
+ interface SendRefundEmailRequest {
4749
4780
  /**
4750
- * URL to redirect buyer in case of buyer canceled the transaction
4751
- * @format WEB_URL
4781
+ * The ID of order that is refunded
4782
+ * @format GUID
4752
4783
  */
4753
- cancelUrl?: string | null;
4784
+ orderId?: string;
4754
4785
  /**
4755
- * URL to redirect buyer in case of failed/rejected transaction
4756
- * @format WEB_URL
4786
+ * Refund ID
4787
+ * @format GUID
4757
4788
  */
4758
- errorUrl?: string | null;
4789
+ refundId?: string;
4759
4790
  /**
4760
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4761
- * @format WEB_URL
4791
+ * Personal note added to the email (optional)
4792
+ * @minLength 1
4793
+ * @maxLength 1000
4762
4794
  */
4763
- pendingUrl?: string | null;
4795
+ customMessage?: string | null;
4764
4796
  }
4765
- interface DelayedCaptureSettings {
4766
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4767
- scheduledAction?: ScheduledActionWithLiterals;
4768
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4769
- delayDuration?: Duration;
4797
+ interface SendRefundEmailResponse {
4770
4798
  }
4771
- declare enum ScheduledAction {
4772
- /** Whether payment will be auto-voided when duration passes */
4773
- VOID = "VOID",
4774
- /** Whether payment will be auto-captured when duration passes */
4775
- CAPTURE = "CAPTURE"
4799
+ interface SendFulfillmentEmailRequest {
4800
+ /** @format GUID */
4801
+ orderId?: string;
4802
+ /** @format GUID */
4803
+ fulfillerId?: string;
4776
4804
  }
4777
- /** @enumType */
4778
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4779
- interface Duration {
4805
+ interface SendFulfillmentEmailResponse {
4806
+ }
4807
+ interface SendMerchantOrderReceivedPushRequest {
4780
4808
  /**
4781
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4782
- * @min 1
4809
+ * @minLength 1
4810
+ * @maxLength 100
4783
4811
  */
4784
- count?: number;
4785
- /** Duration unit: MINUTES, HOURS and DAYS */
4786
- unit?: DurationUnitWithLiterals;
4812
+ orderId?: string;
4787
4813
  }
4788
- declare enum DurationUnit {
4789
- MINUTES = "MINUTES",
4790
- HOURS = "HOURS",
4791
- DAYS = "DAYS"
4814
+ interface SendMerchantOrderReceivedPushResponse {
4815
+ }
4816
+ interface PreviewEmailByTypeRequest {
4817
+ emailType?: PreviewEmailTypeWithLiterals;
4818
+ }
4819
+ declare enum PreviewEmailType {
4820
+ ORDER_PLACED = "ORDER_PLACED",
4821
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4822
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4823
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4792
4824
  }
4793
4825
  /** @enumType */
4794
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4795
- interface PreparePaymentCollectionResponse {
4796
- /** Payment gateway order id which is associated with given payment */
4797
- paymentGatewayOrderId?: string;
4826
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4827
+ interface PreviewEmailByTypeResponse {
4828
+ emailPreview?: string;
4798
4829
  }
4799
- interface GetPaymentCollectabilityStatusRequest {
4830
+ interface PreviewRefundEmailRequest {
4800
4831
  /**
4801
- * Ecom order ID.
4802
4832
  * @minLength 1
4803
4833
  * @maxLength 100
4804
4834
  */
4805
- ecomOrderId: string;
4806
- }
4807
- interface GetPaymentCollectabilityStatusResponse {
4808
- /** Payment collectability status */
4809
- status?: PaymentCollectabilityStatusWithLiterals;
4810
- /** Collectable order amount */
4811
- amount?: Price;
4835
+ orderId?: string;
4836
+ /** Refund amount */
4837
+ refundAmount?: Price;
4838
+ /** Refund business details */
4839
+ details?: RefundDetails;
4812
4840
  /**
4813
- * Whether authorization supported
4814
- * @internal
4841
+ * Personal note added to the email (optional)
4842
+ * @minLength 1
4843
+ * @maxLength 1000
4815
4844
  */
4816
- authorizationSupported?: boolean;
4845
+ customMessage?: string | null;
4817
4846
  /**
4818
- * Whether custom amount is supported for payment collection
4819
- * @internal
4847
+ * Refund ID. (Optional)
4848
+ * @format GUID
4820
4849
  */
4821
- customAmountSupported?: boolean;
4822
- }
4823
- declare enum PaymentCollectabilityStatus {
4824
- UNKNOWN = "UNKNOWN",
4825
- COLLECTABLE = "COLLECTABLE",
4826
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4827
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4828
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4829
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4830
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4831
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4832
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4833
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4834
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4835
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4836
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4850
+ refundId?: string | null;
4837
4851
  }
4838
- /** @enumType */
4839
- 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';
4840
- interface RecordManuallyCollectedPaymentRequest {
4852
+ /** Business model of a refund request */
4853
+ interface RefundDetails {
4841
4854
  /**
4842
- * Order ID.
4843
- * @minLength 1
4844
- * @maxLength 100
4855
+ * Order line item IDs and quantities that were refunded.
4856
+ * @maxSize 300
4845
4857
  */
4846
- orderId: string;
4847
- /** Amount to be recorded as approved manual payment for given order */
4848
- amount: Price;
4858
+ items?: RefundItem[];
4859
+ /** Whether the shipping fee was also refunded. */
4860
+ shippingIncluded?: boolean;
4849
4861
  /**
4850
- * Payment method name provided by user.
4851
- *
4852
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4853
- * @internal
4862
+ * Reason for the refund, provided by customer (optional).
4863
+ * @maxLength 200
4854
4864
  */
4855
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4856
- }
4857
- /**
4858
- * User-defined payment method name.
4859
- * Allows specifying either a predefined type or a custom name.
4860
- */
4861
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4862
- /** Predefined payment method. */
4863
- predefined?: PredefinedPaymentMethodWithLiterals;
4865
+ reason?: string | null;
4864
4866
  /**
4865
- * Custom payment method name provided by user.
4866
- *
4867
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4868
- * @minLength 1
4869
- * @maxLength 150
4867
+ * Line items that were refunded.
4868
+ * @maxSize 300
4870
4869
  */
4871
- custom?: string | null;
4872
- }
4873
- /** @oneof */
4874
- interface UserDefinedPaymentMethodNameKindOneOf {
4875
- /** Predefined payment method. */
4876
- predefined?: PredefinedPaymentMethodWithLiterals;
4870
+ lineItems?: LineItemRefund[];
4877
4871
  /**
4878
- * Custom payment method name provided by user.
4879
- *
4880
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4881
- * @minLength 1
4882
- * @maxLength 150
4872
+ * Additional fees that were refunded.
4873
+ * @maxSize 100
4883
4874
  */
4884
- custom?: string | null;
4885
- }
4886
- /** Predefined payment method types for offline/manual payments. */
4887
- declare enum PredefinedPaymentMethod {
4888
- /** Cash payment. */
4889
- CASH = "CASH",
4890
- /** Bank transfer. */
4891
- BANK_TRANSFER = "BANK_TRANSFER",
4892
- /** Payment by check. */
4893
- CHECK = "CHECK"
4894
- }
4895
- /** @enumType */
4896
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4897
- interface RecordManuallyCollectedPaymentResponse {
4875
+ additionalFees?: AdditionalFeeRefund[];
4876
+ /** Shipping amount that was refunded. */
4877
+ shipping?: ShippingRefund;
4898
4878
  }
4899
- interface MarkOrderAsPaidRequest {
4879
+ interface RefundItem {
4900
4880
  /**
4901
- * Ecom order ID.
4902
- * @minLength 1
4903
- * @maxLength 100
4881
+ * Line item ID the refunded line item.
4882
+ * @format GUID
4904
4883
  */
4905
- ecomOrderId: string;
4884
+ lineItemId?: string;
4906
4885
  /**
4907
- * Payment method name provided by user.
4908
- *
4909
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4910
- * @internal
4886
+ * Line item quantity refunded.
4887
+ * @min 1
4888
+ * @max 100000
4911
4889
  */
4912
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4913
- }
4914
- interface MarkOrderAsPaidResponse {
4915
- /** Updated order. */
4916
- order?: Order;
4890
+ quantity?: number;
4917
4891
  }
4918
- interface BulkMarkOrdersAsPaidRequest {
4892
+ interface LineItemRefund {
4919
4893
  /**
4920
- * IDs of orders to mark as paid.
4921
- * @minSize 1
4922
- * @maxSize 100
4923
- * @minLength 1
4924
- * @maxLength 100
4894
+ * Line item ID.
4895
+ * @format GUID
4896
+ * @immutable
4925
4897
  */
4926
- ecomOrderIds: string[];
4927
- }
4928
- interface BulkMarkOrdersAsPaidResponse {
4898
+ lineItemId?: string;
4929
4899
  /**
4930
- * Items updated by the bulk action.
4931
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4900
+ * Refund quantity.
4901
+ * @min 1
4902
+ * @max 100000
4903
+ * @immutable
4932
4904
  */
4933
- results?: BulkOrderResult[];
4934
- /** Bulk action metadata. */
4935
- bulkActionMetadata?: BulkActionMetadata;
4905
+ quantity?: number;
4936
4906
  }
4937
- interface BulkOrderResult {
4938
- /** Item metadata. */
4939
- itemMetadata?: ItemMetadata;
4907
+ interface AdditionalFeeRefund {
4940
4908
  /**
4941
- * Updated order.
4942
- *
4943
- * Returned when `returnFullEntity = true`.
4909
+ * Additional fee ID.
4910
+ * @format GUID
4911
+ * @immutable
4944
4912
  */
4945
- item?: Order;
4946
- }
4947
- interface ItemMetadata {
4948
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4949
- _id?: string | null;
4950
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4951
- originalIndex?: number;
4952
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4953
- success?: boolean;
4954
- /** Details about the error in case of failure. */
4955
- error?: ApplicationError;
4956
- }
4957
- interface ApplicationError {
4958
- /** Error code. */
4959
- code?: string;
4960
- /** Description of the error. */
4961
- description?: string;
4962
- /** Data related to the error. */
4963
- data?: Record<string, any> | null;
4964
- }
4965
- interface BulkActionMetadata {
4966
- /** Number of items that were successfully processed. */
4967
- totalSuccesses?: number;
4968
- /** Number of items that couldn't be processed. */
4969
- totalFailures?: number;
4970
- /** Number of failures without details because detailed failure threshold was exceeded. */
4971
- undetailedFailures?: number;
4972
- }
4973
- interface GetRefundabilityStatusRequest {
4913
+ additionalFeeId?: string;
4974
4914
  /**
4975
- * Order ID.
4976
- * @minLength 1
4977
- * @maxLength 100
4915
+ * Refund amount.
4916
+ * @immutable
4978
4917
  */
4979
- ecomOrderId: string;
4918
+ amount?: Price;
4980
4919
  }
4981
- interface GetRefundabilityStatusResponse {
4982
- /**
4983
- * Refundability details.
4984
- * @maxSize 300
4985
- */
4986
- refundabilities?: Refundability[];
4920
+ interface ShippingRefund {
4987
4921
  /**
4988
- * Whether the order supports refunding per item.
4989
- * @deprecated
4922
+ * Refund amount.
4923
+ * @immutable
4990
4924
  */
4991
- refundablePerItem?: boolean;
4992
- }
4993
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4994
- /** Reason why payment is not refundable. */
4995
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4996
- /** Reason why payment is only refundable manually. */
4997
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4998
- /** Payment ID. */
4999
- paymentId?: string;
5000
- /** Payment refundability status. */
5001
- refundabilityStatus?: RefundableStatusWithLiterals;
5002
- /** Link to payment provider dashboard. */
5003
- providerLink?: string | null;
5004
- }
5005
- /** @oneof */
5006
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5007
- /** Reason why payment is not refundable. */
5008
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5009
- /** Reason why payment is only refundable manually. */
5010
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5011
- }
5012
- declare enum RefundableStatus {
5013
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5014
- MANUAL = "MANUAL",
5015
- REFUNDABLE = "REFUNDABLE"
5016
- }
5017
- /** @enumType */
5018
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5019
- declare enum NonRefundableReason {
5020
- NONE = "NONE",
5021
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5022
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5023
- INTERNAL_ERROR = "INTERNAL_ERROR",
5024
- NOT_PAID = "NOT_PAID",
5025
- ACCESS_DENIED = "ACCESS_DENIED",
5026
- ZERO_PRICE = "ZERO_PRICE",
5027
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5028
- PENDING_REFUND = "PENDING_REFUND",
5029
- FORBIDDEN = "FORBIDDEN",
5030
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5031
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5032
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4925
+ amount?: Price;
5033
4926
  }
5034
- /** @enumType */
5035
- 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';
5036
- declare enum ManuallyRefundableReason {
5037
- EXPIRED = "EXPIRED",
5038
- NOT_SUPPORTED = "NOT_SUPPORTED",
5039
- OFFLINE = "OFFLINE",
5040
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4927
+ interface PreviewRefundEmailResponse {
4928
+ emailPreview?: string;
5041
4929
  }
5042
- /** @enumType */
5043
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5044
- interface CreatePaymentGatewayOrderRequest {
4930
+ interface PreviewCancelEmailRequest {
5045
4931
  /**
5046
- * Ecom order ID.
5047
4932
  * @minLength 1
5048
4933
  * @maxLength 100
5049
4934
  */
5050
- ecomOrderId: string;
5051
- /** Information about the user who initiated the payment. */
5052
- chargedBy?: ChargedBy;
5053
- /**
5054
- * Whether to delay capture of the payment.
5055
- *
5056
- * Default: false
5057
- * @internal
5058
- */
5059
- delayedCapture?: boolean;
5060
- }
5061
- interface ChargedBy {
5062
- /**
5063
- * ID - id of the user who initiated the payment
5064
- * @format GUID
5065
- */
5066
- _id?: string;
4935
+ orderId?: string;
5067
4936
  /**
5068
- * Full name - name of the user who initiated the payment
4937
+ * Personal note added to the email (optional)
5069
4938
  * @minLength 1
5070
- * @maxLength 200
4939
+ * @maxLength 1000
5071
4940
  */
5072
- fullName?: string | null;
4941
+ customMessage?: string | null;
5073
4942
  }
5074
- interface CreatePaymentGatewayOrderResponse {
5075
- /** ID of the order created in the payment gateway */
5076
- paymentGatewayOrderId?: string;
4943
+ interface PreviewCancelEmailResponse {
4944
+ emailPreview?: string;
5077
4945
  }
5078
- interface ChargeMembershipsRequest {
4946
+ interface PreviewCancelRefundEmailRequest {
5079
4947
  /**
5080
- * Order ID.
5081
4948
  * @minLength 1
5082
4949
  * @maxLength 100
5083
4950
  */
5084
- ecomOrderId: string;
5085
- /**
5086
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5087
- * but a user which is using the membership on behalf of the a member
5088
- * @format GUID
5089
- */
5090
- memberId: string;
5091
- /**
5092
- * List of items to be paid by memberships
5093
- * @minSize 1
5094
- * @maxSize 300
5095
- */
5096
- membershipCharges?: MembershipChargeItem[];
5097
- }
5098
- interface MembershipChargeItem {
4951
+ orderId?: string;
5099
4952
  /**
5100
- * The id of used membership
4953
+ * Personal note added to the email (optional)
5101
4954
  * @minLength 1
5102
- * @maxLength 100
4955
+ * @maxLength 1000
5103
4956
  */
5104
- membershipId?: string;
4957
+ customMessage?: string | null;
4958
+ /** Refund amount */
4959
+ refundAmount?: Price;
5105
4960
  /**
5106
- * ID of the application providing this payment option
4961
+ * Refund ID. (Optional)
5107
4962
  * @format GUID
5108
4963
  */
5109
- appId?: string;
5110
- /** The name of used membership */
5111
- membershipName?: MembershipName;
5112
- /** Additional data about this membership */
5113
- membershipAdditionalData?: Record<string, any> | null;
5114
- /** Catalog and item reference info. */
5115
- catalogReference?: CatalogReference;
5116
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5117
- serviceProperties?: ServiceProperties;
5118
- /**
5119
- * Usually would be the same as catalogReference.catalogItemId
5120
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5121
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5122
- * @minLength 1
5123
- * @maxLength 36
5124
- */
5125
- rootCatalogItemId?: string | null;
5126
- /**
5127
- * line item id of Checkout/Order line item
5128
- * @minLength 1
5129
- * @maxLength 100
5130
- */
5131
- lineItemId?: string;
4964
+ refundId?: string | null;
5132
4965
  }
5133
- interface MembershipName {
5134
- /**
5135
- * Membership name in the site's original language.
5136
- * @maxLength 100
5137
- */
5138
- original?: string;
5139
- /**
5140
- * Membership name translated into the buyer's language.
5141
- *
5142
- * Default: The value of `original`
5143
- * @maxLength 100
5144
- */
5145
- translated?: string | null;
4966
+ interface PreviewCancelRefundEmailResponse {
4967
+ emailPreview?: string;
5146
4968
  }
5147
- interface ChargeMembershipsResponse {
4969
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5148
4970
  }
5149
- interface TriggerRefundRequest {
5150
- /**
5151
- * The order this refund related to
5152
- * @minLength 1
5153
- * @maxLength 100
5154
- */
5155
- ecomOrderId: string;
5156
- /**
5157
- * Refund operations information
5158
- * @minSize 1
5159
- * @maxSize 1
5160
- */
5161
- payments: PaymentRefund[];
5162
- /** Business model of a refund */
5163
- details?: RefundDetails;
5164
- /** Side effect details related to refund */
5165
- sideEffects?: RefundSideEffects;
4971
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4972
+ emailPreview?: string;
5166
4973
  }
5167
- interface PaymentRefund {
5168
- /**
5169
- * Specific payment within the order to refund
5170
- * @format GUID
5171
- */
5172
- paymentId?: string;
5173
- /** Refund amount. Not relevant for membership and gift card refunds. */
5174
- amount?: Price;
5175
- /**
5176
- * Whether refund is made externally and manually (on the payment provider's side)
5177
- * 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.
5178
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5179
- */
5180
- externalRefund?: boolean;
5181
- /**
5182
- * Gateway refund id. When param is present, new refund is not created.
5183
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5184
- * and all side effects from request will be executed.
5185
- * @internal
5186
- * @minLength 1
5187
- * @maxLength 100
5188
- */
5189
- gatewayRefundId?: string | null;
4974
+ interface PreviewBuyerConfirmationEmailRequest {
5190
4975
  }
5191
- /** Business model of a refund request */
5192
- interface RefundDetails {
5193
- /**
5194
- * Order line item IDs and quantities that were refunded.
5195
- * @maxSize 300
5196
- */
5197
- items?: RefundItem[];
5198
- /** Whether the shipping fee was also refunded. */
5199
- shippingIncluded?: boolean;
5200
- /**
5201
- * Reason for the refund, provided by customer (optional).
5202
- * @maxLength 200
5203
- */
5204
- reason?: string | null;
5205
- /**
5206
- * Line items that were refunded.
5207
- * @maxSize 300
5208
- */
5209
- lineItems?: LineItemRefund[];
5210
- /**
5211
- * Additional fees that were refunded.
5212
- * @maxSize 100
5213
- */
5214
- additionalFees?: AdditionalFeeRefund[];
5215
- /** Shipping amount that was refunded. */
5216
- shipping?: ShippingRefund;
4976
+ interface PreviewBuyerConfirmationEmailResponse {
4977
+ emailPreview?: string;
5217
4978
  }
5218
- interface RefundItem {
5219
- /**
5220
- * Line item ID the refunded line item.
5221
- * @format GUID
5222
- */
5223
- lineItemId?: string;
5224
- /**
5225
- * Line item quantity refunded.
5226
- * @min 1
5227
- * @max 100000
5228
- */
5229
- quantity?: number;
4979
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5230
4980
  }
5231
- interface LineItemRefund {
5232
- /**
5233
- * Line item ID.
5234
- * @format GUID
5235
- * @immutable
5236
- */
5237
- lineItemId?: string;
5238
- /**
5239
- * Refund quantity.
5240
- * @min 1
5241
- * @max 100000
5242
- * @immutable
5243
- */
5244
- quantity?: number;
4981
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4982
+ emailPreview?: string;
5245
4983
  }
5246
- interface AdditionalFeeRefund {
4984
+ interface PreviewShippingConfirmationEmailRequest {
4985
+ }
4986
+ interface PreviewShippingConfirmationEmailResponse {
4987
+ emailPreview?: string;
4988
+ }
4989
+ interface PreviewResendDownloadLinksEmailRequest {
4990
+ }
4991
+ interface PreviewResendDownloadLinksEmailResponse {
4992
+ emailPreview?: string;
4993
+ }
4994
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4995
+ /** Emitted on a meta site creation. */
4996
+ siteCreated?: SiteCreated;
4997
+ /** Emitted on a meta site transfer completion. */
4998
+ siteTransferred?: SiteTransferred;
4999
+ /** Emitted on a meta site deletion. */
5000
+ siteDeleted?: SiteDeleted;
5001
+ /** Emitted on a meta site restoration. */
5002
+ siteUndeleted?: SiteUndeleted;
5003
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5004
+ sitePublished?: SitePublished;
5005
+ /** Emitted on a meta site unpublish. */
5006
+ siteUnpublished?: SiteUnpublished;
5007
+ /** Emitted when meta site is marked as template. */
5008
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5009
+ /** Emitted when meta site is marked as a WixSite. */
5010
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5011
+ /** Emitted when an application is provisioned (installed). */
5012
+ serviceProvisioned?: ServiceProvisioned;
5013
+ /** Emitted when an application is removed (uninstalled). */
5014
+ serviceRemoved?: ServiceRemoved;
5015
+ /** Emitted when meta site name (URL slug) is changed. */
5016
+ siteRenamedPayload?: SiteRenamed;
5017
+ /** Emitted when meta site was permanently deleted. */
5018
+ hardDeleted?: SiteHardDeleted;
5019
+ /** Emitted on a namespace change. */
5020
+ namespaceChanged?: NamespaceChanged;
5021
+ /** Emitted when Studio is attached. */
5022
+ studioAssigned?: StudioAssigned;
5023
+ /** Emitted when Studio is detached. */
5024
+ studioUnassigned?: StudioUnassigned;
5247
5025
  /**
5248
- * Additional fee ID.
5249
- * @format GUID
5250
- * @immutable
5026
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5027
+ * the actual URL.
5028
+ *
5029
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5030
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5251
5031
  */
5252
- additionalFeeId?: string;
5032
+ urlChanged?: SiteUrlChanged;
5033
+ /** Site is marked as PurgedExternally */
5034
+ sitePurgedExternally?: SitePurgedExternally;
5035
+ /** Emitted when Odeditor is attached. */
5036
+ odeditorAssigned?: OdeditorAssigned;
5037
+ /** Emitted when Odeditor is detached. */
5038
+ odeditorUnassigned?: OdeditorUnassigned;
5039
+ /** Emitted when Picasso is attached. */
5040
+ picassoAssigned?: PicassoAssigned;
5041
+ /** Emitted when Picasso is detached. */
5042
+ picassoUnassigned?: PicassoUnassigned;
5043
+ /** Emitted when Wixel is attached. */
5044
+ wixelAssigned?: WixelAssigned;
5045
+ /** Emitted when Wixel is detached. */
5046
+ wixelUnassigned?: WixelUnassigned;
5047
+ /** Emitted when StudioTwo is attached. */
5048
+ studioTwoAssigned?: StudioTwoAssigned;
5049
+ /** Emitted when StudioTwo is detached. */
5050
+ studioTwoUnassigned?: StudioTwoUnassigned;
5051
+ /** Emitted when media from user domain is enabled. */
5052
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5053
+ /** Emitted when media from user domain is disabled. */
5054
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5055
+ /** Emitted when Editorless is attached. */
5056
+ editorlessAssigned?: EditorlessAssigned;
5057
+ /** Emitted when Editorless is detached. */
5058
+ editorlessUnassigned?: EditorlessUnassigned;
5253
5059
  /**
5254
- * Refund amount.
5255
- * @immutable
5060
+ * A meta site id.
5061
+ * @format GUID
5256
5062
  */
5257
- amount?: Price;
5258
- }
5259
- interface ShippingRefund {
5063
+ metaSiteId?: string;
5064
+ /** A meta site version. Monotonically increasing. */
5065
+ version?: string;
5066
+ /** A timestamp of the event. */
5067
+ timestamp?: string;
5260
5068
  /**
5261
- * Refund amount.
5262
- * @immutable
5069
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5070
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5071
+ * @maxSize 4000
5263
5072
  */
5264
- amount?: Price;
5073
+ assets?: Asset[];
5265
5074
  }
5266
- interface RefundSideEffects {
5267
- /** Inventory restock details as part of this refund. */
5268
- restockInfo?: RestockInfo;
5269
- /** Whether to send a refund confirmation email to the customer. */
5270
- sendOrderRefundedEmail?: boolean;
5075
+ /** @oneof */
5076
+ interface MetaSiteSpecialEventPayloadOneOf {
5077
+ /** Emitted on a meta site creation. */
5078
+ siteCreated?: SiteCreated;
5079
+ /** Emitted on a meta site transfer completion. */
5080
+ siteTransferred?: SiteTransferred;
5081
+ /** Emitted on a meta site deletion. */
5082
+ siteDeleted?: SiteDeleted;
5083
+ /** Emitted on a meta site restoration. */
5084
+ siteUndeleted?: SiteUndeleted;
5085
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5086
+ sitePublished?: SitePublished;
5087
+ /** Emitted on a meta site unpublish. */
5088
+ siteUnpublished?: SiteUnpublished;
5089
+ /** Emitted when meta site is marked as template. */
5090
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5091
+ /** Emitted when meta site is marked as a WixSite. */
5092
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5093
+ /** Emitted when an application is provisioned (installed). */
5094
+ serviceProvisioned?: ServiceProvisioned;
5095
+ /** Emitted when an application is removed (uninstalled). */
5096
+ serviceRemoved?: ServiceRemoved;
5097
+ /** Emitted when meta site name (URL slug) is changed. */
5098
+ siteRenamedPayload?: SiteRenamed;
5099
+ /** Emitted when meta site was permanently deleted. */
5100
+ hardDeleted?: SiteHardDeleted;
5101
+ /** Emitted on a namespace change. */
5102
+ namespaceChanged?: NamespaceChanged;
5103
+ /** Emitted when Studio is attached. */
5104
+ studioAssigned?: StudioAssigned;
5105
+ /** Emitted when Studio is detached. */
5106
+ studioUnassigned?: StudioUnassigned;
5271
5107
  /**
5272
- * Custom message added to the refund confirmation email.
5273
- * @minLength 1
5274
- * @maxLength 1000
5108
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5109
+ * the actual URL.
5110
+ *
5111
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5112
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5275
5113
  */
5276
- customMessage?: string | null;
5114
+ urlChanged?: SiteUrlChanged;
5115
+ /** Site is marked as PurgedExternally */
5116
+ sitePurgedExternally?: SitePurgedExternally;
5117
+ /** Emitted when Odeditor is attached. */
5118
+ odeditorAssigned?: OdeditorAssigned;
5119
+ /** Emitted when Odeditor is detached. */
5120
+ odeditorUnassigned?: OdeditorUnassigned;
5121
+ /** Emitted when Picasso is attached. */
5122
+ picassoAssigned?: PicassoAssigned;
5123
+ /** Emitted when Picasso is detached. */
5124
+ picassoUnassigned?: PicassoUnassigned;
5125
+ /** Emitted when Wixel is attached. */
5126
+ wixelAssigned?: WixelAssigned;
5127
+ /** Emitted when Wixel is detached. */
5128
+ wixelUnassigned?: WixelUnassigned;
5129
+ /** Emitted when StudioTwo is attached. */
5130
+ studioTwoAssigned?: StudioTwoAssigned;
5131
+ /** Emitted when StudioTwo is detached. */
5132
+ studioTwoUnassigned?: StudioTwoUnassigned;
5133
+ /** Emitted when media from user domain is enabled. */
5134
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5135
+ /** Emitted when media from user domain is disabled. */
5136
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5137
+ /** Emitted when Editorless is attached. */
5138
+ editorlessAssigned?: EditorlessAssigned;
5139
+ /** Emitted when Editorless is detached. */
5140
+ editorlessUnassigned?: EditorlessUnassigned;
5277
5141
  }
5278
- interface RestockInfo {
5279
- /** Restock type. */
5280
- type?: RestockTypeWithLiterals;
5142
+ interface Asset {
5281
5143
  /**
5282
- * Deprecated, use items instead
5283
- * @internal
5284
- * @maxSize 300
5285
- * @deprecated
5144
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5145
+ * @maxLength 36
5286
5146
  */
5287
- lineItemIds?: string[];
5147
+ appDefId?: string;
5288
5148
  /**
5289
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5290
- * @maxSize 300
5149
+ * An instance id. For legacy reasons may be UUID or a string.
5150
+ * @maxLength 200
5291
5151
  */
5292
- items?: RestockItem[];
5152
+ instanceId?: string;
5153
+ /** An application state. */
5154
+ state?: StateWithLiterals;
5293
5155
  }
5294
- declare enum RestockType {
5295
- NO_ITEMS = "NO_ITEMS",
5296
- ALL_ITEMS = "ALL_ITEMS",
5297
- SOME_ITEMS = "SOME_ITEMS"
5156
+ declare enum State {
5157
+ UNKNOWN = "UNKNOWN",
5158
+ ENABLED = "ENABLED",
5159
+ DISABLED = "DISABLED",
5160
+ PENDING = "PENDING",
5161
+ DEMO = "DEMO"
5298
5162
  }
5299
5163
  /** @enumType */
5300
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5301
- interface RestockItem {
5164
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5165
+ interface SiteCreated {
5302
5166
  /**
5303
- * ID of the line item being restocked.
5167
+ * A template identifier (empty if not created from a template).
5168
+ * @maxLength 36
5169
+ */
5170
+ originTemplateId?: string;
5171
+ /**
5172
+ * An account id of the owner.
5304
5173
  * @format GUID
5305
5174
  */
5306
- lineItemId?: string;
5175
+ ownerId?: string;
5176
+ /** A context in which meta site was created. */
5177
+ context?: SiteCreatedContextWithLiterals;
5307
5178
  /**
5308
- * Line item quantity being restocked.
5309
- * @min 1
5310
- * @max 100000
5179
+ * A meta site id from which this site was created.
5180
+ *
5181
+ * In case of a creation from a template it's a template id.
5182
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5183
+ * @format GUID
5311
5184
  */
5312
- quantity?: number;
5185
+ originMetaSiteId?: string | null;
5313
5186
  /**
5314
- * Per-location breakdown of restock quantities.
5315
- * @internal
5316
- * @maxSize 5
5187
+ * A meta site name (URL slug).
5188
+ * @maxLength 20
5317
5189
  */
5318
- restockLocations?: RestockLocation[];
5190
+ siteName?: string;
5191
+ /** A namespace. */
5192
+ namespace?: NamespaceWithLiterals;
5319
5193
  }
5320
- interface TriggerRefundResponse {
5321
- /** All order's transactions after the refunds were added */
5322
- orderTransactions?: OrderTransactions;
5323
- /** Created refund ID */
5324
- refundId?: string | null;
5325
- /** Payment ID's that the refund execution had failed for */
5326
- failedPaymentIds?: ItemMetadata[];
5194
+ declare enum SiteCreatedContext {
5195
+ /** A valid option, we don't expose all reasons why site might be created. */
5196
+ OTHER = "OTHER",
5197
+ /** A meta site was created from template. */
5198
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5199
+ /** A meta site was created by copying of the transfferred meta site. */
5200
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5201
+ /** A copy of existing meta site. */
5202
+ DUPLICATE = "DUPLICATE",
5203
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5204
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5205
+ /** deprecated A meta site was created for Flash editor. */
5206
+ FLASH = "FLASH"
5327
5207
  }
5328
- /**
5329
- * A record of all payments and refunds associated with an order.
5330
- *
5331
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5332
- */
5333
- interface OrderTransactions {
5208
+ /** @enumType */
5209
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5210
+ declare enum Namespace {
5211
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5212
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5213
+ WIX = "WIX",
5214
+ /** 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. */
5215
+ SHOUT_OUT = "SHOUT_OUT",
5216
+ /** 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. */
5217
+ ALBUMS = "ALBUMS",
5218
+ /** 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. */
5219
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5220
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5221
+ HOTELS = "HOTELS",
5222
+ /** 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. */
5223
+ CLUBS = "CLUBS",
5224
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5225
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5334
5226
  /**
5335
- * Order ID.
5336
- * @format GUID
5227
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5228
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5337
5229
  */
5338
- orderId?: string;
5230
+ DEV_SITE = "DEV_SITE",
5231
+ /** 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. */
5232
+ LOGOS = "LOGOS",
5233
+ /** 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. */
5234
+ VIDEO_MAKER = "VIDEO_MAKER",
5235
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5236
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5237
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5238
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5339
5239
  /**
5340
- * Record of payments made to the merchant.
5341
- * @maxSize 100
5240
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5241
+ *
5242
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5342
5243
  */
5343
- payments?: Payment[];
5244
+ HTML_DRAFT = "HTML_DRAFT",
5344
5245
  /**
5345
- * Record of refunds made to the buyer.
5346
- * @maxSize 300
5246
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5247
+ * Will be accessible from Site List and will not have a website app.
5248
+ * Once the user attaches a site, the site will become a regular wixsite.
5347
5249
  */
5348
- refunds?: Refund[];
5349
- }
5350
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5351
- /** Regular payment details. */
5352
- regularPaymentDetails?: RegularPaymentDetails;
5353
- /** Gift card payment details. */
5354
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5355
- /** Membership payment details. */
5356
- membershipPaymentDetails?: MembershipPaymentDetails;
5250
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5251
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5252
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5253
+ /** It is to be used in the Business First efforts. */
5254
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5255
+ /** Bookings business flow with no site. */
5256
+ ANYWHERE = "ANYWHERE",
5257
+ /** Namespace for Headless Backoffice with no editor */
5258
+ HEADLESS = "HEADLESS",
5357
5259
  /**
5358
- * Receipt created by Wix
5359
- * @internal
5260
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5261
+ * The site will be used for account level CSM feature for enterprise
5360
5262
  */
5361
- wixReceipt?: WixReceiptInfo;
5263
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5264
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5265
+ RISE = "RISE",
5362
5266
  /**
5363
- * Receipt created by an external system.
5364
- * @internal
5267
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5268
+ * There's a blank site behind the scene but it's blank).
5269
+ * The Mobile company will be the owner of this namespace.
5365
5270
  */
5366
- externalReceipt?: ExternalReceiptInfo;
5367
- /** @internal */
5368
- canceled?: CanceledStatusDetails;
5369
- /** @internal */
5370
- declined?: DeclinedStatusDetails;
5371
- /** @internal */
5372
- voided?: VoidedStatusDetails;
5271
+ BRANDED_FIRST = "BRANDED_FIRST",
5272
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5273
+ NOWNIA = "NOWNIA",
5373
5274
  /**
5374
- * Payment ID.
5375
- * @format GUID
5376
- * @readonly
5275
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5276
+ * The Partners company owns this namespace.
5377
5277
  */
5378
- _id?: string | null;
5379
- /** 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. */
5380
- _createdDate?: Date | null;
5278
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5279
+ /** Codux Headless Sites */
5280
+ CODUX = "CODUX",
5281
+ /** Bobb - AI Design Creator. */
5282
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5381
5283
  /**
5382
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5383
- * @readonly
5284
+ * Shared Blog Site is a unique single site across Enterprise account,
5285
+ * This site will hold all Blog posts related to the Marketing product.
5384
5286
  */
5385
- _updatedDate?: Date | null;
5386
- /** Payment amount. */
5387
- amount?: Price;
5287
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5288
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5289
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5290
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5291
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5292
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5293
+ MIMIR = "MIMIR",
5294
+ /** Wix Twins platform. */
5295
+ TWINS = "TWINS",
5296
+ /** Wix Nano. */
5297
+ NANO = "NANO",
5298
+ /** Base44 headless sites. */
5299
+ BASE44 = "BASE44",
5300
+ /** Wix Channels Sites */
5301
+ CHANNELS = "CHANNELS",
5302
+ /** Nautilus platform. */
5303
+ NAUTILUS = "NAUTILUS",
5388
5304
  /**
5389
- * Whether refunds for this payment are disabled.
5390
- * + `true`: This payment is not refundable.
5391
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5305
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5306
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5392
5307
  */
5393
- refundDisabled?: boolean;
5308
+ SYMPHONY = "SYMPHONY",
5309
+ /** Nautilus platform app. */
5310
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5394
5311
  /**
5395
- * Whether receipt generation is allowed for this payment.
5396
- * + `true`: This payment supports receipt generation.
5397
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5398
- * @readonly
5312
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5313
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5399
5314
  */
5400
- supportReceiptGeneration?: boolean;
5401
- /** Details about cash rounding applied to this payment, when relevant. */
5402
- cashRounding?: CashRoundingDetails;
5315
+ VIBU = "VIBU",
5403
5316
  /**
5404
- * Overall payment status.
5405
- *
5406
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5317
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5318
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5319
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5320
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5407
5321
  */
5408
- status?: PaymentStatusWithLiterals;
5322
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5409
5323
  /**
5410
- * Detailed payment status information including gateway reason codes and status-specific details.
5411
- * @internal
5324
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5325
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5412
5326
  */
5413
- paymentStatusDetails?: PaymentStatusDetails;
5327
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5328
+ }
5329
+ /** @enumType */
5330
+ 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';
5331
+ /** Site transferred to another user. */
5332
+ interface SiteTransferred {
5414
5333
  /**
5415
- * Location where the payment was processed.
5416
- * @internal
5334
+ * A previous owner id (user that transfers meta site).
5417
5335
  * @format GUID
5418
- * @immutable
5419
5336
  */
5420
- locationId?: string | null;
5337
+ oldOwnerId?: string;
5421
5338
  /**
5422
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5339
+ * A new owner id (user that accepts meta site).
5423
5340
  * @format GUID
5424
5341
  */
5425
- chargeCorrelationId?: string | null;
5342
+ newOwnerId?: string;
5426
5343
  }
5427
- /** @oneof */
5428
- interface PaymentPaymentDetailsOneOf {
5429
- /** Regular payment details. */
5430
- regularPaymentDetails?: RegularPaymentDetails;
5431
- /** Gift card payment details. */
5432
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5433
- /** Membership payment details. */
5434
- membershipPaymentDetails?: MembershipPaymentDetails;
5344
+ /** Soft deletion of the meta site. Could be restored. */
5345
+ interface SiteDeleted {
5346
+ /** A deletion context. */
5347
+ deleteContext?: DeleteContext;
5435
5348
  }
5436
- /** @oneof */
5437
- interface PaymentReceiptInfoOneOf {
5349
+ interface DeleteContext {
5350
+ /** When the meta site was deleted. */
5351
+ dateDeleted?: Date | null;
5352
+ /** A status. */
5353
+ deleteStatus?: DeleteStatusWithLiterals;
5438
5354
  /**
5439
- * Receipt created by Wix
5440
- * @internal
5355
+ * A reason (flow).
5356
+ * @maxLength 255
5441
5357
  */
5442
- wixReceipt?: WixReceiptInfo;
5358
+ deleteOrigin?: string;
5443
5359
  /**
5444
- * Receipt created by an external system.
5445
- * @internal
5360
+ * A service that deleted it.
5361
+ * @maxLength 255
5446
5362
  */
5447
- externalReceipt?: ExternalReceiptInfo;
5363
+ initiatorId?: string | null;
5448
5364
  }
5449
- /** @oneof */
5450
- interface PaymentStatusDetailsOneOf {
5451
- /** @internal */
5452
- canceled?: CanceledStatusDetails;
5453
- /** @internal */
5454
- declined?: DeclinedStatusDetails;
5455
- /** @internal */
5456
- voided?: VoidedStatusDetails;
5365
+ declare enum DeleteStatus {
5366
+ UNKNOWN = "UNKNOWN",
5367
+ TRASH = "TRASH",
5368
+ DELETED = "DELETED",
5369
+ PENDING_PURGE = "PENDING_PURGE",
5370
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5457
5371
  }
5458
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5459
- /** Credit card details. */
5460
- creditCardDetails?: CreditCardPaymentMethodDetails;
5372
+ /** @enumType */
5373
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5374
+ /** Restoration of the meta site. */
5375
+ interface SiteUndeleted {
5376
+ }
5377
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5378
+ interface SitePublished {
5379
+ }
5380
+ interface SiteUnpublished {
5461
5381
  /**
5462
- * Wix Payments order ID.
5463
- * @maxLength 100
5382
+ * A list of URLs previously associated with the meta site.
5383
+ * @maxLength 4000
5384
+ * @maxSize 10000
5464
5385
  */
5465
- paymentOrderId?: string | null;
5386
+ urls?: string[];
5387
+ }
5388
+ interface SiteMarkedAsTemplate {
5389
+ }
5390
+ interface SiteMarkedAsWixSite {
5391
+ }
5392
+ /**
5393
+ * Represents a service provisioned a site.
5394
+ *
5395
+ * Note on `origin_instance_id`:
5396
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5397
+ * This is because of the following scenario:
5398
+ *
5399
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5400
+ * such as a product catalog. When you create a site from this template, you inherit this
5401
+ * default product catalog. However, if the template's product catalog is modified,
5402
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5403
+ * your site remains consistent with what you initially received and does not include any
5404
+ * changes made to the original template afterward.
5405
+ * To ensure this, the TPA on the template gets a new instance_id.
5406
+ */
5407
+ interface ServiceProvisioned {
5466
5408
  /**
5467
- * Payment gateway's transaction ID.
5468
- * This field is only returned when the value of `offline_payment` is `false`.
5469
- * @maxLength 100
5409
+ * Either UUID or EmbeddedServiceType.
5410
+ * @maxLength 36
5470
5411
  */
5471
- gatewayTransactionId?: string | null;
5412
+ appDefId?: string;
5472
5413
  /**
5473
- * Payment method.
5474
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5475
- * Non-exhaustive list of supported values:
5476
- * + `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`
5477
- * @maxLength 150
5478
- * @deprecated Payment method.
5479
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5480
- * Non-exhaustive list of supported values:
5481
- * + `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`
5482
- * @replacedBy payment_method_name
5483
- * @targetRemovalDate 2026-07-01
5414
+ * Not only UUID. Something here could be something weird.
5415
+ * @maxLength 36
5484
5416
  */
5485
- paymentMethod?: string | null;
5417
+ instanceId?: string;
5486
5418
  /**
5487
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5488
- * @maxLength 100
5419
+ * An instance id from which this instance is originated.
5420
+ * @maxLength 36
5489
5421
  */
5490
- providerTransactionId?: string | null;
5491
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5492
- offlinePayment?: boolean;
5422
+ originInstanceId?: string;
5493
5423
  /**
5494
- * Payment status.
5495
- * @deprecated Payment status.
5496
- * @replacedBy payment.status
5497
- * @targetRemovalDate 2026-11-01
5424
+ * A version.
5425
+ * @maxLength 500
5498
5426
  */
5499
- status?: TransactionStatusWithLiterals;
5500
- /** Whether there is a payment agreement that allows for future charges. */
5501
- savedPaymentMethod?: boolean;
5502
- /** Authorization details. */
5503
- authorizationDetails?: AuthorizationDetails;
5427
+ version?: string | null;
5504
5428
  /**
5505
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5506
- * @internal
5507
- * @maxLength 300
5429
+ * The origin meta site id
5430
+ * @format GUID
5508
5431
  */
5509
- paymentProvider?: string | null;
5432
+ originMetaSiteId?: string | null;
5433
+ }
5434
+ interface ServiceRemoved {
5510
5435
  /**
5511
- * Record of chargebacks made by the buyer.
5512
- * @maxSize 6
5436
+ * Either UUID or EmbeddedServiceType.
5437
+ * @maxLength 36
5513
5438
  */
5514
- chargebacks?: Chargeback[];
5439
+ appDefId?: string;
5515
5440
  /**
5516
- * Payment method ID.
5517
- * @internal
5441
+ * Not only UUID. Something here could be something weird.
5518
5442
  * @maxLength 36
5519
5443
  */
5520
- paymentMethodId?: string | null;
5521
- /** Platform fee amount associated with this payment. */
5522
- platformFee?: Price;
5444
+ instanceId?: string;
5523
5445
  /**
5524
- * Payment method with buyer and optional owner translations.
5525
- * Non-exhaustive list of supported values:
5526
- * + `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`
5446
+ * A version.
5447
+ * @maxLength 500
5527
5448
  */
5528
- paymentMethodName?: PaymentMethodName;
5529
- }
5530
- /** @oneof */
5531
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5532
- /** Credit card details. */
5533
- creditCardDetails?: CreditCardPaymentMethodDetails;
5534
- }
5535
- declare enum TransactionStatus {
5536
- UNDEFINED = "UNDEFINED",
5537
- APPROVED = "APPROVED",
5538
- PENDING = "PENDING",
5539
- PENDING_MERCHANT = "PENDING_MERCHANT",
5540
- CANCELED = "CANCELED",
5541
- DECLINED = "DECLINED",
5542
- REFUNDED = "REFUNDED",
5543
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5544
- AUTHORIZED = "AUTHORIZED",
5545
- VOIDED = "VOIDED"
5449
+ version?: string | null;
5546
5450
  }
5547
- /** @enumType */
5548
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5549
- interface CreditCardPaymentMethodDetails {
5451
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5452
+ interface SiteRenamed {
5550
5453
  /**
5551
- * The last 4 digits of the card number.
5552
- * @maxLength 4
5454
+ * A new meta site name (URL slug).
5455
+ * @maxLength 20
5553
5456
  */
5554
- lastFourDigits?: string | null;
5457
+ newSiteName?: string;
5555
5458
  /**
5556
- * Card issuer's brand.
5557
- * @maxLength 100
5459
+ * A previous meta site name (URL slug).
5460
+ * @maxLength 255
5558
5461
  */
5559
- brand?: string | null;
5462
+ oldSiteName?: string;
5560
5463
  }
5561
- interface AuthorizationDetails {
5562
- /**
5563
- * Whether the authorized payment is of a delayed capture.
5564
- * @readonly
5565
- */
5566
- delayedCapture?: boolean;
5567
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5568
- authorizedDate?: Date | null;
5569
- /**
5570
- * List of captures associated with payment
5571
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5572
- * @maxSize 1
5573
- */
5574
- captures?: AuthorizationCapture[];
5575
- /** Void associated with payment */
5576
- void?: AuthorizationVoid;
5577
- /** Scheduled action for this transaction */
5578
- scheduledAction?: V1ScheduledAction;
5464
+ /**
5465
+ * Hard deletion of the meta site.
5466
+ *
5467
+ * Could not be restored. Therefore it's desirable to cleanup data.
5468
+ */
5469
+ interface SiteHardDeleted {
5470
+ /** A deletion context. */
5471
+ deleteContext?: DeleteContext;
5579
5472
  }
5580
- interface AuthorizationCapture {
5581
- /**
5582
- * Capture ID.
5583
- * @format GUID
5584
- * @readonly
5585
- */
5586
- _id?: string | null;
5587
- /** Status of this capture action */
5588
- status?: AuthorizationCaptureStatusWithLiterals;
5473
+ interface NamespaceChanged {
5474
+ /** A previous namespace. */
5475
+ oldNamespace?: NamespaceWithLiterals;
5476
+ /** A new namespace. */
5477
+ newNamespace?: NamespaceWithLiterals;
5478
+ }
5479
+ /** Assigned Studio editor */
5480
+ interface StudioAssigned {
5481
+ }
5482
+ /** Unassigned Studio editor */
5483
+ interface StudioUnassigned {
5484
+ }
5485
+ /**
5486
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5487
+ *
5488
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5489
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5490
+ *
5491
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5492
+ */
5493
+ interface SiteUrlChanged {
5494
+ }
5495
+ /**
5496
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5497
+ * Consumed by other teams to remove relevant data.
5498
+ */
5499
+ interface SitePurgedExternally {
5589
5500
  /**
5590
- * Amount of this capture
5591
- * @immutable
5501
+ * @maxLength 2048
5502
+ * @maxSize 100
5503
+ * @deprecated
5504
+ * @targetRemovalDate 2025-04-15
5592
5505
  */
5593
- amount?: Price;
5594
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5595
- _createdDate?: Date | null;
5596
- /** In case of status is FAILED may contain failure details */
5597
- failureDetails?: AuthorizationActionFailureDetails;
5506
+ appDefId?: string[];
5598
5507
  }
5599
- declare enum AuthorizationCaptureStatus {
5600
- /** Capture operation still in progress. */
5601
- PENDING = "PENDING",
5602
- /** Capture operation succeeded. */
5603
- SUCCEEDED = "SUCCEEDED",
5604
- /** Capture operation failed. */
5605
- FAILED = "FAILED"
5508
+ /** Assigned Odeditor */
5509
+ interface OdeditorAssigned {
5606
5510
  }
5607
- /** @enumType */
5608
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5609
- interface AuthorizationActionFailureDetails {
5610
- /** @maxLength 100 */
5611
- failureCode?: string;
5511
+ /** Unassigned Odeditor */
5512
+ interface OdeditorUnassigned {
5612
5513
  }
5613
- interface AuthorizationVoid {
5614
- /** Status of this void action */
5615
- status?: AuthorizationVoidStatusWithLiterals;
5616
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5617
- voidedDate?: Date | null;
5618
- /** In case of status is FAILED may contain failure details */
5619
- failureDetails?: AuthorizationActionFailureDetails;
5620
- /** Reason of void action */
5621
- reason?: ReasonWithLiterals;
5514
+ /** Assigned Picasso editor */
5515
+ interface PicassoAssigned {
5622
5516
  }
5623
- declare enum AuthorizationVoidStatus {
5624
- /** Void operation still in progress. */
5625
- PENDING = "PENDING",
5626
- /** Void operation succeeded. */
5627
- SUCCEEDED = "SUCCEEDED",
5628
- /** Void operation failed. */
5629
- FAILED = "FAILED"
5517
+ /** Unassigned Picasso */
5518
+ interface PicassoUnassigned {
5630
5519
  }
5631
- /** @enumType */
5632
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5633
- /** Reason the authorization was voided. */
5634
- declare enum Reason {
5635
- /** Authorization was voided by user. */
5636
- MANUAL = "MANUAL",
5637
- /** Authorization passed execution date. */
5638
- SCHEDULED = "SCHEDULED"
5520
+ /** Assigned Wixel */
5521
+ interface WixelAssigned {
5639
5522
  }
5640
- /** @enumType */
5641
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5642
- interface V1ScheduledAction {
5643
- /** Type of the action. */
5644
- actionType?: ActionTypeWithLiterals;
5645
- /** The date and time of the action. */
5646
- executionDate?: Date | null;
5523
+ /** Unassigned Wixel */
5524
+ interface WixelUnassigned {
5647
5525
  }
5648
- declare enum ActionType {
5649
- VOID = "VOID",
5650
- CAPTURE = "CAPTURE"
5526
+ /** Assigned StudioTwo */
5527
+ interface StudioTwoAssigned {
5528
+ }
5529
+ /** Unassigned StudioTwo */
5530
+ interface StudioTwoUnassigned {
5531
+ }
5532
+ /** Media from user domain is enabled. */
5533
+ interface UserDomainMediaEnabled {
5534
+ }
5535
+ /** Media from user domain is disabled. */
5536
+ interface UserDomainMediaDisabled {
5537
+ }
5538
+ /** Assigned Editorless */
5539
+ interface EditorlessAssigned {
5540
+ }
5541
+ /** Unassigned Editorless */
5542
+ interface EditorlessUnassigned {
5543
+ }
5544
+ interface HasCustomEmailConfigurationsRequest {
5545
+ }
5546
+ interface HasCustomEmailConfigurationsResponse {
5547
+ hasCustomConfigurations?: boolean;
5548
+ }
5549
+ interface AddToAutomationMigrationPopulationRequest {
5550
+ /** When true, sends custom email configurations to automation system via email */
5551
+ sendCustomEmailConfigs?: boolean;
5552
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5553
+ origin?: OriginWithLiterals;
5554
+ }
5555
+ declare enum Origin {
5556
+ OPT_IN = "OPT_IN",
5557
+ MIGRATION = "MIGRATION"
5651
5558
  }
5652
5559
  /** @enumType */
5653
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5654
- interface Chargeback {
5655
- /**
5656
- * Chargeback ID.
5657
- * @format GUID
5658
- * @readonly
5659
- * @immutable
5660
- */
5661
- _id?: string;
5662
- /**
5663
- * 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.
5664
- * @readonly
5665
- * @immutable
5666
- */
5667
- _createdDate?: Date | null;
5560
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5561
+ interface AddToAutomationMigrationPopulationResponse {
5562
+ success?: boolean;
5563
+ }
5564
+ interface IsInAutomationMigrationPopulationRequest {
5565
+ }
5566
+ interface IsInAutomationMigrationPopulationResponse {
5567
+ inPopulation?: boolean;
5568
+ }
5569
+ interface PreparePaymentCollectionRequest {
5668
5570
  /**
5669
- * 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.
5670
- * @readonly
5571
+ * Ecom order ID.
5572
+ * @minLength 1
5573
+ * @maxLength 100
5671
5574
  */
5672
- _updatedDate?: Date | null;
5575
+ ecomOrderId: string;
5576
+ /** Amount to collect */
5577
+ amount: Price;
5673
5578
  /**
5674
- * Amount.
5675
- * @readonly
5676
- * @immutable
5579
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5580
+ * Existing payment gateway order will be updated with a new amount.
5581
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
5677
5582
  */
5678
- amount?: Price;
5583
+ paymentGatewayOrderId?: string | null;
5679
5584
  /**
5680
- * Reversal amount. Present only when status is REVERSED.
5681
- * @readonly
5585
+ * Whether to delay capture of the payment.
5586
+ * Default: false
5587
+ * @deprecated Whether to delay capture of the payment.
5588
+ * Default: false
5589
+ * @replacedBy delayed_capture_settings.scheduled_action
5590
+ * @targetRemovalDate 2024-09-30
5682
5591
  */
5683
- reversalAmount?: Price;
5592
+ delayedCapture?: boolean;
5684
5593
  /**
5685
- * Status.
5686
- *
5687
- * Default: `"APPROVED"`.
5594
+ * Specifies whether payment collection is initiated by Merchant or User of User
5595
+ * Default: `true`
5596
+ * @internal
5688
5597
  */
5689
- status?: ChargebackStatusWithLiterals;
5598
+ merchantInitiated?: boolean | null;
5690
5599
  /**
5691
- * External chargeback ID.
5692
- * @format GUID
5693
- * @readonly
5694
- * @immutable
5600
+ * Redirect urls which are used to return buyer to third party system.
5601
+ * @internal
5695
5602
  */
5696
- externalId?: string | null;
5697
- }
5698
- declare enum ChargebackStatus {
5699
- /** Chargeback was approved. */
5700
- APPROVED = "APPROVED",
5701
- /** Chargeback was reversed. */
5702
- REVERSED = "REVERSED"
5603
+ redirectUrls?: RedirectUrls;
5604
+ /** Delayed capture payment settings */
5605
+ delayedCaptureSettings?: DelayedCaptureSettings;
5703
5606
  }
5704
- /** @enumType */
5705
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5706
- interface PaymentMethodName {
5607
+ interface RedirectUrls {
5707
5608
  /**
5708
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5709
- * @maxLength 150
5609
+ * URL to redirect buyer in case of approved (successful) transaction
5610
+ * @format WEB_URL
5710
5611
  */
5711
- buyerLanguageName?: string | null;
5612
+ successUrl?: string | null;
5712
5613
  /**
5713
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5714
- *
5715
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5716
- * @maxLength 150
5614
+ * URL to redirect buyer in case of buyer canceled the transaction
5615
+ * @format WEB_URL
5717
5616
  */
5718
- siteLanguageName?: string | null;
5617
+ cancelUrl?: string | null;
5719
5618
  /**
5720
- * User-provided payment method name.
5721
- *
5722
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5619
+ * URL to redirect buyer in case of failed/rejected transaction
5620
+ * @format WEB_URL
5723
5621
  */
5724
- userDefinedName?: UserDefinedPaymentMethodName;
5725
- }
5726
- interface GiftCardPaymentDetails {
5622
+ errorUrl?: string | null;
5727
5623
  /**
5728
- * Gift card payment ID.
5729
- * @maxLength 100
5624
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5625
+ * @format WEB_URL
5730
5626
  */
5731
- giftCardPaymentId?: string;
5627
+ pendingUrl?: string | null;
5628
+ }
5629
+ interface DelayedCaptureSettings {
5630
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5631
+ scheduledAction?: ScheduledActionWithLiterals;
5632
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5633
+ delayDuration?: Duration;
5634
+ }
5635
+ declare enum ScheduledAction {
5636
+ /** Whether payment will be auto-voided when duration passes */
5637
+ VOID = "VOID",
5638
+ /** Whether payment will be auto-captured when duration passes */
5639
+ CAPTURE = "CAPTURE"
5640
+ }
5641
+ /** @enumType */
5642
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5643
+ interface Duration {
5732
5644
  /**
5733
- * Gift card ID.
5734
- * @internal
5735
- * @deprecated
5645
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5646
+ * @min 1
5736
5647
  */
5737
- giftCardId?: string;
5648
+ count?: number;
5649
+ /** Duration unit: MINUTES, HOURS and DAYS */
5650
+ unit?: DurationUnitWithLiterals;
5651
+ }
5652
+ declare enum DurationUnit {
5653
+ MINUTES = "MINUTES",
5654
+ HOURS = "HOURS",
5655
+ DAYS = "DAYS"
5656
+ }
5657
+ /** @enumType */
5658
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5659
+ interface PreparePaymentCollectionResponse {
5660
+ /** Payment gateway order id which is associated with given payment */
5661
+ paymentGatewayOrderId?: string;
5662
+ }
5663
+ interface GetPaymentCollectabilityStatusRequest {
5738
5664
  /**
5739
- * ID of the app that created the gift card.
5740
- * @format GUID
5665
+ * Ecom order ID.
5666
+ * @minLength 1
5667
+ * @maxLength 100
5741
5668
  */
5742
- appId?: string;
5669
+ ecomOrderId: string;
5670
+ }
5671
+ interface GetPaymentCollectabilityStatusResponse {
5672
+ /** Payment collectability status */
5673
+ status?: PaymentCollectabilityStatusWithLiterals;
5674
+ /** Collectable order amount */
5675
+ amount?: Price;
5743
5676
  /**
5744
- * Whether the gift card is voided.
5745
- * @readonly
5746
- * @deprecated Whether the gift card is voided.
5747
- * @replacedBy payment.status
5748
- * @targetRemovalDate 2026-11-01
5677
+ * Whether authorization supported
5678
+ * @internal
5749
5679
  */
5750
- voided?: boolean;
5680
+ authorizationSupported?: boolean;
5751
5681
  /**
5752
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5753
- * @maxLength 30
5754
- * @immutable
5682
+ * Whether custom amount is supported for payment collection
5683
+ * @internal
5755
5684
  */
5756
- obfuscatedCode?: string | null;
5685
+ customAmountSupported?: boolean;
5757
5686
  }
5758
- interface MembershipPaymentDetails {
5759
- /**
5760
- * Membership ID.
5761
- * @maxLength 200
5762
- */
5763
- membershipId?: string;
5687
+ declare enum PaymentCollectabilityStatus {
5688
+ UNKNOWN = "UNKNOWN",
5689
+ COLLECTABLE = "COLLECTABLE",
5690
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5691
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5692
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5693
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5694
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5695
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5696
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5697
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5698
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5699
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5700
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5701
+ }
5702
+ /** @enumType */
5703
+ 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';
5704
+ interface RecordManuallyCollectedPaymentRequest {
5764
5705
  /**
5765
- * ID of the line item this membership applies to.
5706
+ * Order ID.
5766
5707
  * @minLength 1
5767
5708
  * @maxLength 100
5768
5709
  */
5769
- lineItemId?: string;
5710
+ orderId: string;
5711
+ /** Amount to be recorded as approved manual payment for given order */
5712
+ amount: Price;
5770
5713
  /**
5771
- * Payment status.
5772
- * @deprecated Payment status.
5773
- * @replacedBy payment.status
5774
- * @targetRemovalDate 2026-11-01
5714
+ * Payment method name provided by user.
5715
+ *
5716
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5717
+ * @internal
5775
5718
  */
5776
- status?: MembershipPaymentStatusWithLiterals;
5777
- /** Membership name. */
5778
- name?: MembershipName;
5719
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5720
+ }
5721
+ /**
5722
+ * User-defined payment method name.
5723
+ * Allows specifying either a predefined type or a custom name.
5724
+ */
5725
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5726
+ /** Predefined payment method. */
5727
+ predefined?: PredefinedPaymentMethodWithLiterals;
5779
5728
  /**
5780
- * The transaction ID in the membership system. Can be used to void the transaction.
5729
+ * Custom payment method name provided by user.
5730
+ *
5731
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5781
5732
  * @minLength 1
5782
- * @maxLength 100
5783
- */
5784
- externalTransactionId?: string | null;
5785
- /**
5786
- * Whether the membership is voided.
5787
- * @readonly
5788
- * @deprecated Whether the membership is voided.
5789
- * @replacedBy payment.status
5790
- * @targetRemovalDate 2026-11-01
5733
+ * @maxLength 150
5791
5734
  */
5792
- voided?: boolean;
5735
+ custom?: string | null;
5736
+ }
5737
+ /** @oneof */
5738
+ interface UserDefinedPaymentMethodNameKindOneOf {
5739
+ /** Predefined payment method. */
5740
+ predefined?: PredefinedPaymentMethodWithLiterals;
5793
5741
  /**
5794
- * ID of the application providing this payment option.
5795
- * @format GUID
5742
+ * Custom payment method name provided by user.
5743
+ *
5744
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5745
+ * @minLength 1
5746
+ * @maxLength 150
5796
5747
  */
5797
- providerAppId?: string;
5798
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5799
- futureMembership?: FutureMembershipDetails;
5748
+ custom?: string | null;
5800
5749
  }
5801
- declare enum MembershipPaymentStatus {
5802
- /** Payment was charged. */
5803
- CHARGED = "CHARGED",
5804
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5805
- CHARGE_FAILED = "CHARGE_FAILED",
5806
- /** Payment is pending. */
5807
- CHARGE_PENDING = "CHARGE_PENDING",
5808
- /** Payment was voided. */
5809
- VOIDED = "VOIDED"
5750
+ /** Predefined payment method types for offline/manual payments. */
5751
+ declare enum PredefinedPaymentMethod {
5752
+ /** Cash payment. */
5753
+ CASH = "CASH",
5754
+ /** Bank transfer. */
5755
+ BANK_TRANSFER = "BANK_TRANSFER",
5756
+ /** Payment by check. */
5757
+ CHECK = "CHECK"
5810
5758
  }
5811
5759
  /** @enumType */
5812
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5813
- interface FutureMembershipDetails {
5760
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5761
+ interface RecordManuallyCollectedPaymentResponse {
5762
+ }
5763
+ interface MarkOrderAsPaidRequest {
5814
5764
  /**
5815
- * ID of the plan line item in the order from which the membership will be created.
5816
- * @format GUID
5765
+ * Ecom order ID.
5766
+ * @minLength 1
5767
+ * @maxLength 100
5817
5768
  */
5818
- lineItemId?: string;
5769
+ ecomOrderId: string;
5819
5770
  /**
5820
- * ID of the benefit the future membership will grant.
5821
- * @maxLength 200
5771
+ * Payment method name provided by user.
5772
+ *
5773
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5774
+ * @internal
5822
5775
  */
5823
- benefitId?: string;
5776
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5824
5777
  }
5825
- interface WixReceiptInfo {
5826
- /**
5827
- * Receipt ID
5828
- * @format GUID
5829
- */
5830
- receiptId?: string;
5778
+ interface MarkOrderAsPaidResponse {
5779
+ /** Updated order. */
5780
+ order?: Order;
5781
+ }
5782
+ interface BulkMarkOrdersAsPaidRequest {
5831
5783
  /**
5832
- * Display number of receipt
5784
+ * IDs of orders to mark as paid.
5785
+ * @minSize 1
5786
+ * @maxSize 100
5833
5787
  * @minLength 1
5834
- * @maxLength 40
5788
+ * @maxLength 100
5835
5789
  */
5836
- displayNumber?: string | null;
5790
+ ecomOrderIds: string[];
5837
5791
  }
5838
- interface ExternalReceiptInfo {
5792
+ interface BulkMarkOrdersAsPaidResponse {
5839
5793
  /**
5840
- * External receipt ID
5841
- * @maxLength 100
5794
+ * Items updated by the bulk action.
5795
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5842
5796
  */
5843
- receiptId?: string | null;
5797
+ results?: BulkOrderResult[];
5798
+ /** Bulk action metadata. */
5799
+ bulkActionMetadata?: BulkActionMetadata;
5800
+ }
5801
+ interface BulkOrderResult {
5802
+ /** Item metadata. */
5803
+ itemMetadata?: ItemMetadata;
5844
5804
  /**
5845
- * ID of the app providing the receipt
5846
- * @format GUID
5805
+ * Updated order.
5806
+ *
5807
+ * Returned when `returnFullEntity = true`.
5847
5808
  */
5848
- appId?: string | null;
5809
+ item?: Order;
5810
+ }
5811
+ interface ItemMetadata {
5812
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5813
+ _id?: string | null;
5814
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5815
+ originalIndex?: number;
5816
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5817
+ success?: boolean;
5818
+ /** Details about the error in case of failure. */
5819
+ error?: ApplicationError;
5820
+ }
5821
+ interface ApplicationError {
5822
+ /** Error code. */
5823
+ code?: string;
5824
+ /** Description of the error. */
5825
+ description?: string;
5826
+ /** Data related to the error. */
5827
+ data?: Record<string, any> | null;
5828
+ }
5829
+ interface BulkActionMetadata {
5830
+ /** Number of items that were successfully processed. */
5831
+ totalSuccesses?: number;
5832
+ /** Number of items that couldn't be processed. */
5833
+ totalFailures?: number;
5834
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5835
+ undetailedFailures?: number;
5836
+ }
5837
+ interface GetRefundabilityStatusRequest {
5849
5838
  /**
5850
- * Display number of receipt
5839
+ * Order ID.
5851
5840
  * @minLength 1
5852
- * @maxLength 40
5841
+ * @maxLength 100
5853
5842
  */
5854
- displayNumber?: string | null;
5843
+ ecomOrderId: string;
5855
5844
  }
5856
- interface CashRoundingDetails {
5857
- /**
5858
- * Payment amount before cash rounding was applied.
5859
- * When provided, balance and status calculations use this value instead of `amount`
5860
- * to prevent false overpayment or underpayment due to rounding.
5861
- */
5862
- unroundedAmount?: Price;
5845
+ interface GetRefundabilityStatusResponse {
5863
5846
  /**
5864
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5865
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5866
- * @readonly
5847
+ * Refundability details.
5848
+ * @maxSize 300
5867
5849
  */
5868
- roundingAdjustment?: CashRounding;
5869
- }
5870
- declare enum PaymentStatus {
5871
- /** Payment was charged successfully. */
5872
- APPROVED = "APPROVED",
5873
- /** Payment is being processed and hasn't been confirmed yet. */
5874
- PENDING = "PENDING",
5875
- /** 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. */
5876
- PENDING_MERCHANT = "PENDING_MERCHANT",
5877
- /** Payment was canceled before it was charged. */
5878
- CANCELED = "CANCELED",
5879
- /** Payment was declined by the payment provider. */
5880
- DECLINED = "DECLINED",
5881
- /** Payment was fully refunded. */
5882
- REFUNDED = "REFUNDED",
5883
- /** Part of the payment amount was refunded. */
5884
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5885
- /** 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. */
5886
- AUTHORIZED = "AUTHORIZED",
5850
+ refundabilities?: Refundability[];
5887
5851
  /**
5888
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5889
- *
5890
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5852
+ * Whether the order supports refunding per item.
5853
+ * @deprecated
5891
5854
  */
5892
- VOIDED = "VOIDED"
5893
- }
5894
- /** @enumType */
5895
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5896
- interface CanceledStatusDetails {
5897
- reason?: CanceledReasonWithLiterals;
5855
+ refundablePerItem?: boolean;
5898
5856
  }
5899
- declare enum CanceledReason {
5900
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5901
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5902
- /** Payment was not completed by user and expired. */
5903
- EXPIRED = "EXPIRED"
5857
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5858
+ /** Reason why payment is not refundable. */
5859
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5860
+ /** Reason why payment is only refundable manually. */
5861
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5862
+ /** Payment ID. */
5863
+ paymentId?: string;
5864
+ /** Payment refundability status. */
5865
+ refundabilityStatus?: RefundableStatusWithLiterals;
5866
+ /** Link to payment provider dashboard. */
5867
+ providerLink?: string | null;
5904
5868
  }
5905
- /** @enumType */
5906
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5907
- interface DeclinedStatusDetails {
5908
- reason?: DeclinedReasonWithLiterals;
5869
+ /** @oneof */
5870
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5871
+ /** Reason why payment is not refundable. */
5872
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5873
+ /** Reason why payment is only refundable manually. */
5874
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5909
5875
  }
5910
- declare enum DeclinedReason {
5911
- /** Corresponding charge failed. */
5912
- CHARGE_FAILED = "CHARGE_FAILED",
5913
- /** Payment details expired. */
5914
- EXPIRED = "EXPIRED",
5915
- /** Insufficient funds. */
5916
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5917
- /** Gift card was disabled before charge was attempted. */
5918
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5876
+ declare enum RefundableStatus {
5877
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5878
+ MANUAL = "MANUAL",
5879
+ REFUNDABLE = "REFUNDABLE"
5919
5880
  }
5920
5881
  /** @enumType */
5921
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5922
- interface VoidedStatusDetails {
5923
- reason?: VoidedReasonWithLiterals;
5882
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5883
+ declare enum NonRefundableReason {
5884
+ NONE = "NONE",
5885
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5886
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5887
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5888
+ NOT_PAID = "NOT_PAID",
5889
+ ACCESS_DENIED = "ACCESS_DENIED",
5890
+ ZERO_PRICE = "ZERO_PRICE",
5891
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5892
+ PENDING_REFUND = "PENDING_REFUND",
5893
+ FORBIDDEN = "FORBIDDEN",
5894
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5895
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5896
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5924
5897
  }
5925
- declare enum VoidedReason {
5926
- /** Payment was voided by merchant request. */
5927
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5928
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5929
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5898
+ /** @enumType */
5899
+ 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';
5900
+ declare enum ManuallyRefundableReason {
5901
+ EXPIRED = "EXPIRED",
5902
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5903
+ OFFLINE = "OFFLINE",
5904
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5930
5905
  }
5931
5906
  /** @enumType */
5932
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5933
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5934
- /** @internal */
5935
- canceled?: CanceledStatusDetails;
5936
- /** @internal */
5937
- declined?: DeclinedStatusDetails;
5938
- /** @internal */
5939
- voided?: VoidedStatusDetails;
5907
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5908
+ interface CreatePaymentGatewayOrderRequest {
5940
5909
  /**
5941
- * Reason code from the payment gateway.
5942
- * @internal
5910
+ * Ecom order ID.
5943
5911
  * @minLength 1
5944
- * @maxLength 10
5912
+ * @maxLength 100
5945
5913
  */
5946
- paymentGatewayReasonCode?: string | null;
5947
- }
5948
- /** @oneof */
5949
- interface PaymentStatusDetailsStatusDetailsOneOf {
5950
- /** @internal */
5951
- canceled?: CanceledStatusDetails;
5952
- /** @internal */
5953
- declined?: DeclinedStatusDetails;
5954
- /** @internal */
5955
- voided?: VoidedStatusDetails;
5914
+ ecomOrderId: string;
5915
+ /** Information about the user who initiated the payment. */
5916
+ chargedBy?: ChargedBy;
5917
+ /**
5918
+ * Whether to delay capture of the payment.
5919
+ *
5920
+ * Default: false
5921
+ * @internal
5922
+ */
5923
+ delayedCapture?: boolean;
5956
5924
  }
5957
- interface Refund {
5925
+ interface ChargedBy {
5958
5926
  /**
5959
- * Refund ID.
5927
+ * ID - id of the user who initiated the payment
5960
5928
  * @format GUID
5961
- * @readonly
5962
5929
  */
5963
5930
  _id?: string;
5964
5931
  /**
5965
- * List of transactions.
5966
- * @maxSize 50
5932
+ * Full name - name of the user who initiated the payment
5933
+ * @minLength 1
5934
+ * @maxLength 200
5967
5935
  */
5968
- transactions?: RefundTransaction[];
5969
- /** Refund business details. */
5970
- details?: RefundDetails;
5936
+ fullName?: string | null;
5937
+ }
5938
+ interface CreatePaymentGatewayOrderResponse {
5939
+ /** ID of the order created in the payment gateway */
5940
+ paymentGatewayOrderId?: string;
5941
+ }
5942
+ interface ChargeMembershipsRequest {
5971
5943
  /**
5972
- * 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.
5973
- * @readonly
5974
- * @immutable
5944
+ * Order ID.
5945
+ * @minLength 1
5946
+ * @maxLength 100
5975
5947
  */
5976
- _createdDate?: Date | null;
5948
+ ecomOrderId: string;
5977
5949
  /**
5978
- * Aggregated refund summary.
5979
- * @readonly
5950
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5951
+ * but a user which is using the membership on behalf of the a member
5952
+ * @format GUID
5980
5953
  */
5981
- summary?: AggregatedRefundSummary;
5954
+ memberId: string;
5982
5955
  /**
5983
- * ID of the app that initiated this refund.
5984
- * @format GUID
5985
- * @readonly
5986
- * @immutable
5956
+ * List of items to be paid by memberships
5957
+ * @minSize 1
5958
+ * @maxSize 300
5987
5959
  */
5988
- requestingServiceAppId?: string | null;
5960
+ membershipCharges?: MembershipChargeItem[];
5989
5961
  }
5990
- interface RefundTransaction {
5962
+ interface MembershipChargeItem {
5991
5963
  /**
5992
- * ID of the payment associated with this refund.
5964
+ * The id of used membership
5965
+ * @minLength 1
5966
+ * @maxLength 100
5967
+ */
5968
+ membershipId?: string;
5969
+ /**
5970
+ * ID of the application providing this payment option
5993
5971
  * @format GUID
5994
- * @immutable
5995
5972
  */
5996
- paymentId?: string;
5973
+ appId?: string;
5974
+ /** The name of used membership */
5975
+ membershipName?: MembershipName;
5976
+ /** Additional data about this membership */
5977
+ membershipAdditionalData?: Record<string, any> | null;
5978
+ /** Catalog and item reference info. */
5979
+ catalogReference?: CatalogReference;
5980
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5981
+ serviceProperties?: ServiceProperties;
5997
5982
  /**
5998
- * Refund amount.
5999
- * @immutable
5983
+ * Usually would be the same as catalogReference.catalogItemId
5984
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5985
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5986
+ * @minLength 1
5987
+ * @maxLength 36
6000
5988
  */
6001
- amount?: Price;
6002
- /** Refund status. */
6003
- refundStatus?: RefundStatusWithLiterals;
6004
- /** Optional details of current refund status. */
6005
- refundStatusInfo?: RefundStatusInfo;
5989
+ rootCatalogItemId?: string | null;
6006
5990
  /**
6007
- * Payment gateway's refund ID.
6008
- * This field is only returned when the value of `external_refund` is `false`.
6009
- * @format GUID
5991
+ * line item id of Checkout/Order line item
5992
+ * @minLength 1
5993
+ * @maxLength 100
6010
5994
  */
6011
- gatewayRefundId?: string | null;
6012
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6013
- providerRefundId?: string | null;
5995
+ lineItemId?: string;
5996
+ }
5997
+ interface MembershipName {
6014
5998
  /**
6015
- * Whether refund was made externally and manually on the payment provider's side.
6016
- * @immutable
5999
+ * Membership name in the site's original language.
6000
+ * @maxLength 100
6017
6001
  */
6018
- externalRefund?: boolean;
6002
+ original?: string;
6019
6003
  /**
6020
- * Location where the refund was processed.
6021
- * @internal
6022
- * @format GUID
6023
- * @immutable
6004
+ * Membership name translated into the buyer's language.
6005
+ *
6006
+ * Default: The value of `original`
6007
+ * @maxLength 100
6024
6008
  */
6025
- locationId?: string | null;
6009
+ translated?: string | null;
6026
6010
  }
6027
- /** Refund transaction status. */
6028
- declare enum RefundStatus {
6029
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6030
- PENDING = "PENDING",
6031
- /** Refund transaction succeeded. */
6032
- SUCCEEDED = "SUCCEEDED",
6033
- /** Refund transaction failed. */
6034
- FAILED = "FAILED",
6035
- /** Refund request acknowledged, and will be executed soon. */
6036
- SCHEDULED = "SCHEDULED",
6037
- /** Refund was initiated on payment provider side. */
6038
- STARTED = "STARTED"
6011
+ interface ChargeMembershipsResponse {
6039
6012
  }
6040
- /** @enumType */
6041
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6042
- interface RefundStatusInfo {
6013
+ interface TriggerRefundRequest {
6014
+ /**
6015
+ * The order this refund related to
6016
+ * @minLength 1
6017
+ * @maxLength 100
6018
+ */
6019
+ ecomOrderId: string;
6020
+ /**
6021
+ * Refund operations information
6022
+ * @minSize 1
6023
+ * @maxSize 1
6024
+ */
6025
+ payments: PaymentRefund[];
6026
+ /** Business model of a refund */
6027
+ details?: RefundDetails;
6028
+ /** Side effect details related to refund */
6029
+ sideEffects?: RefundSideEffects;
6030
+ }
6031
+ interface PaymentRefund {
6032
+ /**
6033
+ * Specific payment within the order to refund
6034
+ * @format GUID
6035
+ */
6036
+ paymentId?: string;
6037
+ /** Refund amount. Not relevant for membership and gift card refunds. */
6038
+ amount?: Price;
6043
6039
  /**
6044
- * Reason code for the refund's current status.
6045
- *
6046
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6040
+ * Whether refund is made externally and manually (on the payment provider's side)
6041
+ * 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.
6042
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
6043
+ */
6044
+ externalRefund?: boolean;
6045
+ /**
6046
+ * Gateway refund id. When param is present, new refund is not created.
6047
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
6048
+ * and all side effects from request will be executed.
6049
+ * @internal
6047
6050
  * @minLength 1
6048
- * @maxLength 10
6051
+ * @maxLength 100
6049
6052
  */
6050
- paymentGatewayReasonCode?: string | null;
6053
+ gatewayRefundId?: string | null;
6054
+ }
6055
+ interface RefundSideEffects {
6056
+ /** Inventory restock details as part of this refund. */
6057
+ restockInfo?: RestockInfo;
6058
+ /** Whether to send a refund confirmation email to the customer. */
6059
+ sendOrderRefundedEmail?: boolean;
6051
6060
  /**
6052
- * Free text explanation of current refund status.
6061
+ * Custom message added to the refund confirmation email.
6053
6062
  * @minLength 1
6054
6063
  * @maxLength 1000
6055
6064
  */
6056
- description?: string | null;
6057
- }
6058
- interface AggregatedRefundSummary {
6059
- /** Total amount requested for refund. */
6060
- requestedRefund?: Price;
6061
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6062
- pendingRefund?: Price;
6063
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6064
- refunded?: Price;
6065
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
6066
- failedRefundAmount?: Price;
6067
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
6068
- pending?: boolean;
6069
- /** Breakdown of refunded items. Available only after refund is complete. */
6070
- breakdown?: RefundItemsBreakdown;
6065
+ customMessage?: string | null;
6071
6066
  }
6072
- interface RefundItemsBreakdown {
6067
+ interface RestockInfo {
6068
+ /** Restock type. */
6069
+ type?: RestockTypeWithLiterals;
6073
6070
  /**
6074
- * Refunded line items and the amount refunded for each.
6071
+ * Deprecated, use items instead
6072
+ * @internal
6075
6073
  * @maxSize 300
6074
+ * @deprecated
6076
6075
  */
6077
- lineItems?: LineItemRefundSummary[];
6076
+ lineItemIds?: string[];
6077
+ /**
6078
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
6079
+ * @maxSize 300
6080
+ */
6081
+ items?: RestockItem[];
6078
6082
  }
6079
- interface LineItemRefundSummary {
6083
+ declare enum RestockType {
6084
+ NO_ITEMS = "NO_ITEMS",
6085
+ ALL_ITEMS = "ALL_ITEMS",
6086
+ SOME_ITEMS = "SOME_ITEMS"
6087
+ }
6088
+ /** @enumType */
6089
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
6090
+ interface RestockItem {
6080
6091
  /**
6081
- * ID of the refunded line item.
6092
+ * ID of the line item being restocked.
6082
6093
  * @format GUID
6083
6094
  */
6084
6095
  lineItemId?: string;
6085
- /** Total refunded amount for the line item. */
6086
- totalRefundedAmount?: Price;
6087
- }
6088
- interface CalculateRefundRequest {
6089
6096
  /**
6090
- * Order ID
6091
- * @minLength 1
6092
- * @maxLength 100
6097
+ * Line item quantity being restocked.
6098
+ * @min 1
6099
+ * @max 100000
6093
6100
  */
6094
- ecomOrderId?: string;
6101
+ quantity?: number;
6095
6102
  /**
6096
- * Refunded line items and quantity
6097
- * @maxSize 300
6103
+ * Per-location breakdown of restock quantities.
6104
+ * @internal
6105
+ * @maxSize 5
6098
6106
  */
6099
- refundItems?: CalculateRefundItemRequest[];
6100
- /** Should include shipping in refund calculation */
6101
- refundShipping?: boolean;
6107
+ restockLocations?: RestockLocation[];
6102
6108
  }
6103
- interface CalculateRefundItemRequest {
6109
+ interface TriggerRefundResponse {
6110
+ /** All order's transactions after the refunds were added */
6111
+ orderTransactions?: OrderTransactions;
6112
+ /** Created refund ID */
6113
+ refundId?: string | null;
6114
+ /** Payment ID's that the refund execution had failed for */
6115
+ failedPaymentIds?: ItemMetadata[];
6116
+ }
6117
+ /**
6118
+ * A record of all payments and refunds associated with an order.
6119
+ *
6120
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
6121
+ */
6122
+ interface OrderTransactions {
6104
6123
  /**
6105
- * ID of the line item being refunded
6124
+ * Order ID.
6106
6125
  * @format GUID
6107
6126
  */
6108
- _id?: string;
6127
+ orderId?: string;
6109
6128
  /**
6110
- * How much of that line item is being refunded
6111
- * @min 1
6112
- * @max 100000
6129
+ * Record of payments made to the merchant.
6130
+ * @maxSize 100
6113
6131
  */
6114
- quantity?: number;
6115
- }
6116
- interface CalculateRefundResponse {
6117
- /** Total refundable amount */
6118
- total?: Price;
6119
- /** Tax cost of the order */
6120
- tax?: Price;
6121
- /** Discount given for this order */
6122
- discount?: Price;
6123
- /** Total cost of the order (without tax) */
6124
- subtotal?: Price;
6125
- /** Total shipping cost for order */
6126
- shipping?: Price;
6127
- /** Previous refund given on that order */
6128
- previouslyRefundedAmount?: Price;
6132
+ payments?: Payment[];
6129
6133
  /**
6130
- * The refundable items of that order
6134
+ * Record of refunds made to the buyer.
6131
6135
  * @maxSize 300
6132
6136
  */
6133
- items?: CalculateRefundItemResponse[];
6137
+ refunds?: Refund[];
6134
6138
  }
6135
- interface CalculateRefundItemResponse {
6139
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
6140
+ /** Regular payment details. */
6141
+ regularPaymentDetails?: RegularPaymentDetails;
6142
+ /** Gift card payment details. */
6143
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6144
+ /** Membership payment details. */
6145
+ membershipPaymentDetails?: MembershipPaymentDetails;
6136
6146
  /**
6137
- * Line item ID
6147
+ * Receipt created by Wix
6148
+ * @internal
6149
+ */
6150
+ wixReceipt?: WixReceiptInfo;
6151
+ /**
6152
+ * Receipt created by an external system.
6153
+ * @internal
6154
+ */
6155
+ externalReceipt?: ExternalReceiptInfo;
6156
+ /** @internal */
6157
+ canceled?: CanceledStatusDetails;
6158
+ /** @internal */
6159
+ declined?: DeclinedStatusDetails;
6160
+ /** @internal */
6161
+ voided?: VoidedStatusDetails;
6162
+ /**
6163
+ * Payment ID.
6138
6164
  * @format GUID
6165
+ * @readonly
6139
6166
  */
6140
- _id?: string;
6141
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6142
- price?: Price;
6143
- }
6144
- interface VoidAuthorizedPaymentsRequest {
6167
+ _id?: string | null;
6168
+ /** 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. */
6169
+ _createdDate?: Date | null;
6145
6170
  /**
6146
- * Wix eCommerce order ID
6147
- * @minLength 1
6148
- * @maxLength 100
6171
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6172
+ * @readonly
6149
6173
  */
6150
- ecomOrderId: string;
6174
+ _updatedDate?: Date | null;
6175
+ /** Payment amount. */
6176
+ amount?: Price;
6151
6177
  /**
6152
- * Payment IDs
6153
- * @minSize 1
6154
- * @maxSize 100
6178
+ * Whether refunds for this payment are disabled.
6179
+ * + `true`: This payment is not refundable.
6180
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
6181
+ */
6182
+ refundDisabled?: boolean;
6183
+ /**
6184
+ * Whether receipt generation is allowed for this payment.
6185
+ * + `true`: This payment supports receipt generation.
6186
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6187
+ * @readonly
6188
+ */
6189
+ supportReceiptGeneration?: boolean;
6190
+ /** Details about cash rounding applied to this payment, when relevant. */
6191
+ cashRounding?: CashRoundingDetails;
6192
+ /**
6193
+ * Overall payment status.
6194
+ *
6195
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6196
+ */
6197
+ status?: PaymentStatusWithLiterals;
6198
+ /**
6199
+ * Detailed payment status information including gateway reason codes and status-specific details.
6200
+ * @internal
6201
+ */
6202
+ paymentStatusDetails?: PaymentStatusDetails;
6203
+ /**
6204
+ * Location where the payment was processed.
6205
+ * @internal
6155
6206
  * @format GUID
6207
+ * @immutable
6156
6208
  */
6157
- paymentIds: string[];
6209
+ locationId?: string | null;
6210
+ /**
6211
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6212
+ * @format GUID
6213
+ */
6214
+ chargeCorrelationId?: string | null;
6158
6215
  }
6159
- interface VoidAuthorizedPaymentsResponse {
6160
- /** All order's transactions after the void was triggered */
6161
- orderTransactions?: OrderTransactions;
6216
+ /** @oneof */
6217
+ interface PaymentPaymentDetailsOneOf {
6218
+ /** Regular payment details. */
6219
+ regularPaymentDetails?: RegularPaymentDetails;
6220
+ /** Gift card payment details. */
6221
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6222
+ /** Membership payment details. */
6223
+ membershipPaymentDetails?: MembershipPaymentDetails;
6162
6224
  }
6163
- interface CaptureAuthorizedPaymentsRequest {
6225
+ /** @oneof */
6226
+ interface PaymentReceiptInfoOneOf {
6164
6227
  /**
6165
- * Wix eCommerce order ID
6166
- * @minLength 1
6167
- * @maxLength 100
6228
+ * Receipt created by Wix
6229
+ * @internal
6168
6230
  */
6169
- ecomOrderId: string;
6231
+ wixReceipt?: WixReceiptInfo;
6232
+ /**
6233
+ * Receipt created by an external system.
6234
+ * @internal
6235
+ */
6236
+ externalReceipt?: ExternalReceiptInfo;
6237
+ }
6238
+ /** @oneof */
6239
+ interface PaymentStatusDetailsOneOf {
6240
+ /** @internal */
6241
+ canceled?: CanceledStatusDetails;
6242
+ /** @internal */
6243
+ declined?: DeclinedStatusDetails;
6244
+ /** @internal */
6245
+ voided?: VoidedStatusDetails;
6246
+ }
6247
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6248
+ /** Credit card details. */
6249
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6170
6250
  /**
6171
- * Capture payments information
6172
- * @minSize 1
6173
- * @maxSize 100
6251
+ * Wix Payments order ID.
6252
+ * @maxLength 100
6174
6253
  */
6175
- payments: PaymentCapture[];
6176
- }
6177
- interface PaymentCapture {
6254
+ paymentOrderId?: string | null;
6178
6255
  /**
6179
- * Payment ID
6180
- * @format GUID
6256
+ * Payment gateway's transaction ID.
6257
+ * This field is only returned when the value of `offline_payment` is `false`.
6258
+ * @maxLength 100
6181
6259
  */
6182
- paymentId?: string | null;
6260
+ gatewayTransactionId?: string | null;
6183
6261
  /**
6184
- * Capture amount.
6185
- * If not provided - full authorized amount will be captured.
6262
+ * Payment method.
6263
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6264
+ * Non-exhaustive list of supported values:
6265
+ * + `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`
6266
+ * @maxLength 150
6267
+ * @deprecated Payment method.
6268
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6269
+ * Non-exhaustive list of supported values:
6270
+ * + `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`
6271
+ * @replacedBy payment_method_name
6272
+ * @targetRemovalDate 2026-07-01
6186
6273
  */
6187
- amount?: Price;
6188
- }
6189
- interface CaptureAuthorizedPaymentsResponse {
6190
- /** All order's transactions after the capture was triggered */
6191
- orderTransactions?: OrderTransactions;
6192
- }
6193
- interface ChargeSavedPaymentMethodRequest {
6274
+ paymentMethod?: string | null;
6194
6275
  /**
6195
- * Ecom Order ID.
6196
- * @minLength 1
6276
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6197
6277
  * @maxLength 100
6198
6278
  */
6199
- ecomOrderId?: string;
6200
- /** Amount to be charged */
6201
- amount?: Price;
6202
- }
6203
- interface ChargeSavedPaymentMethodResponse {
6204
- /** Payment gateway's order ID (e.g Wix Payments) */
6205
- paymentGatewayOrderId?: string;
6206
- }
6207
- interface SendBuyerConfirmationEmailRequest {
6208
- /** @format GUID */
6209
- orderId?: string;
6210
- }
6211
- interface SendBuyerConfirmationEmailResponse {
6212
- }
6213
- interface SendBuyerPaymentsReceivedEmailRequest {
6279
+ providerTransactionId?: string | null;
6280
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6281
+ offlinePayment?: boolean;
6214
6282
  /**
6215
- * @minLength 1
6216
- * @maxLength 100
6283
+ * Payment status.
6284
+ * @deprecated Payment status.
6285
+ * @replacedBy payment.status
6286
+ * @targetRemovalDate 2026-11-01
6217
6287
  */
6218
- orderId?: string;
6219
- }
6220
- interface SendBuyerPaymentsReceivedEmailResponse {
6221
- }
6222
- interface SendBuyerPickupConfirmationEmailRequest {
6288
+ status?: TransactionStatusWithLiterals;
6289
+ /** Whether there is a payment agreement that allows for future charges. */
6290
+ savedPaymentMethod?: boolean;
6291
+ /** Authorization details. */
6292
+ authorizationDetails?: AuthorizationDetails;
6223
6293
  /**
6224
- * @minLength 1
6225
- * @maxLength 100
6294
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6295
+ * @internal
6296
+ * @maxLength 300
6226
6297
  */
6227
- orderId?: string;
6228
- }
6229
- interface SendBuyerPickupConfirmationEmailResponse {
6230
- }
6231
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
6298
+ paymentProvider?: string | null;
6232
6299
  /**
6233
- * IDs of orders to send pickup emails for.
6234
- * @minSize 1
6235
- * @maxSize 300
6300
+ * Record of chargebacks made by the buyer.
6301
+ * @maxSize 6
6236
6302
  */
6237
- orderIds?: string[];
6238
- }
6239
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
6240
- }
6241
- interface SendBuyerShippingConfirmationEmailRequest {
6303
+ chargebacks?: Chargeback[];
6242
6304
  /**
6243
- * @minLength 1
6244
- * @maxLength 100
6305
+ * Payment method ID.
6306
+ * @internal
6307
+ * @maxLength 36
6245
6308
  */
6246
- orderId?: string;
6247
- }
6248
- interface SendBuyerShippingConfirmationEmailResponse {
6249
- }
6250
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
6309
+ paymentMethodId?: string | null;
6310
+ /** Platform fee amount associated with this payment. */
6311
+ platformFee?: Price;
6251
6312
  /**
6252
- * IDs of orders to send pickup emails for.
6253
- * @minSize 1
6254
- * @maxSize 300
6313
+ * Payment method with buyer and optional owner translations.
6314
+ * Non-exhaustive list of supported values:
6315
+ * + `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`
6255
6316
  */
6256
- orderIds?: string[];
6317
+ paymentMethodName?: PaymentMethodName;
6257
6318
  }
6258
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
6319
+ /** @oneof */
6320
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6321
+ /** Credit card details. */
6322
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6259
6323
  }
6260
- interface SendMerchantOrderReceivedNotificationRequest {
6324
+ declare enum TransactionStatus {
6325
+ UNDEFINED = "UNDEFINED",
6326
+ APPROVED = "APPROVED",
6327
+ PENDING = "PENDING",
6328
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6329
+ CANCELED = "CANCELED",
6330
+ DECLINED = "DECLINED",
6331
+ REFUNDED = "REFUNDED",
6332
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6333
+ AUTHORIZED = "AUTHORIZED",
6334
+ VOIDED = "VOIDED"
6335
+ }
6336
+ /** @enumType */
6337
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6338
+ interface CreditCardPaymentMethodDetails {
6261
6339
  /**
6262
- * @minLength 1
6263
- * @maxLength 100
6340
+ * The last 4 digits of the card number.
6341
+ * @maxLength 4
6264
6342
  */
6265
- orderId?: string;
6266
- }
6267
- interface SendMerchantOrderReceivedNotificationResponse {
6268
- }
6269
- interface SendCancelRefundEmailRequest {
6343
+ lastFourDigits?: string | null;
6270
6344
  /**
6271
- * The ID of order that is canceled/refunded
6272
- * @minLength 1
6345
+ * Card issuer's brand.
6273
6346
  * @maxLength 100
6274
6347
  */
6275
- orderId?: string;
6348
+ brand?: string | null;
6349
+ }
6350
+ interface AuthorizationDetails {
6276
6351
  /**
6277
- * Personal note added to the email (optional)
6278
- * @minLength 1
6279
- * @maxLength 1000
6352
+ * Whether the authorized payment is of a delayed capture.
6353
+ * @readonly
6280
6354
  */
6281
- customMessage?: string | null;
6282
- /** Refund amount */
6283
- refundAmount?: Price;
6355
+ delayedCapture?: boolean;
6356
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6357
+ authorizedDate?: Date | null;
6284
6358
  /**
6285
- * Refund ID. (Optional)
6286
- * @format GUID
6359
+ * List of captures associated with payment
6360
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6361
+ * @maxSize 1
6287
6362
  */
6288
- refundId?: string | null;
6289
- }
6290
- interface SendCancelRefundEmailResponse {
6363
+ captures?: AuthorizationCapture[];
6364
+ /** Void associated with payment */
6365
+ void?: AuthorizationVoid;
6366
+ /** Scheduled action for this transaction */
6367
+ scheduledAction?: V1ScheduledAction;
6291
6368
  }
6292
- interface SendRefundEmailRequest {
6293
- /**
6294
- * The ID of order that is refunded
6295
- * @format GUID
6296
- */
6297
- orderId?: string;
6369
+ interface AuthorizationCapture {
6298
6370
  /**
6299
- * Refund ID
6371
+ * Capture ID.
6300
6372
  * @format GUID
6373
+ * @readonly
6301
6374
  */
6302
- refundId?: string;
6375
+ _id?: string | null;
6376
+ /** Status of this capture action */
6377
+ status?: AuthorizationCaptureStatusWithLiterals;
6303
6378
  /**
6304
- * Personal note added to the email (optional)
6305
- * @minLength 1
6306
- * @maxLength 1000
6379
+ * Amount of this capture
6380
+ * @immutable
6307
6381
  */
6308
- customMessage?: string | null;
6382
+ amount?: Price;
6383
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6384
+ _createdDate?: Date | null;
6385
+ /** In case of status is FAILED may contain failure details */
6386
+ failureDetails?: AuthorizationActionFailureDetails;
6309
6387
  }
6310
- interface SendRefundEmailResponse {
6388
+ declare enum AuthorizationCaptureStatus {
6389
+ /** Capture operation still in progress. */
6390
+ PENDING = "PENDING",
6391
+ /** Capture operation succeeded. */
6392
+ SUCCEEDED = "SUCCEEDED",
6393
+ /** Capture operation failed. */
6394
+ FAILED = "FAILED"
6311
6395
  }
6312
- interface SendFulfillmentEmailRequest {
6313
- /** @format GUID */
6314
- orderId?: string;
6315
- /** @format GUID */
6316
- fulfillerId?: string;
6396
+ /** @enumType */
6397
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6398
+ interface AuthorizationActionFailureDetails {
6399
+ /** @maxLength 100 */
6400
+ failureCode?: string;
6317
6401
  }
6318
- interface SendFulfillmentEmailResponse {
6402
+ interface AuthorizationVoid {
6403
+ /** Status of this void action */
6404
+ status?: AuthorizationVoidStatusWithLiterals;
6405
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6406
+ voidedDate?: Date | null;
6407
+ /** In case of status is FAILED may contain failure details */
6408
+ failureDetails?: AuthorizationActionFailureDetails;
6409
+ /** Reason of void action */
6410
+ reason?: ReasonWithLiterals;
6319
6411
  }
6320
- interface SendMerchantOrderReceivedPushRequest {
6321
- /**
6322
- * @minLength 1
6323
- * @maxLength 100
6324
- */
6325
- orderId?: string;
6412
+ declare enum AuthorizationVoidStatus {
6413
+ /** Void operation still in progress. */
6414
+ PENDING = "PENDING",
6415
+ /** Void operation succeeded. */
6416
+ SUCCEEDED = "SUCCEEDED",
6417
+ /** Void operation failed. */
6418
+ FAILED = "FAILED"
6326
6419
  }
6327
- interface SendMerchantOrderReceivedPushResponse {
6420
+ /** @enumType */
6421
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6422
+ /** Reason the authorization was voided. */
6423
+ declare enum Reason {
6424
+ /** Authorization was voided by user. */
6425
+ MANUAL = "MANUAL",
6426
+ /** Authorization passed execution date. */
6427
+ SCHEDULED = "SCHEDULED"
6328
6428
  }
6329
- interface PreviewEmailByTypeRequest {
6330
- emailType?: PreviewEmailTypeWithLiterals;
6429
+ /** @enumType */
6430
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6431
+ interface V1ScheduledAction {
6432
+ /** Type of the action. */
6433
+ actionType?: ActionTypeWithLiterals;
6434
+ /** The date and time of the action. */
6435
+ executionDate?: Date | null;
6331
6436
  }
6332
- declare enum PreviewEmailType {
6333
- ORDER_PLACED = "ORDER_PLACED",
6334
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6335
- ORDER_SHIPPED = "ORDER_SHIPPED",
6336
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6437
+ declare enum ActionType {
6438
+ VOID = "VOID",
6439
+ CAPTURE = "CAPTURE"
6337
6440
  }
6338
6441
  /** @enumType */
6339
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6340
- interface PreviewEmailByTypeResponse {
6341
- emailPreview?: string;
6342
- }
6343
- interface PreviewRefundEmailRequest {
6344
- /**
6345
- * @minLength 1
6346
- * @maxLength 100
6347
- */
6348
- orderId?: string;
6349
- /** Refund amount */
6350
- refundAmount?: Price;
6351
- /** Refund business details */
6352
- details?: RefundDetails;
6442
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6443
+ interface Chargeback {
6353
6444
  /**
6354
- * Personal note added to the email (optional)
6355
- * @minLength 1
6356
- * @maxLength 1000
6445
+ * Chargeback ID.
6446
+ * @format GUID
6447
+ * @readonly
6448
+ * @immutable
6357
6449
  */
6358
- customMessage?: string | null;
6450
+ _id?: string;
6359
6451
  /**
6360
- * Refund ID. (Optional)
6361
- * @format GUID
6452
+ * 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.
6453
+ * @readonly
6454
+ * @immutable
6362
6455
  */
6363
- refundId?: string | null;
6364
- }
6365
- interface PreviewRefundEmailResponse {
6366
- emailPreview?: string;
6367
- }
6368
- interface PreviewCancelEmailRequest {
6456
+ _createdDate?: Date | null;
6369
6457
  /**
6370
- * @minLength 1
6371
- * @maxLength 100
6458
+ * 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.
6459
+ * @readonly
6372
6460
  */
6373
- orderId?: string;
6461
+ _updatedDate?: Date | null;
6374
6462
  /**
6375
- * Personal note added to the email (optional)
6376
- * @minLength 1
6377
- * @maxLength 1000
6463
+ * Amount.
6464
+ * @readonly
6465
+ * @immutable
6378
6466
  */
6379
- customMessage?: string | null;
6380
- }
6381
- interface PreviewCancelEmailResponse {
6382
- emailPreview?: string;
6383
- }
6384
- interface PreviewCancelRefundEmailRequest {
6467
+ amount?: Price;
6385
6468
  /**
6386
- * @minLength 1
6387
- * @maxLength 100
6469
+ * Reversal amount. Present only when status is REVERSED.
6470
+ * @readonly
6388
6471
  */
6389
- orderId?: string;
6472
+ reversalAmount?: Price;
6390
6473
  /**
6391
- * Personal note added to the email (optional)
6392
- * @minLength 1
6393
- * @maxLength 1000
6474
+ * Status.
6475
+ *
6476
+ * Default: `"APPROVED"`.
6394
6477
  */
6395
- customMessage?: string | null;
6396
- /** Refund amount */
6397
- refundAmount?: Price;
6478
+ status?: ChargebackStatusWithLiterals;
6398
6479
  /**
6399
- * Refund ID. (Optional)
6480
+ * External chargeback ID.
6400
6481
  * @format GUID
6482
+ * @readonly
6483
+ * @immutable
6401
6484
  */
6402
- refundId?: string | null;
6403
- }
6404
- interface PreviewCancelRefundEmailResponse {
6405
- emailPreview?: string;
6406
- }
6407
- interface PreviewBuyerPaymentsReceivedEmailRequest {
6408
- }
6409
- interface PreviewBuyerPaymentsReceivedEmailResponse {
6410
- emailPreview?: string;
6411
- }
6412
- interface PreviewBuyerConfirmationEmailRequest {
6413
- }
6414
- interface PreviewBuyerConfirmationEmailResponse {
6415
- emailPreview?: string;
6416
- }
6417
- interface PreviewBuyerPickupConfirmationEmailRequest {
6418
- }
6419
- interface PreviewBuyerPickupConfirmationEmailResponse {
6420
- emailPreview?: string;
6421
- }
6422
- interface PreviewShippingConfirmationEmailRequest {
6423
- }
6424
- interface PreviewShippingConfirmationEmailResponse {
6425
- emailPreview?: string;
6426
- }
6427
- interface PreviewResendDownloadLinksEmailRequest {
6485
+ externalId?: string | null;
6428
6486
  }
6429
- interface PreviewResendDownloadLinksEmailResponse {
6430
- emailPreview?: string;
6487
+ declare enum ChargebackStatus {
6488
+ /** Chargeback was approved. */
6489
+ APPROVED = "APPROVED",
6490
+ /** Chargeback was reversed. */
6491
+ REVERSED = "REVERSED"
6431
6492
  }
6432
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6433
- /** Emitted on a meta site creation. */
6434
- siteCreated?: SiteCreated;
6435
- /** Emitted on a meta site transfer completion. */
6436
- siteTransferred?: SiteTransferred;
6437
- /** Emitted on a meta site deletion. */
6438
- siteDeleted?: SiteDeleted;
6439
- /** Emitted on a meta site restoration. */
6440
- siteUndeleted?: SiteUndeleted;
6441
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6442
- sitePublished?: SitePublished;
6443
- /** Emitted on a meta site unpublish. */
6444
- siteUnpublished?: SiteUnpublished;
6445
- /** Emitted when meta site is marked as template. */
6446
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6447
- /** Emitted when meta site is marked as a WixSite. */
6448
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6449
- /** Emitted when an application is provisioned (installed). */
6450
- serviceProvisioned?: ServiceProvisioned;
6451
- /** Emitted when an application is removed (uninstalled). */
6452
- serviceRemoved?: ServiceRemoved;
6453
- /** Emitted when meta site name (URL slug) is changed. */
6454
- siteRenamedPayload?: SiteRenamed;
6455
- /** Emitted when meta site was permanently deleted. */
6456
- hardDeleted?: SiteHardDeleted;
6457
- /** Emitted on a namespace change. */
6458
- namespaceChanged?: NamespaceChanged;
6459
- /** Emitted when Studio is attached. */
6460
- studioAssigned?: StudioAssigned;
6461
- /** Emitted when Studio is detached. */
6462
- studioUnassigned?: StudioUnassigned;
6493
+ /** @enumType */
6494
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6495
+ interface PaymentMethodName {
6463
6496
  /**
6464
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6465
- * the actual URL.
6466
- *
6467
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6468
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6497
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6498
+ * @maxLength 150
6469
6499
  */
6470
- urlChanged?: SiteUrlChanged;
6471
- /** Site is marked as PurgedExternally */
6472
- sitePurgedExternally?: SitePurgedExternally;
6473
- /** Emitted when Odeditor is attached. */
6474
- odeditorAssigned?: OdeditorAssigned;
6475
- /** Emitted when Odeditor is detached. */
6476
- odeditorUnassigned?: OdeditorUnassigned;
6477
- /** Emitted when Picasso is attached. */
6478
- picassoAssigned?: PicassoAssigned;
6479
- /** Emitted when Picasso is detached. */
6480
- picassoUnassigned?: PicassoUnassigned;
6481
- /** Emitted when Wixel is attached. */
6482
- wixelAssigned?: WixelAssigned;
6483
- /** Emitted when Wixel is detached. */
6484
- wixelUnassigned?: WixelUnassigned;
6485
- /** Emitted when StudioTwo is attached. */
6486
- studioTwoAssigned?: StudioTwoAssigned;
6487
- /** Emitted when StudioTwo is detached. */
6488
- studioTwoUnassigned?: StudioTwoUnassigned;
6489
- /** Emitted when media from user domain is enabled. */
6490
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6491
- /** Emitted when media from user domain is disabled. */
6492
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6493
- /** Emitted when Editorless is attached. */
6494
- editorlessAssigned?: EditorlessAssigned;
6495
- /** Emitted when Editorless is detached. */
6496
- editorlessUnassigned?: EditorlessUnassigned;
6500
+ buyerLanguageName?: string | null;
6497
6501
  /**
6498
- * A meta site id.
6499
- * @format GUID
6502
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6503
+ *
6504
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6505
+ * @maxLength 150
6500
6506
  */
6501
- metaSiteId?: string;
6502
- /** A meta site version. Monotonically increasing. */
6503
- version?: string;
6504
- /** A timestamp of the event. */
6505
- timestamp?: string;
6507
+ siteLanguageName?: string | null;
6506
6508
  /**
6507
- * TODO(meta-site): Change validation once validations are disabled for consumers
6508
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6509
- * @maxSize 4000
6509
+ * User-provided payment method name.
6510
+ *
6511
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6510
6512
  */
6511
- assets?: Asset[];
6513
+ userDefinedName?: UserDefinedPaymentMethodName;
6512
6514
  }
6513
- /** @oneof */
6514
- interface MetaSiteSpecialEventPayloadOneOf {
6515
- /** Emitted on a meta site creation. */
6516
- siteCreated?: SiteCreated;
6517
- /** Emitted on a meta site transfer completion. */
6518
- siteTransferred?: SiteTransferred;
6519
- /** Emitted on a meta site deletion. */
6520
- siteDeleted?: SiteDeleted;
6521
- /** Emitted on a meta site restoration. */
6522
- siteUndeleted?: SiteUndeleted;
6523
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6524
- sitePublished?: SitePublished;
6525
- /** Emitted on a meta site unpublish. */
6526
- siteUnpublished?: SiteUnpublished;
6527
- /** Emitted when meta site is marked as template. */
6528
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6529
- /** Emitted when meta site is marked as a WixSite. */
6530
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6531
- /** Emitted when an application is provisioned (installed). */
6532
- serviceProvisioned?: ServiceProvisioned;
6533
- /** Emitted when an application is removed (uninstalled). */
6534
- serviceRemoved?: ServiceRemoved;
6535
- /** Emitted when meta site name (URL slug) is changed. */
6536
- siteRenamedPayload?: SiteRenamed;
6537
- /** Emitted when meta site was permanently deleted. */
6538
- hardDeleted?: SiteHardDeleted;
6539
- /** Emitted on a namespace change. */
6540
- namespaceChanged?: NamespaceChanged;
6541
- /** Emitted when Studio is attached. */
6542
- studioAssigned?: StudioAssigned;
6543
- /** Emitted when Studio is detached. */
6544
- studioUnassigned?: StudioUnassigned;
6515
+ interface GiftCardPaymentDetails {
6516
+ /**
6517
+ * Gift card payment ID.
6518
+ * @maxLength 100
6519
+ */
6520
+ giftCardPaymentId?: string;
6521
+ /**
6522
+ * Gift card ID.
6523
+ * @internal
6524
+ * @deprecated
6525
+ */
6526
+ giftCardId?: string;
6545
6527
  /**
6546
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6547
- * the actual URL.
6548
- *
6549
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6550
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6528
+ * ID of the app that created the gift card.
6529
+ * @format GUID
6551
6530
  */
6552
- urlChanged?: SiteUrlChanged;
6553
- /** Site is marked as PurgedExternally */
6554
- sitePurgedExternally?: SitePurgedExternally;
6555
- /** Emitted when Odeditor is attached. */
6556
- odeditorAssigned?: OdeditorAssigned;
6557
- /** Emitted when Odeditor is detached. */
6558
- odeditorUnassigned?: OdeditorUnassigned;
6559
- /** Emitted when Picasso is attached. */
6560
- picassoAssigned?: PicassoAssigned;
6561
- /** Emitted when Picasso is detached. */
6562
- picassoUnassigned?: PicassoUnassigned;
6563
- /** Emitted when Wixel is attached. */
6564
- wixelAssigned?: WixelAssigned;
6565
- /** Emitted when Wixel is detached. */
6566
- wixelUnassigned?: WixelUnassigned;
6567
- /** Emitted when StudioTwo is attached. */
6568
- studioTwoAssigned?: StudioTwoAssigned;
6569
- /** Emitted when StudioTwo is detached. */
6570
- studioTwoUnassigned?: StudioTwoUnassigned;
6571
- /** Emitted when media from user domain is enabled. */
6572
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6573
- /** Emitted when media from user domain is disabled. */
6574
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6575
- /** Emitted when Editorless is attached. */
6576
- editorlessAssigned?: EditorlessAssigned;
6577
- /** Emitted when Editorless is detached. */
6578
- editorlessUnassigned?: EditorlessUnassigned;
6579
- }
6580
- interface Asset {
6531
+ appId?: string;
6581
6532
  /**
6582
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6583
- * @maxLength 36
6533
+ * Whether the gift card is voided.
6534
+ * @readonly
6535
+ * @deprecated Whether the gift card is voided.
6536
+ * @replacedBy payment.status
6537
+ * @targetRemovalDate 2026-11-01
6584
6538
  */
6585
- appDefId?: string;
6539
+ voided?: boolean;
6586
6540
  /**
6587
- * An instance id. For legacy reasons may be UUID or a string.
6541
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6542
+ * @maxLength 30
6543
+ * @immutable
6544
+ */
6545
+ obfuscatedCode?: string | null;
6546
+ }
6547
+ interface MembershipPaymentDetails {
6548
+ /**
6549
+ * Membership ID.
6588
6550
  * @maxLength 200
6589
6551
  */
6590
- instanceId?: string;
6591
- /** An application state. */
6592
- state?: StateWithLiterals;
6552
+ membershipId?: string;
6553
+ /**
6554
+ * ID of the line item this membership applies to.
6555
+ * @minLength 1
6556
+ * @maxLength 100
6557
+ */
6558
+ lineItemId?: string;
6559
+ /**
6560
+ * Payment status.
6561
+ * @deprecated Payment status.
6562
+ * @replacedBy payment.status
6563
+ * @targetRemovalDate 2026-11-01
6564
+ */
6565
+ status?: MembershipPaymentStatusWithLiterals;
6566
+ /** Membership name. */
6567
+ name?: MembershipName;
6568
+ /**
6569
+ * The transaction ID in the membership system. Can be used to void the transaction.
6570
+ * @minLength 1
6571
+ * @maxLength 100
6572
+ */
6573
+ externalTransactionId?: string | null;
6574
+ /**
6575
+ * Whether the membership is voided.
6576
+ * @readonly
6577
+ * @deprecated Whether the membership is voided.
6578
+ * @replacedBy payment.status
6579
+ * @targetRemovalDate 2026-11-01
6580
+ */
6581
+ voided?: boolean;
6582
+ /**
6583
+ * ID of the application providing this payment option.
6584
+ * @format GUID
6585
+ */
6586
+ providerAppId?: string;
6587
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6588
+ futureMembership?: FutureMembershipDetails;
6593
6589
  }
6594
- declare enum State {
6595
- UNKNOWN = "UNKNOWN",
6596
- ENABLED = "ENABLED",
6597
- DISABLED = "DISABLED",
6598
- PENDING = "PENDING",
6599
- DEMO = "DEMO"
6590
+ declare enum MembershipPaymentStatus {
6591
+ /** Payment was charged. */
6592
+ CHARGED = "CHARGED",
6593
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6594
+ CHARGE_FAILED = "CHARGE_FAILED",
6595
+ /** Payment is pending. */
6596
+ CHARGE_PENDING = "CHARGE_PENDING",
6597
+ /** Payment was voided. */
6598
+ VOIDED = "VOIDED"
6600
6599
  }
6601
6600
  /** @enumType */
6602
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6603
- interface SiteCreated {
6601
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6602
+ interface FutureMembershipDetails {
6604
6603
  /**
6605
- * A template identifier (empty if not created from a template).
6606
- * @maxLength 36
6604
+ * ID of the plan line item in the order from which the membership will be created.
6605
+ * @format GUID
6607
6606
  */
6608
- originTemplateId?: string;
6607
+ lineItemId?: string;
6609
6608
  /**
6610
- * An account id of the owner.
6611
- * @format GUID
6609
+ * ID of the benefit the future membership will grant.
6610
+ * @maxLength 200
6612
6611
  */
6613
- ownerId?: string;
6614
- /** A context in which meta site was created. */
6615
- context?: SiteCreatedContextWithLiterals;
6612
+ benefitId?: string;
6613
+ }
6614
+ interface WixReceiptInfo {
6616
6615
  /**
6617
- * A meta site id from which this site was created.
6618
- *
6619
- * In case of a creation from a template it's a template id.
6620
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6616
+ * Receipt ID
6621
6617
  * @format GUID
6622
6618
  */
6623
- originMetaSiteId?: string | null;
6619
+ receiptId?: string;
6624
6620
  /**
6625
- * A meta site name (URL slug).
6626
- * @maxLength 20
6621
+ * Display number of receipt
6622
+ * @minLength 1
6623
+ * @maxLength 40
6627
6624
  */
6628
- siteName?: string;
6629
- /** A namespace. */
6630
- namespace?: NamespaceWithLiterals;
6631
- }
6632
- declare enum SiteCreatedContext {
6633
- /** A valid option, we don't expose all reasons why site might be created. */
6634
- OTHER = "OTHER",
6635
- /** A meta site was created from template. */
6636
- FROM_TEMPLATE = "FROM_TEMPLATE",
6637
- /** A meta site was created by copying of the transfferred meta site. */
6638
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6639
- /** A copy of existing meta site. */
6640
- DUPLICATE = "DUPLICATE",
6641
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6642
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6643
- /** deprecated A meta site was created for Flash editor. */
6644
- FLASH = "FLASH"
6625
+ displayNumber?: string | null;
6645
6626
  }
6646
- /** @enumType */
6647
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6648
- declare enum Namespace {
6649
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6650
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6651
- WIX = "WIX",
6652
- /** 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. */
6653
- SHOUT_OUT = "SHOUT_OUT",
6654
- /** 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. */
6655
- ALBUMS = "ALBUMS",
6656
- /** 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. */
6657
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6658
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6659
- HOTELS = "HOTELS",
6660
- /** 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. */
6661
- CLUBS = "CLUBS",
6662
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6663
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6627
+ interface ExternalReceiptInfo {
6664
6628
  /**
6665
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6666
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6629
+ * External receipt ID
6630
+ * @maxLength 100
6667
6631
  */
6668
- DEV_SITE = "DEV_SITE",
6669
- /** 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. */
6670
- LOGOS = "LOGOS",
6671
- /** 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. */
6672
- VIDEO_MAKER = "VIDEO_MAKER",
6673
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6674
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6675
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6676
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6632
+ receiptId?: string | null;
6677
6633
  /**
6678
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6679
- *
6680
- * Meta site with this namespace will *not* be shown in a user's site list by default.
6634
+ * ID of the app providing the receipt
6635
+ * @format GUID
6681
6636
  */
6682
- HTML_DRAFT = "HTML_DRAFT",
6637
+ appId?: string | null;
6683
6638
  /**
6684
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6685
- * Will be accessible from Site List and will not have a website app.
6686
- * Once the user attaches a site, the site will become a regular wixsite.
6639
+ * Display number of receipt
6640
+ * @minLength 1
6641
+ * @maxLength 40
6687
6642
  */
6688
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
6689
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6690
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
6691
- /** It is to be used in the Business First efforts. */
6692
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
6693
- /** Bookings business flow with no site. */
6694
- ANYWHERE = "ANYWHERE",
6695
- /** Namespace for Headless Backoffice with no editor */
6696
- HEADLESS = "HEADLESS",
6643
+ displayNumber?: string | null;
6644
+ }
6645
+ interface CashRoundingDetails {
6697
6646
  /**
6698
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6699
- * The site will be used for account level CSM feature for enterprise
6647
+ * Payment amount before cash rounding was applied.
6648
+ * When provided, balance and status calculations use this value instead of `amount`
6649
+ * to prevent false overpayment or underpayment due to rounding.
6700
6650
  */
6701
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6702
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6703
- RISE = "RISE",
6651
+ unroundedAmount?: Price;
6652
+ /**
6653
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6654
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6655
+ * @readonly
6656
+ */
6657
+ roundingAdjustment?: CashRounding;
6658
+ }
6659
+ declare enum PaymentStatus {
6660
+ /** Payment was charged successfully. */
6661
+ APPROVED = "APPROVED",
6662
+ /** Payment is being processed and hasn't been confirmed yet. */
6663
+ PENDING = "PENDING",
6664
+ /** 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. */
6665
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6666
+ /** Payment was canceled before it was charged. */
6667
+ CANCELED = "CANCELED",
6668
+ /** Payment was declined by the payment provider. */
6669
+ DECLINED = "DECLINED",
6670
+ /** Payment was fully refunded. */
6671
+ REFUNDED = "REFUNDED",
6672
+ /** Part of the payment amount was refunded. */
6673
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6674
+ /** 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. */
6675
+ AUTHORIZED = "AUTHORIZED",
6704
6676
  /**
6705
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6706
- * There's a blank site behind the scene but it's blank).
6707
- * The Mobile company will be the owner of this namespace.
6677
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6678
+ *
6679
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6708
6680
  */
6709
- BRANDED_FIRST = "BRANDED_FIRST",
6710
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6711
- NOWNIA = "NOWNIA",
6681
+ VOIDED = "VOIDED"
6682
+ }
6683
+ /** @enumType */
6684
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6685
+ interface CanceledStatusDetails {
6686
+ reason?: CanceledReasonWithLiterals;
6687
+ }
6688
+ declare enum CanceledReason {
6689
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6690
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6691
+ /** Payment was not completed by user and expired. */
6692
+ EXPIRED = "EXPIRED"
6693
+ }
6694
+ /** @enumType */
6695
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6696
+ interface DeclinedStatusDetails {
6697
+ reason?: DeclinedReasonWithLiterals;
6698
+ }
6699
+ declare enum DeclinedReason {
6700
+ /** Corresponding charge failed. */
6701
+ CHARGE_FAILED = "CHARGE_FAILED",
6702
+ /** Payment details expired. */
6703
+ EXPIRED = "EXPIRED",
6704
+ /** Insufficient funds. */
6705
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6706
+ /** Gift card was disabled before charge was attempted. */
6707
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6708
+ }
6709
+ /** @enumType */
6710
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6711
+ interface VoidedStatusDetails {
6712
+ reason?: VoidedReasonWithLiterals;
6713
+ }
6714
+ declare enum VoidedReason {
6715
+ /** Payment was voided by merchant request. */
6716
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6717
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6718
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6719
+ }
6720
+ /** @enumType */
6721
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6722
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6723
+ /** @internal */
6724
+ canceled?: CanceledStatusDetails;
6725
+ /** @internal */
6726
+ declined?: DeclinedStatusDetails;
6727
+ /** @internal */
6728
+ voided?: VoidedStatusDetails;
6712
6729
  /**
6713
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
6714
- * The Partners company owns this namespace.
6730
+ * Reason code from the payment gateway.
6731
+ * @internal
6732
+ * @minLength 1
6733
+ * @maxLength 10
6715
6734
  */
6716
- UGC_TEMPLATE = "UGC_TEMPLATE",
6717
- /** Codux Headless Sites */
6718
- CODUX = "CODUX",
6719
- /** Bobb - AI Design Creator. */
6720
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6735
+ paymentGatewayReasonCode?: string | null;
6736
+ }
6737
+ /** @oneof */
6738
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6739
+ /** @internal */
6740
+ canceled?: CanceledStatusDetails;
6741
+ /** @internal */
6742
+ declined?: DeclinedStatusDetails;
6743
+ /** @internal */
6744
+ voided?: VoidedStatusDetails;
6745
+ }
6746
+ interface Refund {
6721
6747
  /**
6722
- * Shared Blog Site is a unique single site across Enterprise account,
6723
- * This site will hold all Blog posts related to the Marketing product.
6748
+ * Refund ID.
6749
+ * @format GUID
6750
+ * @readonly
6724
6751
  */
6725
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6726
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6727
- STANDALONE_FORMS = "STANDALONE_FORMS",
6728
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6729
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6730
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6731
- MIMIR = "MIMIR",
6732
- /** Wix Twins platform. */
6733
- TWINS = "TWINS",
6734
- /** Wix Nano. */
6735
- NANO = "NANO",
6736
- /** Base44 headless sites. */
6737
- BASE44 = "BASE44",
6738
- /** Wix Channels Sites */
6739
- CHANNELS = "CHANNELS",
6740
- /** Nautilus platform. */
6741
- NAUTILUS = "NAUTILUS",
6752
+ _id?: string;
6742
6753
  /**
6743
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6744
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6754
+ * List of transactions.
6755
+ * @maxSize 50
6745
6756
  */
6746
- SYMPHONY = "SYMPHONY",
6747
- /** Nautilus platform app. */
6748
- NAUTILUS_APPS = "NAUTILUS_APPS",
6757
+ transactions?: RefundTransaction[];
6758
+ /** Refund business details. */
6759
+ details?: RefundDetails;
6749
6760
  /**
6750
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6751
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6761
+ * 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.
6762
+ * @readonly
6763
+ * @immutable
6752
6764
  */
6753
- VIBU = "VIBU",
6765
+ _createdDate?: Date | null;
6754
6766
  /**
6755
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6756
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6757
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6758
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6767
+ * Aggregated refund summary.
6768
+ * @readonly
6759
6769
  */
6760
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6770
+ summary?: AggregatedRefundSummary;
6761
6771
  /**
6762
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6763
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6772
+ * ID of the app that initiated this refund.
6773
+ * @format GUID
6774
+ * @readonly
6775
+ * @immutable
6764
6776
  */
6765
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6777
+ requestingServiceAppId?: string | null;
6766
6778
  }
6767
- /** @enumType */
6768
- 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';
6769
- /** Site transferred to another user. */
6770
- interface SiteTransferred {
6779
+ interface RefundTransaction {
6771
6780
  /**
6772
- * A previous owner id (user that transfers meta site).
6781
+ * ID of the payment associated with this refund.
6773
6782
  * @format GUID
6783
+ * @immutable
6774
6784
  */
6775
- oldOwnerId?: string;
6785
+ paymentId?: string;
6776
6786
  /**
6777
- * A new owner id (user that accepts meta site).
6787
+ * Refund amount.
6788
+ * @immutable
6789
+ */
6790
+ amount?: Price;
6791
+ /** Refund status. */
6792
+ refundStatus?: RefundStatusWithLiterals;
6793
+ /** Optional details of current refund status. */
6794
+ refundStatusInfo?: RefundStatusInfo;
6795
+ /**
6796
+ * Payment gateway's refund ID.
6797
+ * This field is only returned when the value of `external_refund` is `false`.
6778
6798
  * @format GUID
6779
6799
  */
6780
- newOwnerId?: string;
6781
- }
6782
- /** Soft deletion of the meta site. Could be restored. */
6783
- interface SiteDeleted {
6784
- /** A deletion context. */
6785
- deleteContext?: DeleteContext;
6786
- }
6787
- interface DeleteContext {
6788
- /** When the meta site was deleted. */
6789
- dateDeleted?: Date | null;
6790
- /** A status. */
6791
- deleteStatus?: DeleteStatusWithLiterals;
6800
+ gatewayRefundId?: string | null;
6801
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6802
+ providerRefundId?: string | null;
6792
6803
  /**
6793
- * A reason (flow).
6794
- * @maxLength 255
6804
+ * Whether refund was made externally and manually on the payment provider's side.
6805
+ * @immutable
6795
6806
  */
6796
- deleteOrigin?: string;
6807
+ externalRefund?: boolean;
6797
6808
  /**
6798
- * A service that deleted it.
6799
- * @maxLength 255
6809
+ * Location where the refund was processed.
6810
+ * @internal
6811
+ * @format GUID
6812
+ * @immutable
6800
6813
  */
6801
- initiatorId?: string | null;
6814
+ locationId?: string | null;
6802
6815
  }
6803
- declare enum DeleteStatus {
6804
- UNKNOWN = "UNKNOWN",
6805
- TRASH = "TRASH",
6806
- DELETED = "DELETED",
6807
- PENDING_PURGE = "PENDING_PURGE",
6808
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6816
+ /** Refund transaction status. */
6817
+ declare enum RefundStatus {
6818
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6819
+ PENDING = "PENDING",
6820
+ /** Refund transaction succeeded. */
6821
+ SUCCEEDED = "SUCCEEDED",
6822
+ /** Refund transaction failed. */
6823
+ FAILED = "FAILED",
6824
+ /** Refund request acknowledged, and will be executed soon. */
6825
+ SCHEDULED = "SCHEDULED",
6826
+ /** Refund was initiated on payment provider side. */
6827
+ STARTED = "STARTED"
6809
6828
  }
6810
6829
  /** @enumType */
6811
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6812
- /** Restoration of the meta site. */
6813
- interface SiteUndeleted {
6814
- }
6815
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6816
- interface SitePublished {
6817
- }
6818
- interface SiteUnpublished {
6830
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6831
+ interface RefundStatusInfo {
6819
6832
  /**
6820
- * A list of URLs previously associated with the meta site.
6821
- * @maxLength 4000
6822
- * @maxSize 10000
6833
+ * Reason code for the refund's current status.
6834
+ *
6835
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6836
+ * @minLength 1
6837
+ * @maxLength 10
6823
6838
  */
6824
- urls?: string[];
6825
- }
6826
- interface SiteMarkedAsTemplate {
6827
- }
6828
- interface SiteMarkedAsWixSite {
6839
+ paymentGatewayReasonCode?: string | null;
6840
+ /**
6841
+ * Free text explanation of current refund status.
6842
+ * @minLength 1
6843
+ * @maxLength 1000
6844
+ */
6845
+ description?: string | null;
6829
6846
  }
6830
- /**
6831
- * Represents a service provisioned a site.
6832
- *
6833
- * Note on `origin_instance_id`:
6834
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6835
- * This is because of the following scenario:
6836
- *
6837
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6838
- * such as a product catalog. When you create a site from this template, you inherit this
6839
- * default product catalog. However, if the template's product catalog is modified,
6840
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6841
- * your site remains consistent with what you initially received and does not include any
6842
- * changes made to the original template afterward.
6843
- * To ensure this, the TPA on the template gets a new instance_id.
6844
- */
6845
- interface ServiceProvisioned {
6847
+ interface AggregatedRefundSummary {
6848
+ /** Total amount requested for refund. */
6849
+ requestedRefund?: Price;
6850
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6851
+ pendingRefund?: Price;
6852
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6853
+ refunded?: Price;
6854
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6855
+ failedRefundAmount?: Price;
6856
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6857
+ pending?: boolean;
6858
+ /** Breakdown of refunded items. Available only after refund is complete. */
6859
+ breakdown?: RefundItemsBreakdown;
6860
+ }
6861
+ interface RefundItemsBreakdown {
6846
6862
  /**
6847
- * Either UUID or EmbeddedServiceType.
6848
- * @maxLength 36
6863
+ * Refunded line items and the amount refunded for each.
6864
+ * @maxSize 300
6849
6865
  */
6850
- appDefId?: string;
6866
+ lineItems?: LineItemRefundSummary[];
6867
+ }
6868
+ interface LineItemRefundSummary {
6851
6869
  /**
6852
- * Not only UUID. Something here could be something weird.
6853
- * @maxLength 36
6870
+ * ID of the refunded line item.
6871
+ * @format GUID
6854
6872
  */
6855
- instanceId?: string;
6873
+ lineItemId?: string;
6874
+ /** Total refunded amount for the line item. */
6875
+ totalRefundedAmount?: Price;
6876
+ }
6877
+ interface CalculateRefundRequest {
6856
6878
  /**
6857
- * An instance id from which this instance is originated.
6858
- * @maxLength 36
6879
+ * Order ID
6880
+ * @minLength 1
6881
+ * @maxLength 100
6859
6882
  */
6860
- originInstanceId?: string;
6883
+ ecomOrderId?: string;
6861
6884
  /**
6862
- * A version.
6863
- * @maxLength 500
6885
+ * Refunded line items and quantity
6886
+ * @maxSize 300
6864
6887
  */
6865
- version?: string | null;
6888
+ refundItems?: CalculateRefundItemRequest[];
6889
+ /** Should include shipping in refund calculation */
6890
+ refundShipping?: boolean;
6891
+ }
6892
+ interface CalculateRefundItemRequest {
6866
6893
  /**
6867
- * The origin meta site id
6894
+ * ID of the line item being refunded
6868
6895
  * @format GUID
6869
6896
  */
6870
- originMetaSiteId?: string | null;
6871
- }
6872
- interface ServiceRemoved {
6897
+ _id?: string;
6873
6898
  /**
6874
- * Either UUID or EmbeddedServiceType.
6875
- * @maxLength 36
6899
+ * How much of that line item is being refunded
6900
+ * @min 1
6901
+ * @max 100000
6876
6902
  */
6877
- appDefId?: string;
6903
+ quantity?: number;
6904
+ }
6905
+ interface CalculateRefundResponse {
6906
+ /** Total refundable amount */
6907
+ total?: Price;
6908
+ /** Tax cost of the order */
6909
+ tax?: Price;
6910
+ /** Discount given for this order */
6911
+ discount?: Price;
6912
+ /** Total cost of the order (without tax) */
6913
+ subtotal?: Price;
6914
+ /** Total shipping cost for order */
6915
+ shipping?: Price;
6916
+ /** Previous refund given on that order */
6917
+ previouslyRefundedAmount?: Price;
6878
6918
  /**
6879
- * Not only UUID. Something here could be something weird.
6880
- * @maxLength 36
6919
+ * The refundable items of that order
6920
+ * @maxSize 300
6881
6921
  */
6882
- instanceId?: string;
6922
+ items?: CalculateRefundItemResponse[];
6923
+ }
6924
+ interface CalculateRefundItemResponse {
6883
6925
  /**
6884
- * A version.
6885
- * @maxLength 500
6926
+ * Line item ID
6927
+ * @format GUID
6886
6928
  */
6887
- version?: string | null;
6929
+ _id?: string;
6930
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6931
+ price?: Price;
6888
6932
  }
6889
- /** Rename of the site. Meaning, free public url has been changed as well. */
6890
- interface SiteRenamed {
6933
+ interface VoidAuthorizedPaymentsRequest {
6891
6934
  /**
6892
- * A new meta site name (URL slug).
6893
- * @maxLength 20
6935
+ * Wix eCommerce order ID
6936
+ * @minLength 1
6937
+ * @maxLength 100
6894
6938
  */
6895
- newSiteName?: string;
6939
+ ecomOrderId: string;
6896
6940
  /**
6897
- * A previous meta site name (URL slug).
6898
- * @maxLength 255
6941
+ * Payment IDs
6942
+ * @minSize 1
6943
+ * @maxSize 100
6944
+ * @format GUID
6899
6945
  */
6900
- oldSiteName?: string;
6901
- }
6902
- /**
6903
- * Hard deletion of the meta site.
6904
- *
6905
- * Could not be restored. Therefore it's desirable to cleanup data.
6906
- */
6907
- interface SiteHardDeleted {
6908
- /** A deletion context. */
6909
- deleteContext?: DeleteContext;
6910
- }
6911
- interface NamespaceChanged {
6912
- /** A previous namespace. */
6913
- oldNamespace?: NamespaceWithLiterals;
6914
- /** A new namespace. */
6915
- newNamespace?: NamespaceWithLiterals;
6916
- }
6917
- /** Assigned Studio editor */
6918
- interface StudioAssigned {
6919
- }
6920
- /** Unassigned Studio editor */
6921
- interface StudioUnassigned {
6946
+ paymentIds: string[];
6922
6947
  }
6923
- /**
6924
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6925
- *
6926
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6927
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6928
- *
6929
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6930
- */
6931
- interface SiteUrlChanged {
6948
+ interface VoidAuthorizedPaymentsResponse {
6949
+ /** All order's transactions after the void was triggered */
6950
+ orderTransactions?: OrderTransactions;
6932
6951
  }
6933
- /**
6934
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6935
- * Consumed by other teams to remove relevant data.
6936
- */
6937
- interface SitePurgedExternally {
6952
+ interface CaptureAuthorizedPaymentsRequest {
6938
6953
  /**
6939
- * @maxLength 2048
6954
+ * Wix eCommerce order ID
6955
+ * @minLength 1
6956
+ * @maxLength 100
6957
+ */
6958
+ ecomOrderId: string;
6959
+ /**
6960
+ * Capture payments information
6961
+ * @minSize 1
6940
6962
  * @maxSize 100
6941
- * @deprecated
6942
- * @targetRemovalDate 2025-04-15
6943
6963
  */
6944
- appDefId?: string[];
6945
- }
6946
- /** Assigned Odeditor */
6947
- interface OdeditorAssigned {
6948
- }
6949
- /** Unassigned Odeditor */
6950
- interface OdeditorUnassigned {
6951
- }
6952
- /** Assigned Picasso editor */
6953
- interface PicassoAssigned {
6954
- }
6955
- /** Unassigned Picasso */
6956
- interface PicassoUnassigned {
6957
- }
6958
- /** Assigned Wixel */
6959
- interface WixelAssigned {
6960
- }
6961
- /** Unassigned Wixel */
6962
- interface WixelUnassigned {
6963
- }
6964
- /** Assigned StudioTwo */
6965
- interface StudioTwoAssigned {
6966
- }
6967
- /** Unassigned StudioTwo */
6968
- interface StudioTwoUnassigned {
6969
- }
6970
- /** Media from user domain is enabled. */
6971
- interface UserDomainMediaEnabled {
6972
- }
6973
- /** Media from user domain is disabled. */
6974
- interface UserDomainMediaDisabled {
6975
- }
6976
- /** Assigned Editorless */
6977
- interface EditorlessAssigned {
6978
- }
6979
- /** Unassigned Editorless */
6980
- interface EditorlessUnassigned {
6964
+ payments: PaymentCapture[];
6981
6965
  }
6982
- interface HasCustomEmailConfigurationsRequest {
6966
+ interface PaymentCapture {
6967
+ /**
6968
+ * Payment ID
6969
+ * @format GUID
6970
+ */
6971
+ paymentId?: string | null;
6972
+ /**
6973
+ * Capture amount.
6974
+ * If not provided - full authorized amount will be captured.
6975
+ */
6976
+ amount?: Price;
6983
6977
  }
6984
- interface HasCustomEmailConfigurationsResponse {
6985
- hasCustomConfigurations?: boolean;
6978
+ interface CaptureAuthorizedPaymentsResponse {
6979
+ /** All order's transactions after the capture was triggered */
6980
+ orderTransactions?: OrderTransactions;
6986
6981
  }
6987
- interface AddToAutomationMigrationPopulationRequest {
6988
- /** When true, sends custom email configurations to automation system via email */
6989
- sendCustomEmailConfigs?: boolean;
6990
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6991
- origin?: OriginWithLiterals;
6982
+ interface ChargeSavedPaymentMethodRequest {
6983
+ /**
6984
+ * Ecom Order ID.
6985
+ * @minLength 1
6986
+ * @maxLength 100
6987
+ */
6988
+ ecomOrderId?: string;
6989
+ /** Amount to be charged */
6990
+ amount?: Price;
6992
6991
  }
6993
- declare enum Origin {
6994
- OPT_IN = "OPT_IN",
6995
- MIGRATION = "MIGRATION"
6992
+ interface ChargeSavedPaymentMethodResponse {
6993
+ /** Payment gateway's order ID (e.g Wix Payments) */
6994
+ paymentGatewayOrderId?: string;
6996
6995
  }
6997
- /** @enumType */
6998
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6999
- interface AddToAutomationMigrationPopulationResponse {
7000
- success?: boolean;
6996
+ interface V1TriggerReindexRequest {
6997
+ /** @format GUID */
6998
+ metasiteId?: string;
6999
+ /**
7000
+ * @minLength 1
7001
+ * @maxLength 100
7002
+ * @maxSize 100
7003
+ */
7004
+ orderIds?: string[];
7001
7005
  }
7002
- interface IsInAutomationMigrationPopulationRequest {
7006
+ interface V1TriggerReindexResponse {
7003
7007
  }
7004
- interface IsInAutomationMigrationPopulationResponse {
7005
- inPopulation?: boolean;
7008
+ interface V1TriggerReindexOrderRequest {
7009
+ /** @format GUID */
7010
+ metasiteId?: string;
7011
+ /**
7012
+ * @minLength 1
7013
+ * @maxLength 100
7014
+ */
7015
+ orderId?: string;
7006
7016
  }
7007
7017
  interface DiffmatokyPayload {
7008
7018
  left?: string;
@@ -10837,4 +10847,4 @@ interface BulkUpdateOrderTagsOptions {
10837
10847
  unassignTags?: TagsTags;
10838
10848
  }
10839
10849
 
10840
- export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, AuthorizationVoidStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountReason as aD, LineItemQuantityChangeType as aE, ActivityType as aF, OrderActivityTypeEnumActivityType as aG, AttributionSource as aH, ChannelType as aI, AdditionalFeeSource as aJ, OrderActionType as aK, SpecificItemsCouponBehavior as aL, ChargeType as aM, VersioningMode as aN, DeltaPaymentOptionType as aO, InventoryAction as aP, WebhookIdentityType as aQ, ScheduledAction as aR, DurationUnit as aS, PaymentCollectabilityStatus as aT, PredefinedPaymentMethod as aU, RefundableStatus as aV, NonRefundableReason as aW, ManuallyRefundableReason as aX, RestockType as aY, TransactionStatus as aZ, AuthorizationCaptureStatus as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type CrossBorderPriceAdjustment as b$, Reason as b0, ActionType as b1, ChargebackStatus as b2, MembershipPaymentStatus as b3, PaymentStatus as b4, CanceledReason as b5, DeclinedReason as b6, VoidedReason as b7, RefundStatus as b8, PreviewEmailType as b9, type ItemType as bA, type ItemTypeItemTypeDataOneOf as bB, type RestockLocation as bC, type ItemTaxFullDetails as bD, type LineItemTaxInfo as bE, type LineItemTaxBreakdown as bF, type DigitalFile as bG, type SubscriptionInfo as bH, type SubscriptionTitle as bI, type SubscriptionDescription as bJ, type SubscriptionSettings as bK, type FreeTrialPeriod as bL, type BillingSettings as bM, type BillingAdjustment as bN, type BillingAdjustmentPriceSummary as bO, type CyclePriceOverride as bP, type PriceDescription as bQ, type LocationAndQuantity as bR, type TaxableAddress as bS, type TaxableAddressTaxableAddressDataOneOf as bT, type DecimalQuantity as bU, type DecimalQuantityUnitOneOf as bV, type TranslatableString as bW, type ExtendedFields as bX, type ModifierGroup as bY, type ItemModifier as bZ, type ServiceProperties as b_, State as ba, SiteCreatedContext as bb, Namespace as bc, DeleteStatus as bd, Origin as be, SortOrder as bf, OrderApprovalStrategy as bg, Placement as bh, SubdivisionType as bi, SourceType as bj, CustomFieldGroup as bk, ValueType as bl, DepositType as bm, InvoiceStatus as bn, type OrderLineItem as bo, type ProductName as bp, type CatalogReference as bq, type DescriptionLine as br, type DescriptionLineValueOneOf as bs, type DescriptionLineDescriptionLineValueOneOf as bt, type DescriptionLineName as bu, type PlainTextValue as bv, type Color as bw, type FocalPoint as bx, type PhysicalProperties as by, type Dimensions as bz, type SetOrderNumberCounterApplicationErrors as c, type RefundedPayment as c$, type BuyerInfo as c0, type BuyerInfoIdOneOf as c1, type CurrencyConversionDetails as c2, type CrossBorderRepricing as c3, type PriceSummary as c4, type AddressWithContact as c5, type Address as c6, type StreetAddress as c7, type AddressLocation as c8, type FullAddressContactDetails as c9, type MerchantComment as cA, type OrderRefunded as cB, type OrderCreatedFromExchange as cC, type NewExchangeOrderCreated as cD, type LineItemExchangeData as cE, type DraftOrderChangesApplied as cF, type OrderChange as cG, type OrderChangeValueOneOf as cH, type LineItemChanges as cI, type LineItemQuantityChange as cJ, type LineItemPriceChange as cK, type LineItemProductNameChange as cL, type LineItemDescriptionLineChange as cM, type LineItemModifiersChange as cN, type ManagedLineItem as cO, type ManagedDiscount as cP, type TranslatedValue as cQ, type LineItemAmount as cR, type ManagedAdditionalFee as cS, type TotalPriceChange as cT, type ShippingInformationChange as cU, type ShippingInformation as cV, type SavedPaymentMethod as cW, type AuthorizedPaymentCreated as cX, type AuthorizedPaymentCaptured as cY, type AuthorizedPaymentVoided as cZ, type RefundInitiated as c_, type VatId as ca, type V1ShippingInformation as cb, type DeliveryLogistics as cc, type DeliveryLogisticsAddressOneOf as cd, type PickupDetails as ce, type PickupAddress as cf, type DeliveryTimeSlot as cg, type ShippingPrice as ch, type ShippingRegion as ci, type TaxSummary as cj, type OrderTaxInfo as ck, type OrderTaxBreakdown as cl, type CrossBorderCalculation as cm, type AppliedDiscount as cn, type AppliedDiscountDiscountSourceOneOf as co, type Coupon as cp, type MerchantDiscount as cq, type MerchantDiscountMerchantDiscountReasonOneOf as cr, type DiscountRule as cs, type DiscountRuleName as ct, type LineItemDiscount as cu, type ItemCombination as cv, type ItemCombinationLineItem as cw, type Activity as cx, type ActivityContentOneOf as cy, type CustomActivity as cz, type PreparePaymentCollectionOptions as d, type ImportedOrderDeleted as d$, type RefundedPaymentKindOneOf as d0, type RegularPaymentRefund as d1, type GiftCardPaymentRefund as d2, type MembershipPaymentRefund as d3, type PaymentRefunded as d4, type PaymentRefundFailed as d5, type RefundedAsStoreCredit as d6, type PaymentPending as d7, type PaymentPendingPaymentDetailsOneOf as d8, type RegularPayment as d9, type Location as dA, type OrderSettings as dB, type OrderSettingsAllowedActionsOneOf as dC, type OrderSettingsEditableByOneOf as dD, type CustomAllowedActions as dE, type OwnerApps as dF, type FormInfo as dG, type FormIdentifier as dH, type PlatformFeeSummary as dI, type PlatformFee as dJ, type UpdateInternalDocumentsEvent as dK, type UpdateInternalDocumentsEventOperationOneOf as dL, type InternalDocument as dM, type InternalDocumentUpdateOperation as dN, type DeleteByIdsOperation as dO, type DeleteByFilterOperation as dP, type InternalDocumentUpdateByFilterOperation as dQ, type InternalUpdateExistingOperation as dR, type VersionedDocumentUpdateOperation as dS, type VersionedDeleteByIdsOperation as dT, type VersionedDocumentId as dU, type OrderApproved as dV, type OrdersExperiments as dW, type OrderRejectedEventOrderRejected as dX, type OrderItemsRestocked as dY, type V1RestockItem as dZ, type OrderImported as d_, type RegularPaymentPaymentMethodDetailsOneOf as da, type CreditCardDetails as db, type PaymentCanceled as dc, type PaymentCanceledPaymentDetailsOneOf as dd, type PaymentDeclined as de, type PaymentDeclinedPaymentDetailsOneOf as df, type ReceiptCreated as dg, type ReceiptCreatedReceiptInfoOneOf as dh, type WixReceipt as di, type ExternalReceipt as dj, type ReceiptSent as dk, type ReceiptSentReceiptInfoOneOf as dl, type ChargebackCreated as dm, type ChargebackReversed as dn, type CreatedBy as dp, type CreatedByStringOneOf as dq, type ChannelInfo as dr, type CustomField as ds, type BalanceSummary as dt, type Balance as du, type CashRounding as dv, type AdditionalFee as dw, type FulfillmentStatusesAggregate as dx, type Tags as dy, type TagList as dz, type PreparePaymentCollectionResponse as e, type TriggerRefundRequest as e$, type PaymentStatusUpdated as e0, type FulfillmentStatusUpdated as e1, type OrderCanceledEventOrderCanceled as e2, type OrderDeltasCommitted as e3, type CommittedDiffs as e4, type CommittedDiffsShippingUpdateInfoOneOf as e5, type ItemChangedDetails as e6, type OrderLineItemChangedDetails as e7, type DecimalQuantityUpdate as e8, type CrossBorderAdjustmentUpdate as e9, type V1TriggerReindexRequest as eA, type V1TriggerReindexResponse as eB, type V1TriggerReindexOrderRequest as eC, type PreparePaymentCollectionRequest as eD, type RedirectUrls as eE, type DelayedCaptureSettings as eF, type Duration as eG, type GetPaymentCollectabilityStatusRequest as eH, type RecordManuallyCollectedPaymentRequest as eI, type UserDefinedPaymentMethodName as eJ, type UserDefinedPaymentMethodNameKindOneOf as eK, type RecordManuallyCollectedPaymentResponse as eL, type MarkOrderAsPaidRequest as eM, type BulkMarkOrdersAsPaidRequest as eN, type BulkOrderResult as eO, type ItemMetadata as eP, type ApplicationError as eQ, type BulkActionMetadata as eR, type GetRefundabilityStatusRequest as eS, type Refundability as eT, type RefundabilityAdditionalRefundabilityInfoOneOf as eU, type CreatePaymentGatewayOrderRequest as eV, type ChargedBy as eW, type ChargeMembershipsRequest as eX, type MembershipChargeItem as eY, type MembershipName as eZ, type ChargeMembershipsResponse as e_, type LineItemDelta as ea, type LineItemDeltaDeltaOneOf as eb, type AppliedDiscountDelta as ec, type AppliedDiscountDeltaDeltaOneOf as ed, type AdditionalFeeDelta as ee, type AdditionalFeeDeltaDeltaOneOf as ef, type DraftOrderCommitSettings as eg, type InventoryUpdateDetails as eh, type TriggerReindexRequest as ei, type TriggerReindexResponse as ej, type DomainEvent as ek, type DomainEventBodyOneOf as el, type EntityCreatedEvent as em, type RestoreInfo as en, type EntityUpdatedEvent as eo, type EntityDeletedEvent as ep, type ActionEvent as eq, type Empty as er, type TriggerReindexOrderRequest as es, type MessageEnvelope as et, type IdentificationData as eu, type IdentificationDataIdOneOf as ev, type AccountInfo as ew, type ImportOrderRequest as ex, type SetOrderNumberCounterRequest as ey, type BulkDeleteImportedOrdersRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type SendCancelRefundEmailResponse as f$, type RefundDetails as f0, type RefundItem as f1, type LineItemRefund as f2, type AdditionalFeeRefund as f3, type ShippingRefund as f4, type RefundSideEffects as f5, type RestockInfo as f6, type RestockItem as f7, type OrderTransactions as f8, type Payment as f9, type RefundStatusInfo as fA, type AggregatedRefundSummary as fB, type RefundItemsBreakdown as fC, type LineItemRefundSummary as fD, type CalculateRefundRequest as fE, type CalculateRefundItemRequest as fF, type CalculateRefundResponse as fG, type CalculateRefundItemResponse as fH, type VoidAuthorizedPaymentsRequest as fI, type CaptureAuthorizedPaymentsRequest as fJ, type ChargeSavedPaymentMethodRequest as fK, type ChargeSavedPaymentMethodResponse as fL, type SendBuyerConfirmationEmailRequest as fM, type SendBuyerConfirmationEmailResponse as fN, type SendBuyerPaymentsReceivedEmailRequest as fO, type SendBuyerPaymentsReceivedEmailResponse as fP, type SendBuyerPickupConfirmationEmailRequest as fQ, type SendBuyerPickupConfirmationEmailResponse as fR, type BulkSendBuyerPickupConfirmationEmailsRequest as fS, type BulkSendBuyerPickupConfirmationEmailsResponse as fT, type SendBuyerShippingConfirmationEmailRequest as fU, type SendBuyerShippingConfirmationEmailResponse as fV, type BulkSendBuyerShippingConfirmationEmailsRequest as fW, type BulkSendBuyerShippingConfirmationEmailsResponse as fX, type SendMerchantOrderReceivedNotificationRequest as fY, type SendMerchantOrderReceivedNotificationResponse as fZ, type SendCancelRefundEmailRequest as f_, type PaymentPaymentDetailsOneOf as fa, type PaymentReceiptInfoOneOf as fb, type PaymentStatusDetailsOneOf as fc, type RegularPaymentDetails as fd, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fe, type CreditCardPaymentMethodDetails as ff, type AuthorizationDetails as fg, type AuthorizationCapture as fh, type AuthorizationActionFailureDetails as fi, type AuthorizationVoid as fj, type V1ScheduledAction as fk, type Chargeback as fl, type PaymentMethodName as fm, type GiftCardPaymentDetails as fn, type MembershipPaymentDetails as fo, type FutureMembershipDetails as fp, type WixReceiptInfo as fq, type ExternalReceiptInfo as fr, type CashRoundingDetails as fs, type CanceledStatusDetails as ft, type DeclinedStatusDetails as fu, type VoidedStatusDetails as fv, type PaymentStatusDetails as fw, type PaymentStatusDetailsStatusDetailsOneOf as fx, type Refund as fy, type RefundTransaction as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type DiffmatokyPayload as g$, type SendRefundEmailRequest as g0, type SendRefundEmailResponse as g1, type SendFulfillmentEmailRequest as g2, type SendFulfillmentEmailResponse as g3, type SendMerchantOrderReceivedPushRequest as g4, type SendMerchantOrderReceivedPushResponse as g5, type PreviewEmailByTypeRequest as g6, type PreviewEmailByTypeResponse as g7, type PreviewRefundEmailRequest as g8, type PreviewRefundEmailResponse as g9, type ServiceProvisioned as gA, type ServiceRemoved as gB, type SiteRenamed as gC, type SiteHardDeleted as gD, type NamespaceChanged as gE, type StudioAssigned as gF, type StudioUnassigned as gG, type SiteUrlChanged as gH, type SitePurgedExternally as gI, type OdeditorAssigned as gJ, type OdeditorUnassigned as gK, type PicassoAssigned as gL, type PicassoUnassigned as gM, type WixelAssigned as gN, type WixelUnassigned as gO, type StudioTwoAssigned as gP, type StudioTwoUnassigned as gQ, type UserDomainMediaEnabled as gR, type UserDomainMediaDisabled as gS, type EditorlessAssigned as gT, type EditorlessUnassigned as gU, type HasCustomEmailConfigurationsRequest as gV, type HasCustomEmailConfigurationsResponse as gW, type AddToAutomationMigrationPopulationRequest as gX, type AddToAutomationMigrationPopulationResponse as gY, type IsInAutomationMigrationPopulationRequest as gZ, type IsInAutomationMigrationPopulationResponse as g_, type PreviewCancelEmailRequest as ga, type PreviewCancelEmailResponse as gb, type PreviewCancelRefundEmailRequest as gc, type PreviewCancelRefundEmailResponse as gd, type PreviewBuyerPaymentsReceivedEmailRequest as ge, type PreviewBuyerPaymentsReceivedEmailResponse as gf, type PreviewBuyerConfirmationEmailRequest as gg, type PreviewBuyerConfirmationEmailResponse as gh, type PreviewBuyerPickupConfirmationEmailRequest as gi, type PreviewBuyerPickupConfirmationEmailResponse as gj, type PreviewShippingConfirmationEmailRequest as gk, type PreviewShippingConfirmationEmailResponse as gl, type PreviewResendDownloadLinksEmailRequest as gm, type PreviewResendDownloadLinksEmailResponse as gn, type MetaSiteSpecialEvent as go, type MetaSiteSpecialEventPayloadOneOf as gp, type Asset as gq, type SiteCreated as gr, type SiteTransferred as gs, type SiteDeleted as gt, type DeleteContext as gu, type SiteUndeleted as gv, type SitePublished as gw, type SiteUnpublished as gx, type SiteMarkedAsTemplate as gy, type SiteMarkedAsWixSite as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type OrderPlaced as h$, type ErrorInformation as h0, type GetOrderRequest as h1, type GetOrderResponse as h2, type InternalQueryOrdersRequest as h3, type PlatformQuery as h4, type PlatformQueryPagingMethodOneOf as h5, type Sorting as h6, type PlatformPaging as h7, type CursorPaging as h8, type InternalQueryOrdersResponse as h9, type ArchiveOrderResponse as hA, type BulkArchiveOrdersRequest as hB, type BulkArchiveOrdersResponse as hC, type BulkArchiveOrdersByFilterRequest as hD, type BulkArchiveOrdersByFilterResponse as hE, type UnArchiveOrderRequest as hF, type UnArchiveOrderResponse as hG, type BulkUnArchiveOrdersRequest as hH, type BulkUnArchiveOrdersResponse as hI, type BulkUnArchiveOrdersByFilterRequest as hJ, type BulkUnArchiveOrdersByFilterResponse as hK, type UpdateBuyerInfoRequest as hL, type BuyerInfoUpdate as hM, type UpdateBuyerInfoResponse as hN, type UpdateBuyerEmailRequest as hO, type UpdateBuyerEmailResponse as hP, type UpdateOrderShippingAddressRequest as hQ, type UpdateOrderShippingAddressResponse as hR, type UpdateBillingContactDetailsRequest as hS, type UpdateBillingContactDetailsResponse as hT, type UpdateOrderLineItemRequest as hU, type UpdateOrderLineItemsRequest as hV, type MaskedOrderLineItem as hW, type UpdateOrderLineItemsResponse as hX, type AddInternalActivityRequest as hY, type InternalActivity as hZ, type InternalActivityContentOneOf as h_, type PlatformPagingMetadata as ha, type Cursors as hb, type QueryOrderRequest as hc, type QueryOrderResponse as hd, type SearchOrdersRequest as he, type CursorSearch as hf, type CursorSearchPagingMethodOneOf as hg, type CursorPagingMetadata as hh, type CreateOrderRequest as hi, type OrderCreationSettings as hj, type OrderCreationSettingsEditableByOneOf as hk, type OrderCreateNotifications as hl, type CreateOrderResponse as hm, type UpdateOrderRequest as hn, type UpdateOrderResponse as ho, type BulkUpdateOrdersRequest as hp, type CommitDeltasRequest as hq, type DraftOrderDiffs as hr, type DraftOrderDiffsShippingUpdateInfoOneOf as hs, type DraftOrderDiffsBuyerUpdateInfoOneOf as ht, type DraftOrderDiffsBillingUpdateInfoOneOf as hu, type DraftOrderDiffsRecipientUpdateInfoOneOf as hv, type V1LineItemDelta as hw, type V1LineItemDeltaDeltaOneOf as hx, type CommitDeltasResponse as hy, type ArchiveOrderRequest as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type BulkUpdateOrderTagsResult as i$, type OrderPaid as i0, type OrderFulfilled as i1, type OrderNotFulfilled as i2, type OrderCanceled as i3, type DownloadLinkSent as i4, type TrackingNumberAdded as i5, type TrackingNumberEdited as i6, type TrackingLinkAdded as i7, type ShippingConfirmationEmailSent as i8, type InvoiceAdded as i9, type BulkMarkAsFulfilledResponse as iA, type BulkMarkAsFulfilledByFilterRequest as iB, type BulkMarkAsFulfilledByFilterResponse as iC, type MarkAsUnfulfilledRequest as iD, type MarkAsUnfulfilledResponse as iE, type BulkMarkAsUnfulfilledRequest as iF, type BulkMarkAsUnfulfilledResponse as iG, type BulkMarkAsUnfulfilledByFilterRequest as iH, type BulkMarkAsUnfulfilledByFilterResponse as iI, type BulkSetBusinessLocationRequest as iJ, type BulkSetBusinessLocationResponse as iK, type BulkSetBusinessLocationResult as iL, type V1MarkOrderAsPaidRequest as iM, type V1MarkOrderAsPaidResponse as iN, type V1BulkMarkOrdersAsPaidRequest as iO, type V1BulkMarkOrdersAsPaidResponse as iP, type V1CreatePaymentGatewayOrderRequest as iQ, type V1CreatePaymentGatewayOrderResponse as iR, type GetShipmentsRequest as iS, type GetShipmentsResponse as iT, type AggregateOrdersRequest as iU, type DecrementItemsQuantityRequest as iV, type DecrementData as iW, type DecrementItemsQuantityResponse as iX, type BulkUpdateOrderTagsRequest as iY, type TagsTags as iZ, type TagsTagList as i_, type InvoiceSent as ia, type FulfillerEmailSent as ib, type ShippingAddressEdited as ic, type EmailEdited as id, type PickupReadyEmailSent as ie, type OrderPartiallyPaid as ig, type OrderPending as ih, type OrderRejected as ii, type AddInternalActivityResponse as ij, type AddActivityRequest as ik, type PublicActivityContentOneOf as il, type AddActivitiesRequest as im, type UpdateActivityRequest as io, type DeleteActivityRequest as ip, type UpdateLineItemsDescriptionLinesRequest as iq, type LineItemUpdate as ir, type UpdateLineItemsDescriptionLinesResponse as is, type MarkOrderAsSeenByHumanRequest as it, type MarkOrderAsSeenByHumanResponse as iu, type CancelOrderRequest as iv, type UpdateOrderStatusRequest as iw, type MarkAsFulfilledRequest as ix, type MarkAsFulfilledResponse as iy, type BulkMarkAsFulfilledRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type WeightUnitWithLiterals as j$, type SendOrderUpdatedDomainEventRequest as j0, type SendOrderUpdatedDomainEventResponse as j1, type Task as j2, type TaskKey as j3, type TaskAction as j4, type TaskActionActionOneOf as j5, type Complete as j6, type Cancel as j7, type Reschedule as j8, type InvoiceSentEvent as j9, type CalculatedTax as jA, type Payments as jB, type InvoicesPayment as jC, type MetaData as jD, type InvoiceDynamicPriceTotals as jE, type CustomFieldValue as jF, type Value as jG, type Deposit as jH, type BaseEventMetadata as jI, type EventMetadata as jJ, type AccountInfoMetadata as jK, type OrderSearchSpec as jL, utils as jM, type DescriptionLineTypeWithLiterals as jN, type DimensionsUnitWithLiterals as jO, type ItemTypePresetWithLiterals as jP, type PaymentOptionTypeWithLiterals as jQ, type JurisdictionTypeWithLiterals as jR, type SubscriptionFrequencyWithLiterals as jS, type ProductPeriodAlignmentWithLiterals as jT, type AdjustmentTypeWithLiterals as jU, type TaxableAddressTypeWithLiterals as jV, type MeasurementUnitWithLiterals as jW, type RepriceStatusWithLiterals as jX, type BaseRateSourceWithLiterals as jY, type PaymentStatusEnumPaymentStatusWithLiterals as jZ, type FulfillmentStatusWithLiterals as j_, type IdAndVersion as ja, type InvoiceFields as jb, type Customer as jc, type Email as jd, type QuotesAddress as je, type AddressDescription as jf, type Phone as jg, type Company as jh, type CommonAddress as ji, type CommonAddressStreetOneOf as jj, type Subdivision as jk, type StandardDetails as jl, type ShippingContactDetails as jm, type InvoiceDates as jn, type LineItems as jo, type LineItem as jp, type BigDecimalWrapper as jq, type LineItemTax as jr, type Source as js, type LineItemMetaData as jt, type Locale as ju, type TotalPrice as jv, type ItemizedFee as jw, type Discount as jx, type DiscountOneDiscountTypeOneOf as jy, type CalculatedTaxes as jz, type GetRefundabilityStatusResponse as k, onOrderUpdated as k$, type VatTypeWithLiterals as k0, type PickupMethodWithLiterals as k1, type CrossBorderNotApplicableReasonWithLiterals as k2, type CrossBorderRepricingModeWithLiterals as k3, type DiscountTypeWithLiterals as k4, type DiscountReasonWithLiterals as k5, type LineItemQuantityChangeTypeWithLiterals as k6, type ActivityTypeWithLiterals as k7, type OrderActivityTypeEnumActivityTypeWithLiterals as k8, type AttributionSourceWithLiterals as k9, type DeclinedReasonWithLiterals as kA, type VoidedReasonWithLiterals as kB, type RefundStatusWithLiterals as kC, type PreviewEmailTypeWithLiterals as kD, type StateWithLiterals as kE, type SiteCreatedContextWithLiterals as kF, type NamespaceWithLiterals as kG, type DeleteStatusWithLiterals as kH, type OriginWithLiterals as kI, type SortOrderWithLiterals as kJ, type OrderApprovalStrategyWithLiterals as kK, type PlacementWithLiterals as kL, type SubdivisionTypeWithLiterals as kM, type SourceTypeWithLiterals as kN, type CustomFieldGroupWithLiterals as kO, type ValueTypeWithLiterals as kP, type DepositTypeWithLiterals as kQ, type InvoiceStatusWithLiterals as kR, type CommonSearchWithEntityContext as kS, onOrderApproved as kT, onOrderCanceled as kU, onOrderCommitted as kV, onOrderCreated as kW, onOrderFulfilled as kX, onOrderImported as kY, onOrderImportedOrderDeleted as kZ, onOrderPaymentStatusUpdated as k_, type ChannelTypeWithLiterals as ka, type AdditionalFeeSourceWithLiterals as kb, type OrderActionTypeWithLiterals as kc, type SpecificItemsCouponBehaviorWithLiterals as kd, type ChargeTypeWithLiterals as ke, type VersioningModeWithLiterals as kf, type DeltaPaymentOptionTypeWithLiterals as kg, type InventoryActionWithLiterals as kh, type WebhookIdentityTypeWithLiterals as ki, type ScheduledActionWithLiterals as kj, type DurationUnitWithLiterals as kk, type PaymentCollectabilityStatusWithLiterals as kl, type PredefinedPaymentMethodWithLiterals as km, type RefundableStatusWithLiterals as kn, type NonRefundableReasonWithLiterals as ko, type ManuallyRefundableReasonWithLiterals as kp, type RestockTypeWithLiterals as kq, type TransactionStatusWithLiterals as kr, type AuthorizationCaptureStatusWithLiterals as ks, type AuthorizationVoidStatusWithLiterals as kt, type ReasonWithLiterals as ku, type ActionTypeWithLiterals as kv, type ChargebackStatusWithLiterals as kw, type MembershipPaymentStatusWithLiterals as kx, type PaymentStatusWithLiterals as ky, type CanceledReasonWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, importOrder as l0, setOrderNumberCounter as l1, bulkDeleteImportedOrders as l2, preparePaymentCollection as l3, getPaymentCollectabilityStatus as l4, recordManuallyCollectedPayment as l5, paymentCollectionMarkOrderAsPaid as l6, paymentCollectionBulkMarkOrdersAsPaid as l7, getRefundabilityStatus as l8, paymentCollectionCreatePaymentGatewayOrder as l9, chargeMemberships as la, triggerRefund as lb, voidAuthorizedPayments as lc, captureAuthorizedPayments as ld, getOrder as le, createOrder as lf, updateOrder as lg, bulkUpdateOrders as lh, updateOrderLineItem as li, addActivity as lj, addActivities as lk, updateActivity as ll, deleteActivity as lm, cancelOrder as ln, updateOrderStatus as lo, aggregateOrders as lp, bulkUpdateOrderTags as lq, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };
10850
+ export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, RefundableStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountReason as aD, LineItemQuantityChangeType as aE, ActivityType as aF, OrderActivityTypeEnumActivityType as aG, AttributionSource as aH, ChannelType as aI, AdditionalFeeSource as aJ, OrderActionType as aK, SpecificItemsCouponBehavior as aL, ChargeType as aM, VersioningMode as aN, DeltaPaymentOptionType as aO, InventoryAction as aP, WebhookIdentityType as aQ, PreviewEmailType as aR, State as aS, SiteCreatedContext as aT, Namespace as aU, DeleteStatus as aV, Origin as aW, ScheduledAction as aX, DurationUnit as aY, PaymentCollectabilityStatus as aZ, PredefinedPaymentMethod as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type CrossBorderPriceAdjustment as b$, NonRefundableReason as b0, ManuallyRefundableReason as b1, RestockType as b2, TransactionStatus as b3, AuthorizationCaptureStatus as b4, AuthorizationVoidStatus as b5, Reason as b6, ActionType as b7, ChargebackStatus as b8, MembershipPaymentStatus as b9, type ItemType as bA, type ItemTypeItemTypeDataOneOf as bB, type RestockLocation as bC, type ItemTaxFullDetails as bD, type LineItemTaxInfo as bE, type LineItemTaxBreakdown as bF, type DigitalFile as bG, type SubscriptionInfo as bH, type SubscriptionTitle as bI, type SubscriptionDescription as bJ, type SubscriptionSettings as bK, type FreeTrialPeriod as bL, type BillingSettings as bM, type BillingAdjustment as bN, type BillingAdjustmentPriceSummary as bO, type CyclePriceOverride as bP, type PriceDescription as bQ, type LocationAndQuantity as bR, type TaxableAddress as bS, type TaxableAddressTaxableAddressDataOneOf as bT, type DecimalQuantity as bU, type DecimalQuantityUnitOneOf as bV, type TranslatableString as bW, type ExtendedFields as bX, type ModifierGroup as bY, type ItemModifier as bZ, type ServiceProperties as b_, PaymentStatus as ba, CanceledReason as bb, DeclinedReason as bc, VoidedReason as bd, RefundStatus as be, SortOrder as bf, OrderApprovalStrategy as bg, Placement as bh, SubdivisionType as bi, SourceType as bj, CustomFieldGroup as bk, ValueType as bl, DepositType as bm, InvoiceStatus as bn, type OrderLineItem as bo, type ProductName as bp, type CatalogReference as bq, type DescriptionLine as br, type DescriptionLineValueOneOf as bs, type DescriptionLineDescriptionLineValueOneOf as bt, type DescriptionLineName as bu, type PlainTextValue as bv, type Color as bw, type FocalPoint as bx, type PhysicalProperties as by, type Dimensions as bz, type SetOrderNumberCounterApplicationErrors as c, type RefundedPayment as c$, type BuyerInfo as c0, type BuyerInfoIdOneOf as c1, type CurrencyConversionDetails as c2, type CrossBorderRepricing as c3, type PriceSummary as c4, type AddressWithContact as c5, type Address as c6, type StreetAddress as c7, type AddressLocation as c8, type FullAddressContactDetails as c9, type MerchantComment as cA, type OrderRefunded as cB, type OrderCreatedFromExchange as cC, type NewExchangeOrderCreated as cD, type LineItemExchangeData as cE, type DraftOrderChangesApplied as cF, type OrderChange as cG, type OrderChangeValueOneOf as cH, type LineItemChanges as cI, type LineItemQuantityChange as cJ, type LineItemPriceChange as cK, type LineItemProductNameChange as cL, type LineItemDescriptionLineChange as cM, type LineItemModifiersChange as cN, type ManagedLineItem as cO, type ManagedDiscount as cP, type TranslatedValue as cQ, type LineItemAmount as cR, type ManagedAdditionalFee as cS, type TotalPriceChange as cT, type ShippingInformationChange as cU, type ShippingInformation as cV, type SavedPaymentMethod as cW, type AuthorizedPaymentCreated as cX, type AuthorizedPaymentCaptured as cY, type AuthorizedPaymentVoided as cZ, type RefundInitiated as c_, type VatId as ca, type V1ShippingInformation as cb, type DeliveryLogistics as cc, type DeliveryLogisticsAddressOneOf as cd, type PickupDetails as ce, type PickupAddress as cf, type DeliveryTimeSlot as cg, type ShippingPrice as ch, type ShippingRegion as ci, type TaxSummary as cj, type OrderTaxInfo as ck, type OrderTaxBreakdown as cl, type CrossBorderCalculation as cm, type AppliedDiscount as cn, type AppliedDiscountDiscountSourceOneOf as co, type Coupon as cp, type MerchantDiscount as cq, type MerchantDiscountMerchantDiscountReasonOneOf as cr, type DiscountRule as cs, type DiscountRuleName as ct, type LineItemDiscount as cu, type ItemCombination as cv, type ItemCombinationLineItem as cw, type Activity as cx, type ActivityContentOneOf as cy, type CustomActivity as cz, type PreparePaymentCollectionOptions as d, type ImportedOrderDeleted as d$, type RefundedPaymentKindOneOf as d0, type RegularPaymentRefund as d1, type GiftCardPaymentRefund as d2, type MembershipPaymentRefund as d3, type PaymentRefunded as d4, type PaymentRefundFailed as d5, type RefundedAsStoreCredit as d6, type PaymentPending as d7, type PaymentPendingPaymentDetailsOneOf as d8, type RegularPayment as d9, type Location as dA, type OrderSettings as dB, type OrderSettingsAllowedActionsOneOf as dC, type OrderSettingsEditableByOneOf as dD, type CustomAllowedActions as dE, type OwnerApps as dF, type FormInfo as dG, type FormIdentifier as dH, type PlatformFeeSummary as dI, type PlatformFee as dJ, type UpdateInternalDocumentsEvent as dK, type UpdateInternalDocumentsEventOperationOneOf as dL, type InternalDocument as dM, type InternalDocumentUpdateOperation as dN, type DeleteByIdsOperation as dO, type DeleteByFilterOperation as dP, type InternalDocumentUpdateByFilterOperation as dQ, type InternalUpdateExistingOperation as dR, type VersionedDocumentUpdateOperation as dS, type VersionedDeleteByIdsOperation as dT, type VersionedDocumentId as dU, type OrderApproved as dV, type OrdersExperiments as dW, type OrderRejectedEventOrderRejected as dX, type OrderItemsRestocked as dY, type V1RestockItem as dZ, type OrderImported as d_, type RegularPaymentPaymentMethodDetailsOneOf as da, type CreditCardDetails as db, type PaymentCanceled as dc, type PaymentCanceledPaymentDetailsOneOf as dd, type PaymentDeclined as de, type PaymentDeclinedPaymentDetailsOneOf as df, type ReceiptCreated as dg, type ReceiptCreatedReceiptInfoOneOf as dh, type WixReceipt as di, type ExternalReceipt as dj, type ReceiptSent as dk, type ReceiptSentReceiptInfoOneOf as dl, type ChargebackCreated as dm, type ChargebackReversed as dn, type CreatedBy as dp, type CreatedByStringOneOf as dq, type ChannelInfo as dr, type CustomField as ds, type BalanceSummary as dt, type Balance as du, type CashRounding as dv, type AdditionalFee as dw, type FulfillmentStatusesAggregate as dx, type Tags as dy, type TagList as dz, type PreparePaymentCollectionResponse as e, type LineItemRefund as e$, type PaymentStatusUpdated as e0, type FulfillmentStatusUpdated as e1, type OrderCanceledEventOrderCanceled as e2, type OrderDeltasCommitted as e3, type CommittedDiffs as e4, type CommittedDiffsShippingUpdateInfoOneOf as e5, type ItemChangedDetails as e6, type OrderLineItemChangedDetails as e7, type DecimalQuantityUpdate as e8, type CrossBorderAdjustmentUpdate as e9, type SendBuyerConfirmationEmailRequest as eA, type SendBuyerConfirmationEmailResponse as eB, type SendBuyerPaymentsReceivedEmailRequest as eC, type SendBuyerPaymentsReceivedEmailResponse as eD, type SendBuyerPickupConfirmationEmailRequest as eE, type SendBuyerPickupConfirmationEmailResponse as eF, type BulkSendBuyerPickupConfirmationEmailsRequest as eG, type BulkSendBuyerPickupConfirmationEmailsResponse as eH, type SendBuyerShippingConfirmationEmailRequest as eI, type SendBuyerShippingConfirmationEmailResponse as eJ, type BulkSendBuyerShippingConfirmationEmailsRequest as eK, type BulkSendBuyerShippingConfirmationEmailsResponse as eL, type SendMerchantOrderReceivedNotificationRequest as eM, type SendMerchantOrderReceivedNotificationResponse as eN, type SendCancelRefundEmailRequest as eO, type SendCancelRefundEmailResponse as eP, type SendRefundEmailRequest as eQ, type SendRefundEmailResponse as eR, type SendFulfillmentEmailRequest as eS, type SendFulfillmentEmailResponse as eT, type SendMerchantOrderReceivedPushRequest as eU, type SendMerchantOrderReceivedPushResponse as eV, type PreviewEmailByTypeRequest as eW, type PreviewEmailByTypeResponse as eX, type PreviewRefundEmailRequest as eY, type RefundDetails as eZ, type RefundItem as e_, type LineItemDelta as ea, type LineItemDeltaDeltaOneOf as eb, type AppliedDiscountDelta as ec, type AppliedDiscountDeltaDeltaOneOf as ed, type AdditionalFeeDelta as ee, type AdditionalFeeDeltaDeltaOneOf as ef, type DraftOrderCommitSettings as eg, type InventoryUpdateDetails as eh, type TriggerReindexRequest as ei, type TriggerReindexResponse as ej, type DomainEvent as ek, type DomainEventBodyOneOf as el, type EntityCreatedEvent as em, type RestoreInfo as en, type EntityUpdatedEvent as eo, type EntityDeletedEvent as ep, type ActionEvent as eq, type Empty as er, type TriggerReindexOrderRequest as es, type MessageEnvelope as et, type IdentificationData as eu, type IdentificationDataIdOneOf as ev, type AccountInfo as ew, type ImportOrderRequest as ex, type SetOrderNumberCounterRequest as ey, type BulkDeleteImportedOrdersRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type UserDefinedPaymentMethodNameKindOneOf as f$, type AdditionalFeeRefund as f0, type ShippingRefund as f1, type PreviewRefundEmailResponse as f2, type PreviewCancelEmailRequest as f3, type PreviewCancelEmailResponse as f4, type PreviewCancelRefundEmailRequest as f5, type PreviewCancelRefundEmailResponse as f6, type PreviewBuyerPaymentsReceivedEmailRequest as f7, type PreviewBuyerPaymentsReceivedEmailResponse as f8, type PreviewBuyerConfirmationEmailRequest as f9, type SiteUrlChanged as fA, type SitePurgedExternally as fB, type OdeditorAssigned as fC, type OdeditorUnassigned as fD, type PicassoAssigned as fE, type PicassoUnassigned as fF, type WixelAssigned as fG, type WixelUnassigned as fH, type StudioTwoAssigned as fI, type StudioTwoUnassigned as fJ, type UserDomainMediaEnabled as fK, type UserDomainMediaDisabled as fL, type EditorlessAssigned as fM, type EditorlessUnassigned as fN, type HasCustomEmailConfigurationsRequest as fO, type HasCustomEmailConfigurationsResponse as fP, type AddToAutomationMigrationPopulationRequest as fQ, type AddToAutomationMigrationPopulationResponse as fR, type IsInAutomationMigrationPopulationRequest as fS, type IsInAutomationMigrationPopulationResponse as fT, type PreparePaymentCollectionRequest as fU, type RedirectUrls as fV, type DelayedCaptureSettings as fW, type Duration as fX, type GetPaymentCollectabilityStatusRequest as fY, type RecordManuallyCollectedPaymentRequest as fZ, type UserDefinedPaymentMethodName as f_, type PreviewBuyerConfirmationEmailResponse as fa, type PreviewBuyerPickupConfirmationEmailRequest as fb, type PreviewBuyerPickupConfirmationEmailResponse as fc, type PreviewShippingConfirmationEmailRequest as fd, type PreviewShippingConfirmationEmailResponse as fe, type PreviewResendDownloadLinksEmailRequest as ff, type PreviewResendDownloadLinksEmailResponse as fg, type MetaSiteSpecialEvent as fh, type MetaSiteSpecialEventPayloadOneOf as fi, type Asset as fj, type SiteCreated as fk, type SiteTransferred as fl, type SiteDeleted as fm, type DeleteContext as fn, type SiteUndeleted as fo, type SitePublished as fp, type SiteUnpublished as fq, type SiteMarkedAsTemplate as fr, type SiteMarkedAsWixSite as fs, type ServiceProvisioned as ft, type ServiceRemoved as fu, type SiteRenamed as fv, type SiteHardDeleted as fw, type NamespaceChanged as fx, type StudioAssigned as fy, type StudioUnassigned as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type DiffmatokyPayload as g$, type RecordManuallyCollectedPaymentResponse as g0, type MarkOrderAsPaidRequest as g1, type BulkMarkOrdersAsPaidRequest as g2, type BulkOrderResult as g3, type ItemMetadata as g4, type ApplicationError as g5, type BulkActionMetadata as g6, type GetRefundabilityStatusRequest as g7, type Refundability as g8, type RefundabilityAdditionalRefundabilityInfoOneOf as g9, type MembershipPaymentDetails as gA, type FutureMembershipDetails as gB, type WixReceiptInfo as gC, type ExternalReceiptInfo as gD, type CashRoundingDetails as gE, type CanceledStatusDetails as gF, type DeclinedStatusDetails as gG, type VoidedStatusDetails as gH, type PaymentStatusDetails as gI, type PaymentStatusDetailsStatusDetailsOneOf as gJ, type Refund as gK, type RefundTransaction as gL, type RefundStatusInfo as gM, type AggregatedRefundSummary as gN, type RefundItemsBreakdown as gO, type LineItemRefundSummary as gP, type CalculateRefundRequest as gQ, type CalculateRefundItemRequest as gR, type CalculateRefundResponse as gS, type CalculateRefundItemResponse as gT, type VoidAuthorizedPaymentsRequest as gU, type CaptureAuthorizedPaymentsRequest as gV, type ChargeSavedPaymentMethodRequest as gW, type ChargeSavedPaymentMethodResponse as gX, type V1TriggerReindexRequest as gY, type V1TriggerReindexResponse as gZ, type V1TriggerReindexOrderRequest as g_, type CreatePaymentGatewayOrderRequest as ga, type ChargedBy as gb, type ChargeMembershipsRequest as gc, type MembershipChargeItem as gd, type MembershipName as ge, type ChargeMembershipsResponse as gf, type TriggerRefundRequest as gg, type RefundSideEffects as gh, type RestockInfo as gi, type RestockItem as gj, type OrderTransactions as gk, type Payment as gl, type PaymentPaymentDetailsOneOf as gm, type PaymentReceiptInfoOneOf as gn, type PaymentStatusDetailsOneOf as go, type RegularPaymentDetails as gp, type RegularPaymentDetailsPaymentMethodDetailsOneOf as gq, type CreditCardPaymentMethodDetails as gr, type AuthorizationDetails as gs, type AuthorizationCapture as gt, type AuthorizationActionFailureDetails as gu, type AuthorizationVoid as gv, type V1ScheduledAction as gw, type Chargeback as gx, type PaymentMethodName as gy, type GiftCardPaymentDetails as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type OrderPlaced as h$, type ErrorInformation as h0, type GetOrderRequest as h1, type GetOrderResponse as h2, type InternalQueryOrdersRequest as h3, type PlatformQuery as h4, type PlatformQueryPagingMethodOneOf as h5, type Sorting as h6, type PlatformPaging as h7, type CursorPaging as h8, type InternalQueryOrdersResponse as h9, type ArchiveOrderResponse as hA, type BulkArchiveOrdersRequest as hB, type BulkArchiveOrdersResponse as hC, type BulkArchiveOrdersByFilterRequest as hD, type BulkArchiveOrdersByFilterResponse as hE, type UnArchiveOrderRequest as hF, type UnArchiveOrderResponse as hG, type BulkUnArchiveOrdersRequest as hH, type BulkUnArchiveOrdersResponse as hI, type BulkUnArchiveOrdersByFilterRequest as hJ, type BulkUnArchiveOrdersByFilterResponse as hK, type UpdateBuyerInfoRequest as hL, type BuyerInfoUpdate as hM, type UpdateBuyerInfoResponse as hN, type UpdateBuyerEmailRequest as hO, type UpdateBuyerEmailResponse as hP, type UpdateOrderShippingAddressRequest as hQ, type UpdateOrderShippingAddressResponse as hR, type UpdateBillingContactDetailsRequest as hS, type UpdateBillingContactDetailsResponse as hT, type UpdateOrderLineItemRequest as hU, type UpdateOrderLineItemsRequest as hV, type MaskedOrderLineItem as hW, type UpdateOrderLineItemsResponse as hX, type AddInternalActivityRequest as hY, type InternalActivity as hZ, type InternalActivityContentOneOf as h_, type PlatformPagingMetadata as ha, type Cursors as hb, type QueryOrderRequest as hc, type QueryOrderResponse as hd, type SearchOrdersRequest as he, type CursorSearch as hf, type CursorSearchPagingMethodOneOf as hg, type CursorPagingMetadata as hh, type CreateOrderRequest as hi, type OrderCreationSettings as hj, type OrderCreationSettingsEditableByOneOf as hk, type OrderCreateNotifications as hl, type CreateOrderResponse as hm, type UpdateOrderRequest as hn, type UpdateOrderResponse as ho, type BulkUpdateOrdersRequest as hp, type CommitDeltasRequest as hq, type DraftOrderDiffs as hr, type DraftOrderDiffsShippingUpdateInfoOneOf as hs, type DraftOrderDiffsBuyerUpdateInfoOneOf as ht, type DraftOrderDiffsBillingUpdateInfoOneOf as hu, type DraftOrderDiffsRecipientUpdateInfoOneOf as hv, type V1LineItemDelta as hw, type V1LineItemDeltaDeltaOneOf as hx, type CommitDeltasResponse as hy, type ArchiveOrderRequest as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type BulkUpdateOrderTagsResult as i$, type OrderPaid as i0, type OrderFulfilled as i1, type OrderNotFulfilled as i2, type OrderCanceled as i3, type DownloadLinkSent as i4, type TrackingNumberAdded as i5, type TrackingNumberEdited as i6, type TrackingLinkAdded as i7, type ShippingConfirmationEmailSent as i8, type InvoiceAdded as i9, type BulkMarkAsFulfilledResponse as iA, type BulkMarkAsFulfilledByFilterRequest as iB, type BulkMarkAsFulfilledByFilterResponse as iC, type MarkAsUnfulfilledRequest as iD, type MarkAsUnfulfilledResponse as iE, type BulkMarkAsUnfulfilledRequest as iF, type BulkMarkAsUnfulfilledResponse as iG, type BulkMarkAsUnfulfilledByFilterRequest as iH, type BulkMarkAsUnfulfilledByFilterResponse as iI, type BulkSetBusinessLocationRequest as iJ, type BulkSetBusinessLocationResponse as iK, type BulkSetBusinessLocationResult as iL, type V1MarkOrderAsPaidRequest as iM, type V1MarkOrderAsPaidResponse as iN, type V1BulkMarkOrdersAsPaidRequest as iO, type V1BulkMarkOrdersAsPaidResponse as iP, type V1CreatePaymentGatewayOrderRequest as iQ, type V1CreatePaymentGatewayOrderResponse as iR, type GetShipmentsRequest as iS, type GetShipmentsResponse as iT, type AggregateOrdersRequest as iU, type DecrementItemsQuantityRequest as iV, type DecrementData as iW, type DecrementItemsQuantityResponse as iX, type BulkUpdateOrderTagsRequest as iY, type TagsTags as iZ, type TagsTagList as i_, type InvoiceSent as ia, type FulfillerEmailSent as ib, type ShippingAddressEdited as ic, type EmailEdited as id, type PickupReadyEmailSent as ie, type OrderPartiallyPaid as ig, type OrderPending as ih, type OrderRejected as ii, type AddInternalActivityResponse as ij, type AddActivityRequest as ik, type PublicActivityContentOneOf as il, type AddActivitiesRequest as im, type UpdateActivityRequest as io, type DeleteActivityRequest as ip, type UpdateLineItemsDescriptionLinesRequest as iq, type LineItemUpdate as ir, type UpdateLineItemsDescriptionLinesResponse as is, type MarkOrderAsSeenByHumanRequest as it, type MarkOrderAsSeenByHumanResponse as iu, type CancelOrderRequest as iv, type UpdateOrderStatusRequest as iw, type MarkAsFulfilledRequest as ix, type MarkAsFulfilledResponse as iy, type BulkMarkAsFulfilledRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type WeightUnitWithLiterals as j$, type SendOrderUpdatedDomainEventRequest as j0, type SendOrderUpdatedDomainEventResponse as j1, type Task as j2, type TaskKey as j3, type TaskAction as j4, type TaskActionActionOneOf as j5, type Complete as j6, type Cancel as j7, type Reschedule as j8, type InvoiceSentEvent as j9, type CalculatedTax as jA, type Payments as jB, type InvoicesPayment as jC, type MetaData as jD, type InvoiceDynamicPriceTotals as jE, type CustomFieldValue as jF, type Value as jG, type Deposit as jH, type BaseEventMetadata as jI, type EventMetadata as jJ, type AccountInfoMetadata as jK, type OrderSearchSpec as jL, utils as jM, type DescriptionLineTypeWithLiterals as jN, type DimensionsUnitWithLiterals as jO, type ItemTypePresetWithLiterals as jP, type PaymentOptionTypeWithLiterals as jQ, type JurisdictionTypeWithLiterals as jR, type SubscriptionFrequencyWithLiterals as jS, type ProductPeriodAlignmentWithLiterals as jT, type AdjustmentTypeWithLiterals as jU, type TaxableAddressTypeWithLiterals as jV, type MeasurementUnitWithLiterals as jW, type RepriceStatusWithLiterals as jX, type BaseRateSourceWithLiterals as jY, type PaymentStatusEnumPaymentStatusWithLiterals as jZ, type FulfillmentStatusWithLiterals as j_, type IdAndVersion as ja, type InvoiceFields as jb, type Customer as jc, type Email as jd, type QuotesAddress as je, type AddressDescription as jf, type Phone as jg, type Company as jh, type CommonAddress as ji, type CommonAddressStreetOneOf as jj, type Subdivision as jk, type StandardDetails as jl, type ShippingContactDetails as jm, type InvoiceDates as jn, type LineItems as jo, type LineItem as jp, type BigDecimalWrapper as jq, type LineItemTax as jr, type Source as js, type LineItemMetaData as jt, type Locale as ju, type TotalPrice as jv, type ItemizedFee as jw, type Discount as jx, type DiscountOneDiscountTypeOneOf as jy, type CalculatedTaxes as jz, type GetRefundabilityStatusResponse as k, onOrderUpdated as k$, type VatTypeWithLiterals as k0, type PickupMethodWithLiterals as k1, type CrossBorderNotApplicableReasonWithLiterals as k2, type CrossBorderRepricingModeWithLiterals as k3, type DiscountTypeWithLiterals as k4, type DiscountReasonWithLiterals as k5, type LineItemQuantityChangeTypeWithLiterals as k6, type ActivityTypeWithLiterals as k7, type OrderActivityTypeEnumActivityTypeWithLiterals as k8, type AttributionSourceWithLiterals as k9, type ReasonWithLiterals as kA, type ActionTypeWithLiterals as kB, type ChargebackStatusWithLiterals as kC, type MembershipPaymentStatusWithLiterals as kD, type PaymentStatusWithLiterals as kE, type CanceledReasonWithLiterals as kF, type DeclinedReasonWithLiterals as kG, type VoidedReasonWithLiterals as kH, type RefundStatusWithLiterals as kI, type SortOrderWithLiterals as kJ, type OrderApprovalStrategyWithLiterals as kK, type PlacementWithLiterals as kL, type SubdivisionTypeWithLiterals as kM, type SourceTypeWithLiterals as kN, type CustomFieldGroupWithLiterals as kO, type ValueTypeWithLiterals as kP, type DepositTypeWithLiterals as kQ, type InvoiceStatusWithLiterals as kR, type CommonSearchWithEntityContext as kS, onOrderApproved as kT, onOrderCanceled as kU, onOrderCommitted as kV, onOrderCreated as kW, onOrderFulfilled as kX, onOrderImported as kY, onOrderImportedOrderDeleted as kZ, onOrderPaymentStatusUpdated as k_, type ChannelTypeWithLiterals as ka, type AdditionalFeeSourceWithLiterals as kb, type OrderActionTypeWithLiterals as kc, type SpecificItemsCouponBehaviorWithLiterals as kd, type ChargeTypeWithLiterals as ke, type VersioningModeWithLiterals as kf, type DeltaPaymentOptionTypeWithLiterals as kg, type InventoryActionWithLiterals as kh, type WebhookIdentityTypeWithLiterals as ki, type PreviewEmailTypeWithLiterals as kj, type StateWithLiterals as kk, type SiteCreatedContextWithLiterals as kl, type NamespaceWithLiterals as km, type DeleteStatusWithLiterals as kn, type OriginWithLiterals as ko, type ScheduledActionWithLiterals as kp, type DurationUnitWithLiterals as kq, type PaymentCollectabilityStatusWithLiterals as kr, type PredefinedPaymentMethodWithLiterals as ks, type RefundableStatusWithLiterals as kt, type NonRefundableReasonWithLiterals as ku, type ManuallyRefundableReasonWithLiterals as kv, type RestockTypeWithLiterals as kw, type TransactionStatusWithLiterals as kx, type AuthorizationCaptureStatusWithLiterals as ky, type AuthorizationVoidStatusWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, importOrder as l0, setOrderNumberCounter as l1, bulkDeleteImportedOrders as l2, preparePaymentCollection as l3, getPaymentCollectabilityStatus as l4, recordManuallyCollectedPayment as l5, paymentCollectionMarkOrderAsPaid as l6, paymentCollectionBulkMarkOrdersAsPaid as l7, getRefundabilityStatus as l8, paymentCollectionCreatePaymentGatewayOrder as l9, chargeMemberships as la, triggerRefund as lb, voidAuthorizedPayments as lc, captureAuthorizedPayments as ld, getOrder as le, createOrder as lf, updateOrder as lg, bulkUpdateOrders as lh, updateOrderLineItem as li, addActivity as lj, addActivities as lk, updateActivity as ll, deleteActivity as lm, cancelOrder as ln, updateOrderStatus as lo, aggregateOrders as lp, bulkUpdateOrderTags as lq, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };