@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
@@ -1,4 +1,4 @@
1
- import { ex as ImportOrderRequest$1, I as ImportOrderResponse$1, ey as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, ez as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, eD as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, eH as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, eI as RecordManuallyCollectedPaymentRequest$1, eL as RecordManuallyCollectedPaymentResponse$1, eM as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, eN as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, eS as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, eV as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, eX as ChargeMembershipsRequest$1, e_ as ChargeMembershipsResponse$1, e$ as TriggerRefundRequest$1, p as TriggerRefundResponse$1, fI as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fJ as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, h1 as GetOrderRequest$1, h2 as GetOrderResponse$1, he as SearchOrdersRequest$1, x as SearchOrdersResponse$1, hi as CreateOrderRequest$1, hm as CreateOrderResponse$1, hn as UpdateOrderRequest$1, ho as UpdateOrderResponse$1, hp as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hU as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ik as AddActivityRequest$1, N as AddActivityResponse$1, im as AddActivitiesRequest$1, W as AddActivitiesResponse$1, io as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ip as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, iv as CancelOrderRequest$1, a0 as CancelOrderResponse$1, iw as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iU as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iY as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-CaNCF4JV.js';
1
+ import { ex as ImportOrderRequest$1, I as ImportOrderResponse$1, ey as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, ez as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fU as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fY as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fZ as RecordManuallyCollectedPaymentRequest$1, g0 as RecordManuallyCollectedPaymentResponse$1, g1 as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, g2 as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, g7 as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, ga as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, gc as ChargeMembershipsRequest$1, gf as ChargeMembershipsResponse$1, gg as TriggerRefundRequest$1, p as TriggerRefundResponse$1, gU as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gV as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, h2 as GetOrderRequest$1, h3 as GetOrderResponse$1, hf as SearchOrdersRequest$1, x as SearchOrdersResponse$1, hj as CreateOrderRequest$1, hn as CreateOrderResponse$1, ho as UpdateOrderRequest$1, hp as UpdateOrderResponse$1, hq as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hV as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, il as AddActivityRequest$1, N as AddActivityResponse$1, io as AddActivitiesRequest$1, W as AddActivitiesResponse$1, ip as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, iq as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, iw as CancelOrderRequest$1, a0 as CancelOrderResponse$1, ix as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iV as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iZ as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-BNIqP3GR.js';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -950,10 +950,16 @@ interface DigitalFile {
950
950
  interface SubscriptionInfo {
951
951
  /**
952
952
  * Subscription ID.
953
+ *
954
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
955
+ * 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).
953
956
  * @format GUID
954
957
  */
955
958
  id?: string | null;
956
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
959
+ /**
960
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
961
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
962
+ */
957
963
  cycleNumber?: number;
958
964
  /**
959
965
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -1029,7 +1035,7 @@ interface SubscriptionDescription {
1029
1035
  translated?: string | null;
1030
1036
  }
1031
1037
  interface SubscriptionSettings {
1032
- /** Frequency of recurring payment. */
1038
+ /** Frequency unit of the billing cycle. */
1033
1039
  frequency?: SubscriptionFrequencyWithLiterals;
1034
1040
  /**
1035
1041
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -1037,16 +1043,20 @@ interface SubscriptionSettings {
1037
1043
  * @max 3650
1038
1044
  */
1039
1045
  interval?: number | null;
1040
- /** Whether subscription is renewed automatically at the end of each period. */
1046
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
1041
1047
  autoRenewal?: boolean;
1042
1048
  /**
1043
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1049
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
1044
1050
  * @min 1
1045
1051
  */
1046
1052
  billingCycles?: number | null;
1047
- /** Whether to allow the customer to cancel the subscription. */
1053
+ /** Whether the buyer can cancel the subscription. */
1048
1054
  enableCustomerCancellation?: boolean;
1049
- /** Period until first cycle starts. If None => no free trial */
1055
+ /**
1056
+ * Free trial period before the first billing cycle starts.
1057
+ *
1058
+ * Returned only when the subscription has a free trial.
1059
+ */
1050
1060
  freeTrialPeriod?: FreeTrialPeriod;
1051
1061
  /**
1052
1062
  * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
@@ -1075,7 +1085,7 @@ declare enum SubscriptionFrequency {
1075
1085
  /** @enumType */
1076
1086
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1077
1087
  interface FreeTrialPeriod {
1078
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
1088
+ /** Frequency unit of the free trial period. */
1079
1089
  frequency?: SubscriptionFrequencyWithLiterals;
1080
1090
  /**
1081
1091
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -2498,6 +2508,11 @@ interface OrderChange extends OrderChangeValueOneOf {
2498
2508
  additionalFeeRemoved?: ManagedAdditionalFee;
2499
2509
  totalPriceChanged?: TotalPriceChange;
2500
2510
  shippingInformationChanged?: ShippingInformationChange;
2511
+ /**
2512
+ * Prices recalculated because the destination tax region of at least one line item changed. The destination country may be the same before and after.
2513
+ * @internal
2514
+ */
2515
+ pricesRecalculatedForDestination?: PricesRecalculatedForDestination;
2501
2516
  }
2502
2517
  /** @oneof */
2503
2518
  interface OrderChangeValueOneOf {
@@ -2510,6 +2525,11 @@ interface OrderChangeValueOneOf {
2510
2525
  additionalFeeRemoved?: ManagedAdditionalFee;
2511
2526
  totalPriceChanged?: TotalPriceChange;
2512
2527
  shippingInformationChanged?: ShippingInformationChange;
2528
+ /**
2529
+ * Prices recalculated because the destination tax region of at least one line item changed. The destination country may be the same before and after.
2530
+ * @internal
2531
+ */
2532
+ pricesRecalculatedForDestination?: PricesRecalculatedForDestination;
2513
2533
  }
2514
2534
  interface LineItemChanges {
2515
2535
  /**
@@ -4765,2328 +4785,2346 @@ interface BulkDeleteImportedOrdersResponse {
4765
4785
  */
4766
4786
  jobId?: string;
4767
4787
  }
4768
- interface V1TriggerReindexRequest {
4788
+ interface SendBuyerConfirmationEmailRequest {
4769
4789
  /** @format GUID */
4770
- metasiteId?: string;
4790
+ orderId?: string;
4791
+ }
4792
+ interface SendBuyerConfirmationEmailResponse {
4793
+ }
4794
+ interface SendBuyerPaymentsReceivedEmailRequest {
4771
4795
  /**
4772
4796
  * @minLength 1
4773
4797
  * @maxLength 100
4774
- * @maxSize 100
4775
4798
  */
4776
- orderIds?: string[];
4799
+ orderId?: string;
4777
4800
  }
4778
- interface V1TriggerReindexResponse {
4801
+ interface SendBuyerPaymentsReceivedEmailResponse {
4779
4802
  }
4780
- interface V1TriggerReindexOrderRequest {
4781
- /** @format GUID */
4782
- metasiteId?: string;
4803
+ interface SendBuyerPickupConfirmationEmailRequest {
4783
4804
  /**
4784
4805
  * @minLength 1
4785
4806
  * @maxLength 100
4786
4807
  */
4787
4808
  orderId?: string;
4788
4809
  }
4789
- interface PreparePaymentCollectionRequest {
4810
+ interface SendBuyerPickupConfirmationEmailResponse {
4811
+ }
4812
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4813
+ /**
4814
+ * IDs of orders to send pickup emails for.
4815
+ * @minSize 1
4816
+ * @maxSize 300
4817
+ */
4818
+ orderIds?: string[];
4819
+ }
4820
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4821
+ }
4822
+ interface SendBuyerShippingConfirmationEmailRequest {
4790
4823
  /**
4791
- * Ecom order ID.
4792
4824
  * @minLength 1
4793
4825
  * @maxLength 100
4794
4826
  */
4795
- ecomOrderId: string;
4796
- /** Amount to collect */
4797
- amount: Price;
4827
+ orderId?: string;
4828
+ }
4829
+ interface SendBuyerShippingConfirmationEmailResponse {
4830
+ }
4831
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4798
4832
  /**
4799
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4800
- * Existing payment gateway order will be updated with a new amount.
4801
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4833
+ * IDs of orders to send pickup emails for.
4834
+ * @minSize 1
4835
+ * @maxSize 300
4802
4836
  */
4803
- paymentGatewayOrderId?: string | null;
4837
+ orderIds?: string[];
4838
+ }
4839
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4840
+ }
4841
+ interface SendMerchantOrderReceivedNotificationRequest {
4804
4842
  /**
4805
- * Whether to delay capture of the payment.
4806
- * Default: false
4807
- * @deprecated Whether to delay capture of the payment.
4808
- * Default: false
4809
- * @replacedBy delayed_capture_settings.scheduled_action
4810
- * @targetRemovalDate 2024-09-30
4843
+ * @minLength 1
4844
+ * @maxLength 100
4811
4845
  */
4812
- delayedCapture?: boolean;
4846
+ orderId?: string;
4847
+ }
4848
+ interface SendMerchantOrderReceivedNotificationResponse {
4849
+ }
4850
+ interface SendCancelRefundEmailRequest {
4813
4851
  /**
4814
- * Specifies whether payment collection is initiated by Merchant or User of User
4815
- * Default: `true`
4816
- * @internal
4852
+ * The ID of order that is canceled/refunded
4853
+ * @minLength 1
4854
+ * @maxLength 100
4817
4855
  */
4818
- merchantInitiated?: boolean | null;
4856
+ orderId?: string;
4819
4857
  /**
4820
- * Redirect urls which are used to return buyer to third party system.
4821
- * @internal
4858
+ * Personal note added to the email (optional)
4859
+ * @minLength 1
4860
+ * @maxLength 1000
4822
4861
  */
4823
- redirectUrls?: RedirectUrls;
4824
- /** Delayed capture payment settings */
4825
- delayedCaptureSettings?: DelayedCaptureSettings;
4826
- }
4827
- interface RedirectUrls {
4862
+ customMessage?: string | null;
4863
+ /** Refund amount */
4864
+ refundAmount?: Price;
4828
4865
  /**
4829
- * URL to redirect buyer in case of approved (successful) transaction
4830
- * @format WEB_URL
4866
+ * Refund ID. (Optional)
4867
+ * @format GUID
4831
4868
  */
4832
- successUrl?: string | null;
4869
+ refundId?: string | null;
4870
+ }
4871
+ interface SendCancelRefundEmailResponse {
4872
+ }
4873
+ interface SendRefundEmailRequest {
4833
4874
  /**
4834
- * URL to redirect buyer in case of buyer canceled the transaction
4835
- * @format WEB_URL
4875
+ * The ID of order that is refunded
4876
+ * @format GUID
4836
4877
  */
4837
- cancelUrl?: string | null;
4878
+ orderId?: string;
4838
4879
  /**
4839
- * URL to redirect buyer in case of failed/rejected transaction
4840
- * @format WEB_URL
4880
+ * Refund ID
4881
+ * @format GUID
4841
4882
  */
4842
- errorUrl?: string | null;
4883
+ refundId?: string;
4843
4884
  /**
4844
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4845
- * @format WEB_URL
4885
+ * Personal note added to the email (optional)
4886
+ * @minLength 1
4887
+ * @maxLength 1000
4846
4888
  */
4847
- pendingUrl?: string | null;
4889
+ customMessage?: string | null;
4848
4890
  }
4849
- interface DelayedCaptureSettings {
4850
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4851
- scheduledAction?: ScheduledActionWithLiterals;
4852
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4853
- delayDuration?: Duration;
4891
+ interface SendRefundEmailResponse {
4854
4892
  }
4855
- declare enum ScheduledAction {
4856
- /** Whether payment will be auto-voided when duration passes */
4857
- VOID = "VOID",
4858
- /** Whether payment will be auto-captured when duration passes */
4859
- CAPTURE = "CAPTURE"
4893
+ interface SendFulfillmentEmailRequest {
4894
+ /** @format GUID */
4895
+ orderId?: string;
4896
+ /** @format GUID */
4897
+ fulfillerId?: string;
4860
4898
  }
4861
- /** @enumType */
4862
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4863
- interface Duration {
4899
+ interface SendFulfillmentEmailResponse {
4900
+ }
4901
+ interface SendMerchantOrderReceivedPushRequest {
4864
4902
  /**
4865
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4866
- * @min 1
4903
+ * @minLength 1
4904
+ * @maxLength 100
4867
4905
  */
4868
- count?: number;
4869
- /** Duration unit: MINUTES, HOURS and DAYS */
4870
- unit?: DurationUnitWithLiterals;
4906
+ orderId?: string;
4871
4907
  }
4872
- declare enum DurationUnit {
4873
- MINUTES = "MINUTES",
4874
- HOURS = "HOURS",
4875
- DAYS = "DAYS"
4908
+ interface SendMerchantOrderReceivedPushResponse {
4909
+ }
4910
+ interface PreviewEmailByTypeRequest {
4911
+ emailType?: PreviewEmailTypeWithLiterals;
4912
+ }
4913
+ declare enum PreviewEmailType {
4914
+ ORDER_PLACED = "ORDER_PLACED",
4915
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4916
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4917
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4876
4918
  }
4877
4919
  /** @enumType */
4878
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4879
- interface PreparePaymentCollectionResponse {
4880
- /** Payment gateway order id which is associated with given payment */
4881
- paymentGatewayOrderId?: string;
4920
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4921
+ interface PreviewEmailByTypeResponse {
4922
+ emailPreview?: string;
4882
4923
  }
4883
- interface GetPaymentCollectabilityStatusRequest {
4924
+ interface PreviewRefundEmailRequest {
4884
4925
  /**
4885
- * Ecom order ID.
4886
4926
  * @minLength 1
4887
4927
  * @maxLength 100
4888
4928
  */
4889
- ecomOrderId: string;
4890
- }
4891
- interface GetPaymentCollectabilityStatusResponse {
4892
- /** Payment collectability status */
4893
- status?: PaymentCollectabilityStatusWithLiterals;
4894
- /** Collectable order amount */
4895
- amount?: Price;
4929
+ orderId?: string;
4930
+ /** Refund amount */
4931
+ refundAmount?: Price;
4932
+ /** Refund business details */
4933
+ details?: RefundDetails;
4896
4934
  /**
4897
- * Whether authorization supported
4898
- * @internal
4935
+ * Personal note added to the email (optional)
4936
+ * @minLength 1
4937
+ * @maxLength 1000
4899
4938
  */
4900
- authorizationSupported?: boolean;
4939
+ customMessage?: string | null;
4901
4940
  /**
4902
- * Whether custom amount is supported for payment collection
4903
- * @internal
4941
+ * Refund ID. (Optional)
4942
+ * @format GUID
4904
4943
  */
4905
- customAmountSupported?: boolean;
4906
- }
4907
- declare enum PaymentCollectabilityStatus {
4908
- UNKNOWN = "UNKNOWN",
4909
- COLLECTABLE = "COLLECTABLE",
4910
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4911
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4912
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4913
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4914
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4915
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4916
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4917
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4918
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4919
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4920
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4944
+ refundId?: string | null;
4921
4945
  }
4922
- /** @enumType */
4923
- 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';
4924
- interface RecordManuallyCollectedPaymentRequest {
4946
+ /** Business model of a refund request */
4947
+ interface RefundDetails {
4925
4948
  /**
4926
- * Order ID.
4927
- * @minLength 1
4928
- * @maxLength 100
4949
+ * Order line item IDs and quantities that were refunded.
4950
+ * @maxSize 300
4929
4951
  */
4930
- orderId: string;
4931
- /** Amount to be recorded as approved manual payment for given order */
4932
- amount: Price;
4952
+ items?: RefundItem[];
4953
+ /** Whether the shipping fee was also refunded. */
4954
+ shippingIncluded?: boolean;
4933
4955
  /**
4934
- * Payment method name provided by user.
4935
- *
4936
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4937
- * @internal
4956
+ * Reason for the refund, provided by customer (optional).
4957
+ * @maxLength 200
4938
4958
  */
4939
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4940
- }
4941
- /**
4942
- * User-defined payment method name.
4943
- * Allows specifying either a predefined type or a custom name.
4944
- */
4945
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4946
- /** Predefined payment method. */
4947
- predefined?: PredefinedPaymentMethodWithLiterals;
4959
+ reason?: string | null;
4948
4960
  /**
4949
- * Custom payment method name provided by user.
4950
- *
4951
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4952
- * @minLength 1
4953
- * @maxLength 150
4961
+ * Line items that were refunded.
4962
+ * @maxSize 300
4954
4963
  */
4955
- custom?: string | null;
4956
- }
4957
- /** @oneof */
4958
- interface UserDefinedPaymentMethodNameKindOneOf {
4959
- /** Predefined payment method. */
4960
- predefined?: PredefinedPaymentMethodWithLiterals;
4964
+ lineItems?: LineItemRefund[];
4961
4965
  /**
4962
- * Custom payment method name provided by user.
4963
- *
4964
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4965
- * @minLength 1
4966
- * @maxLength 150
4966
+ * Additional fees that were refunded.
4967
+ * @maxSize 100
4967
4968
  */
4968
- custom?: string | null;
4969
- }
4970
- /** Predefined payment method types for offline/manual payments. */
4971
- declare enum PredefinedPaymentMethod {
4972
- /** Cash payment. */
4973
- CASH = "CASH",
4974
- /** Bank transfer. */
4975
- BANK_TRANSFER = "BANK_TRANSFER",
4976
- /** Payment by check. */
4977
- CHECK = "CHECK"
4978
- }
4979
- /** @enumType */
4980
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4981
- interface RecordManuallyCollectedPaymentResponse {
4969
+ additionalFees?: AdditionalFeeRefund[];
4970
+ /** Shipping amount that was refunded. */
4971
+ shipping?: ShippingRefund;
4982
4972
  }
4983
- interface MarkOrderAsPaidRequest {
4973
+ interface RefundItem {
4984
4974
  /**
4985
- * Ecom order ID.
4986
- * @minLength 1
4987
- * @maxLength 100
4975
+ * Line item ID the refunded line item.
4976
+ * @format GUID
4988
4977
  */
4989
- ecomOrderId: string;
4978
+ lineItemId?: string;
4990
4979
  /**
4991
- * Payment method name provided by user.
4992
- *
4993
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4994
- * @internal
4980
+ * Line item quantity refunded.
4981
+ * @min 1
4982
+ * @max 100000
4995
4983
  */
4996
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4997
- }
4998
- interface MarkOrderAsPaidResponse {
4999
- /** Updated order. */
5000
- order?: Order;
4984
+ quantity?: number;
5001
4985
  }
5002
- interface BulkMarkOrdersAsPaidRequest {
4986
+ interface LineItemRefund {
5003
4987
  /**
5004
- * IDs of orders to mark as paid.
5005
- * @minSize 1
5006
- * @maxSize 100
5007
- * @minLength 1
5008
- * @maxLength 100
4988
+ * Line item ID.
4989
+ * @format GUID
4990
+ * @immutable
5009
4991
  */
5010
- ecomOrderIds: string[];
5011
- }
5012
- interface BulkMarkOrdersAsPaidResponse {
4992
+ lineItemId?: string;
5013
4993
  /**
5014
- * Items updated by the bulk action.
5015
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4994
+ * Refund quantity.
4995
+ * @min 1
4996
+ * @max 100000
4997
+ * @immutable
5016
4998
  */
5017
- results?: BulkOrderResult[];
5018
- /** Bulk action metadata. */
5019
- bulkActionMetadata?: BulkActionMetadata;
4999
+ quantity?: number;
5020
5000
  }
5021
- interface BulkOrderResult {
5022
- /** Item metadata. */
5023
- itemMetadata?: ItemMetadata;
5001
+ interface AdditionalFeeRefund {
5024
5002
  /**
5025
- * Updated order.
5026
- *
5027
- * Returned when `returnFullEntity = true`.
5003
+ * Additional fee ID.
5004
+ * @format GUID
5005
+ * @immutable
5028
5006
  */
5029
- item?: Order;
5030
- }
5031
- interface ItemMetadata {
5032
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5033
- id?: string | null;
5034
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5035
- originalIndex?: number;
5036
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5037
- success?: boolean;
5038
- /** Details about the error in case of failure. */
5039
- error?: ApplicationError;
5040
- }
5041
- interface ApplicationError {
5042
- /** Error code. */
5043
- code?: string;
5044
- /** Description of the error. */
5045
- description?: string;
5046
- /** Data related to the error. */
5047
- data?: Record<string, any> | null;
5048
- }
5049
- interface BulkActionMetadata {
5050
- /** Number of items that were successfully processed. */
5051
- totalSuccesses?: number;
5052
- /** Number of items that couldn't be processed. */
5053
- totalFailures?: number;
5054
- /** Number of failures without details because detailed failure threshold was exceeded. */
5055
- undetailedFailures?: number;
5056
- }
5057
- interface GetRefundabilityStatusRequest {
5007
+ additionalFeeId?: string;
5058
5008
  /**
5059
- * Order ID.
5060
- * @minLength 1
5061
- * @maxLength 100
5009
+ * Refund amount.
5010
+ * @immutable
5062
5011
  */
5063
- ecomOrderId: string;
5012
+ amount?: Price;
5064
5013
  }
5065
- interface GetRefundabilityStatusResponse {
5066
- /**
5067
- * Refundability details.
5068
- * @maxSize 300
5069
- */
5070
- refundabilities?: Refundability[];
5014
+ interface ShippingRefund {
5071
5015
  /**
5072
- * Whether the order supports refunding per item.
5073
- * @deprecated
5016
+ * Refund amount.
5017
+ * @immutable
5074
5018
  */
5075
- refundablePerItem?: boolean;
5076
- }
5077
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5078
- /** Reason why payment is not refundable. */
5079
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5080
- /** Reason why payment is only refundable manually. */
5081
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5082
- /** Payment ID. */
5083
- paymentId?: string;
5084
- /** Payment refundability status. */
5085
- refundabilityStatus?: RefundableStatusWithLiterals;
5086
- /** Link to payment provider dashboard. */
5087
- providerLink?: string | null;
5088
- }
5089
- /** @oneof */
5090
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5091
- /** Reason why payment is not refundable. */
5092
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5093
- /** Reason why payment is only refundable manually. */
5094
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5095
- }
5096
- declare enum RefundableStatus {
5097
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5098
- MANUAL = "MANUAL",
5099
- REFUNDABLE = "REFUNDABLE"
5100
- }
5101
- /** @enumType */
5102
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5103
- declare enum NonRefundableReason {
5104
- NONE = "NONE",
5105
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5106
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5107
- INTERNAL_ERROR = "INTERNAL_ERROR",
5108
- NOT_PAID = "NOT_PAID",
5109
- ACCESS_DENIED = "ACCESS_DENIED",
5110
- ZERO_PRICE = "ZERO_PRICE",
5111
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5112
- PENDING_REFUND = "PENDING_REFUND",
5113
- FORBIDDEN = "FORBIDDEN",
5114
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5115
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5116
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5019
+ amount?: Price;
5117
5020
  }
5118
- /** @enumType */
5119
- 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';
5120
- declare enum ManuallyRefundableReason {
5121
- EXPIRED = "EXPIRED",
5122
- NOT_SUPPORTED = "NOT_SUPPORTED",
5123
- OFFLINE = "OFFLINE",
5124
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5021
+ interface PreviewRefundEmailResponse {
5022
+ emailPreview?: string;
5125
5023
  }
5126
- /** @enumType */
5127
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5128
- interface CreatePaymentGatewayOrderRequest {
5024
+ interface PreviewCancelEmailRequest {
5129
5025
  /**
5130
- * Ecom order ID.
5131
5026
  * @minLength 1
5132
5027
  * @maxLength 100
5133
5028
  */
5134
- ecomOrderId: string;
5135
- /** Information about the user who initiated the payment. */
5136
- chargedBy?: ChargedBy;
5137
- /**
5138
- * Whether to delay capture of the payment.
5139
- *
5140
- * Default: false
5141
- * @internal
5142
- */
5143
- delayedCapture?: boolean;
5144
- }
5145
- interface ChargedBy {
5146
- /**
5147
- * ID - id of the user who initiated the payment
5148
- * @format GUID
5149
- */
5150
- id?: string;
5029
+ orderId?: string;
5151
5030
  /**
5152
- * Full name - name of the user who initiated the payment
5031
+ * Personal note added to the email (optional)
5153
5032
  * @minLength 1
5154
- * @maxLength 200
5033
+ * @maxLength 1000
5155
5034
  */
5156
- fullName?: string | null;
5035
+ customMessage?: string | null;
5157
5036
  }
5158
- interface CreatePaymentGatewayOrderResponse {
5159
- /** ID of the order created in the payment gateway */
5160
- paymentGatewayOrderId?: string;
5037
+ interface PreviewCancelEmailResponse {
5038
+ emailPreview?: string;
5161
5039
  }
5162
- interface ChargeMembershipsRequest {
5040
+ interface PreviewCancelRefundEmailRequest {
5163
5041
  /**
5164
- * Order ID.
5165
5042
  * @minLength 1
5166
5043
  * @maxLength 100
5167
5044
  */
5168
- ecomOrderId: string;
5169
- /**
5170
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5171
- * but a user which is using the membership on behalf of the a member
5172
- * @format GUID
5173
- */
5174
- memberId: string;
5175
- /**
5176
- * List of items to be paid by memberships
5177
- * @minSize 1
5178
- * @maxSize 300
5179
- */
5180
- membershipCharges?: MembershipChargeItem[];
5181
- }
5182
- interface MembershipChargeItem {
5045
+ orderId?: string;
5183
5046
  /**
5184
- * The id of used membership
5047
+ * Personal note added to the email (optional)
5185
5048
  * @minLength 1
5186
- * @maxLength 100
5049
+ * @maxLength 1000
5187
5050
  */
5188
- membershipId?: string;
5051
+ customMessage?: string | null;
5052
+ /** Refund amount */
5053
+ refundAmount?: Price;
5189
5054
  /**
5190
- * ID of the application providing this payment option
5055
+ * Refund ID. (Optional)
5191
5056
  * @format GUID
5192
5057
  */
5193
- appId?: string;
5194
- /** The name of used membership */
5195
- membershipName?: MembershipName;
5196
- /** Additional data about this membership */
5197
- membershipAdditionalData?: Record<string, any> | null;
5198
- /** Catalog and item reference info. */
5199
- catalogReference?: CatalogReference;
5200
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5201
- serviceProperties?: ServiceProperties;
5202
- /**
5203
- * Usually would be the same as catalogReference.catalogItemId
5204
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5205
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5206
- * @minLength 1
5207
- * @maxLength 36
5208
- */
5209
- rootCatalogItemId?: string | null;
5210
- /**
5211
- * line item id of Checkout/Order line item
5212
- * @minLength 1
5213
- * @maxLength 100
5214
- */
5215
- lineItemId?: string;
5058
+ refundId?: string | null;
5216
5059
  }
5217
- interface MembershipName {
5218
- /**
5219
- * Membership name in the site's original language.
5220
- * @maxLength 100
5221
- */
5222
- original?: string;
5060
+ interface PreviewCancelRefundEmailResponse {
5061
+ emailPreview?: string;
5062
+ }
5063
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5064
+ }
5065
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
5066
+ emailPreview?: string;
5067
+ }
5068
+ interface PreviewBuyerConfirmationEmailRequest {
5069
+ }
5070
+ interface PreviewBuyerConfirmationEmailResponse {
5071
+ emailPreview?: string;
5072
+ }
5073
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5074
+ }
5075
+ interface PreviewBuyerPickupConfirmationEmailResponse {
5076
+ emailPreview?: string;
5077
+ }
5078
+ interface PreviewShippingConfirmationEmailRequest {
5079
+ }
5080
+ interface PreviewShippingConfirmationEmailResponse {
5081
+ emailPreview?: string;
5082
+ }
5083
+ interface PreviewResendDownloadLinksEmailRequest {
5084
+ }
5085
+ interface PreviewResendDownloadLinksEmailResponse {
5086
+ emailPreview?: string;
5087
+ }
5088
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5089
+ /** Emitted on a meta site creation. */
5090
+ siteCreated?: SiteCreated;
5091
+ /** Emitted on a meta site transfer completion. */
5092
+ siteTransferred?: SiteTransferred;
5093
+ /** Emitted on a meta site deletion. */
5094
+ siteDeleted?: SiteDeleted;
5095
+ /** Emitted on a meta site restoration. */
5096
+ siteUndeleted?: SiteUndeleted;
5097
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5098
+ sitePublished?: SitePublished;
5099
+ /** Emitted on a meta site unpublish. */
5100
+ siteUnpublished?: SiteUnpublished;
5101
+ /** Emitted when meta site is marked as template. */
5102
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5103
+ /** Emitted when meta site is marked as a WixSite. */
5104
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5105
+ /** Emitted when an application is provisioned (installed). */
5106
+ serviceProvisioned?: ServiceProvisioned;
5107
+ /** Emitted when an application is removed (uninstalled). */
5108
+ serviceRemoved?: ServiceRemoved;
5109
+ /** Emitted when meta site name (URL slug) is changed. */
5110
+ siteRenamedPayload?: SiteRenamed;
5111
+ /** Emitted when meta site was permanently deleted. */
5112
+ hardDeleted?: SiteHardDeleted;
5113
+ /** Emitted on a namespace change. */
5114
+ namespaceChanged?: NamespaceChanged;
5115
+ /** Emitted when Studio is attached. */
5116
+ studioAssigned?: StudioAssigned;
5117
+ /** Emitted when Studio is detached. */
5118
+ studioUnassigned?: StudioUnassigned;
5223
5119
  /**
5224
- * Membership name translated into the buyer's language.
5120
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5121
+ * the actual URL.
5225
5122
  *
5226
- * Default: The value of `original`
5227
- * @maxLength 100
5123
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5124
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5228
5125
  */
5229
- translated?: string | null;
5230
- }
5231
- interface ChargeMembershipsResponse {
5232
- }
5233
- interface TriggerRefundRequest {
5126
+ urlChanged?: SiteUrlChanged;
5127
+ /** Site is marked as PurgedExternally */
5128
+ sitePurgedExternally?: SitePurgedExternally;
5129
+ /** Emitted when Odeditor is attached. */
5130
+ odeditorAssigned?: OdeditorAssigned;
5131
+ /** Emitted when Odeditor is detached. */
5132
+ odeditorUnassigned?: OdeditorUnassigned;
5133
+ /** Emitted when Picasso is attached. */
5134
+ picassoAssigned?: PicassoAssigned;
5135
+ /** Emitted when Picasso is detached. */
5136
+ picassoUnassigned?: PicassoUnassigned;
5137
+ /** Emitted when Wixel is attached. */
5138
+ wixelAssigned?: WixelAssigned;
5139
+ /** Emitted when Wixel is detached. */
5140
+ wixelUnassigned?: WixelUnassigned;
5141
+ /** Emitted when StudioTwo is attached. */
5142
+ studioTwoAssigned?: StudioTwoAssigned;
5143
+ /** Emitted when StudioTwo is detached. */
5144
+ studioTwoUnassigned?: StudioTwoUnassigned;
5145
+ /** Emitted when media from user domain is enabled. */
5146
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5147
+ /** Emitted when media from user domain is disabled. */
5148
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5149
+ /** Emitted when Editorless is attached. */
5150
+ editorlessAssigned?: EditorlessAssigned;
5151
+ /** Emitted when Editorless is detached. */
5152
+ editorlessUnassigned?: EditorlessUnassigned;
5234
5153
  /**
5235
- * The order this refund related to
5236
- * @minLength 1
5237
- * @maxLength 100
5154
+ * A meta site id.
5155
+ * @format GUID
5238
5156
  */
5239
- ecomOrderId: string;
5157
+ metaSiteId?: string;
5158
+ /** A meta site version. Monotonically increasing. */
5159
+ version?: string;
5160
+ /** A timestamp of the event. */
5161
+ timestamp?: string;
5240
5162
  /**
5241
- * Refund operations information
5242
- * @minSize 1
5243
- * @maxSize 1
5163
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5164
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5165
+ * @maxSize 4000
5244
5166
  */
5245
- payments: PaymentRefund[];
5246
- /** Business model of a refund */
5247
- details?: RefundDetails;
5248
- /** Side effect details related to refund */
5249
- sideEffects?: RefundSideEffects;
5167
+ assets?: Asset[];
5250
5168
  }
5251
- interface PaymentRefund {
5169
+ /** @oneof */
5170
+ interface MetaSiteSpecialEventPayloadOneOf {
5171
+ /** Emitted on a meta site creation. */
5172
+ siteCreated?: SiteCreated;
5173
+ /** Emitted on a meta site transfer completion. */
5174
+ siteTransferred?: SiteTransferred;
5175
+ /** Emitted on a meta site deletion. */
5176
+ siteDeleted?: SiteDeleted;
5177
+ /** Emitted on a meta site restoration. */
5178
+ siteUndeleted?: SiteUndeleted;
5179
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5180
+ sitePublished?: SitePublished;
5181
+ /** Emitted on a meta site unpublish. */
5182
+ siteUnpublished?: SiteUnpublished;
5183
+ /** Emitted when meta site is marked as template. */
5184
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5185
+ /** Emitted when meta site is marked as a WixSite. */
5186
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5187
+ /** Emitted when an application is provisioned (installed). */
5188
+ serviceProvisioned?: ServiceProvisioned;
5189
+ /** Emitted when an application is removed (uninstalled). */
5190
+ serviceRemoved?: ServiceRemoved;
5191
+ /** Emitted when meta site name (URL slug) is changed. */
5192
+ siteRenamedPayload?: SiteRenamed;
5193
+ /** Emitted when meta site was permanently deleted. */
5194
+ hardDeleted?: SiteHardDeleted;
5195
+ /** Emitted on a namespace change. */
5196
+ namespaceChanged?: NamespaceChanged;
5197
+ /** Emitted when Studio is attached. */
5198
+ studioAssigned?: StudioAssigned;
5199
+ /** Emitted when Studio is detached. */
5200
+ studioUnassigned?: StudioUnassigned;
5252
5201
  /**
5253
- * Specific payment within the order to refund
5254
- * @format GUID
5202
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5203
+ * the actual URL.
5204
+ *
5205
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5206
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5255
5207
  */
5256
- paymentId?: string;
5257
- /** Refund amount. Not relevant for membership and gift card refunds. */
5258
- amount?: Price;
5208
+ urlChanged?: SiteUrlChanged;
5209
+ /** Site is marked as PurgedExternally */
5210
+ sitePurgedExternally?: SitePurgedExternally;
5211
+ /** Emitted when Odeditor is attached. */
5212
+ odeditorAssigned?: OdeditorAssigned;
5213
+ /** Emitted when Odeditor is detached. */
5214
+ odeditorUnassigned?: OdeditorUnassigned;
5215
+ /** Emitted when Picasso is attached. */
5216
+ picassoAssigned?: PicassoAssigned;
5217
+ /** Emitted when Picasso is detached. */
5218
+ picassoUnassigned?: PicassoUnassigned;
5219
+ /** Emitted when Wixel is attached. */
5220
+ wixelAssigned?: WixelAssigned;
5221
+ /** Emitted when Wixel is detached. */
5222
+ wixelUnassigned?: WixelUnassigned;
5223
+ /** Emitted when StudioTwo is attached. */
5224
+ studioTwoAssigned?: StudioTwoAssigned;
5225
+ /** Emitted when StudioTwo is detached. */
5226
+ studioTwoUnassigned?: StudioTwoUnassigned;
5227
+ /** Emitted when media from user domain is enabled. */
5228
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5229
+ /** Emitted when media from user domain is disabled. */
5230
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5231
+ /** Emitted when Editorless is attached. */
5232
+ editorlessAssigned?: EditorlessAssigned;
5233
+ /** Emitted when Editorless is detached. */
5234
+ editorlessUnassigned?: EditorlessUnassigned;
5235
+ }
5236
+ interface Asset {
5259
5237
  /**
5260
- * Whether refund is made externally and manually (on the payment provider's side)
5261
- * 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.
5262
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5238
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5239
+ * @maxLength 36
5263
5240
  */
5264
- externalRefund?: boolean;
5241
+ appDefId?: string;
5265
5242
  /**
5266
- * Gateway refund id. When param is present, new refund is not created.
5267
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5268
- * and all side effects from request will be executed.
5269
- * @internal
5270
- * @minLength 1
5271
- * @maxLength 100
5243
+ * An instance id. For legacy reasons may be UUID or a string.
5244
+ * @maxLength 200
5272
5245
  */
5273
- gatewayRefundId?: string | null;
5246
+ instanceId?: string;
5247
+ /** An application state. */
5248
+ state?: StateWithLiterals;
5274
5249
  }
5275
- /** Business model of a refund request */
5276
- interface RefundDetails {
5250
+ declare enum State {
5251
+ UNKNOWN = "UNKNOWN",
5252
+ ENABLED = "ENABLED",
5253
+ DISABLED = "DISABLED",
5254
+ PENDING = "PENDING",
5255
+ DEMO = "DEMO"
5256
+ }
5257
+ /** @enumType */
5258
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5259
+ interface SiteCreated {
5277
5260
  /**
5278
- * Order line item IDs and quantities that were refunded.
5279
- * @maxSize 300
5261
+ * A template identifier (empty if not created from a template).
5262
+ * @maxLength 36
5280
5263
  */
5281
- items?: RefundItem[];
5282
- /** Whether the shipping fee was also refunded. */
5283
- shippingIncluded?: boolean;
5264
+ originTemplateId?: string;
5284
5265
  /**
5285
- * Reason for the refund, provided by customer (optional).
5286
- * @maxLength 200
5266
+ * An account id of the owner.
5267
+ * @format GUID
5287
5268
  */
5288
- reason?: string | null;
5269
+ ownerId?: string;
5270
+ /** A context in which meta site was created. */
5271
+ context?: SiteCreatedContextWithLiterals;
5289
5272
  /**
5290
- * Line items that were refunded.
5291
- * @maxSize 300
5273
+ * A meta site id from which this site was created.
5274
+ *
5275
+ * In case of a creation from a template it's a template id.
5276
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5277
+ * @format GUID
5292
5278
  */
5293
- lineItems?: LineItemRefund[];
5279
+ originMetaSiteId?: string | null;
5294
5280
  /**
5295
- * Additional fees that were refunded.
5296
- * @maxSize 100
5281
+ * A meta site name (URL slug).
5282
+ * @maxLength 20
5297
5283
  */
5298
- additionalFees?: AdditionalFeeRefund[];
5299
- /** Shipping amount that was refunded. */
5300
- shipping?: ShippingRefund;
5284
+ siteName?: string;
5285
+ /** A namespace. */
5286
+ namespace?: NamespaceWithLiterals;
5301
5287
  }
5302
- interface RefundItem {
5288
+ declare enum SiteCreatedContext {
5289
+ /** A valid option, we don't expose all reasons why site might be created. */
5290
+ OTHER = "OTHER",
5291
+ /** A meta site was created from template. */
5292
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5293
+ /** A meta site was created by copying of the transfferred meta site. */
5294
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5295
+ /** A copy of existing meta site. */
5296
+ DUPLICATE = "DUPLICATE",
5297
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5298
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5299
+ /** deprecated A meta site was created for Flash editor. */
5300
+ FLASH = "FLASH"
5301
+ }
5302
+ /** @enumType */
5303
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5304
+ declare enum Namespace {
5305
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5306
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5307
+ WIX = "WIX",
5308
+ /** 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. */
5309
+ SHOUT_OUT = "SHOUT_OUT",
5310
+ /** 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. */
5311
+ ALBUMS = "ALBUMS",
5312
+ /** 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. */
5313
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5314
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5315
+ HOTELS = "HOTELS",
5316
+ /** 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. */
5317
+ CLUBS = "CLUBS",
5318
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5319
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5320
+ /**
5321
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5322
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5323
+ */
5324
+ DEV_SITE = "DEV_SITE",
5325
+ /** 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. */
5326
+ LOGOS = "LOGOS",
5327
+ /** 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. */
5328
+ VIDEO_MAKER = "VIDEO_MAKER",
5329
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5330
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5331
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5332
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5303
5333
  /**
5304
- * Line item ID the refunded line item.
5305
- * @format GUID
5334
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5335
+ *
5336
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5306
5337
  */
5307
- lineItemId?: string;
5338
+ HTML_DRAFT = "HTML_DRAFT",
5308
5339
  /**
5309
- * Line item quantity refunded.
5310
- * @min 1
5311
- * @max 100000
5340
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5341
+ * Will be accessible from Site List and will not have a website app.
5342
+ * Once the user attaches a site, the site will become a regular wixsite.
5312
5343
  */
5313
- quantity?: number;
5314
- }
5315
- interface LineItemRefund {
5344
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5345
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5346
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5347
+ /** It is to be used in the Business First efforts. */
5348
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5349
+ /** Bookings business flow with no site. */
5350
+ ANYWHERE = "ANYWHERE",
5351
+ /** Namespace for Headless Backoffice with no editor */
5352
+ HEADLESS = "HEADLESS",
5316
5353
  /**
5317
- * Line item ID.
5318
- * @format GUID
5319
- * @immutable
5354
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5355
+ * The site will be used for account level CSM feature for enterprise
5320
5356
  */
5321
- lineItemId?: string;
5357
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5358
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5359
+ RISE = "RISE",
5322
5360
  /**
5323
- * Refund quantity.
5324
- * @min 1
5325
- * @max 100000
5326
- * @immutable
5361
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5362
+ * There's a blank site behind the scene but it's blank).
5363
+ * The Mobile company will be the owner of this namespace.
5327
5364
  */
5328
- quantity?: number;
5329
- }
5330
- interface AdditionalFeeRefund {
5365
+ BRANDED_FIRST = "BRANDED_FIRST",
5366
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5367
+ NOWNIA = "NOWNIA",
5331
5368
  /**
5332
- * Additional fee ID.
5333
- * @format GUID
5334
- * @immutable
5369
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5370
+ * The Partners company owns this namespace.
5335
5371
  */
5336
- additionalFeeId?: string;
5372
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5373
+ /** Codux Headless Sites */
5374
+ CODUX = "CODUX",
5375
+ /** Bobb - AI Design Creator. */
5376
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5337
5377
  /**
5338
- * Refund amount.
5339
- * @immutable
5378
+ * Shared Blog Site is a unique single site across Enterprise account,
5379
+ * This site will hold all Blog posts related to the Marketing product.
5340
5380
  */
5341
- amount?: Price;
5342
- }
5343
- interface ShippingRefund {
5381
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5382
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5383
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5384
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5385
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5386
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5387
+ MIMIR = "MIMIR",
5388
+ /** Wix Twins platform. */
5389
+ TWINS = "TWINS",
5390
+ /** Wix Nano. */
5391
+ NANO = "NANO",
5392
+ /** Base44 headless sites. */
5393
+ BASE44 = "BASE44",
5394
+ /** Wix Channels Sites */
5395
+ CHANNELS = "CHANNELS",
5396
+ /** Nautilus platform. */
5397
+ NAUTILUS = "NAUTILUS",
5344
5398
  /**
5345
- * Refund amount.
5346
- * @immutable
5399
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5400
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5347
5401
  */
5348
- amount?: Price;
5349
- }
5350
- interface RefundSideEffects {
5351
- /** Inventory restock details as part of this refund. */
5352
- restockInfo?: RestockInfo;
5353
- /** Whether to send a refund confirmation email to the customer. */
5354
- sendOrderRefundedEmail?: boolean;
5402
+ SYMPHONY = "SYMPHONY",
5403
+ /** Nautilus platform app. */
5404
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5355
5405
  /**
5356
- * Custom message added to the refund confirmation email.
5357
- * @minLength 1
5358
- * @maxLength 1000
5406
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5407
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5359
5408
  */
5360
- customMessage?: string | null;
5361
- }
5362
- interface RestockInfo {
5363
- /** Restock type. */
5364
- type?: RestockTypeWithLiterals;
5409
+ VIBU = "VIBU",
5365
5410
  /**
5366
- * Deprecated, use items instead
5367
- * @internal
5368
- * @maxSize 300
5369
- * @deprecated
5411
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5412
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5413
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5414
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5370
5415
  */
5371
- lineItemIds?: string[];
5416
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5372
5417
  /**
5373
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5374
- * @maxSize 300
5418
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5419
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5375
5420
  */
5376
- items?: RestockItem[];
5377
- }
5378
- declare enum RestockType {
5379
- NO_ITEMS = "NO_ITEMS",
5380
- ALL_ITEMS = "ALL_ITEMS",
5381
- SOME_ITEMS = "SOME_ITEMS"
5421
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5382
5422
  }
5383
5423
  /** @enumType */
5384
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5385
- interface RestockItem {
5424
+ 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';
5425
+ /** Site transferred to another user. */
5426
+ interface SiteTransferred {
5386
5427
  /**
5387
- * ID of the line item being restocked.
5428
+ * A previous owner id (user that transfers meta site).
5388
5429
  * @format GUID
5389
5430
  */
5390
- lineItemId?: string;
5391
- /**
5392
- * Line item quantity being restocked.
5393
- * @min 1
5394
- * @max 100000
5395
- */
5396
- quantity?: number;
5431
+ oldOwnerId?: string;
5397
5432
  /**
5398
- * Per-location breakdown of restock quantities.
5399
- * @internal
5400
- * @maxSize 5
5433
+ * A new owner id (user that accepts meta site).
5434
+ * @format GUID
5401
5435
  */
5402
- restockLocations?: RestockLocation[];
5436
+ newOwnerId?: string;
5403
5437
  }
5404
- interface TriggerRefundResponse {
5405
- /** All order's transactions after the refunds were added */
5406
- orderTransactions?: OrderTransactions;
5407
- /** Created refund ID */
5408
- refundId?: string | null;
5409
- /** Payment ID's that the refund execution had failed for */
5410
- failedPaymentIds?: ItemMetadata[];
5438
+ /** Soft deletion of the meta site. Could be restored. */
5439
+ interface SiteDeleted {
5440
+ /** A deletion context. */
5441
+ deleteContext?: DeleteContext;
5411
5442
  }
5412
- /**
5413
- * A record of all payments and refunds associated with an order.
5414
- *
5415
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5416
- */
5417
- interface OrderTransactions {
5418
- /**
5419
- * Order ID.
5420
- * @format GUID
5421
- */
5422
- orderId?: string;
5443
+ interface DeleteContext {
5444
+ /** When the meta site was deleted. */
5445
+ dateDeleted?: Date | null;
5446
+ /** A status. */
5447
+ deleteStatus?: DeleteStatusWithLiterals;
5423
5448
  /**
5424
- * Record of payments made to the merchant.
5425
- * @maxSize 100
5449
+ * A reason (flow).
5450
+ * @maxLength 255
5426
5451
  */
5427
- payments?: Payment[];
5452
+ deleteOrigin?: string;
5428
5453
  /**
5429
- * Record of refunds made to the buyer.
5430
- * @maxSize 300
5454
+ * A service that deleted it.
5455
+ * @maxLength 255
5431
5456
  */
5432
- refunds?: Refund[];
5457
+ initiatorId?: string | null;
5433
5458
  }
5434
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5435
- /** Regular payment details. */
5436
- regularPaymentDetails?: RegularPaymentDetails;
5437
- /** Gift card payment details. */
5438
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5439
- /** Membership payment details. */
5440
- membershipPaymentDetails?: MembershipPaymentDetails;
5441
- /**
5442
- * Receipt created by Wix
5443
- * @internal
5444
- */
5445
- wixReceipt?: WixReceiptInfo;
5446
- /**
5447
- * Receipt created by an external system.
5448
- * @internal
5449
- */
5450
- externalReceipt?: ExternalReceiptInfo;
5451
- /** @internal */
5452
- canceled?: CanceledStatusDetails;
5453
- /** @internal */
5454
- declined?: DeclinedStatusDetails;
5455
- /** @internal */
5456
- voided?: VoidedStatusDetails;
5457
- /**
5458
- * Payment ID.
5459
- * @format GUID
5460
- * @readonly
5461
- */
5462
- id?: string | null;
5463
- /** 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. */
5464
- createdDate?: Date | null;
5465
- /**
5466
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5467
- * @readonly
5468
- */
5469
- updatedDate?: Date | null;
5470
- /** Payment amount. */
5471
- amount?: Price;
5472
- /**
5473
- * Whether refunds for this payment are disabled.
5474
- * + `true`: This payment is not refundable.
5475
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5476
- */
5477
- refundDisabled?: boolean;
5478
- /**
5479
- * Whether receipt generation is allowed for this payment.
5480
- * + `true`: This payment supports receipt generation.
5481
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5482
- * @readonly
5483
- */
5484
- supportReceiptGeneration?: boolean;
5485
- /** Details about cash rounding applied to this payment, when relevant. */
5486
- cashRounding?: CashRoundingDetails;
5459
+ declare enum DeleteStatus {
5460
+ UNKNOWN = "UNKNOWN",
5461
+ TRASH = "TRASH",
5462
+ DELETED = "DELETED",
5463
+ PENDING_PURGE = "PENDING_PURGE",
5464
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5465
+ }
5466
+ /** @enumType */
5467
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5468
+ /** Restoration of the meta site. */
5469
+ interface SiteUndeleted {
5470
+ }
5471
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5472
+ interface SitePublished {
5473
+ }
5474
+ interface SiteUnpublished {
5487
5475
  /**
5488
- * Overall payment status.
5489
- *
5490
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5476
+ * A list of URLs previously associated with the meta site.
5477
+ * @maxLength 4000
5478
+ * @maxSize 10000
5491
5479
  */
5492
- status?: PaymentStatusWithLiterals;
5480
+ urls?: string[];
5481
+ }
5482
+ interface SiteMarkedAsTemplate {
5483
+ }
5484
+ interface SiteMarkedAsWixSite {
5485
+ }
5486
+ /**
5487
+ * Represents a service provisioned a site.
5488
+ *
5489
+ * Note on `origin_instance_id`:
5490
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5491
+ * This is because of the following scenario:
5492
+ *
5493
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5494
+ * such as a product catalog. When you create a site from this template, you inherit this
5495
+ * default product catalog. However, if the template's product catalog is modified,
5496
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5497
+ * your site remains consistent with what you initially received and does not include any
5498
+ * changes made to the original template afterward.
5499
+ * To ensure this, the TPA on the template gets a new instance_id.
5500
+ */
5501
+ interface ServiceProvisioned {
5493
5502
  /**
5494
- * Detailed payment status information including gateway reason codes and status-specific details.
5495
- * @internal
5503
+ * Either UUID or EmbeddedServiceType.
5504
+ * @maxLength 36
5496
5505
  */
5497
- paymentStatusDetails?: PaymentStatusDetails;
5506
+ appDefId?: string;
5498
5507
  /**
5499
- * Location where the payment was processed.
5500
- * @internal
5501
- * @format GUID
5502
- * @immutable
5508
+ * Not only UUID. Something here could be something weird.
5509
+ * @maxLength 36
5503
5510
  */
5504
- locationId?: string | null;
5511
+ instanceId?: string;
5505
5512
  /**
5506
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5507
- * @format GUID
5513
+ * An instance id from which this instance is originated.
5514
+ * @maxLength 36
5508
5515
  */
5509
- chargeCorrelationId?: string | null;
5510
- }
5511
- /** @oneof */
5512
- interface PaymentPaymentDetailsOneOf {
5513
- /** Regular payment details. */
5514
- regularPaymentDetails?: RegularPaymentDetails;
5515
- /** Gift card payment details. */
5516
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5517
- /** Membership payment details. */
5518
- membershipPaymentDetails?: MembershipPaymentDetails;
5519
- }
5520
- /** @oneof */
5521
- interface PaymentReceiptInfoOneOf {
5516
+ originInstanceId?: string;
5522
5517
  /**
5523
- * Receipt created by Wix
5524
- * @internal
5518
+ * A version.
5519
+ * @maxLength 500
5525
5520
  */
5526
- wixReceipt?: WixReceiptInfo;
5521
+ version?: string | null;
5527
5522
  /**
5528
- * Receipt created by an external system.
5529
- * @internal
5523
+ * The origin meta site id
5524
+ * @format GUID
5530
5525
  */
5531
- externalReceipt?: ExternalReceiptInfo;
5532
- }
5533
- /** @oneof */
5534
- interface PaymentStatusDetailsOneOf {
5535
- /** @internal */
5536
- canceled?: CanceledStatusDetails;
5537
- /** @internal */
5538
- declined?: DeclinedStatusDetails;
5539
- /** @internal */
5540
- voided?: VoidedStatusDetails;
5526
+ originMetaSiteId?: string | null;
5541
5527
  }
5542
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5543
- /** Credit card details. */
5544
- creditCardDetails?: CreditCardPaymentMethodDetails;
5528
+ interface ServiceRemoved {
5545
5529
  /**
5546
- * Wix Payments order ID.
5547
- * @maxLength 100
5530
+ * Either UUID or EmbeddedServiceType.
5531
+ * @maxLength 36
5548
5532
  */
5549
- paymentOrderId?: string | null;
5533
+ appDefId?: string;
5550
5534
  /**
5551
- * Payment gateway's transaction ID.
5552
- * This field is only returned when the value of `offline_payment` is `false`.
5553
- * @maxLength 100
5535
+ * Not only UUID. Something here could be something weird.
5536
+ * @maxLength 36
5554
5537
  */
5555
- gatewayTransactionId?: string | null;
5538
+ instanceId?: string;
5556
5539
  /**
5557
- * Payment method.
5558
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5559
- * Non-exhaustive list of supported values:
5560
- * + `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`
5561
- * @maxLength 150
5562
- * @deprecated Payment method.
5563
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5564
- * Non-exhaustive list of supported values:
5565
- * + `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`
5566
- * @replacedBy payment_method_name
5567
- * @targetRemovalDate 2026-07-01
5540
+ * A version.
5541
+ * @maxLength 500
5568
5542
  */
5569
- paymentMethod?: string | null;
5543
+ version?: string | null;
5544
+ }
5545
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5546
+ interface SiteRenamed {
5570
5547
  /**
5571
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5572
- * @maxLength 100
5548
+ * A new meta site name (URL slug).
5549
+ * @maxLength 20
5573
5550
  */
5574
- providerTransactionId?: string | null;
5575
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5576
- offlinePayment?: boolean;
5551
+ newSiteName?: string;
5577
5552
  /**
5578
- * Payment status.
5579
- * @deprecated Payment status.
5580
- * @replacedBy payment.status
5581
- * @targetRemovalDate 2026-11-01
5553
+ * A previous meta site name (URL slug).
5554
+ * @maxLength 255
5582
5555
  */
5583
- status?: TransactionStatusWithLiterals;
5584
- /** Whether there is a payment agreement that allows for future charges. */
5585
- savedPaymentMethod?: boolean;
5586
- /** Authorization details. */
5587
- authorizationDetails?: AuthorizationDetails;
5556
+ oldSiteName?: string;
5557
+ }
5558
+ /**
5559
+ * Hard deletion of the meta site.
5560
+ *
5561
+ * Could not be restored. Therefore it's desirable to cleanup data.
5562
+ */
5563
+ interface SiteHardDeleted {
5564
+ /** A deletion context. */
5565
+ deleteContext?: DeleteContext;
5566
+ }
5567
+ interface NamespaceChanged {
5568
+ /** A previous namespace. */
5569
+ oldNamespace?: NamespaceWithLiterals;
5570
+ /** A new namespace. */
5571
+ newNamespace?: NamespaceWithLiterals;
5572
+ }
5573
+ /** Assigned Studio editor */
5574
+ interface StudioAssigned {
5575
+ }
5576
+ /** Unassigned Studio editor */
5577
+ interface StudioUnassigned {
5578
+ }
5579
+ /**
5580
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5581
+ *
5582
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5583
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5584
+ *
5585
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5586
+ */
5587
+ interface SiteUrlChanged {
5588
+ }
5589
+ /**
5590
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5591
+ * Consumed by other teams to remove relevant data.
5592
+ */
5593
+ interface SitePurgedExternally {
5588
5594
  /**
5589
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5590
- * @internal
5591
- * @maxLength 300
5595
+ * @maxLength 2048
5596
+ * @maxSize 100
5597
+ * @deprecated
5598
+ * @targetRemovalDate 2025-04-15
5592
5599
  */
5593
- paymentProvider?: string | null;
5600
+ appDefId?: string[];
5601
+ }
5602
+ /** Assigned Odeditor */
5603
+ interface OdeditorAssigned {
5604
+ }
5605
+ /** Unassigned Odeditor */
5606
+ interface OdeditorUnassigned {
5607
+ }
5608
+ /** Assigned Picasso editor */
5609
+ interface PicassoAssigned {
5610
+ }
5611
+ /** Unassigned Picasso */
5612
+ interface PicassoUnassigned {
5613
+ }
5614
+ /** Assigned Wixel */
5615
+ interface WixelAssigned {
5616
+ }
5617
+ /** Unassigned Wixel */
5618
+ interface WixelUnassigned {
5619
+ }
5620
+ /** Assigned StudioTwo */
5621
+ interface StudioTwoAssigned {
5622
+ }
5623
+ /** Unassigned StudioTwo */
5624
+ interface StudioTwoUnassigned {
5625
+ }
5626
+ /** Media from user domain is enabled. */
5627
+ interface UserDomainMediaEnabled {
5628
+ }
5629
+ /** Media from user domain is disabled. */
5630
+ interface UserDomainMediaDisabled {
5631
+ }
5632
+ /** Assigned Editorless */
5633
+ interface EditorlessAssigned {
5634
+ }
5635
+ /** Unassigned Editorless */
5636
+ interface EditorlessUnassigned {
5637
+ }
5638
+ interface HasCustomEmailConfigurationsRequest {
5639
+ }
5640
+ interface HasCustomEmailConfigurationsResponse {
5641
+ hasCustomConfigurations?: boolean;
5642
+ }
5643
+ interface AddToAutomationMigrationPopulationRequest {
5644
+ /** When true, sends custom email configurations to automation system via email */
5645
+ sendCustomEmailConfigs?: boolean;
5646
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5647
+ origin?: OriginWithLiterals;
5648
+ }
5649
+ declare enum Origin {
5650
+ OPT_IN = "OPT_IN",
5651
+ MIGRATION = "MIGRATION"
5652
+ }
5653
+ /** @enumType */
5654
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5655
+ interface AddToAutomationMigrationPopulationResponse {
5656
+ success?: boolean;
5657
+ }
5658
+ interface IsInAutomationMigrationPopulationRequest {
5659
+ }
5660
+ interface IsInAutomationMigrationPopulationResponse {
5661
+ inPopulation?: boolean;
5662
+ }
5663
+ interface PreparePaymentCollectionRequest {
5594
5664
  /**
5595
- * Record of chargebacks made by the buyer.
5596
- * @maxSize 6
5665
+ * Ecom order ID.
5666
+ * @minLength 1
5667
+ * @maxLength 100
5597
5668
  */
5598
- chargebacks?: Chargeback[];
5669
+ ecomOrderId: string;
5670
+ /** Amount to collect */
5671
+ amount: Price;
5599
5672
  /**
5600
- * Payment method ID.
5601
- * @internal
5602
- * @maxLength 36
5673
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5674
+ * Existing payment gateway order will be updated with a new amount.
5675
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
5603
5676
  */
5604
- paymentMethodId?: string | null;
5605
- /** Platform fee amount associated with this payment. */
5606
- platformFee?: Price;
5677
+ paymentGatewayOrderId?: string | null;
5607
5678
  /**
5608
- * Payment method with buyer and optional owner translations.
5609
- * Non-exhaustive list of supported values:
5610
- * + `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`
5679
+ * Whether to delay capture of the payment.
5680
+ * Default: false
5681
+ * @deprecated Whether to delay capture of the payment.
5682
+ * Default: false
5683
+ * @replacedBy delayed_capture_settings.scheduled_action
5684
+ * @targetRemovalDate 2024-09-30
5611
5685
  */
5612
- paymentMethodName?: PaymentMethodName;
5613
- }
5614
- /** @oneof */
5615
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5616
- /** Credit card details. */
5617
- creditCardDetails?: CreditCardPaymentMethodDetails;
5618
- }
5619
- declare enum TransactionStatus {
5620
- UNDEFINED = "UNDEFINED",
5621
- APPROVED = "APPROVED",
5622
- PENDING = "PENDING",
5623
- PENDING_MERCHANT = "PENDING_MERCHANT",
5624
- CANCELED = "CANCELED",
5625
- DECLINED = "DECLINED",
5626
- REFUNDED = "REFUNDED",
5627
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5628
- AUTHORIZED = "AUTHORIZED",
5629
- VOIDED = "VOIDED"
5630
- }
5631
- /** @enumType */
5632
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5633
- interface CreditCardPaymentMethodDetails {
5686
+ delayedCapture?: boolean;
5634
5687
  /**
5635
- * The last 4 digits of the card number.
5636
- * @maxLength 4
5688
+ * Specifies whether payment collection is initiated by Merchant or User of User
5689
+ * Default: `true`
5690
+ * @internal
5637
5691
  */
5638
- lastFourDigits?: string | null;
5692
+ merchantInitiated?: boolean | null;
5639
5693
  /**
5640
- * Card issuer's brand.
5641
- * @maxLength 100
5694
+ * Redirect urls which are used to return buyer to third party system.
5695
+ * @internal
5642
5696
  */
5643
- brand?: string | null;
5697
+ redirectUrls?: RedirectUrls;
5698
+ /** Delayed capture payment settings */
5699
+ delayedCaptureSettings?: DelayedCaptureSettings;
5644
5700
  }
5645
- interface AuthorizationDetails {
5701
+ interface RedirectUrls {
5646
5702
  /**
5647
- * Whether the authorized payment is of a delayed capture.
5648
- * @readonly
5703
+ * URL to redirect buyer in case of approved (successful) transaction
5704
+ * @format WEB_URL
5649
5705
  */
5650
- delayedCapture?: boolean;
5651
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5652
- authorizedDate?: Date | null;
5706
+ successUrl?: string | null;
5653
5707
  /**
5654
- * List of captures associated with payment
5655
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5656
- * @maxSize 1
5708
+ * URL to redirect buyer in case of buyer canceled the transaction
5709
+ * @format WEB_URL
5657
5710
  */
5658
- captures?: AuthorizationCapture[];
5659
- /** Void associated with payment */
5660
- void?: AuthorizationVoid;
5661
- /** Scheduled action for this transaction */
5662
- scheduledAction?: V1ScheduledAction;
5663
- }
5664
- interface AuthorizationCapture {
5711
+ cancelUrl?: string | null;
5665
5712
  /**
5666
- * Capture ID.
5667
- * @format GUID
5668
- * @readonly
5713
+ * URL to redirect buyer in case of failed/rejected transaction
5714
+ * @format WEB_URL
5669
5715
  */
5670
- id?: string | null;
5671
- /** Status of this capture action */
5672
- status?: AuthorizationCaptureStatusWithLiterals;
5716
+ errorUrl?: string | null;
5673
5717
  /**
5674
- * Amount of this capture
5675
- * @immutable
5718
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5719
+ * @format WEB_URL
5676
5720
  */
5677
- amount?: Price;
5678
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5679
- createdDate?: Date | null;
5680
- /** In case of status is FAILED may contain failure details */
5681
- failureDetails?: AuthorizationActionFailureDetails;
5682
- }
5683
- declare enum AuthorizationCaptureStatus {
5684
- /** Capture operation still in progress. */
5685
- PENDING = "PENDING",
5686
- /** Capture operation succeeded. */
5687
- SUCCEEDED = "SUCCEEDED",
5688
- /** Capture operation failed. */
5689
- FAILED = "FAILED"
5690
- }
5691
- /** @enumType */
5692
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5693
- interface AuthorizationActionFailureDetails {
5694
- /** @maxLength 100 */
5695
- failureCode?: string;
5696
- }
5697
- interface AuthorizationVoid {
5698
- /** Status of this void action */
5699
- status?: AuthorizationVoidStatusWithLiterals;
5700
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5701
- voidedDate?: Date | null;
5702
- /** In case of status is FAILED may contain failure details */
5703
- failureDetails?: AuthorizationActionFailureDetails;
5704
- /** Reason of void action */
5705
- reason?: ReasonWithLiterals;
5706
- }
5707
- declare enum AuthorizationVoidStatus {
5708
- /** Void operation still in progress. */
5709
- PENDING = "PENDING",
5710
- /** Void operation succeeded. */
5711
- SUCCEEDED = "SUCCEEDED",
5712
- /** Void operation failed. */
5713
- FAILED = "FAILED"
5714
- }
5715
- /** @enumType */
5716
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5717
- /** Reason the authorization was voided. */
5718
- declare enum Reason {
5719
- /** Authorization was voided by user. */
5720
- MANUAL = "MANUAL",
5721
- /** Authorization passed execution date. */
5722
- SCHEDULED = "SCHEDULED"
5721
+ pendingUrl?: string | null;
5723
5722
  }
5724
- /** @enumType */
5725
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5726
- interface V1ScheduledAction {
5727
- /** Type of the action. */
5728
- actionType?: ActionTypeWithLiterals;
5729
- /** The date and time of the action. */
5730
- executionDate?: Date | null;
5723
+ interface DelayedCaptureSettings {
5724
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5725
+ scheduledAction?: ScheduledActionWithLiterals;
5726
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5727
+ delayDuration?: Duration;
5731
5728
  }
5732
- declare enum ActionType {
5729
+ declare enum ScheduledAction {
5730
+ /** Whether payment will be auto-voided when duration passes */
5733
5731
  VOID = "VOID",
5732
+ /** Whether payment will be auto-captured when duration passes */
5734
5733
  CAPTURE = "CAPTURE"
5735
5734
  }
5736
5735
  /** @enumType */
5737
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5738
- interface Chargeback {
5739
- /**
5740
- * Chargeback ID.
5741
- * @format GUID
5742
- * @readonly
5743
- * @immutable
5744
- */
5745
- id?: string;
5746
- /**
5747
- * 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.
5748
- * @readonly
5749
- * @immutable
5750
- */
5751
- createdDate?: Date | null;
5736
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5737
+ interface Duration {
5752
5738
  /**
5753
- * 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.
5754
- * @readonly
5739
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5740
+ * @min 1
5755
5741
  */
5756
- updatedDate?: Date | null;
5742
+ count?: number;
5743
+ /** Duration unit: MINUTES, HOURS and DAYS */
5744
+ unit?: DurationUnitWithLiterals;
5745
+ }
5746
+ declare enum DurationUnit {
5747
+ MINUTES = "MINUTES",
5748
+ HOURS = "HOURS",
5749
+ DAYS = "DAYS"
5750
+ }
5751
+ /** @enumType */
5752
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5753
+ interface PreparePaymentCollectionResponse {
5754
+ /** Payment gateway order id which is associated with given payment */
5755
+ paymentGatewayOrderId?: string;
5756
+ }
5757
+ interface GetPaymentCollectabilityStatusRequest {
5757
5758
  /**
5758
- * Amount.
5759
- * @readonly
5760
- * @immutable
5759
+ * Ecom order ID.
5760
+ * @minLength 1
5761
+ * @maxLength 100
5761
5762
  */
5763
+ ecomOrderId: string;
5764
+ }
5765
+ interface GetPaymentCollectabilityStatusResponse {
5766
+ /** Payment collectability status */
5767
+ status?: PaymentCollectabilityStatusWithLiterals;
5768
+ /** Collectable order amount */
5762
5769
  amount?: Price;
5763
5770
  /**
5764
- * Reversal amount. Present only when status is REVERSED.
5765
- * @readonly
5766
- */
5767
- reversalAmount?: Price;
5768
- /**
5769
- * Status.
5770
- *
5771
- * Default: `"APPROVED"`.
5771
+ * Whether authorization supported
5772
+ * @internal
5772
5773
  */
5773
- status?: ChargebackStatusWithLiterals;
5774
+ authorizationSupported?: boolean;
5774
5775
  /**
5775
- * External chargeback ID.
5776
- * @format GUID
5777
- * @readonly
5778
- * @immutable
5776
+ * Whether custom amount is supported for payment collection
5777
+ * @internal
5779
5778
  */
5780
- externalId?: string | null;
5779
+ customAmountSupported?: boolean;
5781
5780
  }
5782
- declare enum ChargebackStatus {
5783
- /** Chargeback was approved. */
5784
- APPROVED = "APPROVED",
5785
- /** Chargeback was reversed. */
5786
- REVERSED = "REVERSED"
5781
+ declare enum PaymentCollectabilityStatus {
5782
+ UNKNOWN = "UNKNOWN",
5783
+ COLLECTABLE = "COLLECTABLE",
5784
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5785
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5786
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5787
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5788
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5789
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5790
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5791
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5792
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5793
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5794
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5787
5795
  }
5788
5796
  /** @enumType */
5789
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5790
- interface PaymentMethodName {
5797
+ 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';
5798
+ interface RecordManuallyCollectedPaymentRequest {
5791
5799
  /**
5792
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5793
- * @maxLength 150
5800
+ * Order ID.
5801
+ * @minLength 1
5802
+ * @maxLength 100
5794
5803
  */
5795
- buyerLanguageName?: string | null;
5804
+ orderId: string;
5805
+ /** Amount to be recorded as approved manual payment for given order */
5806
+ amount: Price;
5796
5807
  /**
5797
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5808
+ * Payment method name provided by user.
5798
5809
  *
5799
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5810
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5811
+ * @internal
5812
+ */
5813
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5814
+ }
5815
+ /**
5816
+ * User-defined payment method name.
5817
+ * Allows specifying either a predefined type or a custom name.
5818
+ */
5819
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5820
+ /** Predefined payment method. */
5821
+ predefined?: PredefinedPaymentMethodWithLiterals;
5822
+ /**
5823
+ * Custom payment method name provided by user.
5824
+ *
5825
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5826
+ * @minLength 1
5800
5827
  * @maxLength 150
5801
5828
  */
5802
- siteLanguageName?: string | null;
5829
+ custom?: string | null;
5830
+ }
5831
+ /** @oneof */
5832
+ interface UserDefinedPaymentMethodNameKindOneOf {
5833
+ /** Predefined payment method. */
5834
+ predefined?: PredefinedPaymentMethodWithLiterals;
5803
5835
  /**
5804
- * User-provided payment method name.
5836
+ * Custom payment method name provided by user.
5805
5837
  *
5806
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5838
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5839
+ * @minLength 1
5840
+ * @maxLength 150
5807
5841
  */
5808
- userDefinedName?: UserDefinedPaymentMethodName;
5842
+ custom?: string | null;
5809
5843
  }
5810
- interface GiftCardPaymentDetails {
5844
+ /** Predefined payment method types for offline/manual payments. */
5845
+ declare enum PredefinedPaymentMethod {
5846
+ /** Cash payment. */
5847
+ CASH = "CASH",
5848
+ /** Bank transfer. */
5849
+ BANK_TRANSFER = "BANK_TRANSFER",
5850
+ /** Payment by check. */
5851
+ CHECK = "CHECK"
5852
+ }
5853
+ /** @enumType */
5854
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5855
+ interface RecordManuallyCollectedPaymentResponse {
5856
+ }
5857
+ interface MarkOrderAsPaidRequest {
5811
5858
  /**
5812
- * Gift card payment ID.
5859
+ * Ecom order ID.
5860
+ * @minLength 1
5813
5861
  * @maxLength 100
5814
5862
  */
5815
- giftCardPaymentId?: string;
5863
+ ecomOrderId: string;
5816
5864
  /**
5817
- * Gift card ID.
5865
+ * Payment method name provided by user.
5866
+ *
5867
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5818
5868
  * @internal
5819
- * @deprecated
5820
- */
5821
- giftCardId?: string;
5822
- /**
5823
- * ID of the app that created the gift card.
5824
- * @format GUID
5825
5869
  */
5826
- appId?: string;
5870
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5871
+ }
5872
+ interface MarkOrderAsPaidResponse {
5873
+ /** Updated order. */
5874
+ order?: Order;
5875
+ }
5876
+ interface BulkMarkOrdersAsPaidRequest {
5827
5877
  /**
5828
- * Whether the gift card is voided.
5829
- * @readonly
5830
- * @deprecated Whether the gift card is voided.
5831
- * @replacedBy payment.status
5832
- * @targetRemovalDate 2026-11-01
5878
+ * IDs of orders to mark as paid.
5879
+ * @minSize 1
5880
+ * @maxSize 100
5881
+ * @minLength 1
5882
+ * @maxLength 100
5833
5883
  */
5834
- voided?: boolean;
5884
+ ecomOrderIds: string[];
5885
+ }
5886
+ interface BulkMarkOrdersAsPaidResponse {
5835
5887
  /**
5836
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5837
- * @maxLength 30
5838
- * @immutable
5888
+ * Items updated by the bulk action.
5889
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5839
5890
  */
5840
- obfuscatedCode?: string | null;
5891
+ results?: BulkOrderResult[];
5892
+ /** Bulk action metadata. */
5893
+ bulkActionMetadata?: BulkActionMetadata;
5841
5894
  }
5842
- interface MembershipPaymentDetails {
5895
+ interface BulkOrderResult {
5896
+ /** Item metadata. */
5897
+ itemMetadata?: ItemMetadata;
5843
5898
  /**
5844
- * Membership ID.
5845
- * @maxLength 200
5899
+ * Updated order.
5900
+ *
5901
+ * Returned when `returnFullEntity = true`.
5846
5902
  */
5847
- membershipId?: string;
5903
+ item?: Order;
5904
+ }
5905
+ interface ItemMetadata {
5906
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5907
+ id?: string | null;
5908
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5909
+ originalIndex?: number;
5910
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5911
+ success?: boolean;
5912
+ /** Details about the error in case of failure. */
5913
+ error?: ApplicationError;
5914
+ }
5915
+ interface ApplicationError {
5916
+ /** Error code. */
5917
+ code?: string;
5918
+ /** Description of the error. */
5919
+ description?: string;
5920
+ /** Data related to the error. */
5921
+ data?: Record<string, any> | null;
5922
+ }
5923
+ interface BulkActionMetadata {
5924
+ /** Number of items that were successfully processed. */
5925
+ totalSuccesses?: number;
5926
+ /** Number of items that couldn't be processed. */
5927
+ totalFailures?: number;
5928
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5929
+ undetailedFailures?: number;
5930
+ }
5931
+ interface GetRefundabilityStatusRequest {
5848
5932
  /**
5849
- * ID of the line item this membership applies to.
5933
+ * Order ID.
5850
5934
  * @minLength 1
5851
5935
  * @maxLength 100
5852
5936
  */
5853
- lineItemId?: string;
5937
+ ecomOrderId: string;
5938
+ }
5939
+ interface GetRefundabilityStatusResponse {
5854
5940
  /**
5855
- * Payment status.
5856
- * @deprecated Payment status.
5857
- * @replacedBy payment.status
5858
- * @targetRemovalDate 2026-11-01
5941
+ * Refundability details.
5942
+ * @maxSize 300
5859
5943
  */
5860
- status?: MembershipPaymentStatusWithLiterals;
5861
- /** Membership name. */
5862
- name?: MembershipName;
5944
+ refundabilities?: Refundability[];
5863
5945
  /**
5864
- * The transaction ID in the membership system. Can be used to void the transaction.
5865
- * @minLength 1
5866
- * @maxLength 100
5946
+ * Whether the order supports refunding per item.
5947
+ * @deprecated
5867
5948
  */
5868
- externalTransactionId?: string | null;
5949
+ refundablePerItem?: boolean;
5950
+ }
5951
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5952
+ /** Reason why payment is not refundable. */
5953
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5954
+ /** Reason why payment is only refundable manually. */
5955
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5956
+ /** Payment ID. */
5957
+ paymentId?: string;
5958
+ /** Payment refundability status. */
5959
+ refundabilityStatus?: RefundableStatusWithLiterals;
5960
+ /** Link to payment provider dashboard. */
5961
+ providerLink?: string | null;
5962
+ }
5963
+ /** @oneof */
5964
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5965
+ /** Reason why payment is not refundable. */
5966
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5967
+ /** Reason why payment is only refundable manually. */
5968
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5969
+ }
5970
+ declare enum RefundableStatus {
5971
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5972
+ MANUAL = "MANUAL",
5973
+ REFUNDABLE = "REFUNDABLE"
5974
+ }
5975
+ /** @enumType */
5976
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5977
+ declare enum NonRefundableReason {
5978
+ NONE = "NONE",
5979
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5980
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5981
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5982
+ NOT_PAID = "NOT_PAID",
5983
+ ACCESS_DENIED = "ACCESS_DENIED",
5984
+ ZERO_PRICE = "ZERO_PRICE",
5985
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5986
+ PENDING_REFUND = "PENDING_REFUND",
5987
+ FORBIDDEN = "FORBIDDEN",
5988
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5989
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5990
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5991
+ }
5992
+ /** @enumType */
5993
+ 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';
5994
+ declare enum ManuallyRefundableReason {
5995
+ EXPIRED = "EXPIRED",
5996
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5997
+ OFFLINE = "OFFLINE",
5998
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5999
+ }
6000
+ /** @enumType */
6001
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
6002
+ interface CreatePaymentGatewayOrderRequest {
5869
6003
  /**
5870
- * Whether the membership is voided.
5871
- * @readonly
5872
- * @deprecated Whether the membership is voided.
5873
- * @replacedBy payment.status
5874
- * @targetRemovalDate 2026-11-01
6004
+ * Ecom order ID.
6005
+ * @minLength 1
6006
+ * @maxLength 100
5875
6007
  */
5876
- voided?: boolean;
6008
+ ecomOrderId: string;
6009
+ /** Information about the user who initiated the payment. */
6010
+ chargedBy?: ChargedBy;
5877
6011
  /**
5878
- * ID of the application providing this payment option.
5879
- * @format GUID
6012
+ * Whether to delay capture of the payment.
6013
+ *
6014
+ * Default: false
6015
+ * @internal
5880
6016
  */
5881
- providerAppId?: string;
5882
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5883
- futureMembership?: FutureMembershipDetails;
5884
- }
5885
- declare enum MembershipPaymentStatus {
5886
- /** Payment was charged. */
5887
- CHARGED = "CHARGED",
5888
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5889
- CHARGE_FAILED = "CHARGE_FAILED",
5890
- /** Payment is pending. */
5891
- CHARGE_PENDING = "CHARGE_PENDING",
5892
- /** Payment was voided. */
5893
- VOIDED = "VOIDED"
6017
+ delayedCapture?: boolean;
5894
6018
  }
5895
- /** @enumType */
5896
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5897
- interface FutureMembershipDetails {
6019
+ interface ChargedBy {
5898
6020
  /**
5899
- * ID of the plan line item in the order from which the membership will be created.
6021
+ * ID - id of the user who initiated the payment
5900
6022
  * @format GUID
5901
6023
  */
5902
- lineItemId?: string;
6024
+ id?: string;
5903
6025
  /**
5904
- * ID of the benefit the future membership will grant.
6026
+ * Full name - name of the user who initiated the payment
6027
+ * @minLength 1
5905
6028
  * @maxLength 200
5906
6029
  */
5907
- benefitId?: string;
6030
+ fullName?: string | null;
5908
6031
  }
5909
- interface WixReceiptInfo {
6032
+ interface CreatePaymentGatewayOrderResponse {
6033
+ /** ID of the order created in the payment gateway */
6034
+ paymentGatewayOrderId?: string;
6035
+ }
6036
+ interface ChargeMembershipsRequest {
5910
6037
  /**
5911
- * Receipt ID
6038
+ * Order ID.
6039
+ * @minLength 1
6040
+ * @maxLength 100
6041
+ */
6042
+ ecomOrderId: string;
6043
+ /**
6044
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
6045
+ * but a user which is using the membership on behalf of the a member
5912
6046
  * @format GUID
5913
6047
  */
5914
- receiptId?: string;
6048
+ memberId: string;
5915
6049
  /**
5916
- * Display number of receipt
5917
- * @minLength 1
5918
- * @maxLength 40
6050
+ * List of items to be paid by memberships
6051
+ * @minSize 1
6052
+ * @maxSize 300
5919
6053
  */
5920
- displayNumber?: string | null;
6054
+ membershipCharges?: MembershipChargeItem[];
5921
6055
  }
5922
- interface ExternalReceiptInfo {
6056
+ interface MembershipChargeItem {
5923
6057
  /**
5924
- * External receipt ID
6058
+ * The id of used membership
6059
+ * @minLength 1
5925
6060
  * @maxLength 100
5926
6061
  */
5927
- receiptId?: string | null;
6062
+ membershipId?: string;
5928
6063
  /**
5929
- * ID of the app providing the receipt
6064
+ * ID of the application providing this payment option
5930
6065
  * @format GUID
5931
6066
  */
5932
- appId?: string | null;
6067
+ appId?: string;
6068
+ /** The name of used membership */
6069
+ membershipName?: MembershipName;
6070
+ /** Additional data about this membership */
6071
+ membershipAdditionalData?: Record<string, any> | null;
6072
+ /** Catalog and item reference info. */
6073
+ catalogReference?: CatalogReference;
6074
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
6075
+ serviceProperties?: ServiceProperties;
5933
6076
  /**
5934
- * Display number of receipt
6077
+ * Usually would be the same as catalogReference.catalogItemId
6078
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
6079
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5935
6080
  * @minLength 1
5936
- * @maxLength 40
6081
+ * @maxLength 36
5937
6082
  */
5938
- displayNumber?: string | null;
5939
- }
5940
- interface CashRoundingDetails {
6083
+ rootCatalogItemId?: string | null;
5941
6084
  /**
5942
- * Payment amount before cash rounding was applied.
5943
- * When provided, balance and status calculations use this value instead of `amount`
5944
- * to prevent false overpayment or underpayment due to rounding.
6085
+ * line item id of Checkout/Order line item
6086
+ * @minLength 1
6087
+ * @maxLength 100
5945
6088
  */
5946
- unroundedAmount?: Price;
6089
+ lineItemId?: string;
6090
+ }
6091
+ interface MembershipName {
5947
6092
  /**
5948
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5949
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5950
- * @readonly
6093
+ * Membership name in the site's original language.
6094
+ * @maxLength 100
5951
6095
  */
5952
- roundingAdjustment?: CashRounding;
5953
- }
5954
- declare enum PaymentStatus {
5955
- /** Payment was charged successfully. */
5956
- APPROVED = "APPROVED",
5957
- /** Payment is being processed and hasn't been confirmed yet. */
5958
- PENDING = "PENDING",
5959
- /** 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. */
5960
- PENDING_MERCHANT = "PENDING_MERCHANT",
5961
- /** Payment was canceled before it was charged. */
5962
- CANCELED = "CANCELED",
5963
- /** Payment was declined by the payment provider. */
5964
- DECLINED = "DECLINED",
5965
- /** Payment was fully refunded. */
5966
- REFUNDED = "REFUNDED",
5967
- /** Part of the payment amount was refunded. */
5968
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5969
- /** 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. */
5970
- AUTHORIZED = "AUTHORIZED",
6096
+ original?: string;
5971
6097
  /**
5972
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6098
+ * Membership name translated into the buyer's language.
5973
6099
  *
5974
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6100
+ * Default: The value of `original`
6101
+ * @maxLength 100
5975
6102
  */
5976
- VOIDED = "VOIDED"
5977
- }
5978
- /** @enumType */
5979
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5980
- interface CanceledStatusDetails {
5981
- reason?: CanceledReasonWithLiterals;
5982
- }
5983
- declare enum CanceledReason {
5984
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5985
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5986
- /** Payment was not completed by user and expired. */
5987
- EXPIRED = "EXPIRED"
5988
- }
5989
- /** @enumType */
5990
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5991
- interface DeclinedStatusDetails {
5992
- reason?: DeclinedReasonWithLiterals;
5993
- }
5994
- declare enum DeclinedReason {
5995
- /** Corresponding charge failed. */
5996
- CHARGE_FAILED = "CHARGE_FAILED",
5997
- /** Payment details expired. */
5998
- EXPIRED = "EXPIRED",
5999
- /** Insufficient funds. */
6000
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6001
- /** Gift card was disabled before charge was attempted. */
6002
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6003
- }
6004
- /** @enumType */
6005
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6006
- interface VoidedStatusDetails {
6007
- reason?: VoidedReasonWithLiterals;
6103
+ translated?: string | null;
6008
6104
  }
6009
- declare enum VoidedReason {
6010
- /** Payment was voided by merchant request. */
6011
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
6012
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6013
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6105
+ interface ChargeMembershipsResponse {
6014
6106
  }
6015
- /** @enumType */
6016
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6017
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6018
- /** @internal */
6019
- canceled?: CanceledStatusDetails;
6020
- /** @internal */
6021
- declined?: DeclinedStatusDetails;
6022
- /** @internal */
6023
- voided?: VoidedStatusDetails;
6107
+ interface TriggerRefundRequest {
6024
6108
  /**
6025
- * Reason code from the payment gateway.
6026
- * @internal
6109
+ * The order this refund related to
6027
6110
  * @minLength 1
6028
- * @maxLength 10
6029
- */
6030
- paymentGatewayReasonCode?: string | null;
6031
- }
6032
- /** @oneof */
6033
- interface PaymentStatusDetailsStatusDetailsOneOf {
6034
- /** @internal */
6035
- canceled?: CanceledStatusDetails;
6036
- /** @internal */
6037
- declined?: DeclinedStatusDetails;
6038
- /** @internal */
6039
- voided?: VoidedStatusDetails;
6040
- }
6041
- interface Refund {
6042
- /**
6043
- * Refund ID.
6044
- * @format GUID
6045
- * @readonly
6111
+ * @maxLength 100
6046
6112
  */
6047
- id?: string;
6113
+ ecomOrderId: string;
6048
6114
  /**
6049
- * List of transactions.
6050
- * @maxSize 50
6115
+ * Refund operations information
6116
+ * @minSize 1
6117
+ * @maxSize 1
6051
6118
  */
6052
- transactions?: RefundTransaction[];
6053
- /** Refund business details. */
6119
+ payments: PaymentRefund[];
6120
+ /** Business model of a refund */
6054
6121
  details?: RefundDetails;
6055
- /**
6056
- * 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.
6057
- * @readonly
6058
- * @immutable
6059
- */
6060
- createdDate?: Date | null;
6061
- /**
6062
- * Aggregated refund summary.
6063
- * @readonly
6064
- */
6065
- summary?: AggregatedRefundSummary;
6066
- /**
6067
- * ID of the app that initiated this refund.
6068
- * @format GUID
6069
- * @readonly
6070
- * @immutable
6071
- */
6072
- requestingServiceAppId?: string | null;
6122
+ /** Side effect details related to refund */
6123
+ sideEffects?: RefundSideEffects;
6073
6124
  }
6074
- interface RefundTransaction {
6125
+ interface PaymentRefund {
6075
6126
  /**
6076
- * ID of the payment associated with this refund.
6127
+ * Specific payment within the order to refund
6077
6128
  * @format GUID
6078
- * @immutable
6079
6129
  */
6080
6130
  paymentId?: string;
6081
- /**
6082
- * Refund amount.
6083
- * @immutable
6084
- */
6131
+ /** Refund amount. Not relevant for membership and gift card refunds. */
6085
6132
  amount?: Price;
6086
- /** Refund status. */
6087
- refundStatus?: RefundStatusWithLiterals;
6088
- /** Optional details of current refund status. */
6089
- refundStatusInfo?: RefundStatusInfo;
6090
- /**
6091
- * Payment gateway's refund ID.
6092
- * This field is only returned when the value of `external_refund` is `false`.
6093
- * @format GUID
6094
- */
6095
- gatewayRefundId?: string | null;
6096
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6097
- providerRefundId?: string | null;
6098
6133
  /**
6099
- * Whether refund was made externally and manually on the payment provider's side.
6100
- * @immutable
6134
+ * Whether refund is made externally and manually (on the payment provider's side)
6135
+ * 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.
6136
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
6101
6137
  */
6102
6138
  externalRefund?: boolean;
6103
6139
  /**
6104
- * Location where the refund was processed.
6105
- * @internal
6106
- * @format GUID
6107
- * @immutable
6108
- */
6109
- locationId?: string | null;
6110
- }
6111
- /** Refund transaction status. */
6112
- declare enum RefundStatus {
6113
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6114
- PENDING = "PENDING",
6115
- /** Refund transaction succeeded. */
6116
- SUCCEEDED = "SUCCEEDED",
6117
- /** Refund transaction failed. */
6118
- FAILED = "FAILED",
6119
- /** Refund request acknowledged, and will be executed soon. */
6120
- SCHEDULED = "SCHEDULED",
6121
- /** Refund was initiated on payment provider side. */
6122
- STARTED = "STARTED"
6123
- }
6124
- /** @enumType */
6125
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6126
- interface RefundStatusInfo {
6127
- /**
6128
- * Reason code for the refund's current status.
6129
- *
6130
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6140
+ * Gateway refund id. When param is present, new refund is not created.
6141
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
6142
+ * and all side effects from request will be executed.
6143
+ * @internal
6131
6144
  * @minLength 1
6132
- * @maxLength 10
6145
+ * @maxLength 100
6133
6146
  */
6134
- paymentGatewayReasonCode?: string | null;
6147
+ gatewayRefundId?: string | null;
6148
+ }
6149
+ interface RefundSideEffects {
6150
+ /** Inventory restock details as part of this refund. */
6151
+ restockInfo?: RestockInfo;
6152
+ /** Whether to send a refund confirmation email to the customer. */
6153
+ sendOrderRefundedEmail?: boolean;
6135
6154
  /**
6136
- * Free text explanation of current refund status.
6155
+ * Custom message added to the refund confirmation email.
6137
6156
  * @minLength 1
6138
6157
  * @maxLength 1000
6139
6158
  */
6140
- description?: string | null;
6141
- }
6142
- interface AggregatedRefundSummary {
6143
- /** Total amount requested for refund. */
6144
- requestedRefund?: Price;
6145
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6146
- pendingRefund?: Price;
6147
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6148
- refunded?: Price;
6149
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
6150
- failedRefundAmount?: Price;
6151
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
6152
- pending?: boolean;
6153
- /** Breakdown of refunded items. Available only after refund is complete. */
6154
- breakdown?: RefundItemsBreakdown;
6159
+ customMessage?: string | null;
6155
6160
  }
6156
- interface RefundItemsBreakdown {
6161
+ interface RestockInfo {
6162
+ /** Restock type. */
6163
+ type?: RestockTypeWithLiterals;
6157
6164
  /**
6158
- * Refunded line items and the amount refunded for each.
6165
+ * Deprecated, use items instead
6166
+ * @internal
6159
6167
  * @maxSize 300
6168
+ * @deprecated
6160
6169
  */
6161
- lineItems?: LineItemRefundSummary[];
6170
+ lineItemIds?: string[];
6171
+ /**
6172
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
6173
+ * @maxSize 300
6174
+ */
6175
+ items?: RestockItem[];
6162
6176
  }
6163
- interface LineItemRefundSummary {
6177
+ declare enum RestockType {
6178
+ NO_ITEMS = "NO_ITEMS",
6179
+ ALL_ITEMS = "ALL_ITEMS",
6180
+ SOME_ITEMS = "SOME_ITEMS"
6181
+ }
6182
+ /** @enumType */
6183
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
6184
+ interface RestockItem {
6164
6185
  /**
6165
- * ID of the refunded line item.
6186
+ * ID of the line item being restocked.
6166
6187
  * @format GUID
6167
6188
  */
6168
6189
  lineItemId?: string;
6169
- /** Total refunded amount for the line item. */
6170
- totalRefundedAmount?: Price;
6171
- }
6172
- interface CalculateRefundRequest {
6173
6190
  /**
6174
- * Order ID
6175
- * @minLength 1
6176
- * @maxLength 100
6191
+ * Line item quantity being restocked.
6192
+ * @min 1
6193
+ * @max 100000
6177
6194
  */
6178
- ecomOrderId?: string;
6195
+ quantity?: number;
6179
6196
  /**
6180
- * Refunded line items and quantity
6181
- * @maxSize 300
6197
+ * Per-location breakdown of restock quantities.
6198
+ * @internal
6199
+ * @maxSize 5
6182
6200
  */
6183
- refundItems?: CalculateRefundItemRequest[];
6184
- /** Should include shipping in refund calculation */
6185
- refundShipping?: boolean;
6201
+ restockLocations?: RestockLocation[];
6186
6202
  }
6187
- interface CalculateRefundItemRequest {
6203
+ interface TriggerRefundResponse {
6204
+ /** All order's transactions after the refunds were added */
6205
+ orderTransactions?: OrderTransactions;
6206
+ /** Created refund ID */
6207
+ refundId?: string | null;
6208
+ /** Payment ID's that the refund execution had failed for */
6209
+ failedPaymentIds?: ItemMetadata[];
6210
+ }
6211
+ /**
6212
+ * A record of all payments and refunds associated with an order.
6213
+ *
6214
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
6215
+ */
6216
+ interface OrderTransactions {
6188
6217
  /**
6189
- * ID of the line item being refunded
6218
+ * Order ID.
6190
6219
  * @format GUID
6191
6220
  */
6192
- id?: string;
6221
+ orderId?: string;
6193
6222
  /**
6194
- * How much of that line item is being refunded
6195
- * @min 1
6196
- * @max 100000
6223
+ * Record of payments made to the merchant.
6224
+ * @maxSize 100
6197
6225
  */
6198
- quantity?: number;
6199
- }
6200
- interface CalculateRefundResponse {
6201
- /** Total refundable amount */
6202
- total?: Price;
6203
- /** Tax cost of the order */
6204
- tax?: Price;
6205
- /** Discount given for this order */
6206
- discount?: Price;
6207
- /** Total cost of the order (without tax) */
6208
- subtotal?: Price;
6209
- /** Total shipping cost for order */
6210
- shipping?: Price;
6211
- /** Previous refund given on that order */
6212
- previouslyRefundedAmount?: Price;
6226
+ payments?: Payment[];
6213
6227
  /**
6214
- * The refundable items of that order
6228
+ * Record of refunds made to the buyer.
6215
6229
  * @maxSize 300
6216
6230
  */
6217
- items?: CalculateRefundItemResponse[];
6231
+ refunds?: Refund[];
6218
6232
  }
6219
- interface CalculateRefundItemResponse {
6233
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
6234
+ /** Regular payment details. */
6235
+ regularPaymentDetails?: RegularPaymentDetails;
6236
+ /** Gift card payment details. */
6237
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6238
+ /** Membership payment details. */
6239
+ membershipPaymentDetails?: MembershipPaymentDetails;
6220
6240
  /**
6221
- * Line item ID
6222
- * @format GUID
6241
+ * Receipt created by Wix
6242
+ * @internal
6223
6243
  */
6224
- id?: string;
6225
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6226
- price?: Price;
6227
- }
6228
- interface VoidAuthorizedPaymentsRequest {
6244
+ wixReceipt?: WixReceiptInfo;
6229
6245
  /**
6230
- * Wix eCommerce order ID
6231
- * @minLength 1
6232
- * @maxLength 100
6246
+ * Receipt created by an external system.
6247
+ * @internal
6233
6248
  */
6234
- ecomOrderId: string;
6249
+ externalReceipt?: ExternalReceiptInfo;
6250
+ /** @internal */
6251
+ canceled?: CanceledStatusDetails;
6252
+ /** @internal */
6253
+ declined?: DeclinedStatusDetails;
6254
+ /** @internal */
6255
+ voided?: VoidedStatusDetails;
6235
6256
  /**
6236
- * Payment IDs
6237
- * @minSize 1
6238
- * @maxSize 100
6257
+ * Payment ID.
6239
6258
  * @format GUID
6259
+ * @readonly
6240
6260
  */
6241
- paymentIds: string[];
6242
- }
6243
- interface VoidAuthorizedPaymentsResponse {
6244
- /** All order's transactions after the void was triggered */
6245
- orderTransactions?: OrderTransactions;
6246
- }
6247
- interface CaptureAuthorizedPaymentsRequest {
6261
+ id?: string | null;
6262
+ /** 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. */
6263
+ createdDate?: Date | null;
6248
6264
  /**
6249
- * Wix eCommerce order ID
6250
- * @minLength 1
6251
- * @maxLength 100
6265
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6266
+ * @readonly
6252
6267
  */
6253
- ecomOrderId: string;
6268
+ updatedDate?: Date | null;
6269
+ /** Payment amount. */
6270
+ amount?: Price;
6254
6271
  /**
6255
- * Capture payments information
6256
- * @minSize 1
6257
- * @maxSize 100
6272
+ * Whether refunds for this payment are disabled.
6273
+ * + `true`: This payment is not refundable.
6274
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
6258
6275
  */
6259
- payments: PaymentCapture[];
6260
- }
6261
- interface PaymentCapture {
6276
+ refundDisabled?: boolean;
6262
6277
  /**
6263
- * Payment ID
6278
+ * Whether receipt generation is allowed for this payment.
6279
+ * + `true`: This payment supports receipt generation.
6280
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6281
+ * @readonly
6282
+ */
6283
+ supportReceiptGeneration?: boolean;
6284
+ /** Details about cash rounding applied to this payment, when relevant. */
6285
+ cashRounding?: CashRoundingDetails;
6286
+ /**
6287
+ * Overall payment status.
6288
+ *
6289
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6290
+ */
6291
+ status?: PaymentStatusWithLiterals;
6292
+ /**
6293
+ * Detailed payment status information including gateway reason codes and status-specific details.
6294
+ * @internal
6295
+ */
6296
+ paymentStatusDetails?: PaymentStatusDetails;
6297
+ /**
6298
+ * Location where the payment was processed.
6299
+ * @internal
6264
6300
  * @format GUID
6301
+ * @immutable
6265
6302
  */
6266
- paymentId?: string | null;
6303
+ locationId?: string | null;
6267
6304
  /**
6268
- * Capture amount.
6269
- * If not provided - full authorized amount will be captured.
6305
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6306
+ * @format GUID
6270
6307
  */
6271
- amount?: Price;
6308
+ chargeCorrelationId?: string | null;
6272
6309
  }
6273
- interface CaptureAuthorizedPaymentsResponse {
6274
- /** All order's transactions after the capture was triggered */
6275
- orderTransactions?: OrderTransactions;
6310
+ /** @oneof */
6311
+ interface PaymentPaymentDetailsOneOf {
6312
+ /** Regular payment details. */
6313
+ regularPaymentDetails?: RegularPaymentDetails;
6314
+ /** Gift card payment details. */
6315
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6316
+ /** Membership payment details. */
6317
+ membershipPaymentDetails?: MembershipPaymentDetails;
6318
+ }
6319
+ /** @oneof */
6320
+ interface PaymentReceiptInfoOneOf {
6321
+ /**
6322
+ * Receipt created by Wix
6323
+ * @internal
6324
+ */
6325
+ wixReceipt?: WixReceiptInfo;
6326
+ /**
6327
+ * Receipt created by an external system.
6328
+ * @internal
6329
+ */
6330
+ externalReceipt?: ExternalReceiptInfo;
6331
+ }
6332
+ /** @oneof */
6333
+ interface PaymentStatusDetailsOneOf {
6334
+ /** @internal */
6335
+ canceled?: CanceledStatusDetails;
6336
+ /** @internal */
6337
+ declined?: DeclinedStatusDetails;
6338
+ /** @internal */
6339
+ voided?: VoidedStatusDetails;
6276
6340
  }
6277
- interface ChargeSavedPaymentMethodRequest {
6341
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6342
+ /** Credit card details. */
6343
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6278
6344
  /**
6279
- * Ecom Order ID.
6280
- * @minLength 1
6345
+ * Wix Payments order ID.
6281
6346
  * @maxLength 100
6282
6347
  */
6283
- ecomOrderId?: string;
6284
- /** Amount to be charged */
6285
- amount?: Price;
6286
- }
6287
- interface ChargeSavedPaymentMethodResponse {
6288
- /** Payment gateway's order ID (e.g Wix Payments) */
6289
- paymentGatewayOrderId?: string;
6290
- }
6291
- interface SendBuyerConfirmationEmailRequest {
6292
- /** @format GUID */
6293
- orderId?: string;
6294
- }
6295
- interface SendBuyerConfirmationEmailResponse {
6296
- }
6297
- interface SendBuyerPaymentsReceivedEmailRequest {
6348
+ paymentOrderId?: string | null;
6298
6349
  /**
6299
- * @minLength 1
6350
+ * Payment gateway's transaction ID.
6351
+ * This field is only returned when the value of `offline_payment` is `false`.
6300
6352
  * @maxLength 100
6301
6353
  */
6302
- orderId?: string;
6303
- }
6304
- interface SendBuyerPaymentsReceivedEmailResponse {
6305
- }
6306
- interface SendBuyerPickupConfirmationEmailRequest {
6354
+ gatewayTransactionId?: string | null;
6307
6355
  /**
6308
- * @minLength 1
6356
+ * Payment method.
6357
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6358
+ * Non-exhaustive list of supported values:
6359
+ * + `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`
6360
+ * @maxLength 150
6361
+ * @deprecated Payment method.
6362
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6363
+ * Non-exhaustive list of supported values:
6364
+ * + `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`
6365
+ * @replacedBy payment_method_name
6366
+ * @targetRemovalDate 2026-07-01
6367
+ */
6368
+ paymentMethod?: string | null;
6369
+ /**
6370
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6309
6371
  * @maxLength 100
6310
6372
  */
6311
- orderId?: string;
6312
- }
6313
- interface SendBuyerPickupConfirmationEmailResponse {
6314
- }
6315
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
6373
+ providerTransactionId?: string | null;
6374
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6375
+ offlinePayment?: boolean;
6316
6376
  /**
6317
- * IDs of orders to send pickup emails for.
6318
- * @minSize 1
6319
- * @maxSize 300
6377
+ * Payment status.
6378
+ * @deprecated Payment status.
6379
+ * @replacedBy payment.status
6380
+ * @targetRemovalDate 2026-11-01
6320
6381
  */
6321
- orderIds?: string[];
6322
- }
6323
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
6324
- }
6325
- interface SendBuyerShippingConfirmationEmailRequest {
6382
+ status?: TransactionStatusWithLiterals;
6383
+ /** Whether there is a payment agreement that allows for future charges. */
6384
+ savedPaymentMethod?: boolean;
6385
+ /** Authorization details. */
6386
+ authorizationDetails?: AuthorizationDetails;
6326
6387
  /**
6327
- * @minLength 1
6328
- * @maxLength 100
6388
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6389
+ * @internal
6390
+ * @maxLength 300
6329
6391
  */
6330
- orderId?: string;
6331
- }
6332
- interface SendBuyerShippingConfirmationEmailResponse {
6333
- }
6334
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
6392
+ paymentProvider?: string | null;
6335
6393
  /**
6336
- * IDs of orders to send pickup emails for.
6337
- * @minSize 1
6338
- * @maxSize 300
6394
+ * Record of chargebacks made by the buyer.
6395
+ * @maxSize 6
6339
6396
  */
6340
- orderIds?: string[];
6341
- }
6342
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
6343
- }
6344
- interface SendMerchantOrderReceivedNotificationRequest {
6397
+ chargebacks?: Chargeback[];
6345
6398
  /**
6346
- * @minLength 1
6347
- * @maxLength 100
6399
+ * Payment method ID.
6400
+ * @internal
6401
+ * @maxLength 36
6348
6402
  */
6349
- orderId?: string;
6403
+ paymentMethodId?: string | null;
6404
+ /** Platform fee amount associated with this payment. */
6405
+ platformFee?: Price;
6406
+ /**
6407
+ * Payment method with buyer and optional owner translations.
6408
+ * Non-exhaustive list of supported values:
6409
+ * + `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`
6410
+ */
6411
+ paymentMethodName?: PaymentMethodName;
6350
6412
  }
6351
- interface SendMerchantOrderReceivedNotificationResponse {
6413
+ /** @oneof */
6414
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6415
+ /** Credit card details. */
6416
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6352
6417
  }
6353
- interface SendCancelRefundEmailRequest {
6418
+ declare enum TransactionStatus {
6419
+ UNDEFINED = "UNDEFINED",
6420
+ APPROVED = "APPROVED",
6421
+ PENDING = "PENDING",
6422
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6423
+ CANCELED = "CANCELED",
6424
+ DECLINED = "DECLINED",
6425
+ REFUNDED = "REFUNDED",
6426
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6427
+ AUTHORIZED = "AUTHORIZED",
6428
+ VOIDED = "VOIDED"
6429
+ }
6430
+ /** @enumType */
6431
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6432
+ interface CreditCardPaymentMethodDetails {
6354
6433
  /**
6355
- * The ID of order that is canceled/refunded
6356
- * @minLength 1
6357
- * @maxLength 100
6434
+ * The last 4 digits of the card number.
6435
+ * @maxLength 4
6358
6436
  */
6359
- orderId?: string;
6437
+ lastFourDigits?: string | null;
6360
6438
  /**
6361
- * Personal note added to the email (optional)
6362
- * @minLength 1
6363
- * @maxLength 1000
6439
+ * Card issuer's brand.
6440
+ * @maxLength 100
6364
6441
  */
6365
- customMessage?: string | null;
6366
- /** Refund amount */
6367
- refundAmount?: Price;
6442
+ brand?: string | null;
6443
+ }
6444
+ interface AuthorizationDetails {
6368
6445
  /**
6369
- * Refund ID. (Optional)
6370
- * @format GUID
6446
+ * Whether the authorized payment is of a delayed capture.
6447
+ * @readonly
6371
6448
  */
6372
- refundId?: string | null;
6373
- }
6374
- interface SendCancelRefundEmailResponse {
6375
- }
6376
- interface SendRefundEmailRequest {
6449
+ delayedCapture?: boolean;
6450
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6451
+ authorizedDate?: Date | null;
6377
6452
  /**
6378
- * The ID of order that is refunded
6379
- * @format GUID
6453
+ * List of captures associated with payment
6454
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6455
+ * @maxSize 1
6380
6456
  */
6381
- orderId?: string;
6457
+ captures?: AuthorizationCapture[];
6458
+ /** Void associated with payment */
6459
+ void?: AuthorizationVoid;
6460
+ /** Scheduled action for this transaction */
6461
+ scheduledAction?: V1ScheduledAction;
6462
+ }
6463
+ interface AuthorizationCapture {
6382
6464
  /**
6383
- * Refund ID
6465
+ * Capture ID.
6384
6466
  * @format GUID
6467
+ * @readonly
6385
6468
  */
6386
- refundId?: string;
6469
+ id?: string | null;
6470
+ /** Status of this capture action */
6471
+ status?: AuthorizationCaptureStatusWithLiterals;
6387
6472
  /**
6388
- * Personal note added to the email (optional)
6389
- * @minLength 1
6390
- * @maxLength 1000
6473
+ * Amount of this capture
6474
+ * @immutable
6391
6475
  */
6392
- customMessage?: string | null;
6393
- }
6394
- interface SendRefundEmailResponse {
6476
+ amount?: Price;
6477
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6478
+ createdDate?: Date | null;
6479
+ /** In case of status is FAILED may contain failure details */
6480
+ failureDetails?: AuthorizationActionFailureDetails;
6395
6481
  }
6396
- interface SendFulfillmentEmailRequest {
6397
- /** @format GUID */
6398
- orderId?: string;
6399
- /** @format GUID */
6400
- fulfillerId?: string;
6482
+ declare enum AuthorizationCaptureStatus {
6483
+ /** Capture operation still in progress. */
6484
+ PENDING = "PENDING",
6485
+ /** Capture operation succeeded. */
6486
+ SUCCEEDED = "SUCCEEDED",
6487
+ /** Capture operation failed. */
6488
+ FAILED = "FAILED"
6401
6489
  }
6402
- interface SendFulfillmentEmailResponse {
6490
+ /** @enumType */
6491
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6492
+ interface AuthorizationActionFailureDetails {
6493
+ /** @maxLength 100 */
6494
+ failureCode?: string;
6403
6495
  }
6404
- interface SendMerchantOrderReceivedPushRequest {
6405
- /**
6406
- * @minLength 1
6407
- * @maxLength 100
6408
- */
6409
- orderId?: string;
6496
+ interface AuthorizationVoid {
6497
+ /** Status of this void action */
6498
+ status?: AuthorizationVoidStatusWithLiterals;
6499
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6500
+ voidedDate?: Date | null;
6501
+ /** In case of status is FAILED may contain failure details */
6502
+ failureDetails?: AuthorizationActionFailureDetails;
6503
+ /** Reason of void action */
6504
+ reason?: ReasonWithLiterals;
6410
6505
  }
6411
- interface SendMerchantOrderReceivedPushResponse {
6506
+ declare enum AuthorizationVoidStatus {
6507
+ /** Void operation still in progress. */
6508
+ PENDING = "PENDING",
6509
+ /** Void operation succeeded. */
6510
+ SUCCEEDED = "SUCCEEDED",
6511
+ /** Void operation failed. */
6512
+ FAILED = "FAILED"
6412
6513
  }
6413
- interface PreviewEmailByTypeRequest {
6414
- emailType?: PreviewEmailTypeWithLiterals;
6514
+ /** @enumType */
6515
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6516
+ /** Reason the authorization was voided. */
6517
+ declare enum Reason {
6518
+ /** Authorization was voided by user. */
6519
+ MANUAL = "MANUAL",
6520
+ /** Authorization passed execution date. */
6521
+ SCHEDULED = "SCHEDULED"
6415
6522
  }
6416
- declare enum PreviewEmailType {
6417
- ORDER_PLACED = "ORDER_PLACED",
6418
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6419
- ORDER_SHIPPED = "ORDER_SHIPPED",
6420
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6523
+ /** @enumType */
6524
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6525
+ interface V1ScheduledAction {
6526
+ /** Type of the action. */
6527
+ actionType?: ActionTypeWithLiterals;
6528
+ /** The date and time of the action. */
6529
+ executionDate?: Date | null;
6421
6530
  }
6422
- /** @enumType */
6423
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6424
- interface PreviewEmailByTypeResponse {
6425
- emailPreview?: string;
6531
+ declare enum ActionType {
6532
+ VOID = "VOID",
6533
+ CAPTURE = "CAPTURE"
6426
6534
  }
6427
- interface PreviewRefundEmailRequest {
6535
+ /** @enumType */
6536
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6537
+ interface Chargeback {
6428
6538
  /**
6429
- * @minLength 1
6430
- * @maxLength 100
6539
+ * Chargeback ID.
6540
+ * @format GUID
6541
+ * @readonly
6542
+ * @immutable
6431
6543
  */
6432
- orderId?: string;
6433
- /** Refund amount */
6434
- refundAmount?: Price;
6435
- /** Refund business details */
6436
- details?: RefundDetails;
6544
+ id?: string;
6437
6545
  /**
6438
- * Personal note added to the email (optional)
6439
- * @minLength 1
6440
- * @maxLength 1000
6546
+ * 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.
6547
+ * @readonly
6548
+ * @immutable
6441
6549
  */
6442
- customMessage?: string | null;
6550
+ createdDate?: Date | null;
6443
6551
  /**
6444
- * Refund ID. (Optional)
6445
- * @format GUID
6552
+ * 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.
6553
+ * @readonly
6446
6554
  */
6447
- refundId?: string | null;
6448
- }
6449
- interface PreviewRefundEmailResponse {
6450
- emailPreview?: string;
6451
- }
6452
- interface PreviewCancelEmailRequest {
6555
+ updatedDate?: Date | null;
6453
6556
  /**
6454
- * @minLength 1
6455
- * @maxLength 100
6557
+ * Amount.
6558
+ * @readonly
6559
+ * @immutable
6456
6560
  */
6457
- orderId?: string;
6561
+ amount?: Price;
6458
6562
  /**
6459
- * Personal note added to the email (optional)
6460
- * @minLength 1
6461
- * @maxLength 1000
6563
+ * Reversal amount. Present only when status is REVERSED.
6564
+ * @readonly
6462
6565
  */
6463
- customMessage?: string | null;
6566
+ reversalAmount?: Price;
6567
+ /**
6568
+ * Status.
6569
+ *
6570
+ * Default: `"APPROVED"`.
6571
+ */
6572
+ status?: ChargebackStatusWithLiterals;
6573
+ /**
6574
+ * External chargeback ID.
6575
+ * @format GUID
6576
+ * @readonly
6577
+ * @immutable
6578
+ */
6579
+ externalId?: string | null;
6464
6580
  }
6465
- interface PreviewCancelEmailResponse {
6466
- emailPreview?: string;
6581
+ declare enum ChargebackStatus {
6582
+ /** Chargeback was approved. */
6583
+ APPROVED = "APPROVED",
6584
+ /** Chargeback was reversed. */
6585
+ REVERSED = "REVERSED"
6467
6586
  }
6468
- interface PreviewCancelRefundEmailRequest {
6587
+ /** @enumType */
6588
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6589
+ interface PaymentMethodName {
6469
6590
  /**
6470
- * @minLength 1
6471
- * @maxLength 100
6591
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6592
+ * @maxLength 150
6472
6593
  */
6473
- orderId?: string;
6594
+ buyerLanguageName?: string | null;
6474
6595
  /**
6475
- * Personal note added to the email (optional)
6476
- * @minLength 1
6477
- * @maxLength 1000
6596
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6597
+ *
6598
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6599
+ * @maxLength 150
6478
6600
  */
6479
- customMessage?: string | null;
6480
- /** Refund amount */
6481
- refundAmount?: Price;
6601
+ siteLanguageName?: string | null;
6482
6602
  /**
6483
- * Refund ID. (Optional)
6484
- * @format GUID
6603
+ * User-provided payment method name.
6604
+ *
6605
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6485
6606
  */
6486
- refundId?: string | null;
6487
- }
6488
- interface PreviewCancelRefundEmailResponse {
6489
- emailPreview?: string;
6490
- }
6491
- interface PreviewBuyerPaymentsReceivedEmailRequest {
6492
- }
6493
- interface PreviewBuyerPaymentsReceivedEmailResponse {
6494
- emailPreview?: string;
6495
- }
6496
- interface PreviewBuyerConfirmationEmailRequest {
6497
- }
6498
- interface PreviewBuyerConfirmationEmailResponse {
6499
- emailPreview?: string;
6500
- }
6501
- interface PreviewBuyerPickupConfirmationEmailRequest {
6502
- }
6503
- interface PreviewBuyerPickupConfirmationEmailResponse {
6504
- emailPreview?: string;
6505
- }
6506
- interface PreviewShippingConfirmationEmailRequest {
6507
- }
6508
- interface PreviewShippingConfirmationEmailResponse {
6509
- emailPreview?: string;
6510
- }
6511
- interface PreviewResendDownloadLinksEmailRequest {
6512
- }
6513
- interface PreviewResendDownloadLinksEmailResponse {
6514
- emailPreview?: string;
6607
+ userDefinedName?: UserDefinedPaymentMethodName;
6515
6608
  }
6516
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6517
- /** Emitted on a meta site creation. */
6518
- siteCreated?: SiteCreated;
6519
- /** Emitted on a meta site transfer completion. */
6520
- siteTransferred?: SiteTransferred;
6521
- /** Emitted on a meta site deletion. */
6522
- siteDeleted?: SiteDeleted;
6523
- /** Emitted on a meta site restoration. */
6524
- siteUndeleted?: SiteUndeleted;
6525
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6526
- sitePublished?: SitePublished;
6527
- /** Emitted on a meta site unpublish. */
6528
- siteUnpublished?: SiteUnpublished;
6529
- /** Emitted when meta site is marked as template. */
6530
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6531
- /** Emitted when meta site is marked as a WixSite. */
6532
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6533
- /** Emitted when an application is provisioned (installed). */
6534
- serviceProvisioned?: ServiceProvisioned;
6535
- /** Emitted when an application is removed (uninstalled). */
6536
- serviceRemoved?: ServiceRemoved;
6537
- /** Emitted when meta site name (URL slug) is changed. */
6538
- siteRenamedPayload?: SiteRenamed;
6539
- /** Emitted when meta site was permanently deleted. */
6540
- hardDeleted?: SiteHardDeleted;
6541
- /** Emitted on a namespace change. */
6542
- namespaceChanged?: NamespaceChanged;
6543
- /** Emitted when Studio is attached. */
6544
- studioAssigned?: StudioAssigned;
6545
- /** Emitted when Studio is detached. */
6546
- studioUnassigned?: StudioUnassigned;
6609
+ interface GiftCardPaymentDetails {
6547
6610
  /**
6548
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6549
- * the actual URL.
6550
- *
6551
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6552
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6611
+ * Gift card payment ID.
6612
+ * @maxLength 100
6553
6613
  */
6554
- urlChanged?: SiteUrlChanged;
6555
- /** Site is marked as PurgedExternally */
6556
- sitePurgedExternally?: SitePurgedExternally;
6557
- /** Emitted when Odeditor is attached. */
6558
- odeditorAssigned?: OdeditorAssigned;
6559
- /** Emitted when Odeditor is detached. */
6560
- odeditorUnassigned?: OdeditorUnassigned;
6561
- /** Emitted when Picasso is attached. */
6562
- picassoAssigned?: PicassoAssigned;
6563
- /** Emitted when Picasso is detached. */
6564
- picassoUnassigned?: PicassoUnassigned;
6565
- /** Emitted when Wixel is attached. */
6566
- wixelAssigned?: WixelAssigned;
6567
- /** Emitted when Wixel is detached. */
6568
- wixelUnassigned?: WixelUnassigned;
6569
- /** Emitted when StudioTwo is attached. */
6570
- studioTwoAssigned?: StudioTwoAssigned;
6571
- /** Emitted when StudioTwo is detached. */
6572
- studioTwoUnassigned?: StudioTwoUnassigned;
6573
- /** Emitted when media from user domain is enabled. */
6574
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6575
- /** Emitted when media from user domain is disabled. */
6576
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6577
- /** Emitted when Editorless is attached. */
6578
- editorlessAssigned?: EditorlessAssigned;
6579
- /** Emitted when Editorless is detached. */
6580
- editorlessUnassigned?: EditorlessUnassigned;
6614
+ giftCardPaymentId?: string;
6581
6615
  /**
6582
- * A meta site id.
6583
- * @format GUID
6616
+ * Gift card ID.
6617
+ * @internal
6618
+ * @deprecated
6584
6619
  */
6585
- metaSiteId?: string;
6586
- /** A meta site version. Monotonically increasing. */
6587
- version?: string;
6588
- /** A timestamp of the event. */
6589
- timestamp?: string;
6620
+ giftCardId?: string;
6590
6621
  /**
6591
- * TODO(meta-site): Change validation once validations are disabled for consumers
6592
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6593
- * @maxSize 4000
6622
+ * ID of the app that created the gift card.
6623
+ * @format GUID
6594
6624
  */
6595
- assets?: Asset[];
6596
- }
6597
- /** @oneof */
6598
- interface MetaSiteSpecialEventPayloadOneOf {
6599
- /** Emitted on a meta site creation. */
6600
- siteCreated?: SiteCreated;
6601
- /** Emitted on a meta site transfer completion. */
6602
- siteTransferred?: SiteTransferred;
6603
- /** Emitted on a meta site deletion. */
6604
- siteDeleted?: SiteDeleted;
6605
- /** Emitted on a meta site restoration. */
6606
- siteUndeleted?: SiteUndeleted;
6607
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6608
- sitePublished?: SitePublished;
6609
- /** Emitted on a meta site unpublish. */
6610
- siteUnpublished?: SiteUnpublished;
6611
- /** Emitted when meta site is marked as template. */
6612
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6613
- /** Emitted when meta site is marked as a WixSite. */
6614
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6615
- /** Emitted when an application is provisioned (installed). */
6616
- serviceProvisioned?: ServiceProvisioned;
6617
- /** Emitted when an application is removed (uninstalled). */
6618
- serviceRemoved?: ServiceRemoved;
6619
- /** Emitted when meta site name (URL slug) is changed. */
6620
- siteRenamedPayload?: SiteRenamed;
6621
- /** Emitted when meta site was permanently deleted. */
6622
- hardDeleted?: SiteHardDeleted;
6623
- /** Emitted on a namespace change. */
6624
- namespaceChanged?: NamespaceChanged;
6625
- /** Emitted when Studio is attached. */
6626
- studioAssigned?: StudioAssigned;
6627
- /** Emitted when Studio is detached. */
6628
- studioUnassigned?: StudioUnassigned;
6625
+ appId?: string;
6626
+ /**
6627
+ * Whether the gift card is voided.
6628
+ * @readonly
6629
+ * @deprecated Whether the gift card is voided.
6630
+ * @replacedBy payment.status
6631
+ * @targetRemovalDate 2026-11-01
6632
+ */
6633
+ voided?: boolean;
6629
6634
  /**
6630
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6631
- * the actual URL.
6632
- *
6633
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6634
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6635
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6636
+ * @maxLength 30
6637
+ * @immutable
6635
6638
  */
6636
- urlChanged?: SiteUrlChanged;
6637
- /** Site is marked as PurgedExternally */
6638
- sitePurgedExternally?: SitePurgedExternally;
6639
- /** Emitted when Odeditor is attached. */
6640
- odeditorAssigned?: OdeditorAssigned;
6641
- /** Emitted when Odeditor is detached. */
6642
- odeditorUnassigned?: OdeditorUnassigned;
6643
- /** Emitted when Picasso is attached. */
6644
- picassoAssigned?: PicassoAssigned;
6645
- /** Emitted when Picasso is detached. */
6646
- picassoUnassigned?: PicassoUnassigned;
6647
- /** Emitted when Wixel is attached. */
6648
- wixelAssigned?: WixelAssigned;
6649
- /** Emitted when Wixel is detached. */
6650
- wixelUnassigned?: WixelUnassigned;
6651
- /** Emitted when StudioTwo is attached. */
6652
- studioTwoAssigned?: StudioTwoAssigned;
6653
- /** Emitted when StudioTwo is detached. */
6654
- studioTwoUnassigned?: StudioTwoUnassigned;
6655
- /** Emitted when media from user domain is enabled. */
6656
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6657
- /** Emitted when media from user domain is disabled. */
6658
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6659
- /** Emitted when Editorless is attached. */
6660
- editorlessAssigned?: EditorlessAssigned;
6661
- /** Emitted when Editorless is detached. */
6662
- editorlessUnassigned?: EditorlessUnassigned;
6639
+ obfuscatedCode?: string | null;
6663
6640
  }
6664
- interface Asset {
6641
+ interface MembershipPaymentDetails {
6665
6642
  /**
6666
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6667
- * @maxLength 36
6643
+ * Membership ID.
6644
+ * @maxLength 200
6668
6645
  */
6669
- appDefId?: string;
6646
+ membershipId?: string;
6670
6647
  /**
6671
- * An instance id. For legacy reasons may be UUID or a string.
6672
- * @maxLength 200
6648
+ * ID of the line item this membership applies to.
6649
+ * @minLength 1
6650
+ * @maxLength 100
6673
6651
  */
6674
- instanceId?: string;
6675
- /** An application state. */
6676
- state?: StateWithLiterals;
6652
+ lineItemId?: string;
6653
+ /**
6654
+ * Payment status.
6655
+ * @deprecated Payment status.
6656
+ * @replacedBy payment.status
6657
+ * @targetRemovalDate 2026-11-01
6658
+ */
6659
+ status?: MembershipPaymentStatusWithLiterals;
6660
+ /** Membership name. */
6661
+ name?: MembershipName;
6662
+ /**
6663
+ * The transaction ID in the membership system. Can be used to void the transaction.
6664
+ * @minLength 1
6665
+ * @maxLength 100
6666
+ */
6667
+ externalTransactionId?: string | null;
6668
+ /**
6669
+ * Whether the membership is voided.
6670
+ * @readonly
6671
+ * @deprecated Whether the membership is voided.
6672
+ * @replacedBy payment.status
6673
+ * @targetRemovalDate 2026-11-01
6674
+ */
6675
+ voided?: boolean;
6676
+ /**
6677
+ * ID of the application providing this payment option.
6678
+ * @format GUID
6679
+ */
6680
+ providerAppId?: string;
6681
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6682
+ futureMembership?: FutureMembershipDetails;
6677
6683
  }
6678
- declare enum State {
6679
- UNKNOWN = "UNKNOWN",
6680
- ENABLED = "ENABLED",
6681
- DISABLED = "DISABLED",
6682
- PENDING = "PENDING",
6683
- DEMO = "DEMO"
6684
+ declare enum MembershipPaymentStatus {
6685
+ /** Payment was charged. */
6686
+ CHARGED = "CHARGED",
6687
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6688
+ CHARGE_FAILED = "CHARGE_FAILED",
6689
+ /** Payment is pending. */
6690
+ CHARGE_PENDING = "CHARGE_PENDING",
6691
+ /** Payment was voided. */
6692
+ VOIDED = "VOIDED"
6684
6693
  }
6685
6694
  /** @enumType */
6686
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6687
- interface SiteCreated {
6695
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6696
+ interface FutureMembershipDetails {
6688
6697
  /**
6689
- * A template identifier (empty if not created from a template).
6690
- * @maxLength 36
6698
+ * ID of the plan line item in the order from which the membership will be created.
6699
+ * @format GUID
6691
6700
  */
6692
- originTemplateId?: string;
6701
+ lineItemId?: string;
6693
6702
  /**
6694
- * An account id of the owner.
6695
- * @format GUID
6703
+ * ID of the benefit the future membership will grant.
6704
+ * @maxLength 200
6696
6705
  */
6697
- ownerId?: string;
6698
- /** A context in which meta site was created. */
6699
- context?: SiteCreatedContextWithLiterals;
6706
+ benefitId?: string;
6707
+ }
6708
+ interface WixReceiptInfo {
6700
6709
  /**
6701
- * A meta site id from which this site was created.
6702
- *
6703
- * In case of a creation from a template it's a template id.
6704
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6710
+ * Receipt ID
6705
6711
  * @format GUID
6706
6712
  */
6707
- originMetaSiteId?: string | null;
6713
+ receiptId?: string;
6708
6714
  /**
6709
- * A meta site name (URL slug).
6710
- * @maxLength 20
6715
+ * Display number of receipt
6716
+ * @minLength 1
6717
+ * @maxLength 40
6711
6718
  */
6712
- siteName?: string;
6713
- /** A namespace. */
6714
- namespace?: NamespaceWithLiterals;
6719
+ displayNumber?: string | null;
6715
6720
  }
6716
- declare enum SiteCreatedContext {
6717
- /** A valid option, we don't expose all reasons why site might be created. */
6718
- OTHER = "OTHER",
6719
- /** A meta site was created from template. */
6720
- FROM_TEMPLATE = "FROM_TEMPLATE",
6721
- /** A meta site was created by copying of the transfferred meta site. */
6722
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6723
- /** A copy of existing meta site. */
6724
- DUPLICATE = "DUPLICATE",
6725
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6726
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6727
- /** deprecated A meta site was created for Flash editor. */
6728
- FLASH = "FLASH"
6721
+ interface ExternalReceiptInfo {
6722
+ /**
6723
+ * External receipt ID
6724
+ * @maxLength 100
6725
+ */
6726
+ receiptId?: string | null;
6727
+ /**
6728
+ * ID of the app providing the receipt
6729
+ * @format GUID
6730
+ */
6731
+ appId?: string | null;
6732
+ /**
6733
+ * Display number of receipt
6734
+ * @minLength 1
6735
+ * @maxLength 40
6736
+ */
6737
+ displayNumber?: string | null;
6729
6738
  }
6730
- /** @enumType */
6731
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6732
- declare enum Namespace {
6733
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6734
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6735
- WIX = "WIX",
6736
- /** 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. */
6737
- SHOUT_OUT = "SHOUT_OUT",
6738
- /** 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. */
6739
- ALBUMS = "ALBUMS",
6740
- /** 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. */
6741
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6742
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6743
- HOTELS = "HOTELS",
6744
- /** 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. */
6745
- CLUBS = "CLUBS",
6746
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6747
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6739
+ interface CashRoundingDetails {
6748
6740
  /**
6749
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6750
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6741
+ * Payment amount before cash rounding was applied.
6742
+ * When provided, balance and status calculations use this value instead of `amount`
6743
+ * to prevent false overpayment or underpayment due to rounding.
6751
6744
  */
6752
- DEV_SITE = "DEV_SITE",
6753
- /** 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. */
6754
- LOGOS = "LOGOS",
6755
- /** 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. */
6756
- VIDEO_MAKER = "VIDEO_MAKER",
6757
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6758
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6759
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6760
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6745
+ unroundedAmount?: Price;
6761
6746
  /**
6762
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6747
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6748
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6749
+ * @readonly
6750
+ */
6751
+ roundingAdjustment?: CashRounding;
6752
+ }
6753
+ declare enum PaymentStatus {
6754
+ /** Payment was charged successfully. */
6755
+ APPROVED = "APPROVED",
6756
+ /** Payment is being processed and hasn't been confirmed yet. */
6757
+ PENDING = "PENDING",
6758
+ /** 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. */
6759
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6760
+ /** Payment was canceled before it was charged. */
6761
+ CANCELED = "CANCELED",
6762
+ /** Payment was declined by the payment provider. */
6763
+ DECLINED = "DECLINED",
6764
+ /** Payment was fully refunded. */
6765
+ REFUNDED = "REFUNDED",
6766
+ /** Part of the payment amount was refunded. */
6767
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6768
+ /** 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. */
6769
+ AUTHORIZED = "AUTHORIZED",
6770
+ /**
6771
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6763
6772
  *
6764
- * Meta site with this namespace will *not* be shown in a user's site list by default.
6773
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6765
6774
  */
6766
- HTML_DRAFT = "HTML_DRAFT",
6775
+ VOIDED = "VOIDED"
6776
+ }
6777
+ /** @enumType */
6778
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6779
+ interface CanceledStatusDetails {
6780
+ reason?: CanceledReasonWithLiterals;
6781
+ }
6782
+ declare enum CanceledReason {
6783
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6784
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6785
+ /** Payment was not completed by user and expired. */
6786
+ EXPIRED = "EXPIRED"
6787
+ }
6788
+ /** @enumType */
6789
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6790
+ interface DeclinedStatusDetails {
6791
+ reason?: DeclinedReasonWithLiterals;
6792
+ }
6793
+ declare enum DeclinedReason {
6794
+ /** Corresponding charge failed. */
6795
+ CHARGE_FAILED = "CHARGE_FAILED",
6796
+ /** Payment details expired. */
6797
+ EXPIRED = "EXPIRED",
6798
+ /** Insufficient funds. */
6799
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6800
+ /** Gift card was disabled before charge was attempted. */
6801
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6802
+ }
6803
+ /** @enumType */
6804
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6805
+ interface VoidedStatusDetails {
6806
+ reason?: VoidedReasonWithLiterals;
6807
+ }
6808
+ declare enum VoidedReason {
6809
+ /** Payment was voided by merchant request. */
6810
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6811
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6812
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6813
+ }
6814
+ /** @enumType */
6815
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6816
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6817
+ /** @internal */
6818
+ canceled?: CanceledStatusDetails;
6819
+ /** @internal */
6820
+ declined?: DeclinedStatusDetails;
6821
+ /** @internal */
6822
+ voided?: VoidedStatusDetails;
6767
6823
  /**
6768
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6769
- * Will be accessible from Site List and will not have a website app.
6770
- * Once the user attaches a site, the site will become a regular wixsite.
6824
+ * Reason code from the payment gateway.
6825
+ * @internal
6826
+ * @minLength 1
6827
+ * @maxLength 10
6771
6828
  */
6772
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
6773
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6774
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
6775
- /** It is to be used in the Business First efforts. */
6776
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
6777
- /** Bookings business flow with no site. */
6778
- ANYWHERE = "ANYWHERE",
6779
- /** Namespace for Headless Backoffice with no editor */
6780
- HEADLESS = "HEADLESS",
6829
+ paymentGatewayReasonCode?: string | null;
6830
+ }
6831
+ /** @oneof */
6832
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6833
+ /** @internal */
6834
+ canceled?: CanceledStatusDetails;
6835
+ /** @internal */
6836
+ declined?: DeclinedStatusDetails;
6837
+ /** @internal */
6838
+ voided?: VoidedStatusDetails;
6839
+ }
6840
+ interface Refund {
6781
6841
  /**
6782
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6783
- * The site will be used for account level CSM feature for enterprise
6842
+ * Refund ID.
6843
+ * @format GUID
6844
+ * @readonly
6784
6845
  */
6785
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6786
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6787
- RISE = "RISE",
6846
+ id?: string;
6788
6847
  /**
6789
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6790
- * There's a blank site behind the scene but it's blank).
6791
- * The Mobile company will be the owner of this namespace.
6848
+ * List of transactions.
6849
+ * @maxSize 50
6792
6850
  */
6793
- BRANDED_FIRST = "BRANDED_FIRST",
6794
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6795
- NOWNIA = "NOWNIA",
6851
+ transactions?: RefundTransaction[];
6852
+ /** Refund business details. */
6853
+ details?: RefundDetails;
6796
6854
  /**
6797
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
6798
- * The Partners company owns this namespace.
6855
+ * 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.
6856
+ * @readonly
6857
+ * @immutable
6799
6858
  */
6800
- UGC_TEMPLATE = "UGC_TEMPLATE",
6801
- /** Codux Headless Sites */
6802
- CODUX = "CODUX",
6803
- /** Bobb - AI Design Creator. */
6804
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6859
+ createdDate?: Date | null;
6805
6860
  /**
6806
- * Shared Blog Site is a unique single site across Enterprise account,
6807
- * This site will hold all Blog posts related to the Marketing product.
6861
+ * Aggregated refund summary.
6862
+ * @readonly
6808
6863
  */
6809
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6810
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6811
- STANDALONE_FORMS = "STANDALONE_FORMS",
6812
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6813
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6814
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6815
- MIMIR = "MIMIR",
6816
- /** Wix Twins platform. */
6817
- TWINS = "TWINS",
6818
- /** Wix Nano. */
6819
- NANO = "NANO",
6820
- /** Base44 headless sites. */
6821
- BASE44 = "BASE44",
6822
- /** Wix Channels Sites */
6823
- CHANNELS = "CHANNELS",
6824
- /** Nautilus platform. */
6825
- NAUTILUS = "NAUTILUS",
6864
+ summary?: AggregatedRefundSummary;
6826
6865
  /**
6827
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6828
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6866
+ * ID of the app that initiated this refund.
6867
+ * @format GUID
6868
+ * @readonly
6869
+ * @immutable
6829
6870
  */
6830
- SYMPHONY = "SYMPHONY",
6831
- /** Nautilus platform app. */
6832
- NAUTILUS_APPS = "NAUTILUS_APPS",
6871
+ requestingServiceAppId?: string | null;
6872
+ }
6873
+ interface RefundTransaction {
6833
6874
  /**
6834
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6835
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6875
+ * ID of the payment associated with this refund.
6876
+ * @format GUID
6877
+ * @immutable
6836
6878
  */
6837
- VIBU = "VIBU",
6879
+ paymentId?: string;
6838
6880
  /**
6839
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6840
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6841
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6842
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6881
+ * Refund amount.
6882
+ * @immutable
6843
6883
  */
6844
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6884
+ amount?: Price;
6885
+ /** Refund status. */
6886
+ refundStatus?: RefundStatusWithLiterals;
6887
+ /** Optional details of current refund status. */
6888
+ refundStatusInfo?: RefundStatusInfo;
6845
6889
  /**
6846
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6847
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6890
+ * Payment gateway's refund ID.
6891
+ * This field is only returned when the value of `external_refund` is `false`.
6892
+ * @format GUID
6848
6893
  */
6849
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6850
- }
6851
- /** @enumType */
6852
- 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';
6853
- /** Site transferred to another user. */
6854
- interface SiteTransferred {
6894
+ gatewayRefundId?: string | null;
6895
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6896
+ providerRefundId?: string | null;
6855
6897
  /**
6856
- * A previous owner id (user that transfers meta site).
6857
- * @format GUID
6898
+ * Whether refund was made externally and manually on the payment provider's side.
6899
+ * @immutable
6858
6900
  */
6859
- oldOwnerId?: string;
6901
+ externalRefund?: boolean;
6860
6902
  /**
6861
- * A new owner id (user that accepts meta site).
6903
+ * Location where the refund was processed.
6904
+ * @internal
6862
6905
  * @format GUID
6906
+ * @immutable
6863
6907
  */
6864
- newOwnerId?: string;
6908
+ locationId?: string | null;
6865
6909
  }
6866
- /** Soft deletion of the meta site. Could be restored. */
6867
- interface SiteDeleted {
6868
- /** A deletion context. */
6869
- deleteContext?: DeleteContext;
6910
+ /** Refund transaction status. */
6911
+ declare enum RefundStatus {
6912
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6913
+ PENDING = "PENDING",
6914
+ /** Refund transaction succeeded. */
6915
+ SUCCEEDED = "SUCCEEDED",
6916
+ /** Refund transaction failed. */
6917
+ FAILED = "FAILED",
6918
+ /** Refund request acknowledged, and will be executed soon. */
6919
+ SCHEDULED = "SCHEDULED",
6920
+ /** Refund was initiated on payment provider side. */
6921
+ STARTED = "STARTED"
6870
6922
  }
6871
- interface DeleteContext {
6872
- /** When the meta site was deleted. */
6873
- dateDeleted?: Date | null;
6874
- /** A status. */
6875
- deleteStatus?: DeleteStatusWithLiterals;
6876
- /**
6877
- * A reason (flow).
6878
- * @maxLength 255
6879
- */
6880
- deleteOrigin?: string;
6923
+ /** @enumType */
6924
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6925
+ interface RefundStatusInfo {
6881
6926
  /**
6882
- * A service that deleted it.
6883
- * @maxLength 255
6927
+ * Reason code for the refund's current status.
6928
+ *
6929
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6930
+ * @minLength 1
6931
+ * @maxLength 10
6884
6932
  */
6885
- initiatorId?: string | null;
6886
- }
6887
- declare enum DeleteStatus {
6888
- UNKNOWN = "UNKNOWN",
6889
- TRASH = "TRASH",
6890
- DELETED = "DELETED",
6891
- PENDING_PURGE = "PENDING_PURGE",
6892
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6893
- }
6894
- /** @enumType */
6895
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6896
- /** Restoration of the meta site. */
6897
- interface SiteUndeleted {
6898
- }
6899
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6900
- interface SitePublished {
6901
- }
6902
- interface SiteUnpublished {
6933
+ paymentGatewayReasonCode?: string | null;
6903
6934
  /**
6904
- * A list of URLs previously associated with the meta site.
6905
- * @maxLength 4000
6906
- * @maxSize 10000
6935
+ * Free text explanation of current refund status.
6936
+ * @minLength 1
6937
+ * @maxLength 1000
6907
6938
  */
6908
- urls?: string[];
6909
- }
6910
- interface SiteMarkedAsTemplate {
6939
+ description?: string | null;
6911
6940
  }
6912
- interface SiteMarkedAsWixSite {
6941
+ interface AggregatedRefundSummary {
6942
+ /** Total amount requested for refund. */
6943
+ requestedRefund?: Price;
6944
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6945
+ pendingRefund?: Price;
6946
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6947
+ refunded?: Price;
6948
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6949
+ failedRefundAmount?: Price;
6950
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6951
+ pending?: boolean;
6952
+ /** Breakdown of refunded items. Available only after refund is complete. */
6953
+ breakdown?: RefundItemsBreakdown;
6913
6954
  }
6914
- /**
6915
- * Represents a service provisioned a site.
6916
- *
6917
- * Note on `origin_instance_id`:
6918
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6919
- * This is because of the following scenario:
6920
- *
6921
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6922
- * such as a product catalog. When you create a site from this template, you inherit this
6923
- * default product catalog. However, if the template's product catalog is modified,
6924
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6925
- * your site remains consistent with what you initially received and does not include any
6926
- * changes made to the original template afterward.
6927
- * To ensure this, the TPA on the template gets a new instance_id.
6928
- */
6929
- interface ServiceProvisioned {
6955
+ interface RefundItemsBreakdown {
6930
6956
  /**
6931
- * Either UUID or EmbeddedServiceType.
6932
- * @maxLength 36
6957
+ * Refunded line items and the amount refunded for each.
6958
+ * @maxSize 300
6933
6959
  */
6934
- appDefId?: string;
6960
+ lineItems?: LineItemRefundSummary[];
6961
+ }
6962
+ interface LineItemRefundSummary {
6935
6963
  /**
6936
- * Not only UUID. Something here could be something weird.
6937
- * @maxLength 36
6964
+ * ID of the refunded line item.
6965
+ * @format GUID
6938
6966
  */
6939
- instanceId?: string;
6967
+ lineItemId?: string;
6968
+ /** Total refunded amount for the line item. */
6969
+ totalRefundedAmount?: Price;
6970
+ }
6971
+ interface CalculateRefundRequest {
6940
6972
  /**
6941
- * An instance id from which this instance is originated.
6942
- * @maxLength 36
6973
+ * Order ID
6974
+ * @minLength 1
6975
+ * @maxLength 100
6943
6976
  */
6944
- originInstanceId?: string;
6977
+ ecomOrderId?: string;
6945
6978
  /**
6946
- * A version.
6947
- * @maxLength 500
6979
+ * Refunded line items and quantity
6980
+ * @maxSize 300
6948
6981
  */
6949
- version?: string | null;
6982
+ refundItems?: CalculateRefundItemRequest[];
6983
+ /** Should include shipping in refund calculation */
6984
+ refundShipping?: boolean;
6985
+ }
6986
+ interface CalculateRefundItemRequest {
6950
6987
  /**
6951
- * The origin meta site id
6988
+ * ID of the line item being refunded
6952
6989
  * @format GUID
6953
6990
  */
6954
- originMetaSiteId?: string | null;
6955
- }
6956
- interface ServiceRemoved {
6991
+ id?: string;
6957
6992
  /**
6958
- * Either UUID or EmbeddedServiceType.
6959
- * @maxLength 36
6993
+ * How much of that line item is being refunded
6994
+ * @min 1
6995
+ * @max 100000
6960
6996
  */
6961
- appDefId?: string;
6997
+ quantity?: number;
6998
+ }
6999
+ interface CalculateRefundResponse {
7000
+ /** Total refundable amount */
7001
+ total?: Price;
7002
+ /** Tax cost of the order */
7003
+ tax?: Price;
7004
+ /** Discount given for this order */
7005
+ discount?: Price;
7006
+ /** Total cost of the order (without tax) */
7007
+ subtotal?: Price;
7008
+ /** Total shipping cost for order */
7009
+ shipping?: Price;
7010
+ /** Previous refund given on that order */
7011
+ previouslyRefundedAmount?: Price;
6962
7012
  /**
6963
- * Not only UUID. Something here could be something weird.
6964
- * @maxLength 36
7013
+ * The refundable items of that order
7014
+ * @maxSize 300
6965
7015
  */
6966
- instanceId?: string;
7016
+ items?: CalculateRefundItemResponse[];
7017
+ }
7018
+ interface CalculateRefundItemResponse {
6967
7019
  /**
6968
- * A version.
6969
- * @maxLength 500
7020
+ * Line item ID
7021
+ * @format GUID
6970
7022
  */
6971
- version?: string | null;
7023
+ id?: string;
7024
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
7025
+ price?: Price;
6972
7026
  }
6973
- /** Rename of the site. Meaning, free public url has been changed as well. */
6974
- interface SiteRenamed {
7027
+ interface VoidAuthorizedPaymentsRequest {
6975
7028
  /**
6976
- * A new meta site name (URL slug).
6977
- * @maxLength 20
7029
+ * Wix eCommerce order ID
7030
+ * @minLength 1
7031
+ * @maxLength 100
6978
7032
  */
6979
- newSiteName?: string;
7033
+ ecomOrderId: string;
6980
7034
  /**
6981
- * A previous meta site name (URL slug).
6982
- * @maxLength 255
7035
+ * Payment IDs
7036
+ * @minSize 1
7037
+ * @maxSize 100
7038
+ * @format GUID
6983
7039
  */
6984
- oldSiteName?: string;
6985
- }
6986
- /**
6987
- * Hard deletion of the meta site.
6988
- *
6989
- * Could not be restored. Therefore it's desirable to cleanup data.
6990
- */
6991
- interface SiteHardDeleted {
6992
- /** A deletion context. */
6993
- deleteContext?: DeleteContext;
6994
- }
6995
- interface NamespaceChanged {
6996
- /** A previous namespace. */
6997
- oldNamespace?: NamespaceWithLiterals;
6998
- /** A new namespace. */
6999
- newNamespace?: NamespaceWithLiterals;
7000
- }
7001
- /** Assigned Studio editor */
7002
- interface StudioAssigned {
7003
- }
7004
- /** Unassigned Studio editor */
7005
- interface StudioUnassigned {
7040
+ paymentIds: string[];
7006
7041
  }
7007
- /**
7008
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
7009
- *
7010
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
7011
- * with sites and its urls, you need to listen to another topic/event. Read about it:
7012
- *
7013
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
7014
- */
7015
- interface SiteUrlChanged {
7042
+ interface VoidAuthorizedPaymentsResponse {
7043
+ /** All order's transactions after the void was triggered */
7044
+ orderTransactions?: OrderTransactions;
7016
7045
  }
7017
- /**
7018
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
7019
- * Consumed by other teams to remove relevant data.
7020
- */
7021
- interface SitePurgedExternally {
7046
+ interface CaptureAuthorizedPaymentsRequest {
7022
7047
  /**
7023
- * @maxLength 2048
7048
+ * Wix eCommerce order ID
7049
+ * @minLength 1
7050
+ * @maxLength 100
7051
+ */
7052
+ ecomOrderId: string;
7053
+ /**
7054
+ * Capture payments information
7055
+ * @minSize 1
7024
7056
  * @maxSize 100
7025
- * @deprecated
7026
- * @targetRemovalDate 2025-04-15
7027
7057
  */
7028
- appDefId?: string[];
7029
- }
7030
- /** Assigned Odeditor */
7031
- interface OdeditorAssigned {
7032
- }
7033
- /** Unassigned Odeditor */
7034
- interface OdeditorUnassigned {
7035
- }
7036
- /** Assigned Picasso editor */
7037
- interface PicassoAssigned {
7038
- }
7039
- /** Unassigned Picasso */
7040
- interface PicassoUnassigned {
7041
- }
7042
- /** Assigned Wixel */
7043
- interface WixelAssigned {
7044
- }
7045
- /** Unassigned Wixel */
7046
- interface WixelUnassigned {
7047
- }
7048
- /** Assigned StudioTwo */
7049
- interface StudioTwoAssigned {
7050
- }
7051
- /** Unassigned StudioTwo */
7052
- interface StudioTwoUnassigned {
7053
- }
7054
- /** Media from user domain is enabled. */
7055
- interface UserDomainMediaEnabled {
7056
- }
7057
- /** Media from user domain is disabled. */
7058
- interface UserDomainMediaDisabled {
7059
- }
7060
- /** Assigned Editorless */
7061
- interface EditorlessAssigned {
7058
+ payments: PaymentCapture[];
7062
7059
  }
7063
- /** Unassigned Editorless */
7064
- interface EditorlessUnassigned {
7060
+ interface PaymentCapture {
7061
+ /**
7062
+ * Payment ID
7063
+ * @format GUID
7064
+ */
7065
+ paymentId?: string | null;
7066
+ /**
7067
+ * Capture amount.
7068
+ * If not provided - full authorized amount will be captured.
7069
+ */
7070
+ amount?: Price;
7065
7071
  }
7066
- interface HasCustomEmailConfigurationsRequest {
7072
+ interface CaptureAuthorizedPaymentsResponse {
7073
+ /** All order's transactions after the capture was triggered */
7074
+ orderTransactions?: OrderTransactions;
7067
7075
  }
7068
- interface HasCustomEmailConfigurationsResponse {
7069
- hasCustomConfigurations?: boolean;
7076
+ interface ChargeSavedPaymentMethodRequest {
7077
+ /**
7078
+ * Ecom Order ID.
7079
+ * @minLength 1
7080
+ * @maxLength 100
7081
+ */
7082
+ ecomOrderId?: string;
7083
+ /** Amount to be charged */
7084
+ amount?: Price;
7070
7085
  }
7071
- interface AddToAutomationMigrationPopulationRequest {
7072
- /** When true, sends custom email configurations to automation system via email */
7073
- sendCustomEmailConfigs?: boolean;
7074
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
7075
- origin?: OriginWithLiterals;
7086
+ interface ChargeSavedPaymentMethodResponse {
7087
+ /** Payment gateway's order ID (e.g Wix Payments) */
7088
+ paymentGatewayOrderId?: string;
7076
7089
  }
7077
- declare enum Origin {
7078
- OPT_IN = "OPT_IN",
7079
- MIGRATION = "MIGRATION"
7090
+ interface V1TriggerReindexRequest {
7091
+ /** @format GUID */
7092
+ metasiteId?: string;
7093
+ /**
7094
+ * @minLength 1
7095
+ * @maxLength 100
7096
+ * @maxSize 100
7097
+ */
7098
+ orderIds?: string[];
7080
7099
  }
7081
- /** @enumType */
7082
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
7083
- interface AddToAutomationMigrationPopulationResponse {
7084
- success?: boolean;
7100
+ interface V1TriggerReindexResponse {
7085
7101
  }
7086
- interface IsInAutomationMigrationPopulationRequest {
7102
+ interface V1TriggerReindexOrderRequest {
7103
+ /** @format GUID */
7104
+ metasiteId?: string;
7105
+ /**
7106
+ * @minLength 1
7107
+ * @maxLength 100
7108
+ */
7109
+ orderId?: string;
7087
7110
  }
7088
- interface IsInAutomationMigrationPopulationResponse {
7089
- inPopulation?: boolean;
7111
+ interface PricesRecalculatedForDestination {
7112
+ /**
7113
+ * 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.
7114
+ * @format COUNTRY
7115
+ */
7116
+ country?: string | null;
7117
+ /**
7118
+ * 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.
7119
+ * @format COUNTRY
7120
+ */
7121
+ previousCountry?: string | null;
7122
+ /**
7123
+ * 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.
7124
+ * @min 1
7125
+ * @max 1000000
7126
+ */
7127
+ lineCount?: number;
7090
7128
  }
7091
7129
  interface DiffmatokyPayload {
7092
7130
  left?: string;
@@ -9320,4 +9358,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
9320
9358
  declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
9321
9359
  declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
9322
9360
 
9323
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CrossBorderAdjustmentUpdate as CrossBorderAdjustmentUpdateOriginal, type CrossBorderCalculation as CrossBorderCalculationOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CrossBorderRepricing as CrossBorderRepricingOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
9361
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CrossBorderAdjustmentUpdate as CrossBorderAdjustmentUpdateOriginal, type CrossBorderCalculation as CrossBorderCalculationOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CrossBorderRepricing as CrossBorderRepricingOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type PricesRecalculatedForDestination as PricesRecalculatedForDestinationOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };