@wix/auto_sdk_ecom_orders 1.0.271 → 1.0.273

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 (41) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-UEDhg1yc.d.ts → ecom-v1-order-orders.universal-BNbEEKoj.d.ts} +1685 -1642
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +104 -77
  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 +104 -77
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1686 -1643
  9. package/build/cjs/meta.js +104 -77
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-UEDhg1yc.d.mts → ecom-v1-order-orders.universal-BNbEEKoj.d.mts} +1685 -1642
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +103 -77
  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 +103 -77
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1686 -1643
  19. package/build/es/meta.mjs +103 -77
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-CuidLNHL.d.ts → ecom-v1-order-orders.universal-Ciarg0NQ.d.ts} +1859 -1749
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.js +104 -77
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +2 -2
  26. package/build/internal/cjs/index.typings.js +104 -77
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +1686 -1643
  29. package/build/internal/cjs/meta.js +104 -77
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/internal/es/{ecom-v1-order-orders.universal-CuidLNHL.d.mts → ecom-v1-order-orders.universal-Ciarg0NQ.d.mts} +1859 -1749
  32. package/build/internal/es/index.d.mts +2 -2
  33. package/build/internal/es/index.mjs +103 -77
  34. package/build/internal/es/index.mjs.map +1 -1
  35. package/build/internal/es/index.typings.d.mts +2 -2
  36. package/build/internal/es/index.typings.mjs +103 -77
  37. package/build/internal/es/index.typings.mjs.map +1 -1
  38. package/build/internal/es/meta.d.mts +1686 -1643
  39. package/build/internal/es/meta.mjs +103 -77
  40. package/build/internal/es/meta.mjs.map +1 -1
  41. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { dK as ImportOrderRequest$1, dL as ImportOrderResponse$1, dM as SetOrderNumberCounterRequest$1, dN as SetOrderNumberCounterResponse$1, dO as BulkDeleteImportedOrdersRequest$1, dP as BulkDeleteImportedOrdersResponse$1, dT as PreparePaymentCollectionRequest$1, b as PreparePaymentCollectionResponse$1, dX as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, dY as RecordManuallyCollectedPaymentRequest$1, d$ as RecordManuallyCollectedPaymentResponse$1, e0 as MarkOrderAsPaidRequest$1, e1 as MarkOrderAsPaidResponse$1, e2 as BulkMarkOrdersAsPaidRequest$1, e3 as BulkMarkOrdersAsPaidResponse$1, e8 as GetRefundabilityStatusRequest$1, e9 as GetRefundabilityStatusResponse$1, ec as CreatePaymentGatewayOrderRequest$1, ee as CreatePaymentGatewayOrderResponse$1, ef as ChargeMembershipsRequest$1, ej as ChargeMembershipsResponse$1, ek as TriggerRefundRequest$1, eu as TriggerRefundResponse$1, f2 as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, f3 as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gn as GetOrderRequest$1, go as GetOrderResponse$1, gA as SearchOrdersRequest$1, S as SearchOrdersResponse$1, gE as CreateOrderRequest$1, gI as CreateOrderResponse$1, gJ as UpdateOrderRequest$1, gK as UpdateOrderResponse$1, gL as BulkUpdateOrdersRequest$1, l as BulkUpdateOrdersResponse$1, he as UpdateOrderLineItemRequest$1, hf as UpdateOrderLineItemResponse$1, hG as AddActivityRequest$1, hJ as AddActivityResponse$1, hK as AddActivitiesRequest$1, m as AddActivitiesResponse$1, hL as UpdateActivityRequest$1, hM as UpdateActivityResponse$1, hN as DeleteActivityRequest$1, hO as DeleteActivityResponse$1, hU as CancelOrderRequest$1, o as CancelOrderResponse$1, hV as UpdateOrderStatusRequest$1, hW as UpdateOrderStatusResponse$1, ij as AggregateOrdersRequest$1, ik as AggregateOrdersResponse$1, ip as BulkUpdateOrderTagsRequest$1, r as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-UEDhg1yc.js';
1
+ import { dN as ImportOrderRequest$1, dO as ImportOrderResponse$1, dP as SetOrderNumberCounterRequest$1, dQ as SetOrderNumberCounterResponse$1, dR as BulkDeleteImportedOrdersRequest$1, dS as BulkDeleteImportedOrdersResponse$1, fb as PreparePaymentCollectionRequest$1, b as PreparePaymentCollectionResponse$1, ff as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fg as RecordManuallyCollectedPaymentRequest$1, fj as RecordManuallyCollectedPaymentResponse$1, fk as MarkOrderAsPaidRequest$1, fl as MarkOrderAsPaidResponse$1, fm as BulkMarkOrdersAsPaidRequest$1, fn as BulkMarkOrdersAsPaidResponse$1, fs as GetRefundabilityStatusRequest$1, ft as GetRefundabilityStatusResponse$1, fw as CreatePaymentGatewayOrderRequest$1, fy as CreatePaymentGatewayOrderResponse$1, fz as ChargeMembershipsRequest$1, fD as ChargeMembershipsResponse$1, fE as TriggerRefundRequest$1, fJ as TriggerRefundResponse$1, gh as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gi as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gq as GetOrderRequest$1, gr as GetOrderResponse$1, gD as SearchOrdersRequest$1, S as SearchOrdersResponse$1, gH as CreateOrderRequest$1, gL as CreateOrderResponse$1, gM as UpdateOrderRequest$1, gN as UpdateOrderResponse$1, gO as BulkUpdateOrdersRequest$1, l as BulkUpdateOrdersResponse$1, hh as UpdateOrderLineItemRequest$1, hi as UpdateOrderLineItemResponse$1, hJ as AddActivityRequest$1, hM as AddActivityResponse$1, hN as AddActivitiesRequest$1, m as AddActivitiesResponse$1, hO as UpdateActivityRequest$1, hP as UpdateActivityResponse$1, hQ as DeleteActivityRequest$1, hR as DeleteActivityResponse$1, hX as CancelOrderRequest$1, o as CancelOrderResponse$1, hY as UpdateOrderStatusRequest$1, hZ as UpdateOrderStatusResponse$1, im as AggregateOrdersRequest$1, io as AggregateOrdersResponse$1, is as BulkUpdateOrderTagsRequest$1, r as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-BNbEEKoj.js';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -889,6 +889,70 @@ declare enum TaxableAddressType {
889
889
  }
890
890
  /** @enumType */
891
891
  type TaxableAddressTypeWithLiterals = TaxableAddressType | 'BUSINESS' | 'BILLING' | 'SHIPPING';
892
+ /**
893
+ * Decimal-quantity metadata for a line item.
894
+ *
895
+ * Set on a line item that represents a non-integer-quantity purchase
896
+ * (e.g. "2.75 square meters of fake grass", "1.5 kg of sugar",
897
+ * "0.75 hours of consultation"). When set, the line item must have
898
+ * `fixedQuantity` = true.
899
+ *
900
+ * The decimal value lives in `value`. When `decimalQuantity` is set,
901
+ * consumers read the human-readable quantity from `value` rather
902
+ * than from `lineItem.quantity`.
903
+ */
904
+ interface DecimalQuantity extends DecimalQuantityUnitOneOf {
905
+ }
906
+ /** @oneof */
907
+ interface DecimalQuantityUnitOneOf {
908
+ }
909
+ interface TranslatableString {
910
+ /**
911
+ * __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
912
+ *
913
+ * Min: 1 character.
914
+ * Max: 200 characters.
915
+ * @minLength 1
916
+ * @maxLength 200
917
+ */
918
+ original?: string;
919
+ /**
920
+ * String translated into the buyer's language.
921
+ *
922
+ * Min: 1 character.
923
+ * Max: 400 characters.
924
+ * Default: Same as `original`.
925
+ * @minLength 1
926
+ * @maxLength 400
927
+ */
928
+ translated?: string | null;
929
+ }
930
+ declare enum MeasurementUnit {
931
+ UNSPECIFIED = "UNSPECIFIED",
932
+ ML = "ML",
933
+ CL = "CL",
934
+ L = "L",
935
+ CBM = "CBM",
936
+ MG = "MG",
937
+ G = "G",
938
+ KG = "KG",
939
+ MM = "MM",
940
+ CM = "CM",
941
+ M = "M",
942
+ SQM = "SQM",
943
+ OZ = "OZ",
944
+ LB = "LB",
945
+ FLOZ = "FLOZ",
946
+ PT = "PT",
947
+ QT = "QT",
948
+ GAL = "GAL",
949
+ IN = "IN",
950
+ FT = "FT",
951
+ YD = "YD",
952
+ SQFT = "SQFT"
953
+ }
954
+ /** @enumType */
955
+ type MeasurementUnitWithLiterals = MeasurementUnit | 'UNSPECIFIED' | 'ML' | 'CL' | 'L' | 'CBM' | 'MG' | 'G' | 'KG' | 'MM' | 'CM' | 'M' | 'SQM' | 'OZ' | 'LB' | 'FLOZ' | 'PT' | 'QT' | 'GAL' | 'IN' | 'FT' | 'YD' | 'SQFT';
892
956
  interface ExtendedFields {
893
957
  /**
894
958
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -916,27 +980,6 @@ interface ModifierGroup {
916
980
  */
917
981
  modifiers?: ItemModifier[];
918
982
  }
919
- interface TranslatableString {
920
- /**
921
- * __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
922
- *
923
- * Min: 1 character.
924
- * Max: 200 characters.
925
- * @minLength 1
926
- * @maxLength 200
927
- */
928
- original?: string;
929
- /**
930
- * String translated into the buyer's language.
931
- *
932
- * Min: 1 character.
933
- * Max: 400 characters.
934
- * Default: Same as `original`.
935
- * @minLength 1
936
- * @maxLength 400
937
- */
938
- translated?: string | null;
939
- }
940
983
  interface ItemModifier {
941
984
  /**
942
985
  * Modifier ID.
@@ -3777,2104 +3820,2104 @@ interface BulkDeleteImportedOrdersResponse {
3777
3820
  */
3778
3821
  jobId?: string;
3779
3822
  }
3780
- interface V1TriggerReindexRequest {
3823
+ interface SendBuyerConfirmationEmailRequest {
3781
3824
  /** @format GUID */
3782
- metasiteId?: string;
3825
+ orderId?: string;
3826
+ }
3827
+ interface SendBuyerConfirmationEmailResponse {
3828
+ }
3829
+ interface SendBuyerPaymentsReceivedEmailRequest {
3783
3830
  /**
3784
3831
  * @minLength 1
3785
3832
  * @maxLength 100
3786
- * @maxSize 100
3787
3833
  */
3788
- orderIds?: string[];
3834
+ orderId?: string;
3789
3835
  }
3790
- interface V1TriggerReindexResponse {
3836
+ interface SendBuyerPaymentsReceivedEmailResponse {
3791
3837
  }
3792
- interface V1TriggerReindexOrderRequest {
3793
- /** @format GUID */
3794
- metasiteId?: string;
3838
+ interface SendBuyerPickupConfirmationEmailRequest {
3795
3839
  /**
3796
3840
  * @minLength 1
3797
3841
  * @maxLength 100
3798
3842
  */
3799
3843
  orderId?: string;
3800
3844
  }
3801
- interface PreparePaymentCollectionRequest {
3845
+ interface SendBuyerPickupConfirmationEmailResponse {
3846
+ }
3847
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
3802
3848
  /**
3803
- * Ecom order ID.
3804
- * @minLength 1
3805
- * @maxLength 100
3849
+ * IDs of orders to send pickup emails for.
3850
+ * @minSize 1
3851
+ * @maxSize 300
3806
3852
  */
3807
- ecomOrderId: string;
3808
- /** Amount to collect */
3809
- amount: Price;
3853
+ orderIds?: string[];
3854
+ }
3855
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
3856
+ }
3857
+ interface SendBuyerShippingConfirmationEmailRequest {
3810
3858
  /**
3811
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
3812
- * Existing payment gateway order will be updated with a new amount.
3813
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
3859
+ * @minLength 1
3860
+ * @maxLength 100
3814
3861
  */
3815
- paymentGatewayOrderId?: string | null;
3862
+ orderId?: string;
3863
+ }
3864
+ interface SendBuyerShippingConfirmationEmailResponse {
3865
+ }
3866
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
3816
3867
  /**
3817
- * Whether to delay capture of the payment.
3818
- * Default: false
3819
- * @deprecated Whether to delay capture of the payment.
3820
- * Default: false
3821
- * @replacedBy delayed_capture_settings.scheduled_action
3822
- * @targetRemovalDate 2024-09-30
3868
+ * IDs of orders to send pickup emails for.
3869
+ * @minSize 1
3870
+ * @maxSize 300
3823
3871
  */
3824
- delayedCapture?: boolean;
3825
- /** Delayed capture payment settings */
3826
- delayedCaptureSettings?: DelayedCaptureSettings;
3872
+ orderIds?: string[];
3827
3873
  }
3828
- interface RedirectUrls {
3874
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
3875
+ }
3876
+ interface SendMerchantOrderReceivedNotificationRequest {
3829
3877
  /**
3830
- * URL to redirect buyer in case of approved (successful) transaction
3831
- * @format WEB_URL
3878
+ * @minLength 1
3879
+ * @maxLength 100
3832
3880
  */
3833
- successUrl?: string | null;
3881
+ orderId?: string;
3882
+ }
3883
+ interface SendMerchantOrderReceivedNotificationResponse {
3884
+ }
3885
+ interface SendCancelRefundEmailRequest {
3834
3886
  /**
3835
- * URL to redirect buyer in case of buyer canceled the transaction
3836
- * @format WEB_URL
3887
+ * The ID of order that is canceled/refunded
3888
+ * @minLength 1
3889
+ * @maxLength 100
3837
3890
  */
3838
- cancelUrl?: string | null;
3891
+ orderId?: string;
3839
3892
  /**
3840
- * URL to redirect buyer in case of failed/rejected transaction
3841
- * @format WEB_URL
3893
+ * Personal note added to the email (optional)
3894
+ * @minLength 1
3895
+ * @maxLength 1000
3842
3896
  */
3843
- errorUrl?: string | null;
3897
+ customMessage?: string | null;
3898
+ /** Refund amount */
3899
+ refundAmount?: Price;
3844
3900
  /**
3845
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
3846
- * @format WEB_URL
3901
+ * Refund ID. (Optional)
3902
+ * @format GUID
3847
3903
  */
3848
- pendingUrl?: string | null;
3849
- }
3850
- interface DelayedCaptureSettings {
3851
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
3852
- scheduledAction?: ScheduledActionWithLiterals;
3853
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
3854
- delayDuration?: Duration;
3904
+ refundId?: string | null;
3855
3905
  }
3856
- declare enum ScheduledAction {
3857
- /** Whether payment will be auto-voided when duration passes */
3858
- VOID = "VOID",
3859
- /** Whether payment will be auto-captured when duration passes */
3860
- CAPTURE = "CAPTURE"
3906
+ interface SendCancelRefundEmailResponse {
3861
3907
  }
3862
- /** @enumType */
3863
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
3864
- interface Duration {
3908
+ interface SendRefundEmailRequest {
3865
3909
  /**
3866
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
3867
- * @min 1
3910
+ * The ID of order that is refunded
3911
+ * @format GUID
3868
3912
  */
3869
- count?: number;
3870
- /** Duration unit: MINUTES, HOURS and DAYS */
3871
- unit?: DurationUnitWithLiterals;
3913
+ orderId?: string;
3914
+ /**
3915
+ * Refund ID
3916
+ * @format GUID
3917
+ */
3918
+ refundId?: string;
3919
+ /**
3920
+ * Personal note added to the email (optional)
3921
+ * @minLength 1
3922
+ * @maxLength 1000
3923
+ */
3924
+ customMessage?: string | null;
3872
3925
  }
3873
- declare enum DurationUnit {
3874
- MINUTES = "MINUTES",
3875
- HOURS = "HOURS",
3876
- DAYS = "DAYS"
3926
+ interface SendRefundEmailResponse {
3877
3927
  }
3878
- /** @enumType */
3879
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
3880
- interface PreparePaymentCollectionResponse {
3881
- /** Payment gateway order id which is associated with given payment */
3882
- paymentGatewayOrderId?: string;
3928
+ interface SendFulfillmentEmailRequest {
3929
+ /** @format GUID */
3930
+ orderId?: string;
3931
+ /** @format GUID */
3932
+ fulfillerId?: string;
3883
3933
  }
3884
- interface GetPaymentCollectabilityStatusRequest {
3934
+ interface SendFulfillmentEmailResponse {
3935
+ }
3936
+ interface SendMerchantOrderReceivedPushRequest {
3885
3937
  /**
3886
- * Ecom order ID.
3887
3938
  * @minLength 1
3888
3939
  * @maxLength 100
3889
3940
  */
3890
- ecomOrderId: string;
3941
+ orderId?: string;
3891
3942
  }
3892
- interface GetPaymentCollectabilityStatusResponse {
3893
- /** Payment collectability status */
3894
- status?: PaymentCollectabilityStatusWithLiterals;
3895
- /** Collectable order amount */
3896
- amount?: Price;
3943
+ interface SendMerchantOrderReceivedPushResponse {
3897
3944
  }
3898
- declare enum PaymentCollectabilityStatus {
3899
- UNKNOWN = "UNKNOWN",
3900
- COLLECTABLE = "COLLECTABLE",
3901
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
3902
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
3903
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
3904
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
3905
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
3906
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
3907
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
3908
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
3909
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
3910
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
3945
+ interface PreviewEmailByTypeRequest {
3946
+ emailType?: PreviewEmailTypeWithLiterals;
3947
+ }
3948
+ declare enum PreviewEmailType {
3949
+ ORDER_PLACED = "ORDER_PLACED",
3950
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
3951
+ ORDER_SHIPPED = "ORDER_SHIPPED",
3952
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
3911
3953
  }
3912
3954
  /** @enumType */
3913
- 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';
3914
- interface RecordManuallyCollectedPaymentRequest {
3955
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
3956
+ interface PreviewEmailByTypeResponse {
3957
+ emailPreview?: string;
3958
+ }
3959
+ interface PreviewRefundEmailRequest {
3915
3960
  /**
3916
- * Order ID.
3917
3961
  * @minLength 1
3918
3962
  * @maxLength 100
3919
3963
  */
3920
- orderId: string;
3921
- /** Amount to be recorded as approved manual payment for given order */
3922
- amount: Price;
3923
- }
3924
- /**
3925
- * User-defined payment method name.
3926
- * Allows specifying either a predefined type or a custom name.
3927
- */
3928
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
3929
- /** Predefined payment method. */
3930
- predefined?: PredefinedPaymentMethodWithLiterals;
3964
+ orderId?: string;
3965
+ /** Refund amount */
3966
+ refundAmount?: Price;
3967
+ /** Refund business details */
3968
+ details?: RefundDetails;
3931
3969
  /**
3932
- * Custom payment method name provided by user.
3933
- *
3934
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
3970
+ * Personal note added to the email (optional)
3935
3971
  * @minLength 1
3936
- * @maxLength 100
3972
+ * @maxLength 1000
3937
3973
  */
3938
- custom?: string | null;
3939
- }
3940
- /** @oneof */
3941
- interface UserDefinedPaymentMethodNameKindOneOf {
3942
- /** Predefined payment method. */
3943
- predefined?: PredefinedPaymentMethodWithLiterals;
3974
+ customMessage?: string | null;
3944
3975
  /**
3945
- * Custom payment method name provided by user.
3946
- *
3947
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
3948
- * @minLength 1
3949
- * @maxLength 100
3976
+ * Refund ID. (Optional)
3977
+ * @format GUID
3950
3978
  */
3951
- custom?: string | null;
3952
- }
3953
- /** Predefined payment method types for offline/manual payments. */
3954
- declare enum PredefinedPaymentMethod {
3955
- /** Cash payment. */
3956
- CASH = "CASH",
3957
- /** Bank transfer. */
3958
- BANK_TRANSFER = "BANK_TRANSFER",
3959
- /** Payment by check. */
3960
- CHECK = "CHECK"
3961
- }
3962
- /** @enumType */
3963
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
3964
- interface RecordManuallyCollectedPaymentResponse {
3979
+ refundId?: string | null;
3965
3980
  }
3966
- interface MarkOrderAsPaidRequest {
3981
+ /** Business model of a refund request */
3982
+ interface RefundDetails {
3967
3983
  /**
3968
- * Ecom order ID.
3969
- * @minLength 1
3970
- * @maxLength 100
3984
+ * Order line item IDs and quantities that were refunded.
3985
+ * @maxSize 300
3971
3986
  */
3972
- ecomOrderId: string;
3973
- }
3974
- interface MarkOrderAsPaidResponse {
3975
- /** Updated order. */
3976
- order?: Order;
3977
- }
3978
- interface BulkMarkOrdersAsPaidRequest {
3987
+ items?: RefundItem[];
3988
+ /** Whether the shipping fee was also refunded. */
3989
+ shippingIncluded?: boolean;
3979
3990
  /**
3980
- * IDs of orders to mark as paid.
3981
- * @minSize 1
3991
+ * Reason for the refund, provided by customer (optional).
3992
+ * @maxLength 200
3993
+ */
3994
+ reason?: string | null;
3995
+ /**
3996
+ * Line items that were refunded.
3997
+ * @maxSize 300
3998
+ */
3999
+ lineItems?: LineItemRefund[];
4000
+ /**
4001
+ * Additional fees that were refunded.
3982
4002
  * @maxSize 100
3983
- * @minLength 1
3984
- * @maxLength 100
3985
4003
  */
3986
- ecomOrderIds: string[];
4004
+ additionalFees?: AdditionalFeeRefund[];
4005
+ /** Shipping amount that was refunded. */
4006
+ shipping?: ShippingRefund;
3987
4007
  }
3988
- interface BulkMarkOrdersAsPaidResponse {
4008
+ interface RefundItem {
3989
4009
  /**
3990
- * Items updated by the bulk action.
3991
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4010
+ * Line item ID the refunded line item.
4011
+ * @format GUID
3992
4012
  */
3993
- results?: BulkOrderResult[];
3994
- /** Bulk action metadata. */
3995
- bulkActionMetadata?: BulkActionMetadata;
3996
- }
3997
- interface BulkOrderResult {
3998
- /** Item metadata. */
3999
- itemMetadata?: ItemMetadata;
4013
+ lineItemId?: string;
4000
4014
  /**
4001
- * Updated order.
4002
- *
4003
- * Returned when `returnFullEntity = true`.
4015
+ * Line item quantity refunded.
4016
+ * @min 1
4017
+ * @max 100000
4004
4018
  */
4005
- item?: Order;
4006
- }
4007
- interface ItemMetadata {
4008
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4009
- id?: string | null;
4010
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4011
- originalIndex?: number;
4012
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4013
- success?: boolean;
4014
- /** Details about the error in case of failure. */
4015
- error?: ApplicationError;
4016
- }
4017
- interface ApplicationError {
4018
- /** Error code. */
4019
- code?: string;
4020
- /** Description of the error. */
4021
- description?: string;
4022
- /** Data related to the error. */
4023
- data?: Record<string, any> | null;
4024
- }
4025
- interface BulkActionMetadata {
4026
- /** Number of items that were successfully processed. */
4027
- totalSuccesses?: number;
4028
- /** Number of items that couldn't be processed. */
4029
- totalFailures?: number;
4030
- /** Number of failures without details because detailed failure threshold was exceeded. */
4031
- undetailedFailures?: number;
4019
+ quantity?: number;
4032
4020
  }
4033
- interface GetRefundabilityStatusRequest {
4021
+ interface LineItemRefund {
4034
4022
  /**
4035
- * Order ID.
4036
- * @minLength 1
4037
- * @maxLength 100
4023
+ * Line item ID.
4024
+ * @format GUID
4025
+ * @immutable
4038
4026
  */
4039
- ecomOrderId: string;
4027
+ lineItemId?: string;
4028
+ /**
4029
+ * Refund quantity.
4030
+ * @min 1
4031
+ * @max 100000
4032
+ * @immutable
4033
+ */
4034
+ quantity?: number;
4040
4035
  }
4041
- interface GetRefundabilityStatusResponse {
4036
+ interface AdditionalFeeRefund {
4042
4037
  /**
4043
- * Refundability details.
4044
- * @maxSize 300
4038
+ * Additional fee ID.
4039
+ * @format GUID
4040
+ * @immutable
4045
4041
  */
4046
- refundabilities?: Refundability[];
4042
+ additionalFeeId?: string;
4047
4043
  /**
4048
- * Whether the order supports refunding per item.
4049
- * @deprecated
4044
+ * Refund amount.
4045
+ * @immutable
4050
4046
  */
4051
- refundablePerItem?: boolean;
4052
- }
4053
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4054
- /** Reason why payment is not refundable. */
4055
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4056
- /** Reason why payment is only refundable manually. */
4057
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4058
- /** Payment ID. */
4059
- paymentId?: string;
4060
- /** Payment refundability status. */
4061
- refundabilityStatus?: RefundableStatusWithLiterals;
4062
- /** Link to payment provider dashboard. */
4063
- providerLink?: string | null;
4064
- }
4065
- /** @oneof */
4066
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4067
- /** Reason why payment is not refundable. */
4068
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4069
- /** Reason why payment is only refundable manually. */
4070
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4071
- }
4072
- declare enum RefundableStatus {
4073
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4074
- MANUAL = "MANUAL",
4075
- REFUNDABLE = "REFUNDABLE"
4047
+ amount?: Price;
4076
4048
  }
4077
- /** @enumType */
4078
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4079
- declare enum NonRefundableReason {
4080
- NONE = "NONE",
4081
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4082
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4083
- INTERNAL_ERROR = "INTERNAL_ERROR",
4084
- NOT_PAID = "NOT_PAID",
4085
- ACCESS_DENIED = "ACCESS_DENIED",
4086
- ZERO_PRICE = "ZERO_PRICE",
4087
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4088
- PENDING_REFUND = "PENDING_REFUND",
4089
- FORBIDDEN = "FORBIDDEN",
4090
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4091
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4092
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4049
+ interface ShippingRefund {
4050
+ /**
4051
+ * Refund amount.
4052
+ * @immutable
4053
+ */
4054
+ amount?: Price;
4093
4055
  }
4094
- /** @enumType */
4095
- 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';
4096
- declare enum ManuallyRefundableReason {
4097
- EXPIRED = "EXPIRED",
4098
- NOT_SUPPORTED = "NOT_SUPPORTED",
4099
- OFFLINE = "OFFLINE",
4100
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4056
+ interface PreviewRefundEmailResponse {
4057
+ emailPreview?: string;
4101
4058
  }
4102
- /** @enumType */
4103
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4104
- interface CreatePaymentGatewayOrderRequest {
4059
+ interface PreviewCancelEmailRequest {
4105
4060
  /**
4106
- * Ecom order ID.
4107
4061
  * @minLength 1
4108
4062
  * @maxLength 100
4109
4063
  */
4110
- ecomOrderId: string;
4111
- /** Information about the user who initiated the payment. */
4112
- chargedBy?: ChargedBy;
4113
- }
4114
- interface ChargedBy {
4115
- /**
4116
- * ID - id of the user who initiated the payment
4117
- * @format GUID
4118
- */
4119
- id?: string;
4064
+ orderId?: string;
4120
4065
  /**
4121
- * Full name - name of the user who initiated the payment
4066
+ * Personal note added to the email (optional)
4122
4067
  * @minLength 1
4123
- * @maxLength 200
4068
+ * @maxLength 1000
4124
4069
  */
4125
- fullName?: string | null;
4070
+ customMessage?: string | null;
4126
4071
  }
4127
- interface CreatePaymentGatewayOrderResponse {
4128
- /** ID of the order created in the payment gateway */
4129
- paymentGatewayOrderId?: string;
4072
+ interface PreviewCancelEmailResponse {
4073
+ emailPreview?: string;
4130
4074
  }
4131
- interface ChargeMembershipsRequest {
4075
+ interface PreviewCancelRefundEmailRequest {
4132
4076
  /**
4133
- * Order ID.
4134
4077
  * @minLength 1
4135
4078
  * @maxLength 100
4136
4079
  */
4137
- ecomOrderId: string;
4080
+ orderId?: string;
4138
4081
  /**
4139
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4140
- * but a user which is using the membership on behalf of the a member
4141
- * @format GUID
4082
+ * Personal note added to the email (optional)
4083
+ * @minLength 1
4084
+ * @maxLength 1000
4142
4085
  */
4143
- memberId: string;
4086
+ customMessage?: string | null;
4087
+ /** Refund amount */
4088
+ refundAmount?: Price;
4144
4089
  /**
4145
- * List of items to be paid by memberships
4146
- * @minSize 1
4147
- * @maxSize 300
4090
+ * Refund ID. (Optional)
4091
+ * @format GUID
4148
4092
  */
4149
- membershipCharges?: MembershipChargeItem[];
4093
+ refundId?: string | null;
4150
4094
  }
4151
- interface MembershipChargeItem {
4095
+ interface PreviewCancelRefundEmailResponse {
4096
+ emailPreview?: string;
4097
+ }
4098
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
4099
+ }
4100
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4101
+ emailPreview?: string;
4102
+ }
4103
+ interface PreviewBuyerConfirmationEmailRequest {
4104
+ }
4105
+ interface PreviewBuyerConfirmationEmailResponse {
4106
+ emailPreview?: string;
4107
+ }
4108
+ interface PreviewBuyerPickupConfirmationEmailRequest {
4109
+ }
4110
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4111
+ emailPreview?: string;
4112
+ }
4113
+ interface PreviewShippingConfirmationEmailRequest {
4114
+ }
4115
+ interface PreviewShippingConfirmationEmailResponse {
4116
+ emailPreview?: string;
4117
+ }
4118
+ interface PreviewResendDownloadLinksEmailRequest {
4119
+ }
4120
+ interface PreviewResendDownloadLinksEmailResponse {
4121
+ emailPreview?: string;
4122
+ }
4123
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4124
+ /** Emitted on a meta site creation. */
4125
+ siteCreated?: SiteCreated;
4126
+ /** Emitted on a meta site transfer completion. */
4127
+ siteTransferred?: SiteTransferred;
4128
+ /** Emitted on a meta site deletion. */
4129
+ siteDeleted?: SiteDeleted;
4130
+ /** Emitted on a meta site restoration. */
4131
+ siteUndeleted?: SiteUndeleted;
4132
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4133
+ sitePublished?: SitePublished;
4134
+ /** Emitted on a meta site unpublish. */
4135
+ siteUnpublished?: SiteUnpublished;
4136
+ /** Emitted when meta site is marked as template. */
4137
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4138
+ /** Emitted when meta site is marked as a WixSite. */
4139
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4140
+ /** Emitted when an application is provisioned (installed). */
4141
+ serviceProvisioned?: ServiceProvisioned;
4142
+ /** Emitted when an application is removed (uninstalled). */
4143
+ serviceRemoved?: ServiceRemoved;
4144
+ /** Emitted when meta site name (URL slug) is changed. */
4145
+ siteRenamedPayload?: SiteRenamed;
4146
+ /** Emitted when meta site was permanently deleted. */
4147
+ hardDeleted?: SiteHardDeleted;
4148
+ /** Emitted on a namespace change. */
4149
+ namespaceChanged?: NamespaceChanged;
4150
+ /** Emitted when Studio is attached. */
4151
+ studioAssigned?: StudioAssigned;
4152
+ /** Emitted when Studio is detached. */
4153
+ studioUnassigned?: StudioUnassigned;
4152
4154
  /**
4153
- * The id of used membership
4154
- * @minLength 1
4155
- * @maxLength 100
4155
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4156
+ * the actual URL.
4157
+ *
4158
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4159
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4156
4160
  */
4157
- membershipId?: string;
4161
+ urlChanged?: SiteUrlChanged;
4162
+ /** Site is marked as PurgedExternally */
4163
+ sitePurgedExternally?: SitePurgedExternally;
4164
+ /** Emitted when Odeditor is attached. */
4165
+ odeditorAssigned?: OdeditorAssigned;
4166
+ /** Emitted when Odeditor is detached. */
4167
+ odeditorUnassigned?: OdeditorUnassigned;
4168
+ /** Emitted when Picasso is attached. */
4169
+ picassoAssigned?: PicassoAssigned;
4170
+ /** Emitted when Picasso is detached. */
4171
+ picassoUnassigned?: PicassoUnassigned;
4172
+ /** Emitted when Wixel is attached. */
4173
+ wixelAssigned?: WixelAssigned;
4174
+ /** Emitted when Wixel is detached. */
4175
+ wixelUnassigned?: WixelUnassigned;
4176
+ /** Emitted when StudioTwo is attached. */
4177
+ studioTwoAssigned?: StudioTwoAssigned;
4178
+ /** Emitted when StudioTwo is detached. */
4179
+ studioTwoUnassigned?: StudioTwoUnassigned;
4180
+ /** Emitted when media from user domain is enabled. */
4181
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4182
+ /** Emitted when media from user domain is disabled. */
4183
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4184
+ /** Emitted when Editorless is attached. */
4185
+ editorlessAssigned?: EditorlessAssigned;
4186
+ /** Emitted when Editorless is detached. */
4187
+ editorlessUnassigned?: EditorlessUnassigned;
4158
4188
  /**
4159
- * ID of the application providing this payment option
4189
+ * A meta site id.
4160
4190
  * @format GUID
4161
4191
  */
4162
- appId?: string;
4163
- /** The name of used membership */
4164
- membershipName?: MembershipName;
4165
- /** Additional data about this membership */
4166
- membershipAdditionalData?: Record<string, any> | null;
4167
- /** Catalog and item reference info. */
4168
- catalogReference?: CatalogReference;
4169
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4170
- serviceProperties?: ServiceProperties;
4171
- /**
4172
- * Usually would be the same as catalogReference.catalogItemId
4173
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4174
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4175
- * @minLength 1
4176
- * @maxLength 36
4177
- */
4178
- rootCatalogItemId?: string | null;
4192
+ metaSiteId?: string;
4193
+ /** A meta site version. Monotonically increasing. */
4194
+ version?: string;
4195
+ /** A timestamp of the event. */
4196
+ timestamp?: string;
4179
4197
  /**
4180
- * line item id of Checkout/Order line item
4181
- * @minLength 1
4182
- * @maxLength 100
4198
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4199
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4200
+ * @maxSize 4000
4183
4201
  */
4184
- lineItemId?: string;
4202
+ assets?: Asset[];
4185
4203
  }
4186
- interface MembershipName {
4187
- /**
4188
- * Membership name.
4189
- * @maxLength 100
4190
- */
4191
- original?: string;
4204
+ /** @oneof */
4205
+ interface MetaSiteSpecialEventPayloadOneOf {
4206
+ /** Emitted on a meta site creation. */
4207
+ siteCreated?: SiteCreated;
4208
+ /** Emitted on a meta site transfer completion. */
4209
+ siteTransferred?: SiteTransferred;
4210
+ /** Emitted on a meta site deletion. */
4211
+ siteDeleted?: SiteDeleted;
4212
+ /** Emitted on a meta site restoration. */
4213
+ siteUndeleted?: SiteUndeleted;
4214
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4215
+ sitePublished?: SitePublished;
4216
+ /** Emitted on a meta site unpublish. */
4217
+ siteUnpublished?: SiteUnpublished;
4218
+ /** Emitted when meta site is marked as template. */
4219
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4220
+ /** Emitted when meta site is marked as a WixSite. */
4221
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4222
+ /** Emitted when an application is provisioned (installed). */
4223
+ serviceProvisioned?: ServiceProvisioned;
4224
+ /** Emitted when an application is removed (uninstalled). */
4225
+ serviceRemoved?: ServiceRemoved;
4226
+ /** Emitted when meta site name (URL slug) is changed. */
4227
+ siteRenamedPayload?: SiteRenamed;
4228
+ /** Emitted when meta site was permanently deleted. */
4229
+ hardDeleted?: SiteHardDeleted;
4230
+ /** Emitted on a namespace change. */
4231
+ namespaceChanged?: NamespaceChanged;
4232
+ /** Emitted when Studio is attached. */
4233
+ studioAssigned?: StudioAssigned;
4234
+ /** Emitted when Studio is detached. */
4235
+ studioUnassigned?: StudioUnassigned;
4192
4236
  /**
4193
- * Translated membership name. Defaults to `original` when not provided.
4194
- * @maxLength 100
4237
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4238
+ * the actual URL.
4239
+ *
4240
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4241
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4195
4242
  */
4196
- translated?: string | null;
4243
+ urlChanged?: SiteUrlChanged;
4244
+ /** Site is marked as PurgedExternally */
4245
+ sitePurgedExternally?: SitePurgedExternally;
4246
+ /** Emitted when Odeditor is attached. */
4247
+ odeditorAssigned?: OdeditorAssigned;
4248
+ /** Emitted when Odeditor is detached. */
4249
+ odeditorUnassigned?: OdeditorUnassigned;
4250
+ /** Emitted when Picasso is attached. */
4251
+ picassoAssigned?: PicassoAssigned;
4252
+ /** Emitted when Picasso is detached. */
4253
+ picassoUnassigned?: PicassoUnassigned;
4254
+ /** Emitted when Wixel is attached. */
4255
+ wixelAssigned?: WixelAssigned;
4256
+ /** Emitted when Wixel is detached. */
4257
+ wixelUnassigned?: WixelUnassigned;
4258
+ /** Emitted when StudioTwo is attached. */
4259
+ studioTwoAssigned?: StudioTwoAssigned;
4260
+ /** Emitted when StudioTwo is detached. */
4261
+ studioTwoUnassigned?: StudioTwoUnassigned;
4262
+ /** Emitted when media from user domain is enabled. */
4263
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4264
+ /** Emitted when media from user domain is disabled. */
4265
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4266
+ /** Emitted when Editorless is attached. */
4267
+ editorlessAssigned?: EditorlessAssigned;
4268
+ /** Emitted when Editorless is detached. */
4269
+ editorlessUnassigned?: EditorlessUnassigned;
4197
4270
  }
4198
- interface ServiceProperties {
4271
+ interface Asset {
4199
4272
  /**
4200
- * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4201
- * For example, the start time of a class.
4273
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4274
+ * @maxLength 36
4202
4275
  */
4203
- scheduledDate?: Date | null;
4276
+ appDefId?: string;
4204
4277
  /**
4205
- * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
4206
- * @min 1
4207
- * @max 10000
4278
+ * An instance id. For legacy reasons may be UUID or a string.
4279
+ * @maxLength 200
4208
4280
  */
4209
- numberOfParticipants?: number | null;
4281
+ instanceId?: string;
4282
+ /** An application state. */
4283
+ state?: StateWithLiterals;
4210
4284
  }
4211
- interface ChargeMembershipsResponse {
4285
+ declare enum State {
4286
+ UNKNOWN = "UNKNOWN",
4287
+ ENABLED = "ENABLED",
4288
+ DISABLED = "DISABLED",
4289
+ PENDING = "PENDING",
4290
+ DEMO = "DEMO"
4212
4291
  }
4213
- interface TriggerRefundRequest {
4292
+ /** @enumType */
4293
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4294
+ interface SiteCreated {
4214
4295
  /**
4215
- * The order this refund related to
4216
- * @minLength 1
4217
- * @maxLength 100
4296
+ * A template identifier (empty if not created from a template).
4297
+ * @maxLength 36
4218
4298
  */
4219
- ecomOrderId: string;
4299
+ originTemplateId?: string;
4220
4300
  /**
4221
- * Refund operations information
4222
- * @minSize 1
4223
- * @maxSize 1
4301
+ * An account id of the owner.
4302
+ * @format GUID
4224
4303
  */
4225
- payments: PaymentRefund[];
4226
- /** Business model of a refund */
4227
- details?: RefundDetails;
4228
- /** Side effect details related to refund */
4229
- sideEffects?: RefundSideEffects;
4230
- }
4231
- interface PaymentRefund {
4304
+ ownerId?: string;
4305
+ /** A context in which meta site was created. */
4306
+ context?: SiteCreatedContextWithLiterals;
4232
4307
  /**
4233
- * Specific payment within the order to refund
4308
+ * A meta site id from which this site was created.
4309
+ *
4310
+ * In case of a creation from a template it's a template id.
4311
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4234
4312
  * @format GUID
4235
4313
  */
4236
- paymentId?: string;
4237
- /** Refund amount. Not relevant for membership and gift card refunds. */
4238
- amount?: Price;
4314
+ originMetaSiteId?: string | null;
4239
4315
  /**
4240
- * Whether refund is made externally and manually (on the payment provider's side)
4241
- * 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.
4242
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4316
+ * A meta site name (URL slug).
4317
+ * @maxLength 20
4243
4318
  */
4244
- externalRefund?: boolean;
4319
+ siteName?: string;
4320
+ /** A namespace. */
4321
+ namespace?: NamespaceWithLiterals;
4245
4322
  }
4246
- /** Business model of a refund request */
4247
- interface RefundDetails {
4248
- /**
4249
- * Order line item IDs and quantities that were refunded.
4250
- * @maxSize 300
4251
- */
4252
- items?: RefundItem[];
4253
- /** Whether the shipping fee was also refunded. */
4254
- shippingIncluded?: boolean;
4323
+ declare enum SiteCreatedContext {
4324
+ /** A valid option, we don't expose all reasons why site might be created. */
4325
+ OTHER = "OTHER",
4326
+ /** A meta site was created from template. */
4327
+ FROM_TEMPLATE = "FROM_TEMPLATE",
4328
+ /** A meta site was created by copying of the transfferred meta site. */
4329
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4330
+ /** A copy of existing meta site. */
4331
+ DUPLICATE = "DUPLICATE",
4332
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4333
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4334
+ /** deprecated A meta site was created for Flash editor. */
4335
+ FLASH = "FLASH"
4336
+ }
4337
+ /** @enumType */
4338
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4339
+ declare enum Namespace {
4340
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4341
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4342
+ WIX = "WIX",
4343
+ /** 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. */
4344
+ SHOUT_OUT = "SHOUT_OUT",
4345
+ /** 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. */
4346
+ ALBUMS = "ALBUMS",
4347
+ /** 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. */
4348
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4349
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4350
+ HOTELS = "HOTELS",
4351
+ /** 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. */
4352
+ CLUBS = "CLUBS",
4353
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4354
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4355
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4356
+ DEV_SITE = "DEV_SITE",
4357
+ /** 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. */
4358
+ LOGOS = "LOGOS",
4359
+ /** 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. */
4360
+ VIDEO_MAKER = "VIDEO_MAKER",
4361
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4362
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4363
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4364
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4255
4365
  /**
4256
- * Reason for the refund, provided by customer (optional).
4257
- * @maxLength 200
4366
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4367
+ *
4368
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
4258
4369
  */
4259
- reason?: string | null;
4370
+ HTML_DRAFT = "HTML_DRAFT",
4260
4371
  /**
4261
- * Line items that were refunded.
4262
- * @maxSize 300
4372
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4373
+ * Will be accessible from Site List and will not have a website app.
4374
+ * Once the user attaches a site, the site will become a regular wixsite.
4263
4375
  */
4264
- lineItems?: LineItemRefund[];
4376
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
4377
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4378
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
4379
+ /** It is to be used in the Business First efforts. */
4380
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
4381
+ /** Bookings business flow with no site. */
4382
+ ANYWHERE = "ANYWHERE",
4383
+ /** Namespace for Headless Backoffice with no editor */
4384
+ HEADLESS = "HEADLESS",
4265
4385
  /**
4266
- * Additional fees that were refunded.
4267
- * @maxSize 100
4386
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4387
+ * The site will be used for account level CSM feature for enterprise
4268
4388
  */
4269
- additionalFees?: AdditionalFeeRefund[];
4270
- /** Shipping amount that was refunded. */
4271
- shipping?: ShippingRefund;
4272
- }
4273
- interface RefundItem {
4389
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4390
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4391
+ RISE = "RISE",
4274
4392
  /**
4275
- * Line item ID the refunded line item.
4276
- * @format GUID
4393
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4394
+ * There's a blank site behind the scene but it's blank).
4395
+ * The Mobile company will be the owner of this namespace.
4277
4396
  */
4278
- lineItemId?: string;
4397
+ BRANDED_FIRST = "BRANDED_FIRST",
4398
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4399
+ NOWNIA = "NOWNIA",
4279
4400
  /**
4280
- * Line item quantity refunded.
4281
- * @min 1
4282
- * @max 100000
4401
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
4402
+ * The Partners company owns this namespace.
4283
4403
  */
4284
- quantity?: number;
4285
- }
4286
- interface LineItemRefund {
4404
+ UGC_TEMPLATE = "UGC_TEMPLATE",
4405
+ /** Codux Headless Sites */
4406
+ CODUX = "CODUX",
4407
+ /** Bobb - AI Design Creator. */
4408
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4287
4409
  /**
4288
- * Line item ID.
4289
- * @format GUID
4290
- * @immutable
4410
+ * Shared Blog Site is a unique single site across Enterprise account,
4411
+ * This site will hold all Blog posts related to the Marketing product.
4291
4412
  */
4292
- lineItemId?: string;
4413
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4414
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4415
+ STANDALONE_FORMS = "STANDALONE_FORMS",
4416
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4417
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
4418
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4419
+ MIMIR = "MIMIR",
4420
+ /** Wix Twins platform. */
4421
+ TWINS = "TWINS",
4422
+ /** Wix Nano. */
4423
+ NANO = "NANO",
4424
+ /** Base44 headless sites. */
4425
+ BASE44 = "BASE44",
4426
+ /** Wix Channels Sites */
4427
+ CHANNELS = "CHANNELS",
4428
+ /** Nautilus platform. */
4429
+ NAUTILUS = "NAUTILUS",
4293
4430
  /**
4294
- * Refund quantity.
4295
- * @min 1
4296
- * @max 100000
4297
- * @immutable
4431
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
4432
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
4298
4433
  */
4299
- quantity?: number;
4434
+ SYMPHONY = "SYMPHONY",
4435
+ /** Nautilus platform app. */
4436
+ NAUTILUS_APPS = "NAUTILUS_APPS"
4300
4437
  }
4301
- interface AdditionalFeeRefund {
4438
+ /** @enumType */
4439
+ 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';
4440
+ /** Site transferred to another user. */
4441
+ interface SiteTransferred {
4302
4442
  /**
4303
- * Additional fee ID.
4443
+ * A previous owner id (user that transfers meta site).
4304
4444
  * @format GUID
4305
- * @immutable
4306
4445
  */
4307
- additionalFeeId?: string;
4446
+ oldOwnerId?: string;
4308
4447
  /**
4309
- * Refund amount.
4310
- * @immutable
4448
+ * A new owner id (user that accepts meta site).
4449
+ * @format GUID
4311
4450
  */
4312
- amount?: Price;
4451
+ newOwnerId?: string;
4313
4452
  }
4314
- interface ShippingRefund {
4315
- /**
4316
- * Refund amount.
4317
- * @immutable
4318
- */
4319
- amount?: Price;
4453
+ /** Soft deletion of the meta site. Could be restored. */
4454
+ interface SiteDeleted {
4455
+ /** A deletion context. */
4456
+ deleteContext?: DeleteContext;
4320
4457
  }
4321
- interface RefundSideEffects {
4322
- /** Inventory restock details as part of this refund. */
4323
- restockInfo?: RestockInfo;
4324
- /** Whether to send a refund confirmation email to the customer. */
4325
- sendOrderRefundedEmail?: boolean;
4458
+ interface DeleteContext {
4459
+ /** When the meta site was deleted. */
4460
+ dateDeleted?: Date | null;
4461
+ /** A status. */
4462
+ deleteStatus?: DeleteStatusWithLiterals;
4326
4463
  /**
4327
- * Custom message added to the refund confirmation email.
4328
- * @minLength 1
4329
- * @maxLength 1000
4464
+ * A reason (flow).
4465
+ * @maxLength 255
4330
4466
  */
4331
- customMessage?: string | null;
4332
- }
4333
- interface RestockInfo {
4334
- /** Restock type. */
4335
- type?: RestockTypeWithLiterals;
4467
+ deleteOrigin?: string;
4336
4468
  /**
4337
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4338
- * @maxSize 300
4469
+ * A service that deleted it.
4470
+ * @maxLength 255
4339
4471
  */
4340
- items?: RestockItem[];
4472
+ initiatorId?: string | null;
4341
4473
  }
4342
- declare enum RestockType {
4343
- NO_ITEMS = "NO_ITEMS",
4344
- ALL_ITEMS = "ALL_ITEMS",
4345
- SOME_ITEMS = "SOME_ITEMS"
4474
+ declare enum DeleteStatus {
4475
+ UNKNOWN = "UNKNOWN",
4476
+ TRASH = "TRASH",
4477
+ DELETED = "DELETED",
4478
+ PENDING_PURGE = "PENDING_PURGE",
4479
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4480
+ }
4481
+ /** @enumType */
4482
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4483
+ /** Restoration of the meta site. */
4484
+ interface SiteUndeleted {
4346
4485
  }
4347
- /** @enumType */
4348
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4349
- interface RestockItem {
4350
- /**
4351
- * ID of the line item being restocked.
4352
- * @format GUID
4353
- */
4354
- lineItemId?: string;
4486
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
4487
+ interface SitePublished {
4488
+ }
4489
+ interface SiteUnpublished {
4355
4490
  /**
4356
- * Line item quantity being restocked.
4357
- * @min 1
4358
- * @max 100000
4491
+ * A list of URLs previously associated with the meta site.
4492
+ * @maxLength 4000
4493
+ * @maxSize 10000
4359
4494
  */
4360
- quantity?: number;
4495
+ urls?: string[];
4361
4496
  }
4362
- interface TriggerRefundResponse {
4363
- /** All order's transactions after the refunds were added */
4364
- orderTransactions?: OrderTransactions;
4365
- /** Created refund ID */
4366
- refundId?: string | null;
4367
- /** Payment ID's that the refund execution had failed for */
4368
- failedPaymentIds?: ItemMetadata[];
4497
+ interface SiteMarkedAsTemplate {
4498
+ }
4499
+ interface SiteMarkedAsWixSite {
4369
4500
  }
4370
4501
  /**
4371
- * A record of all payments and refunds associated with an order.
4502
+ * Represents a service provisioned a site.
4372
4503
  *
4373
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4504
+ * Note on `origin_instance_id`:
4505
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4506
+ * This is because of the following scenario:
4507
+ *
4508
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
4509
+ * such as a product catalog. When you create a site from this template, you inherit this
4510
+ * default product catalog. However, if the template's product catalog is modified,
4511
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
4512
+ * your site remains consistent with what you initially received and does not include any
4513
+ * changes made to the original template afterward.
4514
+ * To ensure this, the TPA on the template gets a new instance_id.
4374
4515
  */
4375
- interface OrderTransactions {
4376
- /**
4377
- * Order ID.
4378
- * @format GUID
4379
- */
4380
- orderId?: string;
4516
+ interface ServiceProvisioned {
4381
4517
  /**
4382
- * Record of payments made to the merchant.
4383
- * @maxSize 100
4518
+ * Either UUID or EmbeddedServiceType.
4519
+ * @maxLength 36
4384
4520
  */
4385
- payments?: Payment[];
4521
+ appDefId?: string;
4386
4522
  /**
4387
- * Record of refunds made to the buyer.
4388
- * @maxSize 300
4523
+ * Not only UUID. Something here could be something weird.
4524
+ * @maxLength 36
4389
4525
  */
4390
- refunds?: Refund[];
4391
- }
4392
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
4393
- /** Regular payment details. */
4394
- regularPaymentDetails?: RegularPaymentDetails;
4395
- /** Gift card payment details. */
4396
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4526
+ instanceId?: string;
4397
4527
  /**
4398
- * Payment ID.
4399
- * @format GUID
4400
- * @readonly
4528
+ * An instance id from which this instance is originated.
4529
+ * @maxLength 36
4401
4530
  */
4402
- id?: string | null;
4403
- /** 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. */
4404
- createdDate?: Date | null;
4531
+ originInstanceId?: string;
4405
4532
  /**
4406
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4407
- * @readonly
4533
+ * A version.
4534
+ * @maxLength 500
4408
4535
  */
4409
- updatedDate?: Date | null;
4410
- /** Payment amount. */
4411
- amount?: Price;
4536
+ version?: string | null;
4412
4537
  /**
4413
- * Whether refunds for this payment are disabled.
4414
- * + `true`: This payment is not refundable.
4415
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4538
+ * The origin meta site id
4539
+ * @format GUID
4416
4540
  */
4417
- refundDisabled?: boolean;
4418
- /** Details about cash rounding applied to this payment, when relevant. */
4419
- cashRounding?: CashRoundingDetails;
4420
- }
4421
- /** @oneof */
4422
- interface PaymentPaymentDetailsOneOf {
4423
- /** Regular payment details. */
4424
- regularPaymentDetails?: RegularPaymentDetails;
4425
- /** Gift card payment details. */
4426
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4427
- }
4428
- /** @oneof */
4429
- interface PaymentReceiptInfoOneOf {
4541
+ originMetaSiteId?: string | null;
4430
4542
  }
4431
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4432
- /** Credit card details. */
4433
- creditCardDetails?: CreditCardPaymentMethodDetails;
4434
- /**
4435
- * Wix Payments order ID.
4436
- * @maxLength 100
4437
- */
4438
- paymentOrderId?: string | null;
4543
+ interface ServiceRemoved {
4439
4544
  /**
4440
- * Payment gateway's transaction ID.
4441
- * This field is only returned when the value of `offline_payment` is `false`.
4442
- * @maxLength 100
4545
+ * Either UUID or EmbeddedServiceType.
4546
+ * @maxLength 36
4443
4547
  */
4444
- gatewayTransactionId?: string | null;
4548
+ appDefId?: string;
4445
4549
  /**
4446
- * Payment method.
4447
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4448
- * Non-exhaustive list of supported values:
4449
- * + `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`
4450
- * @maxLength 100
4451
- * @deprecated Payment method.
4452
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4453
- * Non-exhaustive list of supported values:
4454
- * + `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`
4455
- * @replacedBy payment_method_name
4456
- * @targetRemovalDate 2026-07-01
4550
+ * Not only UUID. Something here could be something weird.
4551
+ * @maxLength 36
4457
4552
  */
4458
- paymentMethod?: string | null;
4553
+ instanceId?: string;
4459
4554
  /**
4460
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4461
- * @maxLength 100
4555
+ * A version.
4556
+ * @maxLength 500
4462
4557
  */
4463
- providerTransactionId?: string | null;
4464
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4465
- offlinePayment?: boolean;
4466
- /** Payment status. */
4467
- status?: TransactionStatusWithLiterals;
4468
- /** Whether there is a payment agreement that allows for future charges. */
4469
- savedPaymentMethod?: boolean;
4470
- /** Authorization details. */
4471
- authorizationDetails?: AuthorizationDetails;
4558
+ version?: string | null;
4559
+ }
4560
+ /** Rename of the site. Meaning, free public url has been changed as well. */
4561
+ interface SiteRenamed {
4472
4562
  /**
4473
- * Record of chargebacks made by the buyer.
4474
- * @maxSize 6
4563
+ * A new meta site name (URL slug).
4564
+ * @maxLength 20
4475
4565
  */
4476
- chargebacks?: Chargeback[];
4477
- /** Platform fee amount associated with this payment. */
4478
- platformFee?: Price;
4566
+ newSiteName?: string;
4479
4567
  /**
4480
- * Payment method with buyer and optional owner translations.
4481
- * Non-exhaustive list of supported values:
4482
- * + `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`
4568
+ * A previous meta site name (URL slug).
4569
+ * @maxLength 255
4483
4570
  */
4484
- paymentMethodName?: PaymentMethodName;
4571
+ oldSiteName?: string;
4485
4572
  }
4486
- /** @oneof */
4487
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4488
- /** Credit card details. */
4489
- creditCardDetails?: CreditCardPaymentMethodDetails;
4573
+ /**
4574
+ * Hard deletion of the meta site.
4575
+ *
4576
+ * Could not be restored. Therefore it's desirable to cleanup data.
4577
+ */
4578
+ interface SiteHardDeleted {
4579
+ /** A deletion context. */
4580
+ deleteContext?: DeleteContext;
4490
4581
  }
4491
- declare enum TransactionStatus {
4492
- UNDEFINED = "UNDEFINED",
4493
- APPROVED = "APPROVED",
4494
- PENDING = "PENDING",
4495
- PENDING_MERCHANT = "PENDING_MERCHANT",
4496
- CANCELED = "CANCELED",
4497
- DECLINED = "DECLINED",
4498
- REFUNDED = "REFUNDED",
4499
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4500
- AUTHORIZED = "AUTHORIZED",
4501
- VOIDED = "VOIDED"
4582
+ interface NamespaceChanged {
4583
+ /** A previous namespace. */
4584
+ oldNamespace?: NamespaceWithLiterals;
4585
+ /** A new namespace. */
4586
+ newNamespace?: NamespaceWithLiterals;
4502
4587
  }
4503
- /** @enumType */
4504
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4505
- interface CreditCardPaymentMethodDetails {
4506
- /**
4507
- * The last 4 digits of the card number.
4508
- * @maxLength 4
4509
- */
4510
- lastFourDigits?: string | null;
4588
+ /** Assigned Studio editor */
4589
+ interface StudioAssigned {
4590
+ }
4591
+ /** Unassigned Studio editor */
4592
+ interface StudioUnassigned {
4593
+ }
4594
+ /**
4595
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4596
+ *
4597
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4598
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
4599
+ *
4600
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4601
+ */
4602
+ interface SiteUrlChanged {
4603
+ }
4604
+ /**
4605
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4606
+ * Consumed by other teams to remove relevant data.
4607
+ */
4608
+ interface SitePurgedExternally {
4511
4609
  /**
4512
- * Card issuer's brand.
4513
- * @maxLength 100
4610
+ * @maxLength 2048
4611
+ * @maxSize 100
4612
+ * @deprecated
4613
+ * @targetRemovalDate 2025-04-15
4514
4614
  */
4515
- brand?: string | null;
4615
+ appDefId?: string[];
4616
+ }
4617
+ /** Assigned Odeditor */
4618
+ interface OdeditorAssigned {
4619
+ }
4620
+ /** Unassigned Odeditor */
4621
+ interface OdeditorUnassigned {
4622
+ }
4623
+ /** Assigned Picasso editor */
4624
+ interface PicassoAssigned {
4625
+ }
4626
+ /** Unassigned Picasso */
4627
+ interface PicassoUnassigned {
4628
+ }
4629
+ /** Assigned Wixel */
4630
+ interface WixelAssigned {
4631
+ }
4632
+ /** Unassigned Wixel */
4633
+ interface WixelUnassigned {
4634
+ }
4635
+ /** Assigned StudioTwo */
4636
+ interface StudioTwoAssigned {
4637
+ }
4638
+ /** Unassigned StudioTwo */
4639
+ interface StudioTwoUnassigned {
4516
4640
  }
4517
- interface AuthorizationDetails {
4518
- /**
4519
- * Whether the authorized payment is of a delayed capture.
4520
- * @readonly
4521
- */
4522
- delayedCapture?: boolean;
4523
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4524
- authorizedDate?: Date | null;
4525
- /**
4526
- * List of captures associated with payment
4527
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4528
- * @maxSize 1
4529
- */
4530
- captures?: AuthorizationCapture[];
4531
- /** Void associated with payment */
4532
- void?: AuthorizationVoid;
4533
- /** Scheduled action for this transaction */
4534
- scheduledAction?: V1ScheduledAction;
4641
+ /** Media from user domain is enabled. */
4642
+ interface UserDomainMediaEnabled {
4535
4643
  }
4536
- interface AuthorizationCapture {
4537
- /**
4538
- * Capture ID.
4539
- * @format GUID
4540
- * @readonly
4541
- */
4542
- id?: string | null;
4543
- /** Status of this capture action */
4544
- status?: AuthorizationCaptureStatusWithLiterals;
4545
- /**
4546
- * Amount of this capture
4547
- * @immutable
4548
- */
4549
- amount?: Price;
4550
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4551
- createdDate?: Date | null;
4552
- /** In case of status is FAILED may contain failure details */
4553
- failureDetails?: AuthorizationActionFailureDetails;
4644
+ /** Media from user domain is disabled. */
4645
+ interface UserDomainMediaDisabled {
4554
4646
  }
4555
- declare enum AuthorizationCaptureStatus {
4556
- /** Capture operation still in progress. */
4557
- PENDING = "PENDING",
4558
- /** Capture operation succeeded. */
4559
- SUCCEEDED = "SUCCEEDED",
4560
- /** Capture operation failed. */
4561
- FAILED = "FAILED"
4647
+ /** Assigned Editorless */
4648
+ interface EditorlessAssigned {
4562
4649
  }
4563
- /** @enumType */
4564
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4565
- interface AuthorizationActionFailureDetails {
4566
- /** @maxLength 100 */
4567
- failureCode?: string;
4650
+ /** Unassigned Editorless */
4651
+ interface EditorlessUnassigned {
4568
4652
  }
4569
- interface AuthorizationVoid {
4570
- /** Status of this void action */
4571
- status?: AuthorizationVoidStatusWithLiterals;
4572
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4573
- voidedDate?: Date | null;
4574
- /** In case of status is FAILED may contain failure details */
4575
- failureDetails?: AuthorizationActionFailureDetails;
4576
- /** Reason of void action */
4577
- reason?: ReasonWithLiterals;
4653
+ interface HasCustomEmailConfigurationsRequest {
4578
4654
  }
4579
- declare enum AuthorizationVoidStatus {
4580
- /** Void operation still in progress. */
4581
- PENDING = "PENDING",
4582
- /** Void operation succeeded. */
4583
- SUCCEEDED = "SUCCEEDED",
4584
- /** Void operation failed. */
4585
- FAILED = "FAILED"
4655
+ interface HasCustomEmailConfigurationsResponse {
4656
+ hasCustomConfigurations?: boolean;
4586
4657
  }
4587
- /** @enumType */
4588
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4589
- /** Reason the authorization was voided. */
4590
- declare enum Reason {
4591
- /** Authorization was voided by user. */
4592
- MANUAL = "MANUAL",
4593
- /** Authorization passed execution date. */
4594
- SCHEDULED = "SCHEDULED"
4658
+ interface AddToAutomationMigrationPopulationRequest {
4659
+ /** When true, sends custom email configurations to automation system via email */
4660
+ sendCustomEmailConfigs?: boolean;
4661
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4662
+ origin?: OriginWithLiterals;
4663
+ }
4664
+ declare enum Origin {
4665
+ OPT_IN = "OPT_IN",
4666
+ MIGRATION = "MIGRATION"
4595
4667
  }
4596
4668
  /** @enumType */
4597
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4598
- interface V1ScheduledAction {
4599
- /** Type of the action. */
4600
- actionType?: ActionTypeWithLiterals;
4601
- /** The date and time of the action. */
4602
- executionDate?: Date | null;
4669
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4670
+ interface AddToAutomationMigrationPopulationResponse {
4671
+ success?: boolean;
4603
4672
  }
4604
- declare enum ActionType {
4605
- VOID = "VOID",
4606
- CAPTURE = "CAPTURE"
4673
+ interface IsInAutomationMigrationPopulationRequest {
4607
4674
  }
4608
- /** @enumType */
4609
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4610
- interface Chargeback {
4675
+ interface IsInAutomationMigrationPopulationResponse {
4676
+ inPopulation?: boolean;
4677
+ }
4678
+ interface PreparePaymentCollectionRequest {
4611
4679
  /**
4612
- * Chargeback ID.
4613
- * @format GUID
4614
- * @readonly
4615
- * @immutable
4680
+ * Ecom order ID.
4681
+ * @minLength 1
4682
+ * @maxLength 100
4616
4683
  */
4617
- id?: string;
4684
+ ecomOrderId: string;
4685
+ /** Amount to collect */
4686
+ amount: Price;
4618
4687
  /**
4619
- * 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.
4620
- * @readonly
4621
- * @immutable
4688
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4689
+ * Existing payment gateway order will be updated with a new amount.
4690
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4622
4691
  */
4623
- createdDate?: Date | null;
4692
+ paymentGatewayOrderId?: string | null;
4624
4693
  /**
4625
- * 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.
4626
- * @readonly
4694
+ * Whether to delay capture of the payment.
4695
+ * Default: false
4696
+ * @deprecated Whether to delay capture of the payment.
4697
+ * Default: false
4698
+ * @replacedBy delayed_capture_settings.scheduled_action
4699
+ * @targetRemovalDate 2024-09-30
4627
4700
  */
4628
- updatedDate?: Date | null;
4701
+ delayedCapture?: boolean;
4702
+ /** Delayed capture payment settings */
4703
+ delayedCaptureSettings?: DelayedCaptureSettings;
4704
+ }
4705
+ interface RedirectUrls {
4629
4706
  /**
4630
- * Amount.
4631
- * @readonly
4632
- * @immutable
4707
+ * URL to redirect buyer in case of approved (successful) transaction
4708
+ * @format WEB_URL
4633
4709
  */
4634
- amount?: Price;
4710
+ successUrl?: string | null;
4635
4711
  /**
4636
- * Reversal amount. Present only when status is REVERSED.
4637
- * @readonly
4712
+ * URL to redirect buyer in case of buyer canceled the transaction
4713
+ * @format WEB_URL
4638
4714
  */
4639
- reversalAmount?: Price;
4715
+ cancelUrl?: string | null;
4640
4716
  /**
4641
- * Status.
4642
- *
4643
- * Default: `"APPROVED"`.
4717
+ * URL to redirect buyer in case of failed/rejected transaction
4718
+ * @format WEB_URL
4644
4719
  */
4645
- status?: ChargebackStatusWithLiterals;
4720
+ errorUrl?: string | null;
4646
4721
  /**
4647
- * External chargeback ID.
4648
- * @format GUID
4649
- * @readonly
4650
- * @immutable
4722
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4723
+ * @format WEB_URL
4651
4724
  */
4652
- externalId?: string | null;
4725
+ pendingUrl?: string | null;
4653
4726
  }
4654
- declare enum ChargebackStatus {
4655
- /** Chargeback was approved. */
4656
- APPROVED = "APPROVED",
4657
- /** Chargeback was reversed. */
4658
- REVERSED = "REVERSED"
4727
+ interface DelayedCaptureSettings {
4728
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4729
+ scheduledAction?: ScheduledActionWithLiterals;
4730
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4731
+ delayDuration?: Duration;
4732
+ }
4733
+ declare enum ScheduledAction {
4734
+ /** Whether payment will be auto-voided when duration passes */
4735
+ VOID = "VOID",
4736
+ /** Whether payment will be auto-captured when duration passes */
4737
+ CAPTURE = "CAPTURE"
4659
4738
  }
4660
4739
  /** @enumType */
4661
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
4662
- interface PaymentMethodName {
4663
- /**
4664
- * Translated payment method name in buyer language.
4665
- * @maxLength 100
4666
- */
4667
- buyerLanguageName?: string | null;
4668
- /**
4669
- * Translated payment method name in site owner language.
4670
- * @maxLength 100
4671
- */
4672
- siteLanguageName?: string | null;
4740
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4741
+ interface Duration {
4673
4742
  /**
4674
- * User-provided payment method name.
4675
- *
4676
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
4743
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4744
+ * @min 1
4677
4745
  */
4678
- userDefinedName?: UserDefinedPaymentMethodName;
4746
+ count?: number;
4747
+ /** Duration unit: MINUTES, HOURS and DAYS */
4748
+ unit?: DurationUnitWithLiterals;
4679
4749
  }
4680
- interface GiftCardPaymentDetails {
4750
+ declare enum DurationUnit {
4751
+ MINUTES = "MINUTES",
4752
+ HOURS = "HOURS",
4753
+ DAYS = "DAYS"
4754
+ }
4755
+ /** @enumType */
4756
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4757
+ interface PreparePaymentCollectionResponse {
4758
+ /** Payment gateway order id which is associated with given payment */
4759
+ paymentGatewayOrderId?: string;
4760
+ }
4761
+ interface GetPaymentCollectabilityStatusRequest {
4681
4762
  /**
4682
- * Gift card payment ID.
4763
+ * Ecom order ID.
4764
+ * @minLength 1
4683
4765
  * @maxLength 100
4684
4766
  */
4685
- giftCardPaymentId?: string;
4686
- /**
4687
- * ID of the app that created the gift card.
4688
- * @format GUID
4689
- */
4690
- appId?: string;
4691
- /**
4692
- * Whether the gift card is voided.
4693
- * @readonly
4694
- */
4695
- voided?: boolean;
4767
+ ecomOrderId: string;
4768
+ }
4769
+ interface GetPaymentCollectabilityStatusResponse {
4770
+ /** Payment collectability status */
4771
+ status?: PaymentCollectabilityStatusWithLiterals;
4772
+ /** Collectable order amount */
4773
+ amount?: Price;
4774
+ }
4775
+ declare enum PaymentCollectabilityStatus {
4776
+ UNKNOWN = "UNKNOWN",
4777
+ COLLECTABLE = "COLLECTABLE",
4778
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4779
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4780
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4781
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4782
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4783
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4784
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4785
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4786
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4787
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
4696
4788
  }
4697
- interface MembershipPaymentDetails {
4789
+ /** @enumType */
4790
+ 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';
4791
+ interface RecordManuallyCollectedPaymentRequest {
4698
4792
  /**
4699
- * Membership ID.
4793
+ * Order ID.
4794
+ * @minLength 1
4700
4795
  * @maxLength 100
4701
4796
  */
4702
- membershipId?: string;
4797
+ orderId: string;
4798
+ /** Amount to be recorded as approved manual payment for given order */
4799
+ amount: Price;
4800
+ }
4801
+ /**
4802
+ * User-defined payment method name.
4803
+ * Allows specifying either a predefined type or a custom name.
4804
+ */
4805
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4806
+ /** Predefined payment method. */
4807
+ predefined?: PredefinedPaymentMethodWithLiterals;
4703
4808
  /**
4704
- * ID of the line item this membership applies to.
4809
+ * Custom payment method name provided by user.
4810
+ *
4811
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4705
4812
  * @minLength 1
4706
4813
  * @maxLength 100
4707
4814
  */
4708
- lineItemId?: string;
4709
- /** Payment status. */
4710
- status?: MembershipPaymentStatusWithLiterals;
4711
- /** Membership name. */
4712
- name?: MembershipName;
4815
+ custom?: string | null;
4816
+ }
4817
+ /** @oneof */
4818
+ interface UserDefinedPaymentMethodNameKindOneOf {
4819
+ /** Predefined payment method. */
4820
+ predefined?: PredefinedPaymentMethodWithLiterals;
4713
4821
  /**
4714
- * The transaction ID in the membership system. Can be used to void the transaction.
4822
+ * Custom payment method name provided by user.
4823
+ *
4824
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4715
4825
  * @minLength 1
4716
4826
  * @maxLength 100
4717
4827
  */
4718
- externalTransactionId?: string | null;
4719
- /**
4720
- * Whether the membership is voided.
4721
- * @readonly
4722
- */
4723
- voided?: boolean;
4724
- /**
4725
- * ID of the application providing this payment option.
4726
- * @format GUID
4727
- */
4728
- providerAppId?: string;
4729
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
4730
- futureMembership?: FutureMembershipDetails;
4828
+ custom?: string | null;
4731
4829
  }
4732
- declare enum MembershipPaymentStatus {
4733
- /** Payment was charged. */
4734
- CHARGED = "CHARGED",
4735
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
4736
- CHARGE_FAILED = "CHARGE_FAILED",
4737
- /** Payment is pending. */
4738
- CHARGE_PENDING = "CHARGE_PENDING",
4739
- /** Payment was voided. */
4740
- VOIDED = "VOIDED"
4830
+ /** Predefined payment method types for offline/manual payments. */
4831
+ declare enum PredefinedPaymentMethod {
4832
+ /** Cash payment. */
4833
+ CASH = "CASH",
4834
+ /** Bank transfer. */
4835
+ BANK_TRANSFER = "BANK_TRANSFER",
4836
+ /** Payment by check. */
4837
+ CHECK = "CHECK"
4741
4838
  }
4742
4839
  /** @enumType */
4743
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
4744
- interface FutureMembershipDetails {
4745
- /**
4746
- * ID of the plan line item in the order from which the membership will be created.
4747
- * @format GUID
4748
- */
4749
- lineItemId?: string;
4750
- /**
4751
- * ID of the benefit the future membership will grant.
4752
- * @maxLength 200
4753
- */
4754
- benefitId?: string;
4840
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4841
+ interface RecordManuallyCollectedPaymentResponse {
4755
4842
  }
4756
- interface WixReceiptInfo {
4843
+ interface MarkOrderAsPaidRequest {
4757
4844
  /**
4758
- * Receipt ID
4759
- * @format GUID
4845
+ * Ecom order ID.
4846
+ * @minLength 1
4847
+ * @maxLength 100
4760
4848
  */
4761
- receiptId?: string;
4849
+ ecomOrderId: string;
4850
+ }
4851
+ interface MarkOrderAsPaidResponse {
4852
+ /** Updated order. */
4853
+ order?: Order;
4854
+ }
4855
+ interface BulkMarkOrdersAsPaidRequest {
4762
4856
  /**
4763
- * Display number of receipt
4857
+ * IDs of orders to mark as paid.
4858
+ * @minSize 1
4859
+ * @maxSize 100
4764
4860
  * @minLength 1
4765
- * @maxLength 40
4861
+ * @maxLength 100
4766
4862
  */
4767
- displayNumber?: string | null;
4863
+ ecomOrderIds: string[];
4768
4864
  }
4769
- interface ExternalReceiptInfo {
4865
+ interface BulkMarkOrdersAsPaidResponse {
4770
4866
  /**
4771
- * External receipt ID
4772
- * @maxLength 100
4867
+ * Items updated by the bulk action.
4868
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4773
4869
  */
4774
- receiptId?: string | null;
4870
+ results?: BulkOrderResult[];
4871
+ /** Bulk action metadata. */
4872
+ bulkActionMetadata?: BulkActionMetadata;
4873
+ }
4874
+ interface BulkOrderResult {
4875
+ /** Item metadata. */
4876
+ itemMetadata?: ItemMetadata;
4775
4877
  /**
4776
- * ID of the app providing the receipt
4777
- * @format GUID
4878
+ * Updated order.
4879
+ *
4880
+ * Returned when `returnFullEntity = true`.
4778
4881
  */
4779
- appId?: string | null;
4882
+ item?: Order;
4883
+ }
4884
+ interface ItemMetadata {
4885
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4886
+ id?: string | null;
4887
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
4888
+ originalIndex?: number;
4889
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4890
+ success?: boolean;
4891
+ /** Details about the error in case of failure. */
4892
+ error?: ApplicationError;
4893
+ }
4894
+ interface ApplicationError {
4895
+ /** Error code. */
4896
+ code?: string;
4897
+ /** Description of the error. */
4898
+ description?: string;
4899
+ /** Data related to the error. */
4900
+ data?: Record<string, any> | null;
4901
+ }
4902
+ interface BulkActionMetadata {
4903
+ /** Number of items that were successfully processed. */
4904
+ totalSuccesses?: number;
4905
+ /** Number of items that couldn't be processed. */
4906
+ totalFailures?: number;
4907
+ /** Number of failures without details because detailed failure threshold was exceeded. */
4908
+ undetailedFailures?: number;
4909
+ }
4910
+ interface GetRefundabilityStatusRequest {
4780
4911
  /**
4781
- * Display number of receipt
4912
+ * Order ID.
4782
4913
  * @minLength 1
4783
- * @maxLength 40
4914
+ * @maxLength 100
4784
4915
  */
4785
- displayNumber?: string | null;
4916
+ ecomOrderId: string;
4786
4917
  }
4787
- interface CashRoundingDetails {
4918
+ interface GetRefundabilityStatusResponse {
4788
4919
  /**
4789
- * Payment amount before cash rounding was applied.
4790
- * When provided, balance and status calculations use this value instead of `amount`
4791
- * to prevent false overpayment or underpayment due to rounding.
4920
+ * Refundability details.
4921
+ * @maxSize 300
4792
4922
  */
4793
- unroundedAmount?: Price;
4923
+ refundabilities?: Refundability[];
4794
4924
  /**
4795
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
4796
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
4797
- * @readonly
4925
+ * Whether the order supports refunding per item.
4926
+ * @deprecated
4798
4927
  */
4799
- roundingAdjustment?: CashRounding;
4800
- }
4801
- declare enum PaymentStatus {
4802
- APPROVED = "APPROVED",
4803
- PENDING = "PENDING",
4804
- PENDING_MERCHANT = "PENDING_MERCHANT",
4805
- CANCELED = "CANCELED",
4806
- DECLINED = "DECLINED",
4807
- REFUNDED = "REFUNDED",
4808
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4809
- AUTHORIZED = "AUTHORIZED",
4810
- VOIDED = "VOIDED"
4928
+ refundablePerItem?: boolean;
4811
4929
  }
4812
- /** @enumType */
4813
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4814
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
4930
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4931
+ /** Reason why payment is not refundable. */
4932
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4933
+ /** Reason why payment is only refundable manually. */
4934
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4935
+ /** Payment ID. */
4936
+ paymentId?: string;
4937
+ /** Payment refundability status. */
4938
+ refundabilityStatus?: RefundableStatusWithLiterals;
4939
+ /** Link to payment provider dashboard. */
4940
+ providerLink?: string | null;
4815
4941
  }
4816
4942
  /** @oneof */
4817
- interface PaymentStatusDetailsStatusDetailsOneOf {
4818
- }
4819
- interface CanceledStatusDetails {
4820
- reason?: CanceledReasonWithLiterals;
4821
- }
4822
- declare enum CanceledReason {
4823
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
4824
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
4825
- /** Payment was not completed by user and expired. */
4826
- EXPIRED = "EXPIRED"
4827
- }
4828
- /** @enumType */
4829
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
4830
- interface DeclinedStatusDetails {
4831
- reason?: DeclinedReasonWithLiterals;
4943
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
4944
+ /** Reason why payment is not refundable. */
4945
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4946
+ /** Reason why payment is only refundable manually. */
4947
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4832
4948
  }
4833
- declare enum DeclinedReason {
4834
- /** Corresponding charge failed. */
4835
- CHARGE_FAILED = "CHARGE_FAILED",
4836
- /** Payment details expired. */
4837
- EXPIRED = "EXPIRED",
4838
- /** Insufficient funds. */
4839
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
4840
- /** Gift card was disabled before charge was attempted. */
4841
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
4949
+ declare enum RefundableStatus {
4950
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
4951
+ MANUAL = "MANUAL",
4952
+ REFUNDABLE = "REFUNDABLE"
4842
4953
  }
4843
4954
  /** @enumType */
4844
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
4845
- interface VoidedStatusDetails {
4846
- reason?: VoidedReasonWithLiterals;
4955
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4956
+ declare enum NonRefundableReason {
4957
+ NONE = "NONE",
4958
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
4959
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4960
+ INTERNAL_ERROR = "INTERNAL_ERROR",
4961
+ NOT_PAID = "NOT_PAID",
4962
+ ACCESS_DENIED = "ACCESS_DENIED",
4963
+ ZERO_PRICE = "ZERO_PRICE",
4964
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4965
+ PENDING_REFUND = "PENDING_REFUND",
4966
+ FORBIDDEN = "FORBIDDEN",
4967
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4968
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
4969
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4847
4970
  }
4848
- declare enum VoidedReason {
4849
- /** Payment was voided by merchant request. */
4850
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
4851
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
4852
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
4971
+ /** @enumType */
4972
+ 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';
4973
+ declare enum ManuallyRefundableReason {
4974
+ EXPIRED = "EXPIRED",
4975
+ NOT_SUPPORTED = "NOT_SUPPORTED",
4976
+ OFFLINE = "OFFLINE",
4977
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4853
4978
  }
4854
4979
  /** @enumType */
4855
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
4856
- interface Refund {
4980
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4981
+ interface CreatePaymentGatewayOrderRequest {
4857
4982
  /**
4858
- * Refund ID.
4983
+ * Ecom order ID.
4984
+ * @minLength 1
4985
+ * @maxLength 100
4986
+ */
4987
+ ecomOrderId: string;
4988
+ /** Information about the user who initiated the payment. */
4989
+ chargedBy?: ChargedBy;
4990
+ }
4991
+ interface ChargedBy {
4992
+ /**
4993
+ * ID - id of the user who initiated the payment
4859
4994
  * @format GUID
4860
- * @readonly
4861
4995
  */
4862
4996
  id?: string;
4863
4997
  /**
4864
- * List of transactions.
4865
- * @maxSize 50
4998
+ * Full name - name of the user who initiated the payment
4999
+ * @minLength 1
5000
+ * @maxLength 200
4866
5001
  */
4867
- transactions?: RefundTransaction[];
4868
- /** Refund business details. */
4869
- details?: RefundDetails;
5002
+ fullName?: string | null;
5003
+ }
5004
+ interface CreatePaymentGatewayOrderResponse {
5005
+ /** ID of the order created in the payment gateway */
5006
+ paymentGatewayOrderId?: string;
5007
+ }
5008
+ interface ChargeMembershipsRequest {
4870
5009
  /**
4871
- * 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.
4872
- * @readonly
4873
- * @immutable
5010
+ * Order ID.
5011
+ * @minLength 1
5012
+ * @maxLength 100
4874
5013
  */
4875
- createdDate?: Date | null;
5014
+ ecomOrderId: string;
4876
5015
  /**
4877
- * Aggregated refund summary.
4878
- * @readonly
5016
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5017
+ * but a user which is using the membership on behalf of the a member
5018
+ * @format GUID
4879
5019
  */
4880
- summary?: AggregatedRefundSummary;
5020
+ memberId: string;
4881
5021
  /**
4882
- * ID of the app that initiated this refund.
4883
- * @format GUID
4884
- * @readonly
4885
- * @immutable
5022
+ * List of items to be paid by memberships
5023
+ * @minSize 1
5024
+ * @maxSize 300
4886
5025
  */
4887
- requestingServiceAppId?: string | null;
5026
+ membershipCharges?: MembershipChargeItem[];
4888
5027
  }
4889
- interface RefundTransaction {
5028
+ interface MembershipChargeItem {
4890
5029
  /**
4891
- * ID of the payment associated with this refund.
4892
- * @format GUID
4893
- * @immutable
5030
+ * The id of used membership
5031
+ * @minLength 1
5032
+ * @maxLength 100
4894
5033
  */
4895
- paymentId?: string;
5034
+ membershipId?: string;
4896
5035
  /**
4897
- * Refund amount.
4898
- * @immutable
5036
+ * ID of the application providing this payment option
5037
+ * @format GUID
4899
5038
  */
4900
- amount?: Price;
4901
- /** Refund status. */
4902
- refundStatus?: RefundStatusWithLiterals;
4903
- /** Optional details of current refund status. */
4904
- refundStatusInfo?: RefundStatusInfo;
5039
+ appId?: string;
5040
+ /** The name of used membership */
5041
+ membershipName?: MembershipName;
5042
+ /** Additional data about this membership */
5043
+ membershipAdditionalData?: Record<string, any> | null;
5044
+ /** Catalog and item reference info. */
5045
+ catalogReference?: CatalogReference;
5046
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5047
+ serviceProperties?: ServiceProperties;
4905
5048
  /**
4906
- * Payment gateway's refund ID.
4907
- * This field is only returned when the value of `external_refund` is `false`.
4908
- * @format GUID
5049
+ * Usually would be the same as catalogReference.catalogItemId
5050
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5051
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5052
+ * @minLength 1
5053
+ * @maxLength 36
4909
5054
  */
4910
- gatewayRefundId?: string | null;
4911
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
4912
- providerRefundId?: string | null;
5055
+ rootCatalogItemId?: string | null;
4913
5056
  /**
4914
- * Whether refund was made externally and manually on the payment provider's side.
4915
- * @immutable
5057
+ * line item id of Checkout/Order line item
5058
+ * @minLength 1
5059
+ * @maxLength 100
4916
5060
  */
4917
- externalRefund?: boolean;
4918
- }
4919
- /** Refund transaction status. */
4920
- declare enum RefundStatus {
4921
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
4922
- PENDING = "PENDING",
4923
- /** Refund transaction succeeded. */
4924
- SUCCEEDED = "SUCCEEDED",
4925
- /** Refund transaction failed. */
4926
- FAILED = "FAILED",
4927
- /** Refund request acknowledged, and will be executed soon. */
4928
- SCHEDULED = "SCHEDULED",
4929
- /** Refund was initiated on payment provider side. */
4930
- STARTED = "STARTED"
5061
+ lineItemId?: string;
4931
5062
  }
4932
- /** @enumType */
4933
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
4934
- interface RefundStatusInfo {
5063
+ interface MembershipName {
4935
5064
  /**
4936
- * Reason code for the refund's current status.
4937
- *
4938
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
4939
- * @minLength 1
4940
- * @maxLength 10
5065
+ * Membership name.
5066
+ * @maxLength 100
4941
5067
  */
4942
- paymentGatewayReasonCode?: string | null;
5068
+ original?: string;
4943
5069
  /**
4944
- * Free text explanation of current refund status.
4945
- * @minLength 1
4946
- * @maxLength 1000
5070
+ * Translated membership name. Defaults to `original` when not provided.
5071
+ * @maxLength 100
4947
5072
  */
4948
- description?: string | null;
4949
- }
4950
- interface AggregatedRefundSummary {
4951
- /** Total amount requested for refund. */
4952
- requestedRefund?: Price;
4953
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
4954
- pendingRefund?: Price;
4955
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
4956
- refunded?: Price;
4957
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
4958
- failedRefundAmount?: Price;
4959
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
4960
- pending?: boolean;
4961
- /** Breakdown of refunded items. Available only after refund is complete. */
4962
- breakdown?: RefundItemsBreakdown;
5073
+ translated?: string | null;
4963
5074
  }
4964
- interface RefundItemsBreakdown {
5075
+ interface ServiceProperties {
4965
5076
  /**
4966
- * Refunded line items and the amount refunded for each.
4967
- * @maxSize 300
5077
+ * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5078
+ * For example, the start time of a class.
4968
5079
  */
4969
- lineItems?: LineItemRefundSummary[];
4970
- }
4971
- interface LineItemRefundSummary {
5080
+ scheduledDate?: Date | null;
4972
5081
  /**
4973
- * ID of the refunded line item.
4974
- * @format GUID
5082
+ * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
5083
+ * @min 1
5084
+ * @max 10000
4975
5085
  */
4976
- lineItemId?: string;
4977
- /** Total refunded amount for the line item. */
4978
- totalRefundedAmount?: Price;
5086
+ numberOfParticipants?: number | null;
4979
5087
  }
4980
- interface CalculateRefundRequest {
5088
+ interface ChargeMembershipsResponse {
5089
+ }
5090
+ interface TriggerRefundRequest {
4981
5091
  /**
4982
- * Order ID
5092
+ * The order this refund related to
4983
5093
  * @minLength 1
4984
5094
  * @maxLength 100
4985
5095
  */
4986
- ecomOrderId?: string;
5096
+ ecomOrderId: string;
4987
5097
  /**
4988
- * Refunded line items and quantity
4989
- * @maxSize 300
5098
+ * Refund operations information
5099
+ * @minSize 1
5100
+ * @maxSize 1
4990
5101
  */
4991
- refundItems?: CalculateRefundItemRequest[];
4992
- /** Should include shipping in refund calculation */
4993
- refundShipping?: boolean;
5102
+ payments: PaymentRefund[];
5103
+ /** Business model of a refund */
5104
+ details?: RefundDetails;
5105
+ /** Side effect details related to refund */
5106
+ sideEffects?: RefundSideEffects;
4994
5107
  }
4995
- interface CalculateRefundItemRequest {
5108
+ interface PaymentRefund {
4996
5109
  /**
4997
- * ID of the line item being refunded
5110
+ * Specific payment within the order to refund
4998
5111
  * @format GUID
4999
5112
  */
5000
- id?: string;
5113
+ paymentId?: string;
5114
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5115
+ amount?: Price;
5001
5116
  /**
5002
- * How much of that line item is being refunded
5003
- * @min 1
5004
- * @max 100000
5117
+ * Whether refund is made externally and manually (on the payment provider's side)
5118
+ * 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.
5119
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5005
5120
  */
5006
- quantity?: number;
5121
+ externalRefund?: boolean;
5007
5122
  }
5008
- interface CalculateRefundResponse {
5009
- /** Total refundable amount */
5010
- total?: Price;
5011
- /** Tax cost of the order */
5012
- tax?: Price;
5013
- /** Discount given for this order */
5014
- discount?: Price;
5015
- /** Total cost of the order (without tax) */
5016
- subtotal?: Price;
5017
- /** Total shipping cost for order */
5018
- shipping?: Price;
5019
- /** Previous refund given on that order */
5020
- previouslyRefundedAmount?: Price;
5123
+ interface RefundSideEffects {
5124
+ /** Inventory restock details as part of this refund. */
5125
+ restockInfo?: RestockInfo;
5126
+ /** Whether to send a refund confirmation email to the customer. */
5127
+ sendOrderRefundedEmail?: boolean;
5021
5128
  /**
5022
- * The refundable items of that order
5023
- * @maxSize 300
5129
+ * Custom message added to the refund confirmation email.
5130
+ * @minLength 1
5131
+ * @maxLength 1000
5024
5132
  */
5025
- items?: CalculateRefundItemResponse[];
5133
+ customMessage?: string | null;
5026
5134
  }
5027
- interface CalculateRefundItemResponse {
5135
+ interface RestockInfo {
5136
+ /** Restock type. */
5137
+ type?: RestockTypeWithLiterals;
5028
5138
  /**
5029
- * Line item ID
5030
- * @format GUID
5139
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5140
+ * @maxSize 300
5031
5141
  */
5032
- id?: string;
5033
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5034
- price?: Price;
5142
+ items?: RestockItem[];
5035
5143
  }
5036
- interface VoidAuthorizedPaymentsRequest {
5144
+ declare enum RestockType {
5145
+ NO_ITEMS = "NO_ITEMS",
5146
+ ALL_ITEMS = "ALL_ITEMS",
5147
+ SOME_ITEMS = "SOME_ITEMS"
5148
+ }
5149
+ /** @enumType */
5150
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5151
+ interface RestockItem {
5037
5152
  /**
5038
- * Wix eCommerce order ID
5039
- * @minLength 1
5040
- * @maxLength 100
5153
+ * ID of the line item being restocked.
5154
+ * @format GUID
5041
5155
  */
5042
- ecomOrderId: string;
5156
+ lineItemId?: string;
5043
5157
  /**
5044
- * Payment IDs
5045
- * @minSize 1
5046
- * @maxSize 100
5047
- * @format GUID
5158
+ * Line item quantity being restocked.
5159
+ * @min 1
5160
+ * @max 100000
5048
5161
  */
5049
- paymentIds: string[];
5162
+ quantity?: number;
5050
5163
  }
5051
- interface VoidAuthorizedPaymentsResponse {
5052
- /** All order's transactions after the void was triggered */
5164
+ interface TriggerRefundResponse {
5165
+ /** All order's transactions after the refunds were added */
5053
5166
  orderTransactions?: OrderTransactions;
5167
+ /** Created refund ID */
5168
+ refundId?: string | null;
5169
+ /** Payment ID's that the refund execution had failed for */
5170
+ failedPaymentIds?: ItemMetadata[];
5054
5171
  }
5055
- interface CaptureAuthorizedPaymentsRequest {
5172
+ /**
5173
+ * A record of all payments and refunds associated with an order.
5174
+ *
5175
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5176
+ */
5177
+ interface OrderTransactions {
5056
5178
  /**
5057
- * Wix eCommerce order ID
5058
- * @minLength 1
5059
- * @maxLength 100
5179
+ * Order ID.
5180
+ * @format GUID
5060
5181
  */
5061
- ecomOrderId: string;
5182
+ orderId?: string;
5062
5183
  /**
5063
- * Capture payments information
5064
- * @minSize 1
5184
+ * Record of payments made to the merchant.
5065
5185
  * @maxSize 100
5066
5186
  */
5067
- payments: PaymentCapture[];
5187
+ payments?: Payment[];
5188
+ /**
5189
+ * Record of refunds made to the buyer.
5190
+ * @maxSize 300
5191
+ */
5192
+ refunds?: Refund[];
5068
5193
  }
5069
- interface PaymentCapture {
5194
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
5195
+ /** Regular payment details. */
5196
+ regularPaymentDetails?: RegularPaymentDetails;
5197
+ /** Gift card payment details. */
5198
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5070
5199
  /**
5071
- * Payment ID
5200
+ * Payment ID.
5072
5201
  * @format GUID
5202
+ * @readonly
5073
5203
  */
5074
- paymentId?: string | null;
5204
+ id?: string | null;
5205
+ /** 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. */
5206
+ createdDate?: Date | null;
5075
5207
  /**
5076
- * Capture amount.
5077
- * If not provided - full authorized amount will be captured.
5208
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5209
+ * @readonly
5078
5210
  */
5211
+ updatedDate?: Date | null;
5212
+ /** Payment amount. */
5079
5213
  amount?: Price;
5080
- }
5081
- interface CaptureAuthorizedPaymentsResponse {
5082
- /** All order's transactions after the capture was triggered */
5083
- orderTransactions?: OrderTransactions;
5084
- }
5085
- interface ChargeSavedPaymentMethodRequest {
5086
5214
  /**
5087
- * Ecom Order ID.
5088
- * @minLength 1
5089
- * @maxLength 100
5215
+ * Whether refunds for this payment are disabled.
5216
+ * + `true`: This payment is not refundable.
5217
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5090
5218
  */
5091
- ecomOrderId?: string;
5092
- /** Amount to be charged */
5093
- amount?: Price;
5094
- }
5095
- interface ChargeSavedPaymentMethodResponse {
5096
- /** Payment gateway's order ID (e.g Wix Payments) */
5097
- paymentGatewayOrderId?: string;
5219
+ refundDisabled?: boolean;
5220
+ /** Details about cash rounding applied to this payment, when relevant. */
5221
+ cashRounding?: CashRoundingDetails;
5098
5222
  }
5099
- interface SendBuyerConfirmationEmailRequest {
5100
- /** @format GUID */
5101
- orderId?: string;
5223
+ /** @oneof */
5224
+ interface PaymentPaymentDetailsOneOf {
5225
+ /** Regular payment details. */
5226
+ regularPaymentDetails?: RegularPaymentDetails;
5227
+ /** Gift card payment details. */
5228
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5102
5229
  }
5103
- interface SendBuyerConfirmationEmailResponse {
5230
+ /** @oneof */
5231
+ interface PaymentReceiptInfoOneOf {
5104
5232
  }
5105
- interface SendBuyerPaymentsReceivedEmailRequest {
5233
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5234
+ /** Credit card details. */
5235
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5106
5236
  /**
5107
- * @minLength 1
5237
+ * Wix Payments order ID.
5108
5238
  * @maxLength 100
5109
5239
  */
5110
- orderId?: string;
5111
- }
5112
- interface SendBuyerPaymentsReceivedEmailResponse {
5113
- }
5114
- interface SendBuyerPickupConfirmationEmailRequest {
5240
+ paymentOrderId?: string | null;
5115
5241
  /**
5116
- * @minLength 1
5242
+ * Payment gateway's transaction ID.
5243
+ * This field is only returned when the value of `offline_payment` is `false`.
5117
5244
  * @maxLength 100
5118
5245
  */
5119
- orderId?: string;
5120
- }
5121
- interface SendBuyerPickupConfirmationEmailResponse {
5122
- }
5123
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
5246
+ gatewayTransactionId?: string | null;
5124
5247
  /**
5125
- * IDs of orders to send pickup emails for.
5126
- * @minSize 1
5127
- * @maxSize 300
5248
+ * Payment method.
5249
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5250
+ * Non-exhaustive list of supported values:
5251
+ * + `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`
5252
+ * @maxLength 100
5253
+ * @deprecated Payment method.
5254
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5255
+ * Non-exhaustive list of supported values:
5256
+ * + `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`
5257
+ * @replacedBy payment_method_name
5258
+ * @targetRemovalDate 2026-07-01
5128
5259
  */
5129
- orderIds?: string[];
5130
- }
5131
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
5132
- }
5133
- interface SendBuyerShippingConfirmationEmailRequest {
5260
+ paymentMethod?: string | null;
5134
5261
  /**
5135
- * @minLength 1
5262
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5136
5263
  * @maxLength 100
5137
5264
  */
5138
- orderId?: string;
5139
- }
5140
- interface SendBuyerShippingConfirmationEmailResponse {
5141
- }
5142
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
5265
+ providerTransactionId?: string | null;
5266
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5267
+ offlinePayment?: boolean;
5268
+ /** Payment status. */
5269
+ status?: TransactionStatusWithLiterals;
5270
+ /** Whether there is a payment agreement that allows for future charges. */
5271
+ savedPaymentMethod?: boolean;
5272
+ /** Authorization details. */
5273
+ authorizationDetails?: AuthorizationDetails;
5143
5274
  /**
5144
- * IDs of orders to send pickup emails for.
5145
- * @minSize 1
5146
- * @maxSize 300
5275
+ * Record of chargebacks made by the buyer.
5276
+ * @maxSize 6
5147
5277
  */
5148
- orderIds?: string[];
5149
- }
5150
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
5151
- }
5152
- interface SendMerchantOrderReceivedNotificationRequest {
5278
+ chargebacks?: Chargeback[];
5279
+ /** Platform fee amount associated with this payment. */
5280
+ platformFee?: Price;
5153
5281
  /**
5154
- * @minLength 1
5155
- * @maxLength 100
5282
+ * Payment method with buyer and optional owner translations.
5283
+ * Non-exhaustive list of supported values:
5284
+ * + `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`
5156
5285
  */
5157
- orderId?: string;
5286
+ paymentMethodName?: PaymentMethodName;
5158
5287
  }
5159
- interface SendMerchantOrderReceivedNotificationResponse {
5288
+ /** @oneof */
5289
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5290
+ /** Credit card details. */
5291
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5160
5292
  }
5161
- interface SendCancelRefundEmailRequest {
5293
+ declare enum TransactionStatus {
5294
+ UNDEFINED = "UNDEFINED",
5295
+ APPROVED = "APPROVED",
5296
+ PENDING = "PENDING",
5297
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5298
+ CANCELED = "CANCELED",
5299
+ DECLINED = "DECLINED",
5300
+ REFUNDED = "REFUNDED",
5301
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5302
+ AUTHORIZED = "AUTHORIZED",
5303
+ VOIDED = "VOIDED"
5304
+ }
5305
+ /** @enumType */
5306
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5307
+ interface CreditCardPaymentMethodDetails {
5162
5308
  /**
5163
- * The ID of order that is canceled/refunded
5164
- * @minLength 1
5165
- * @maxLength 100
5309
+ * The last 4 digits of the card number.
5310
+ * @maxLength 4
5166
5311
  */
5167
- orderId?: string;
5312
+ lastFourDigits?: string | null;
5168
5313
  /**
5169
- * Personal note added to the email (optional)
5170
- * @minLength 1
5171
- * @maxLength 1000
5314
+ * Card issuer's brand.
5315
+ * @maxLength 100
5172
5316
  */
5173
- customMessage?: string | null;
5174
- /** Refund amount */
5175
- refundAmount?: Price;
5317
+ brand?: string | null;
5318
+ }
5319
+ interface AuthorizationDetails {
5176
5320
  /**
5177
- * Refund ID. (Optional)
5178
- * @format GUID
5321
+ * Whether the authorized payment is of a delayed capture.
5322
+ * @readonly
5179
5323
  */
5180
- refundId?: string | null;
5181
- }
5182
- interface SendCancelRefundEmailResponse {
5183
- }
5184
- interface SendRefundEmailRequest {
5324
+ delayedCapture?: boolean;
5325
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5326
+ authorizedDate?: Date | null;
5185
5327
  /**
5186
- * The ID of order that is refunded
5187
- * @format GUID
5328
+ * List of captures associated with payment
5329
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5330
+ * @maxSize 1
5188
5331
  */
5189
- orderId?: string;
5332
+ captures?: AuthorizationCapture[];
5333
+ /** Void associated with payment */
5334
+ void?: AuthorizationVoid;
5335
+ /** Scheduled action for this transaction */
5336
+ scheduledAction?: V1ScheduledAction;
5337
+ }
5338
+ interface AuthorizationCapture {
5190
5339
  /**
5191
- * Refund ID
5340
+ * Capture ID.
5192
5341
  * @format GUID
5342
+ * @readonly
5193
5343
  */
5194
- refundId?: string;
5344
+ id?: string | null;
5345
+ /** Status of this capture action */
5346
+ status?: AuthorizationCaptureStatusWithLiterals;
5195
5347
  /**
5196
- * Personal note added to the email (optional)
5197
- * @minLength 1
5198
- * @maxLength 1000
5348
+ * Amount of this capture
5349
+ * @immutable
5199
5350
  */
5200
- customMessage?: string | null;
5351
+ amount?: Price;
5352
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5353
+ createdDate?: Date | null;
5354
+ /** In case of status is FAILED may contain failure details */
5355
+ failureDetails?: AuthorizationActionFailureDetails;
5201
5356
  }
5202
- interface SendRefundEmailResponse {
5357
+ declare enum AuthorizationCaptureStatus {
5358
+ /** Capture operation still in progress. */
5359
+ PENDING = "PENDING",
5360
+ /** Capture operation succeeded. */
5361
+ SUCCEEDED = "SUCCEEDED",
5362
+ /** Capture operation failed. */
5363
+ FAILED = "FAILED"
5203
5364
  }
5204
- interface SendFulfillmentEmailRequest {
5205
- /** @format GUID */
5206
- orderId?: string;
5207
- /** @format GUID */
5208
- fulfillerId?: string;
5365
+ /** @enumType */
5366
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5367
+ interface AuthorizationActionFailureDetails {
5368
+ /** @maxLength 100 */
5369
+ failureCode?: string;
5209
5370
  }
5210
- interface SendFulfillmentEmailResponse {
5371
+ interface AuthorizationVoid {
5372
+ /** Status of this void action */
5373
+ status?: AuthorizationVoidStatusWithLiterals;
5374
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5375
+ voidedDate?: Date | null;
5376
+ /** In case of status is FAILED may contain failure details */
5377
+ failureDetails?: AuthorizationActionFailureDetails;
5378
+ /** Reason of void action */
5379
+ reason?: ReasonWithLiterals;
5211
5380
  }
5212
- interface SendMerchantOrderReceivedPushRequest {
5213
- /**
5214
- * @minLength 1
5215
- * @maxLength 100
5216
- */
5217
- orderId?: string;
5381
+ declare enum AuthorizationVoidStatus {
5382
+ /** Void operation still in progress. */
5383
+ PENDING = "PENDING",
5384
+ /** Void operation succeeded. */
5385
+ SUCCEEDED = "SUCCEEDED",
5386
+ /** Void operation failed. */
5387
+ FAILED = "FAILED"
5218
5388
  }
5219
- interface SendMerchantOrderReceivedPushResponse {
5389
+ /** @enumType */
5390
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5391
+ /** Reason the authorization was voided. */
5392
+ declare enum Reason {
5393
+ /** Authorization was voided by user. */
5394
+ MANUAL = "MANUAL",
5395
+ /** Authorization passed execution date. */
5396
+ SCHEDULED = "SCHEDULED"
5220
5397
  }
5221
- interface PreviewEmailByTypeRequest {
5222
- emailType?: PreviewEmailTypeWithLiterals;
5398
+ /** @enumType */
5399
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5400
+ interface V1ScheduledAction {
5401
+ /** Type of the action. */
5402
+ actionType?: ActionTypeWithLiterals;
5403
+ /** The date and time of the action. */
5404
+ executionDate?: Date | null;
5223
5405
  }
5224
- declare enum PreviewEmailType {
5225
- ORDER_PLACED = "ORDER_PLACED",
5226
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5227
- ORDER_SHIPPED = "ORDER_SHIPPED",
5228
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5406
+ declare enum ActionType {
5407
+ VOID = "VOID",
5408
+ CAPTURE = "CAPTURE"
5229
5409
  }
5230
5410
  /** @enumType */
5231
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5232
- interface PreviewEmailByTypeResponse {
5233
- emailPreview?: string;
5234
- }
5235
- interface PreviewRefundEmailRequest {
5236
- /**
5237
- * @minLength 1
5238
- * @maxLength 100
5239
- */
5240
- orderId?: string;
5241
- /** Refund amount */
5242
- refundAmount?: Price;
5243
- /** Refund business details */
5244
- details?: RefundDetails;
5411
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5412
+ interface Chargeback {
5245
5413
  /**
5246
- * Personal note added to the email (optional)
5247
- * @minLength 1
5248
- * @maxLength 1000
5414
+ * Chargeback ID.
5415
+ * @format GUID
5416
+ * @readonly
5417
+ * @immutable
5249
5418
  */
5250
- customMessage?: string | null;
5419
+ id?: string;
5251
5420
  /**
5252
- * Refund ID. (Optional)
5253
- * @format GUID
5421
+ * 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.
5422
+ * @readonly
5423
+ * @immutable
5254
5424
  */
5255
- refundId?: string | null;
5256
- }
5257
- interface PreviewRefundEmailResponse {
5258
- emailPreview?: string;
5259
- }
5260
- interface PreviewCancelEmailRequest {
5425
+ createdDate?: Date | null;
5261
5426
  /**
5262
- * @minLength 1
5263
- * @maxLength 100
5427
+ * 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.
5428
+ * @readonly
5264
5429
  */
5265
- orderId?: string;
5430
+ updatedDate?: Date | null;
5266
5431
  /**
5267
- * Personal note added to the email (optional)
5268
- * @minLength 1
5269
- * @maxLength 1000
5432
+ * Amount.
5433
+ * @readonly
5434
+ * @immutable
5270
5435
  */
5271
- customMessage?: string | null;
5272
- }
5273
- interface PreviewCancelEmailResponse {
5274
- emailPreview?: string;
5275
- }
5276
- interface PreviewCancelRefundEmailRequest {
5436
+ amount?: Price;
5277
5437
  /**
5278
- * @minLength 1
5279
- * @maxLength 100
5438
+ * Reversal amount. Present only when status is REVERSED.
5439
+ * @readonly
5280
5440
  */
5281
- orderId?: string;
5441
+ reversalAmount?: Price;
5282
5442
  /**
5283
- * Personal note added to the email (optional)
5284
- * @minLength 1
5285
- * @maxLength 1000
5443
+ * Status.
5444
+ *
5445
+ * Default: `"APPROVED"`.
5286
5446
  */
5287
- customMessage?: string | null;
5288
- /** Refund amount */
5289
- refundAmount?: Price;
5447
+ status?: ChargebackStatusWithLiterals;
5290
5448
  /**
5291
- * Refund ID. (Optional)
5449
+ * External chargeback ID.
5292
5450
  * @format GUID
5451
+ * @readonly
5452
+ * @immutable
5293
5453
  */
5294
- refundId?: string | null;
5295
- }
5296
- interface PreviewCancelRefundEmailResponse {
5297
- emailPreview?: string;
5298
- }
5299
- interface PreviewBuyerPaymentsReceivedEmailRequest {
5300
- }
5301
- interface PreviewBuyerPaymentsReceivedEmailResponse {
5302
- emailPreview?: string;
5303
- }
5304
- interface PreviewBuyerConfirmationEmailRequest {
5305
- }
5306
- interface PreviewBuyerConfirmationEmailResponse {
5307
- emailPreview?: string;
5308
- }
5309
- interface PreviewBuyerPickupConfirmationEmailRequest {
5310
- }
5311
- interface PreviewBuyerPickupConfirmationEmailResponse {
5312
- emailPreview?: string;
5313
- }
5314
- interface PreviewShippingConfirmationEmailRequest {
5315
- }
5316
- interface PreviewShippingConfirmationEmailResponse {
5317
- emailPreview?: string;
5318
- }
5319
- interface PreviewResendDownloadLinksEmailRequest {
5454
+ externalId?: string | null;
5320
5455
  }
5321
- interface PreviewResendDownloadLinksEmailResponse {
5322
- emailPreview?: string;
5456
+ declare enum ChargebackStatus {
5457
+ /** Chargeback was approved. */
5458
+ APPROVED = "APPROVED",
5459
+ /** Chargeback was reversed. */
5460
+ REVERSED = "REVERSED"
5323
5461
  }
5324
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5325
- /** Emitted on a meta site creation. */
5326
- siteCreated?: SiteCreated;
5327
- /** Emitted on a meta site transfer completion. */
5328
- siteTransferred?: SiteTransferred;
5329
- /** Emitted on a meta site deletion. */
5330
- siteDeleted?: SiteDeleted;
5331
- /** Emitted on a meta site restoration. */
5332
- siteUndeleted?: SiteUndeleted;
5333
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5334
- sitePublished?: SitePublished;
5335
- /** Emitted on a meta site unpublish. */
5336
- siteUnpublished?: SiteUnpublished;
5337
- /** Emitted when meta site is marked as template. */
5338
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5339
- /** Emitted when meta site is marked as a WixSite. */
5340
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5341
- /** Emitted when an application is provisioned (installed). */
5342
- serviceProvisioned?: ServiceProvisioned;
5343
- /** Emitted when an application is removed (uninstalled). */
5344
- serviceRemoved?: ServiceRemoved;
5345
- /** Emitted when meta site name (URL slug) is changed. */
5346
- siteRenamedPayload?: SiteRenamed;
5347
- /** Emitted when meta site was permanently deleted. */
5348
- hardDeleted?: SiteHardDeleted;
5349
- /** Emitted on a namespace change. */
5350
- namespaceChanged?: NamespaceChanged;
5351
- /** Emitted when Studio is attached. */
5352
- studioAssigned?: StudioAssigned;
5353
- /** Emitted when Studio is detached. */
5354
- studioUnassigned?: StudioUnassigned;
5355
- /**
5356
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5357
- * the actual URL.
5358
- *
5359
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5360
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5361
- */
5362
- urlChanged?: SiteUrlChanged;
5363
- /** Site is marked as PurgedExternally */
5364
- sitePurgedExternally?: SitePurgedExternally;
5365
- /** Emitted when Odeditor is attached. */
5366
- odeditorAssigned?: OdeditorAssigned;
5367
- /** Emitted when Odeditor is detached. */
5368
- odeditorUnassigned?: OdeditorUnassigned;
5369
- /** Emitted when Picasso is attached. */
5370
- picassoAssigned?: PicassoAssigned;
5371
- /** Emitted when Picasso is detached. */
5372
- picassoUnassigned?: PicassoUnassigned;
5373
- /** Emitted when Wixel is attached. */
5374
- wixelAssigned?: WixelAssigned;
5375
- /** Emitted when Wixel is detached. */
5376
- wixelUnassigned?: WixelUnassigned;
5377
- /** Emitted when StudioTwo is attached. */
5378
- studioTwoAssigned?: StudioTwoAssigned;
5379
- /** Emitted when StudioTwo is detached. */
5380
- studioTwoUnassigned?: StudioTwoUnassigned;
5381
- /** Emitted when media from user domain is enabled. */
5382
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5383
- /** Emitted when media from user domain is disabled. */
5384
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5385
- /** Emitted when Editorless is attached. */
5386
- editorlessAssigned?: EditorlessAssigned;
5387
- /** Emitted when Editorless is detached. */
5388
- editorlessUnassigned?: EditorlessUnassigned;
5462
+ /** @enumType */
5463
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5464
+ interface PaymentMethodName {
5389
5465
  /**
5390
- * A meta site id.
5391
- * @format GUID
5466
+ * Translated payment method name in buyer language.
5467
+ * @maxLength 100
5392
5468
  */
5393
- metaSiteId?: string;
5394
- /** A meta site version. Monotonically increasing. */
5395
- version?: string;
5396
- /** A timestamp of the event. */
5397
- timestamp?: string;
5469
+ buyerLanguageName?: string | null;
5398
5470
  /**
5399
- * TODO(meta-site): Change validation once validations are disabled for consumers
5400
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5401
- * @maxSize 4000
5471
+ * Translated payment method name in site owner language.
5472
+ * @maxLength 100
5402
5473
  */
5403
- assets?: Asset[];
5404
- }
5405
- /** @oneof */
5406
- interface MetaSiteSpecialEventPayloadOneOf {
5407
- /** Emitted on a meta site creation. */
5408
- siteCreated?: SiteCreated;
5409
- /** Emitted on a meta site transfer completion. */
5410
- siteTransferred?: SiteTransferred;
5411
- /** Emitted on a meta site deletion. */
5412
- siteDeleted?: SiteDeleted;
5413
- /** Emitted on a meta site restoration. */
5414
- siteUndeleted?: SiteUndeleted;
5415
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5416
- sitePublished?: SitePublished;
5417
- /** Emitted on a meta site unpublish. */
5418
- siteUnpublished?: SiteUnpublished;
5419
- /** Emitted when meta site is marked as template. */
5420
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5421
- /** Emitted when meta site is marked as a WixSite. */
5422
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5423
- /** Emitted when an application is provisioned (installed). */
5424
- serviceProvisioned?: ServiceProvisioned;
5425
- /** Emitted when an application is removed (uninstalled). */
5426
- serviceRemoved?: ServiceRemoved;
5427
- /** Emitted when meta site name (URL slug) is changed. */
5428
- siteRenamedPayload?: SiteRenamed;
5429
- /** Emitted when meta site was permanently deleted. */
5430
- hardDeleted?: SiteHardDeleted;
5431
- /** Emitted on a namespace change. */
5432
- namespaceChanged?: NamespaceChanged;
5433
- /** Emitted when Studio is attached. */
5434
- studioAssigned?: StudioAssigned;
5435
- /** Emitted when Studio is detached. */
5436
- studioUnassigned?: StudioUnassigned;
5474
+ siteLanguageName?: string | null;
5437
5475
  /**
5438
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5439
- * the actual URL.
5476
+ * User-provided payment method name.
5440
5477
  *
5441
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5442
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5478
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5443
5479
  */
5444
- urlChanged?: SiteUrlChanged;
5445
- /** Site is marked as PurgedExternally */
5446
- sitePurgedExternally?: SitePurgedExternally;
5447
- /** Emitted when Odeditor is attached. */
5448
- odeditorAssigned?: OdeditorAssigned;
5449
- /** Emitted when Odeditor is detached. */
5450
- odeditorUnassigned?: OdeditorUnassigned;
5451
- /** Emitted when Picasso is attached. */
5452
- picassoAssigned?: PicassoAssigned;
5453
- /** Emitted when Picasso is detached. */
5454
- picassoUnassigned?: PicassoUnassigned;
5455
- /** Emitted when Wixel is attached. */
5456
- wixelAssigned?: WixelAssigned;
5457
- /** Emitted when Wixel is detached. */
5458
- wixelUnassigned?: WixelUnassigned;
5459
- /** Emitted when StudioTwo is attached. */
5460
- studioTwoAssigned?: StudioTwoAssigned;
5461
- /** Emitted when StudioTwo is detached. */
5462
- studioTwoUnassigned?: StudioTwoUnassigned;
5463
- /** Emitted when media from user domain is enabled. */
5464
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5465
- /** Emitted when media from user domain is disabled. */
5466
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5467
- /** Emitted when Editorless is attached. */
5468
- editorlessAssigned?: EditorlessAssigned;
5469
- /** Emitted when Editorless is detached. */
5470
- editorlessUnassigned?: EditorlessUnassigned;
5480
+ userDefinedName?: UserDefinedPaymentMethodName;
5471
5481
  }
5472
- interface Asset {
5482
+ interface GiftCardPaymentDetails {
5473
5483
  /**
5474
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5475
- * @maxLength 36
5484
+ * Gift card payment ID.
5485
+ * @maxLength 100
5476
5486
  */
5477
- appDefId?: string;
5487
+ giftCardPaymentId?: string;
5478
5488
  /**
5479
- * An instance id. For legacy reasons may be UUID or a string.
5480
- * @maxLength 200
5489
+ * ID of the app that created the gift card.
5490
+ * @format GUID
5481
5491
  */
5482
- instanceId?: string;
5483
- /** An application state. */
5484
- state?: StateWithLiterals;
5492
+ appId?: string;
5493
+ /**
5494
+ * Whether the gift card is voided.
5495
+ * @readonly
5496
+ */
5497
+ voided?: boolean;
5485
5498
  }
5486
- declare enum State {
5487
- UNKNOWN = "UNKNOWN",
5488
- ENABLED = "ENABLED",
5489
- DISABLED = "DISABLED",
5490
- PENDING = "PENDING",
5491
- DEMO = "DEMO"
5499
+ interface MembershipPaymentDetails {
5500
+ /**
5501
+ * Membership ID.
5502
+ * @maxLength 100
5503
+ */
5504
+ membershipId?: string;
5505
+ /**
5506
+ * ID of the line item this membership applies to.
5507
+ * @minLength 1
5508
+ * @maxLength 100
5509
+ */
5510
+ lineItemId?: string;
5511
+ /** Payment status. */
5512
+ status?: MembershipPaymentStatusWithLiterals;
5513
+ /** Membership name. */
5514
+ name?: MembershipName;
5515
+ /**
5516
+ * The transaction ID in the membership system. Can be used to void the transaction.
5517
+ * @minLength 1
5518
+ * @maxLength 100
5519
+ */
5520
+ externalTransactionId?: string | null;
5521
+ /**
5522
+ * Whether the membership is voided.
5523
+ * @readonly
5524
+ */
5525
+ voided?: boolean;
5526
+ /**
5527
+ * ID of the application providing this payment option.
5528
+ * @format GUID
5529
+ */
5530
+ providerAppId?: string;
5531
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5532
+ futureMembership?: FutureMembershipDetails;
5533
+ }
5534
+ declare enum MembershipPaymentStatus {
5535
+ /** Payment was charged. */
5536
+ CHARGED = "CHARGED",
5537
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5538
+ CHARGE_FAILED = "CHARGE_FAILED",
5539
+ /** Payment is pending. */
5540
+ CHARGE_PENDING = "CHARGE_PENDING",
5541
+ /** Payment was voided. */
5542
+ VOIDED = "VOIDED"
5492
5543
  }
5493
5544
  /** @enumType */
5494
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5495
- interface SiteCreated {
5545
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5546
+ interface FutureMembershipDetails {
5496
5547
  /**
5497
- * A template identifier (empty if not created from a template).
5498
- * @maxLength 36
5548
+ * ID of the plan line item in the order from which the membership will be created.
5549
+ * @format GUID
5499
5550
  */
5500
- originTemplateId?: string;
5551
+ lineItemId?: string;
5501
5552
  /**
5502
- * An account id of the owner.
5503
- * @format GUID
5553
+ * ID of the benefit the future membership will grant.
5554
+ * @maxLength 200
5504
5555
  */
5505
- ownerId?: string;
5506
- /** A context in which meta site was created. */
5507
- context?: SiteCreatedContextWithLiterals;
5556
+ benefitId?: string;
5557
+ }
5558
+ interface WixReceiptInfo {
5508
5559
  /**
5509
- * A meta site id from which this site was created.
5510
- *
5511
- * In case of a creation from a template it's a template id.
5512
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5560
+ * Receipt ID
5513
5561
  * @format GUID
5514
5562
  */
5515
- originMetaSiteId?: string | null;
5563
+ receiptId?: string;
5516
5564
  /**
5517
- * A meta site name (URL slug).
5518
- * @maxLength 20
5565
+ * Display number of receipt
5566
+ * @minLength 1
5567
+ * @maxLength 40
5519
5568
  */
5520
- siteName?: string;
5521
- /** A namespace. */
5522
- namespace?: NamespaceWithLiterals;
5569
+ displayNumber?: string | null;
5523
5570
  }
5524
- declare enum SiteCreatedContext {
5525
- /** A valid option, we don't expose all reasons why site might be created. */
5526
- OTHER = "OTHER",
5527
- /** A meta site was created from template. */
5528
- FROM_TEMPLATE = "FROM_TEMPLATE",
5529
- /** A meta site was created by copying of the transfferred meta site. */
5530
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5531
- /** A copy of existing meta site. */
5532
- DUPLICATE = "DUPLICATE",
5533
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5534
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5535
- /** deprecated A meta site was created for Flash editor. */
5536
- FLASH = "FLASH"
5571
+ interface ExternalReceiptInfo {
5572
+ /**
5573
+ * External receipt ID
5574
+ * @maxLength 100
5575
+ */
5576
+ receiptId?: string | null;
5577
+ /**
5578
+ * ID of the app providing the receipt
5579
+ * @format GUID
5580
+ */
5581
+ appId?: string | null;
5582
+ /**
5583
+ * Display number of receipt
5584
+ * @minLength 1
5585
+ * @maxLength 40
5586
+ */
5587
+ displayNumber?: string | null;
5537
5588
  }
5538
- /** @enumType */
5539
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5540
- declare enum Namespace {
5541
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5542
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5543
- WIX = "WIX",
5544
- /** 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. */
5545
- SHOUT_OUT = "SHOUT_OUT",
5546
- /** 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. */
5547
- ALBUMS = "ALBUMS",
5548
- /** 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. */
5549
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5550
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5551
- HOTELS = "HOTELS",
5552
- /** 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. */
5553
- CLUBS = "CLUBS",
5554
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5555
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5556
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5557
- DEV_SITE = "DEV_SITE",
5558
- /** 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. */
5559
- LOGOS = "LOGOS",
5560
- /** 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. */
5561
- VIDEO_MAKER = "VIDEO_MAKER",
5562
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5563
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5564
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5565
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5589
+ interface CashRoundingDetails {
5566
5590
  /**
5567
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5568
- *
5569
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5591
+ * Payment amount before cash rounding was applied.
5592
+ * When provided, balance and status calculations use this value instead of `amount`
5593
+ * to prevent false overpayment or underpayment due to rounding.
5570
5594
  */
5571
- HTML_DRAFT = "HTML_DRAFT",
5595
+ unroundedAmount?: Price;
5572
5596
  /**
5573
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5574
- * Will be accessible from Site List and will not have a website app.
5575
- * Once the user attaches a site, the site will become a regular wixsite.
5597
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5598
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5599
+ * @readonly
5576
5600
  */
5577
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5578
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5579
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5580
- /** It is to be used in the Business First efforts. */
5581
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5582
- /** Bookings business flow with no site. */
5583
- ANYWHERE = "ANYWHERE",
5584
- /** Namespace for Headless Backoffice with no editor */
5585
- HEADLESS = "HEADLESS",
5601
+ roundingAdjustment?: CashRounding;
5602
+ }
5603
+ declare enum PaymentStatus {
5604
+ APPROVED = "APPROVED",
5605
+ PENDING = "PENDING",
5606
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5607
+ CANCELED = "CANCELED",
5608
+ DECLINED = "DECLINED",
5609
+ REFUNDED = "REFUNDED",
5610
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5611
+ AUTHORIZED = "AUTHORIZED",
5612
+ VOIDED = "VOIDED"
5613
+ }
5614
+ /** @enumType */
5615
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5616
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5617
+ }
5618
+ /** @oneof */
5619
+ interface PaymentStatusDetailsStatusDetailsOneOf {
5620
+ }
5621
+ interface CanceledStatusDetails {
5622
+ reason?: CanceledReasonWithLiterals;
5623
+ }
5624
+ declare enum CanceledReason {
5625
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5626
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5627
+ /** Payment was not completed by user and expired. */
5628
+ EXPIRED = "EXPIRED"
5629
+ }
5630
+ /** @enumType */
5631
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5632
+ interface DeclinedStatusDetails {
5633
+ reason?: DeclinedReasonWithLiterals;
5634
+ }
5635
+ declare enum DeclinedReason {
5636
+ /** Corresponding charge failed. */
5637
+ CHARGE_FAILED = "CHARGE_FAILED",
5638
+ /** Payment details expired. */
5639
+ EXPIRED = "EXPIRED",
5640
+ /** Insufficient funds. */
5641
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5642
+ /** Gift card was disabled before charge was attempted. */
5643
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5644
+ }
5645
+ /** @enumType */
5646
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5647
+ interface VoidedStatusDetails {
5648
+ reason?: VoidedReasonWithLiterals;
5649
+ }
5650
+ declare enum VoidedReason {
5651
+ /** Payment was voided by merchant request. */
5652
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5653
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5654
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5655
+ }
5656
+ /** @enumType */
5657
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5658
+ interface Refund {
5586
5659
  /**
5587
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5588
- * The site will be used for account level CSM feature for enterprise
5660
+ * Refund ID.
5661
+ * @format GUID
5662
+ * @readonly
5589
5663
  */
5590
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5591
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5592
- RISE = "RISE",
5664
+ id?: string;
5593
5665
  /**
5594
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5595
- * There's a blank site behind the scene but it's blank).
5596
- * The Mobile company will be the owner of this namespace.
5666
+ * List of transactions.
5667
+ * @maxSize 50
5597
5668
  */
5598
- BRANDED_FIRST = "BRANDED_FIRST",
5599
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5600
- NOWNIA = "NOWNIA",
5669
+ transactions?: RefundTransaction[];
5670
+ /** Refund business details. */
5671
+ details?: RefundDetails;
5601
5672
  /**
5602
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5603
- * The Partners company owns this namespace.
5673
+ * 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.
5674
+ * @readonly
5675
+ * @immutable
5604
5676
  */
5605
- UGC_TEMPLATE = "UGC_TEMPLATE",
5606
- /** Codux Headless Sites */
5607
- CODUX = "CODUX",
5608
- /** Bobb - AI Design Creator. */
5609
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5677
+ createdDate?: Date | null;
5610
5678
  /**
5611
- * Shared Blog Site is a unique single site across Enterprise account,
5612
- * This site will hold all Blog posts related to the Marketing product.
5679
+ * Aggregated refund summary.
5680
+ * @readonly
5613
5681
  */
5614
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5615
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5616
- STANDALONE_FORMS = "STANDALONE_FORMS",
5617
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5618
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5619
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5620
- MIMIR = "MIMIR",
5621
- /** Wix Twins platform. */
5622
- TWINS = "TWINS",
5623
- /** Wix Nano. */
5624
- NANO = "NANO",
5625
- /** Base44 headless sites. */
5626
- BASE44 = "BASE44",
5627
- /** Wix Channels Sites */
5628
- CHANNELS = "CHANNELS",
5629
- /** Nautilus platform. */
5630
- NAUTILUS = "NAUTILUS",
5682
+ summary?: AggregatedRefundSummary;
5631
5683
  /**
5632
- * Symphony a siteless site representing a project within Symphony (the evolution of Orion).
5633
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5684
+ * ID of the app that initiated this refund.
5685
+ * @format GUID
5686
+ * @readonly
5687
+ * @immutable
5634
5688
  */
5635
- SYMPHONY = "SYMPHONY",
5636
- /** Nautilus platform app. */
5637
- NAUTILUS_APPS = "NAUTILUS_APPS"
5689
+ requestingServiceAppId?: string | null;
5638
5690
  }
5639
- /** @enumType */
5640
- 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';
5641
- /** Site transferred to another user. */
5642
- interface SiteTransferred {
5691
+ interface RefundTransaction {
5643
5692
  /**
5644
- * A previous owner id (user that transfers meta site).
5693
+ * ID of the payment associated with this refund.
5645
5694
  * @format GUID
5695
+ * @immutable
5646
5696
  */
5647
- oldOwnerId?: string;
5697
+ paymentId?: string;
5648
5698
  /**
5649
- * A new owner id (user that accepts meta site).
5650
- * @format GUID
5699
+ * Refund amount.
5700
+ * @immutable
5651
5701
  */
5652
- newOwnerId?: string;
5653
- }
5654
- /** Soft deletion of the meta site. Could be restored. */
5655
- interface SiteDeleted {
5656
- /** A deletion context. */
5657
- deleteContext?: DeleteContext;
5658
- }
5659
- interface DeleteContext {
5660
- /** When the meta site was deleted. */
5661
- dateDeleted?: Date | null;
5662
- /** A status. */
5663
- deleteStatus?: DeleteStatusWithLiterals;
5702
+ amount?: Price;
5703
+ /** Refund status. */
5704
+ refundStatus?: RefundStatusWithLiterals;
5705
+ /** Optional details of current refund status. */
5706
+ refundStatusInfo?: RefundStatusInfo;
5664
5707
  /**
5665
- * A reason (flow).
5666
- * @maxLength 255
5708
+ * Payment gateway's refund ID.
5709
+ * This field is only returned when the value of `external_refund` is `false`.
5710
+ * @format GUID
5667
5711
  */
5668
- deleteOrigin?: string;
5712
+ gatewayRefundId?: string | null;
5713
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5714
+ providerRefundId?: string | null;
5669
5715
  /**
5670
- * A service that deleted it.
5671
- * @maxLength 255
5716
+ * Whether refund was made externally and manually on the payment provider's side.
5717
+ * @immutable
5672
5718
  */
5673
- initiatorId?: string | null;
5719
+ externalRefund?: boolean;
5674
5720
  }
5675
- declare enum DeleteStatus {
5676
- UNKNOWN = "UNKNOWN",
5677
- TRASH = "TRASH",
5678
- DELETED = "DELETED",
5679
- PENDING_PURGE = "PENDING_PURGE",
5680
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5721
+ /** Refund transaction status. */
5722
+ declare enum RefundStatus {
5723
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5724
+ PENDING = "PENDING",
5725
+ /** Refund transaction succeeded. */
5726
+ SUCCEEDED = "SUCCEEDED",
5727
+ /** Refund transaction failed. */
5728
+ FAILED = "FAILED",
5729
+ /** Refund request acknowledged, and will be executed soon. */
5730
+ SCHEDULED = "SCHEDULED",
5731
+ /** Refund was initiated on payment provider side. */
5732
+ STARTED = "STARTED"
5681
5733
  }
5682
5734
  /** @enumType */
5683
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5684
- /** Restoration of the meta site. */
5685
- interface SiteUndeleted {
5686
- }
5687
- /** First publish of a meta site. Or subsequent publish after unpublish. */
5688
- interface SitePublished {
5689
- }
5690
- interface SiteUnpublished {
5735
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5736
+ interface RefundStatusInfo {
5691
5737
  /**
5692
- * A list of URLs previously associated with the meta site.
5693
- * @maxLength 4000
5694
- * @maxSize 10000
5738
+ * Reason code for the refund's current status.
5739
+ *
5740
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5741
+ * @minLength 1
5742
+ * @maxLength 10
5695
5743
  */
5696
- urls?: string[];
5697
- }
5698
- interface SiteMarkedAsTemplate {
5699
- }
5700
- interface SiteMarkedAsWixSite {
5744
+ paymentGatewayReasonCode?: string | null;
5745
+ /**
5746
+ * Free text explanation of current refund status.
5747
+ * @minLength 1
5748
+ * @maxLength 1000
5749
+ */
5750
+ description?: string | null;
5701
5751
  }
5702
- /**
5703
- * Represents a service provisioned a site.
5704
- *
5705
- * Note on `origin_instance_id`:
5706
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5707
- * This is because of the following scenario:
5708
- *
5709
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
5710
- * such as a product catalog. When you create a site from this template, you inherit this
5711
- * default product catalog. However, if the template's product catalog is modified,
5712
- * your site will retain the catalog as it was at the time of site creation. This ensures that
5713
- * your site remains consistent with what you initially received and does not include any
5714
- * changes made to the original template afterward.
5715
- * To ensure this, the TPA on the template gets a new instance_id.
5716
- */
5717
- interface ServiceProvisioned {
5752
+ interface AggregatedRefundSummary {
5753
+ /** Total amount requested for refund. */
5754
+ requestedRefund?: Price;
5755
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5756
+ pendingRefund?: Price;
5757
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5758
+ refunded?: Price;
5759
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
5760
+ failedRefundAmount?: Price;
5761
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
5762
+ pending?: boolean;
5763
+ /** Breakdown of refunded items. Available only after refund is complete. */
5764
+ breakdown?: RefundItemsBreakdown;
5765
+ }
5766
+ interface RefundItemsBreakdown {
5718
5767
  /**
5719
- * Either UUID or EmbeddedServiceType.
5720
- * @maxLength 36
5768
+ * Refunded line items and the amount refunded for each.
5769
+ * @maxSize 300
5721
5770
  */
5722
- appDefId?: string;
5771
+ lineItems?: LineItemRefundSummary[];
5772
+ }
5773
+ interface LineItemRefundSummary {
5723
5774
  /**
5724
- * Not only UUID. Something here could be something weird.
5725
- * @maxLength 36
5775
+ * ID of the refunded line item.
5776
+ * @format GUID
5726
5777
  */
5727
- instanceId?: string;
5778
+ lineItemId?: string;
5779
+ /** Total refunded amount for the line item. */
5780
+ totalRefundedAmount?: Price;
5781
+ }
5782
+ interface CalculateRefundRequest {
5728
5783
  /**
5729
- * An instance id from which this instance is originated.
5730
- * @maxLength 36
5784
+ * Order ID
5785
+ * @minLength 1
5786
+ * @maxLength 100
5731
5787
  */
5732
- originInstanceId?: string;
5788
+ ecomOrderId?: string;
5733
5789
  /**
5734
- * A version.
5735
- * @maxLength 500
5790
+ * Refunded line items and quantity
5791
+ * @maxSize 300
5736
5792
  */
5737
- version?: string | null;
5793
+ refundItems?: CalculateRefundItemRequest[];
5794
+ /** Should include shipping in refund calculation */
5795
+ refundShipping?: boolean;
5796
+ }
5797
+ interface CalculateRefundItemRequest {
5738
5798
  /**
5739
- * The origin meta site id
5799
+ * ID of the line item being refunded
5740
5800
  * @format GUID
5741
5801
  */
5742
- originMetaSiteId?: string | null;
5743
- }
5744
- interface ServiceRemoved {
5802
+ id?: string;
5745
5803
  /**
5746
- * Either UUID or EmbeddedServiceType.
5747
- * @maxLength 36
5804
+ * How much of that line item is being refunded
5805
+ * @min 1
5806
+ * @max 100000
5748
5807
  */
5749
- appDefId?: string;
5808
+ quantity?: number;
5809
+ }
5810
+ interface CalculateRefundResponse {
5811
+ /** Total refundable amount */
5812
+ total?: Price;
5813
+ /** Tax cost of the order */
5814
+ tax?: Price;
5815
+ /** Discount given for this order */
5816
+ discount?: Price;
5817
+ /** Total cost of the order (without tax) */
5818
+ subtotal?: Price;
5819
+ /** Total shipping cost for order */
5820
+ shipping?: Price;
5821
+ /** Previous refund given on that order */
5822
+ previouslyRefundedAmount?: Price;
5750
5823
  /**
5751
- * Not only UUID. Something here could be something weird.
5752
- * @maxLength 36
5824
+ * The refundable items of that order
5825
+ * @maxSize 300
5753
5826
  */
5754
- instanceId?: string;
5827
+ items?: CalculateRefundItemResponse[];
5828
+ }
5829
+ interface CalculateRefundItemResponse {
5755
5830
  /**
5756
- * A version.
5757
- * @maxLength 500
5831
+ * Line item ID
5832
+ * @format GUID
5758
5833
  */
5759
- version?: string | null;
5834
+ id?: string;
5835
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5836
+ price?: Price;
5760
5837
  }
5761
- /** Rename of the site. Meaning, free public url has been changed as well. */
5762
- interface SiteRenamed {
5838
+ interface VoidAuthorizedPaymentsRequest {
5763
5839
  /**
5764
- * A new meta site name (URL slug).
5765
- * @maxLength 20
5840
+ * Wix eCommerce order ID
5841
+ * @minLength 1
5842
+ * @maxLength 100
5766
5843
  */
5767
- newSiteName?: string;
5844
+ ecomOrderId: string;
5768
5845
  /**
5769
- * A previous meta site name (URL slug).
5770
- * @maxLength 255
5846
+ * Payment IDs
5847
+ * @minSize 1
5848
+ * @maxSize 100
5849
+ * @format GUID
5771
5850
  */
5772
- oldSiteName?: string;
5773
- }
5774
- /**
5775
- * Hard deletion of the meta site.
5776
- *
5777
- * Could not be restored. Therefore it's desirable to cleanup data.
5778
- */
5779
- interface SiteHardDeleted {
5780
- /** A deletion context. */
5781
- deleteContext?: DeleteContext;
5782
- }
5783
- interface NamespaceChanged {
5784
- /** A previous namespace. */
5785
- oldNamespace?: NamespaceWithLiterals;
5786
- /** A new namespace. */
5787
- newNamespace?: NamespaceWithLiterals;
5788
- }
5789
- /** Assigned Studio editor */
5790
- interface StudioAssigned {
5791
- }
5792
- /** Unassigned Studio editor */
5793
- interface StudioUnassigned {
5851
+ paymentIds: string[];
5794
5852
  }
5795
- /**
5796
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5797
- *
5798
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5799
- * with sites and its urls, you need to listen to another topic/event. Read about it:
5800
- *
5801
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5802
- */
5803
- interface SiteUrlChanged {
5853
+ interface VoidAuthorizedPaymentsResponse {
5854
+ /** All order's transactions after the void was triggered */
5855
+ orderTransactions?: OrderTransactions;
5804
5856
  }
5805
- /**
5806
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5807
- * Consumed by other teams to remove relevant data.
5808
- */
5809
- interface SitePurgedExternally {
5857
+ interface CaptureAuthorizedPaymentsRequest {
5810
5858
  /**
5811
- * @maxLength 2048
5859
+ * Wix eCommerce order ID
5860
+ * @minLength 1
5861
+ * @maxLength 100
5862
+ */
5863
+ ecomOrderId: string;
5864
+ /**
5865
+ * Capture payments information
5866
+ * @minSize 1
5812
5867
  * @maxSize 100
5813
- * @deprecated
5814
- * @targetRemovalDate 2025-04-15
5815
5868
  */
5816
- appDefId?: string[];
5817
- }
5818
- /** Assigned Odeditor */
5819
- interface OdeditorAssigned {
5820
- }
5821
- /** Unassigned Odeditor */
5822
- interface OdeditorUnassigned {
5823
- }
5824
- /** Assigned Picasso editor */
5825
- interface PicassoAssigned {
5826
- }
5827
- /** Unassigned Picasso */
5828
- interface PicassoUnassigned {
5829
- }
5830
- /** Assigned Wixel */
5831
- interface WixelAssigned {
5832
- }
5833
- /** Unassigned Wixel */
5834
- interface WixelUnassigned {
5835
- }
5836
- /** Assigned StudioTwo */
5837
- interface StudioTwoAssigned {
5838
- }
5839
- /** Unassigned StudioTwo */
5840
- interface StudioTwoUnassigned {
5841
- }
5842
- /** Media from user domain is enabled. */
5843
- interface UserDomainMediaEnabled {
5844
- }
5845
- /** Media from user domain is disabled. */
5846
- interface UserDomainMediaDisabled {
5847
- }
5848
- /** Assigned Editorless */
5849
- interface EditorlessAssigned {
5850
- }
5851
- /** Unassigned Editorless */
5852
- interface EditorlessUnassigned {
5869
+ payments: PaymentCapture[];
5853
5870
  }
5854
- interface HasCustomEmailConfigurationsRequest {
5871
+ interface PaymentCapture {
5872
+ /**
5873
+ * Payment ID
5874
+ * @format GUID
5875
+ */
5876
+ paymentId?: string | null;
5877
+ /**
5878
+ * Capture amount.
5879
+ * If not provided - full authorized amount will be captured.
5880
+ */
5881
+ amount?: Price;
5855
5882
  }
5856
- interface HasCustomEmailConfigurationsResponse {
5857
- hasCustomConfigurations?: boolean;
5883
+ interface CaptureAuthorizedPaymentsResponse {
5884
+ /** All order's transactions after the capture was triggered */
5885
+ orderTransactions?: OrderTransactions;
5858
5886
  }
5859
- interface AddToAutomationMigrationPopulationRequest {
5860
- /** When true, sends custom email configurations to automation system via email */
5861
- sendCustomEmailConfigs?: boolean;
5862
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5863
- origin?: OriginWithLiterals;
5887
+ interface ChargeSavedPaymentMethodRequest {
5888
+ /**
5889
+ * Ecom Order ID.
5890
+ * @minLength 1
5891
+ * @maxLength 100
5892
+ */
5893
+ ecomOrderId?: string;
5894
+ /** Amount to be charged */
5895
+ amount?: Price;
5864
5896
  }
5865
- declare enum Origin {
5866
- OPT_IN = "OPT_IN",
5867
- MIGRATION = "MIGRATION"
5897
+ interface ChargeSavedPaymentMethodResponse {
5898
+ /** Payment gateway's order ID (e.g Wix Payments) */
5899
+ paymentGatewayOrderId?: string;
5868
5900
  }
5869
- /** @enumType */
5870
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5871
- interface AddToAutomationMigrationPopulationResponse {
5872
- success?: boolean;
5901
+ interface V1TriggerReindexRequest {
5902
+ /** @format GUID */
5903
+ metasiteId?: string;
5904
+ /**
5905
+ * @minLength 1
5906
+ * @maxLength 100
5907
+ * @maxSize 100
5908
+ */
5909
+ orderIds?: string[];
5873
5910
  }
5874
- interface IsInAutomationMigrationPopulationRequest {
5911
+ interface V1TriggerReindexResponse {
5875
5912
  }
5876
- interface IsInAutomationMigrationPopulationResponse {
5877
- inPopulation?: boolean;
5913
+ interface V1TriggerReindexOrderRequest {
5914
+ /** @format GUID */
5915
+ metasiteId?: string;
5916
+ /**
5917
+ * @minLength 1
5918
+ * @maxLength 100
5919
+ */
5920
+ orderId?: string;
5878
5921
  }
5879
5922
  interface DiffmatokyPayload {
5880
5923
  left?: string;
@@ -7865,4 +7908,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
7865
7908
  declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
7866
7909
  declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
7867
7910
 
7868
- 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, 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 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, 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, 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 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, 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 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 };
7911
+ 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, 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 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 DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, 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 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, 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 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 };