@wix/auto_sdk_ecom_orders 1.0.318 → 1.0.320

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