@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
@@ -866,6 +866,70 @@ declare enum TaxableAddressType {
866
866
  }
867
867
  /** @enumType */
868
868
  type TaxableAddressTypeWithLiterals = TaxableAddressType | 'BUSINESS' | 'BILLING' | 'SHIPPING';
869
+ /**
870
+ * Decimal-quantity metadata for a line item.
871
+ *
872
+ * Set on a line item that represents a non-integer-quantity purchase
873
+ * (e.g. "2.75 square meters of fake grass", "1.5 kg of sugar",
874
+ * "0.75 hours of consultation"). When set, the line item must have
875
+ * `fixedQuantity` = true.
876
+ *
877
+ * The decimal value lives in `value`. When `decimalQuantity` is set,
878
+ * consumers read the human-readable quantity from `value` rather
879
+ * than from `lineItem.quantity`.
880
+ */
881
+ interface DecimalQuantity extends DecimalQuantityUnitOneOf {
882
+ }
883
+ /** @oneof */
884
+ interface DecimalQuantityUnitOneOf {
885
+ }
886
+ interface TranslatableString {
887
+ /**
888
+ * __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).
889
+ *
890
+ * Min: 1 character.
891
+ * Max: 200 characters.
892
+ * @minLength 1
893
+ * @maxLength 200
894
+ */
895
+ original?: string;
896
+ /**
897
+ * String translated into the buyer's language.
898
+ *
899
+ * Min: 1 character.
900
+ * Max: 400 characters.
901
+ * Default: Same as `original`.
902
+ * @minLength 1
903
+ * @maxLength 400
904
+ */
905
+ translated?: string | null;
906
+ }
907
+ declare enum MeasurementUnit {
908
+ UNSPECIFIED = "UNSPECIFIED",
909
+ ML = "ML",
910
+ CL = "CL",
911
+ L = "L",
912
+ CBM = "CBM",
913
+ MG = "MG",
914
+ G = "G",
915
+ KG = "KG",
916
+ MM = "MM",
917
+ CM = "CM",
918
+ M = "M",
919
+ SQM = "SQM",
920
+ OZ = "OZ",
921
+ LB = "LB",
922
+ FLOZ = "FLOZ",
923
+ PT = "PT",
924
+ QT = "QT",
925
+ GAL = "GAL",
926
+ IN = "IN",
927
+ FT = "FT",
928
+ YD = "YD",
929
+ SQFT = "SQFT"
930
+ }
931
+ /** @enumType */
932
+ 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';
869
933
  interface ExtendedFields {
870
934
  /**
871
935
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -893,27 +957,6 @@ interface ModifierGroup {
893
957
  */
894
958
  modifiers?: ItemModifier[];
895
959
  }
896
- interface TranslatableString {
897
- /**
898
- * __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).
899
- *
900
- * Min: 1 character.
901
- * Max: 200 characters.
902
- * @minLength 1
903
- * @maxLength 200
904
- */
905
- original?: string;
906
- /**
907
- * String translated into the buyer's language.
908
- *
909
- * Min: 1 character.
910
- * Max: 400 characters.
911
- * Default: Same as `original`.
912
- * @minLength 1
913
- * @maxLength 400
914
- */
915
- translated?: string | null;
916
- }
917
960
  interface ItemModifier {
918
961
  /**
919
962
  * Modifier ID.
@@ -3753,2104 +3796,2104 @@ interface BulkDeleteImportedOrdersResponse {
3753
3796
  */
3754
3797
  jobId?: string;
3755
3798
  }
3756
- interface V1TriggerReindexRequest {
3799
+ interface SendBuyerConfirmationEmailRequest {
3757
3800
  /** @format GUID */
3758
- metasiteId?: string;
3801
+ orderId?: string;
3802
+ }
3803
+ interface SendBuyerConfirmationEmailResponse {
3804
+ }
3805
+ interface SendBuyerPaymentsReceivedEmailRequest {
3759
3806
  /**
3760
3807
  * @minLength 1
3761
3808
  * @maxLength 100
3762
- * @maxSize 100
3763
3809
  */
3764
- orderIds?: string[];
3810
+ orderId?: string;
3765
3811
  }
3766
- interface V1TriggerReindexResponse {
3812
+ interface SendBuyerPaymentsReceivedEmailResponse {
3767
3813
  }
3768
- interface V1TriggerReindexOrderRequest {
3769
- /** @format GUID */
3770
- metasiteId?: string;
3814
+ interface SendBuyerPickupConfirmationEmailRequest {
3771
3815
  /**
3772
3816
  * @minLength 1
3773
3817
  * @maxLength 100
3774
3818
  */
3775
3819
  orderId?: string;
3776
3820
  }
3777
- interface PreparePaymentCollectionRequest {
3821
+ interface SendBuyerPickupConfirmationEmailResponse {
3822
+ }
3823
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
3778
3824
  /**
3779
- * Ecom order ID.
3780
- * @minLength 1
3781
- * @maxLength 100
3825
+ * IDs of orders to send pickup emails for.
3826
+ * @minSize 1
3827
+ * @maxSize 300
3782
3828
  */
3783
- ecomOrderId: string;
3784
- /** Amount to collect */
3785
- amount: Price;
3829
+ orderIds?: string[];
3830
+ }
3831
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
3832
+ }
3833
+ interface SendBuyerShippingConfirmationEmailRequest {
3786
3834
  /**
3787
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
3788
- * Existing payment gateway order will be updated with a new amount.
3789
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
3835
+ * @minLength 1
3836
+ * @maxLength 100
3790
3837
  */
3791
- paymentGatewayOrderId?: string | null;
3838
+ orderId?: string;
3839
+ }
3840
+ interface SendBuyerShippingConfirmationEmailResponse {
3841
+ }
3842
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
3792
3843
  /**
3793
- * Whether to delay capture of the payment.
3794
- * Default: false
3795
- * @deprecated Whether to delay capture of the payment.
3796
- * Default: false
3797
- * @replacedBy delayed_capture_settings.scheduled_action
3798
- * @targetRemovalDate 2024-09-30
3844
+ * IDs of orders to send pickup emails for.
3845
+ * @minSize 1
3846
+ * @maxSize 300
3799
3847
  */
3800
- delayedCapture?: boolean;
3801
- /** Delayed capture payment settings */
3802
- delayedCaptureSettings?: DelayedCaptureSettings;
3848
+ orderIds?: string[];
3803
3849
  }
3804
- interface RedirectUrls {
3850
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
3851
+ }
3852
+ interface SendMerchantOrderReceivedNotificationRequest {
3805
3853
  /**
3806
- * URL to redirect buyer in case of approved (successful) transaction
3807
- * @format WEB_URL
3854
+ * @minLength 1
3855
+ * @maxLength 100
3808
3856
  */
3809
- successUrl?: string | null;
3857
+ orderId?: string;
3858
+ }
3859
+ interface SendMerchantOrderReceivedNotificationResponse {
3860
+ }
3861
+ interface SendCancelRefundEmailRequest {
3810
3862
  /**
3811
- * URL to redirect buyer in case of buyer canceled the transaction
3812
- * @format WEB_URL
3863
+ * The ID of order that is canceled/refunded
3864
+ * @minLength 1
3865
+ * @maxLength 100
3813
3866
  */
3814
- cancelUrl?: string | null;
3867
+ orderId?: string;
3815
3868
  /**
3816
- * URL to redirect buyer in case of failed/rejected transaction
3817
- * @format WEB_URL
3869
+ * Personal note added to the email (optional)
3870
+ * @minLength 1
3871
+ * @maxLength 1000
3818
3872
  */
3819
- errorUrl?: string | null;
3873
+ customMessage?: string | null;
3874
+ /** Refund amount */
3875
+ refundAmount?: Price;
3820
3876
  /**
3821
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
3822
- * @format WEB_URL
3877
+ * Refund ID. (Optional)
3878
+ * @format GUID
3823
3879
  */
3824
- pendingUrl?: string | null;
3825
- }
3826
- interface DelayedCaptureSettings {
3827
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
3828
- scheduledAction?: ScheduledActionWithLiterals;
3829
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
3830
- delayDuration?: Duration;
3880
+ refundId?: string | null;
3831
3881
  }
3832
- declare enum ScheduledAction {
3833
- /** Whether payment will be auto-voided when duration passes */
3834
- VOID = "VOID",
3835
- /** Whether payment will be auto-captured when duration passes */
3836
- CAPTURE = "CAPTURE"
3882
+ interface SendCancelRefundEmailResponse {
3837
3883
  }
3838
- /** @enumType */
3839
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
3840
- interface Duration {
3884
+ interface SendRefundEmailRequest {
3841
3885
  /**
3842
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
3843
- * @min 1
3886
+ * The ID of order that is refunded
3887
+ * @format GUID
3844
3888
  */
3845
- count?: number;
3846
- /** Duration unit: MINUTES, HOURS and DAYS */
3847
- unit?: DurationUnitWithLiterals;
3889
+ orderId?: string;
3890
+ /**
3891
+ * Refund ID
3892
+ * @format GUID
3893
+ */
3894
+ refundId?: string;
3895
+ /**
3896
+ * Personal note added to the email (optional)
3897
+ * @minLength 1
3898
+ * @maxLength 1000
3899
+ */
3900
+ customMessage?: string | null;
3848
3901
  }
3849
- declare enum DurationUnit {
3850
- MINUTES = "MINUTES",
3851
- HOURS = "HOURS",
3852
- DAYS = "DAYS"
3902
+ interface SendRefundEmailResponse {
3853
3903
  }
3854
- /** @enumType */
3855
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
3856
- interface PreparePaymentCollectionResponse {
3857
- /** Payment gateway order id which is associated with given payment */
3858
- paymentGatewayOrderId?: string;
3904
+ interface SendFulfillmentEmailRequest {
3905
+ /** @format GUID */
3906
+ orderId?: string;
3907
+ /** @format GUID */
3908
+ fulfillerId?: string;
3859
3909
  }
3860
- interface GetPaymentCollectabilityStatusRequest {
3910
+ interface SendFulfillmentEmailResponse {
3911
+ }
3912
+ interface SendMerchantOrderReceivedPushRequest {
3861
3913
  /**
3862
- * Ecom order ID.
3863
3914
  * @minLength 1
3864
3915
  * @maxLength 100
3865
3916
  */
3866
- ecomOrderId: string;
3917
+ orderId?: string;
3867
3918
  }
3868
- interface GetPaymentCollectabilityStatusResponse {
3869
- /** Payment collectability status */
3870
- status?: PaymentCollectabilityStatusWithLiterals;
3871
- /** Collectable order amount */
3872
- amount?: Price;
3919
+ interface SendMerchantOrderReceivedPushResponse {
3873
3920
  }
3874
- declare enum PaymentCollectabilityStatus {
3875
- UNKNOWN = "UNKNOWN",
3876
- COLLECTABLE = "COLLECTABLE",
3877
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
3878
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
3879
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
3880
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
3881
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
3882
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
3883
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
3884
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
3885
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
3886
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
3921
+ interface PreviewEmailByTypeRequest {
3922
+ emailType?: PreviewEmailTypeWithLiterals;
3923
+ }
3924
+ declare enum PreviewEmailType {
3925
+ ORDER_PLACED = "ORDER_PLACED",
3926
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
3927
+ ORDER_SHIPPED = "ORDER_SHIPPED",
3928
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
3887
3929
  }
3888
3930
  /** @enumType */
3889
- 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';
3890
- interface RecordManuallyCollectedPaymentRequest {
3931
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
3932
+ interface PreviewEmailByTypeResponse {
3933
+ emailPreview?: string;
3934
+ }
3935
+ interface PreviewRefundEmailRequest {
3891
3936
  /**
3892
- * Order ID.
3893
3937
  * @minLength 1
3894
3938
  * @maxLength 100
3895
3939
  */
3896
- orderId: string;
3897
- /** Amount to be recorded as approved manual payment for given order */
3898
- amount: Price;
3899
- }
3900
- /**
3901
- * User-defined payment method name.
3902
- * Allows specifying either a predefined type or a custom name.
3903
- */
3904
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
3905
- /** Predefined payment method. */
3906
- predefined?: PredefinedPaymentMethodWithLiterals;
3940
+ orderId?: string;
3941
+ /** Refund amount */
3942
+ refundAmount?: Price;
3943
+ /** Refund business details */
3944
+ details?: RefundDetails;
3907
3945
  /**
3908
- * Custom payment method name provided by user.
3909
- *
3910
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
3946
+ * Personal note added to the email (optional)
3911
3947
  * @minLength 1
3912
- * @maxLength 100
3948
+ * @maxLength 1000
3913
3949
  */
3914
- custom?: string | null;
3915
- }
3916
- /** @oneof */
3917
- interface UserDefinedPaymentMethodNameKindOneOf {
3918
- /** Predefined payment method. */
3919
- predefined?: PredefinedPaymentMethodWithLiterals;
3950
+ customMessage?: string | null;
3920
3951
  /**
3921
- * Custom payment method name provided by user.
3922
- *
3923
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
3924
- * @minLength 1
3925
- * @maxLength 100
3952
+ * Refund ID. (Optional)
3953
+ * @format GUID
3926
3954
  */
3927
- custom?: string | null;
3928
- }
3929
- /** Predefined payment method types for offline/manual payments. */
3930
- declare enum PredefinedPaymentMethod {
3931
- /** Cash payment. */
3932
- CASH = "CASH",
3933
- /** Bank transfer. */
3934
- BANK_TRANSFER = "BANK_TRANSFER",
3935
- /** Payment by check. */
3936
- CHECK = "CHECK"
3937
- }
3938
- /** @enumType */
3939
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
3940
- interface RecordManuallyCollectedPaymentResponse {
3955
+ refundId?: string | null;
3941
3956
  }
3942
- interface MarkOrderAsPaidRequest {
3957
+ /** Business model of a refund request */
3958
+ interface RefundDetails {
3943
3959
  /**
3944
- * Ecom order ID.
3945
- * @minLength 1
3946
- * @maxLength 100
3960
+ * Order line item IDs and quantities that were refunded.
3961
+ * @maxSize 300
3947
3962
  */
3948
- ecomOrderId: string;
3949
- }
3950
- interface MarkOrderAsPaidResponse {
3951
- /** Updated order. */
3952
- order?: Order;
3953
- }
3954
- interface BulkMarkOrdersAsPaidRequest {
3963
+ items?: RefundItem[];
3964
+ /** Whether the shipping fee was also refunded. */
3965
+ shippingIncluded?: boolean;
3955
3966
  /**
3956
- * IDs of orders to mark as paid.
3957
- * @minSize 1
3967
+ * Reason for the refund, provided by customer (optional).
3968
+ * @maxLength 200
3969
+ */
3970
+ reason?: string | null;
3971
+ /**
3972
+ * Line items that were refunded.
3973
+ * @maxSize 300
3974
+ */
3975
+ lineItems?: LineItemRefund[];
3976
+ /**
3977
+ * Additional fees that were refunded.
3958
3978
  * @maxSize 100
3959
- * @minLength 1
3960
- * @maxLength 100
3961
3979
  */
3962
- ecomOrderIds: string[];
3980
+ additionalFees?: AdditionalFeeRefund[];
3981
+ /** Shipping amount that was refunded. */
3982
+ shipping?: ShippingRefund;
3963
3983
  }
3964
- interface BulkMarkOrdersAsPaidResponse {
3984
+ interface RefundItem {
3965
3985
  /**
3966
- * Items updated by the bulk action.
3967
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
3986
+ * Line item ID the refunded line item.
3987
+ * @format GUID
3968
3988
  */
3969
- results?: BulkOrderResult[];
3970
- /** Bulk action metadata. */
3971
- bulkActionMetadata?: BulkActionMetadata;
3972
- }
3973
- interface BulkOrderResult {
3974
- /** Item metadata. */
3975
- itemMetadata?: ItemMetadata;
3989
+ lineItemId?: string;
3976
3990
  /**
3977
- * Updated order.
3978
- *
3979
- * Returned when `returnFullEntity = true`.
3991
+ * Line item quantity refunded.
3992
+ * @min 1
3993
+ * @max 100000
3980
3994
  */
3981
- item?: Order;
3982
- }
3983
- interface ItemMetadata {
3984
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
3985
- _id?: string | null;
3986
- /** Index of the item within the request array. Allows for correlation between request and response items. */
3987
- originalIndex?: number;
3988
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
3989
- success?: boolean;
3990
- /** Details about the error in case of failure. */
3991
- error?: ApplicationError;
3992
- }
3993
- interface ApplicationError {
3994
- /** Error code. */
3995
- code?: string;
3996
- /** Description of the error. */
3997
- description?: string;
3998
- /** Data related to the error. */
3999
- data?: Record<string, any> | null;
4000
- }
4001
- interface BulkActionMetadata {
4002
- /** Number of items that were successfully processed. */
4003
- totalSuccesses?: number;
4004
- /** Number of items that couldn't be processed. */
4005
- totalFailures?: number;
4006
- /** Number of failures without details because detailed failure threshold was exceeded. */
4007
- undetailedFailures?: number;
3995
+ quantity?: number;
4008
3996
  }
4009
- interface GetRefundabilityStatusRequest {
3997
+ interface LineItemRefund {
4010
3998
  /**
4011
- * Order ID.
4012
- * @minLength 1
4013
- * @maxLength 100
3999
+ * Line item ID.
4000
+ * @format GUID
4001
+ * @immutable
4014
4002
  */
4015
- ecomOrderId: string;
4003
+ lineItemId?: string;
4004
+ /**
4005
+ * Refund quantity.
4006
+ * @min 1
4007
+ * @max 100000
4008
+ * @immutable
4009
+ */
4010
+ quantity?: number;
4016
4011
  }
4017
- interface GetRefundabilityStatusResponse {
4012
+ interface AdditionalFeeRefund {
4018
4013
  /**
4019
- * Refundability details.
4020
- * @maxSize 300
4014
+ * Additional fee ID.
4015
+ * @format GUID
4016
+ * @immutable
4021
4017
  */
4022
- refundabilities?: Refundability[];
4018
+ additionalFeeId?: string;
4023
4019
  /**
4024
- * Whether the order supports refunding per item.
4025
- * @deprecated
4020
+ * Refund amount.
4021
+ * @immutable
4026
4022
  */
4027
- refundablePerItem?: boolean;
4028
- }
4029
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4030
- /** Reason why payment is not refundable. */
4031
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4032
- /** Reason why payment is only refundable manually. */
4033
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4034
- /** Payment ID. */
4035
- paymentId?: string;
4036
- /** Payment refundability status. */
4037
- refundabilityStatus?: RefundableStatusWithLiterals;
4038
- /** Link to payment provider dashboard. */
4039
- providerLink?: string | null;
4040
- }
4041
- /** @oneof */
4042
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4043
- /** Reason why payment is not refundable. */
4044
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4045
- /** Reason why payment is only refundable manually. */
4046
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4047
- }
4048
- declare enum RefundableStatus {
4049
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4050
- MANUAL = "MANUAL",
4051
- REFUNDABLE = "REFUNDABLE"
4023
+ amount?: Price;
4052
4024
  }
4053
- /** @enumType */
4054
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4055
- declare enum NonRefundableReason {
4056
- NONE = "NONE",
4057
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4058
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4059
- INTERNAL_ERROR = "INTERNAL_ERROR",
4060
- NOT_PAID = "NOT_PAID",
4061
- ACCESS_DENIED = "ACCESS_DENIED",
4062
- ZERO_PRICE = "ZERO_PRICE",
4063
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4064
- PENDING_REFUND = "PENDING_REFUND",
4065
- FORBIDDEN = "FORBIDDEN",
4066
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4067
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4068
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4025
+ interface ShippingRefund {
4026
+ /**
4027
+ * Refund amount.
4028
+ * @immutable
4029
+ */
4030
+ amount?: Price;
4069
4031
  }
4070
- /** @enumType */
4071
- 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';
4072
- declare enum ManuallyRefundableReason {
4073
- EXPIRED = "EXPIRED",
4074
- NOT_SUPPORTED = "NOT_SUPPORTED",
4075
- OFFLINE = "OFFLINE",
4076
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4032
+ interface PreviewRefundEmailResponse {
4033
+ emailPreview?: string;
4077
4034
  }
4078
- /** @enumType */
4079
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4080
- interface CreatePaymentGatewayOrderRequest {
4035
+ interface PreviewCancelEmailRequest {
4081
4036
  /**
4082
- * Ecom order ID.
4083
4037
  * @minLength 1
4084
4038
  * @maxLength 100
4085
4039
  */
4086
- ecomOrderId: string;
4087
- /** Information about the user who initiated the payment. */
4088
- chargedBy?: ChargedBy;
4089
- }
4090
- interface ChargedBy {
4091
- /**
4092
- * ID - id of the user who initiated the payment
4093
- * @format GUID
4094
- */
4095
- _id?: string;
4040
+ orderId?: string;
4096
4041
  /**
4097
- * Full name - name of the user who initiated the payment
4042
+ * Personal note added to the email (optional)
4098
4043
  * @minLength 1
4099
- * @maxLength 200
4044
+ * @maxLength 1000
4100
4045
  */
4101
- fullName?: string | null;
4046
+ customMessage?: string | null;
4102
4047
  }
4103
- interface CreatePaymentGatewayOrderResponse {
4104
- /** ID of the order created in the payment gateway */
4105
- paymentGatewayOrderId?: string;
4048
+ interface PreviewCancelEmailResponse {
4049
+ emailPreview?: string;
4106
4050
  }
4107
- interface ChargeMembershipsRequest {
4051
+ interface PreviewCancelRefundEmailRequest {
4108
4052
  /**
4109
- * Order ID.
4110
4053
  * @minLength 1
4111
4054
  * @maxLength 100
4112
4055
  */
4113
- ecomOrderId: string;
4056
+ orderId?: string;
4114
4057
  /**
4115
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4116
- * but a user which is using the membership on behalf of the a member
4117
- * @format GUID
4058
+ * Personal note added to the email (optional)
4059
+ * @minLength 1
4060
+ * @maxLength 1000
4118
4061
  */
4119
- memberId: string;
4062
+ customMessage?: string | null;
4063
+ /** Refund amount */
4064
+ refundAmount?: Price;
4120
4065
  /**
4121
- * List of items to be paid by memberships
4122
- * @minSize 1
4123
- * @maxSize 300
4066
+ * Refund ID. (Optional)
4067
+ * @format GUID
4124
4068
  */
4125
- membershipCharges?: MembershipChargeItem[];
4069
+ refundId?: string | null;
4126
4070
  }
4127
- interface MembershipChargeItem {
4071
+ interface PreviewCancelRefundEmailResponse {
4072
+ emailPreview?: string;
4073
+ }
4074
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
4075
+ }
4076
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4077
+ emailPreview?: string;
4078
+ }
4079
+ interface PreviewBuyerConfirmationEmailRequest {
4080
+ }
4081
+ interface PreviewBuyerConfirmationEmailResponse {
4082
+ emailPreview?: string;
4083
+ }
4084
+ interface PreviewBuyerPickupConfirmationEmailRequest {
4085
+ }
4086
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4087
+ emailPreview?: string;
4088
+ }
4089
+ interface PreviewShippingConfirmationEmailRequest {
4090
+ }
4091
+ interface PreviewShippingConfirmationEmailResponse {
4092
+ emailPreview?: string;
4093
+ }
4094
+ interface PreviewResendDownloadLinksEmailRequest {
4095
+ }
4096
+ interface PreviewResendDownloadLinksEmailResponse {
4097
+ emailPreview?: string;
4098
+ }
4099
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4100
+ /** Emitted on a meta site creation. */
4101
+ siteCreated?: SiteCreated;
4102
+ /** Emitted on a meta site transfer completion. */
4103
+ siteTransferred?: SiteTransferred;
4104
+ /** Emitted on a meta site deletion. */
4105
+ siteDeleted?: SiteDeleted;
4106
+ /** Emitted on a meta site restoration. */
4107
+ siteUndeleted?: SiteUndeleted;
4108
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4109
+ sitePublished?: SitePublished;
4110
+ /** Emitted on a meta site unpublish. */
4111
+ siteUnpublished?: SiteUnpublished;
4112
+ /** Emitted when meta site is marked as template. */
4113
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4114
+ /** Emitted when meta site is marked as a WixSite. */
4115
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4116
+ /** Emitted when an application is provisioned (installed). */
4117
+ serviceProvisioned?: ServiceProvisioned;
4118
+ /** Emitted when an application is removed (uninstalled). */
4119
+ serviceRemoved?: ServiceRemoved;
4120
+ /** Emitted when meta site name (URL slug) is changed. */
4121
+ siteRenamedPayload?: SiteRenamed;
4122
+ /** Emitted when meta site was permanently deleted. */
4123
+ hardDeleted?: SiteHardDeleted;
4124
+ /** Emitted on a namespace change. */
4125
+ namespaceChanged?: NamespaceChanged;
4126
+ /** Emitted when Studio is attached. */
4127
+ studioAssigned?: StudioAssigned;
4128
+ /** Emitted when Studio is detached. */
4129
+ studioUnassigned?: StudioUnassigned;
4128
4130
  /**
4129
- * The id of used membership
4130
- * @minLength 1
4131
- * @maxLength 100
4131
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4132
+ * the actual URL.
4133
+ *
4134
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4135
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4132
4136
  */
4133
- membershipId?: string;
4137
+ urlChanged?: SiteUrlChanged;
4138
+ /** Site is marked as PurgedExternally */
4139
+ sitePurgedExternally?: SitePurgedExternally;
4140
+ /** Emitted when Odeditor is attached. */
4141
+ odeditorAssigned?: OdeditorAssigned;
4142
+ /** Emitted when Odeditor is detached. */
4143
+ odeditorUnassigned?: OdeditorUnassigned;
4144
+ /** Emitted when Picasso is attached. */
4145
+ picassoAssigned?: PicassoAssigned;
4146
+ /** Emitted when Picasso is detached. */
4147
+ picassoUnassigned?: PicassoUnassigned;
4148
+ /** Emitted when Wixel is attached. */
4149
+ wixelAssigned?: WixelAssigned;
4150
+ /** Emitted when Wixel is detached. */
4151
+ wixelUnassigned?: WixelUnassigned;
4152
+ /** Emitted when StudioTwo is attached. */
4153
+ studioTwoAssigned?: StudioTwoAssigned;
4154
+ /** Emitted when StudioTwo is detached. */
4155
+ studioTwoUnassigned?: StudioTwoUnassigned;
4156
+ /** Emitted when media from user domain is enabled. */
4157
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4158
+ /** Emitted when media from user domain is disabled. */
4159
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4160
+ /** Emitted when Editorless is attached. */
4161
+ editorlessAssigned?: EditorlessAssigned;
4162
+ /** Emitted when Editorless is detached. */
4163
+ editorlessUnassigned?: EditorlessUnassigned;
4134
4164
  /**
4135
- * ID of the application providing this payment option
4165
+ * A meta site id.
4136
4166
  * @format GUID
4137
4167
  */
4138
- appId?: string;
4139
- /** The name of used membership */
4140
- membershipName?: MembershipName;
4141
- /** Additional data about this membership */
4142
- membershipAdditionalData?: Record<string, any> | null;
4143
- /** Catalog and item reference info. */
4144
- catalogReference?: CatalogReference;
4145
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4146
- serviceProperties?: ServiceProperties;
4147
- /**
4148
- * Usually would be the same as catalogReference.catalogItemId
4149
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4150
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4151
- * @minLength 1
4152
- * @maxLength 36
4153
- */
4154
- rootCatalogItemId?: string | null;
4168
+ metaSiteId?: string;
4169
+ /** A meta site version. Monotonically increasing. */
4170
+ version?: string;
4171
+ /** A timestamp of the event. */
4172
+ timestamp?: string;
4155
4173
  /**
4156
- * line item id of Checkout/Order line item
4157
- * @minLength 1
4158
- * @maxLength 100
4174
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4175
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4176
+ * @maxSize 4000
4159
4177
  */
4160
- lineItemId?: string;
4178
+ assets?: Asset[];
4161
4179
  }
4162
- interface MembershipName {
4163
- /**
4164
- * Membership name.
4165
- * @maxLength 100
4166
- */
4167
- original?: string;
4180
+ /** @oneof */
4181
+ interface MetaSiteSpecialEventPayloadOneOf {
4182
+ /** Emitted on a meta site creation. */
4183
+ siteCreated?: SiteCreated;
4184
+ /** Emitted on a meta site transfer completion. */
4185
+ siteTransferred?: SiteTransferred;
4186
+ /** Emitted on a meta site deletion. */
4187
+ siteDeleted?: SiteDeleted;
4188
+ /** Emitted on a meta site restoration. */
4189
+ siteUndeleted?: SiteUndeleted;
4190
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4191
+ sitePublished?: SitePublished;
4192
+ /** Emitted on a meta site unpublish. */
4193
+ siteUnpublished?: SiteUnpublished;
4194
+ /** Emitted when meta site is marked as template. */
4195
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4196
+ /** Emitted when meta site is marked as a WixSite. */
4197
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4198
+ /** Emitted when an application is provisioned (installed). */
4199
+ serviceProvisioned?: ServiceProvisioned;
4200
+ /** Emitted when an application is removed (uninstalled). */
4201
+ serviceRemoved?: ServiceRemoved;
4202
+ /** Emitted when meta site name (URL slug) is changed. */
4203
+ siteRenamedPayload?: SiteRenamed;
4204
+ /** Emitted when meta site was permanently deleted. */
4205
+ hardDeleted?: SiteHardDeleted;
4206
+ /** Emitted on a namespace change. */
4207
+ namespaceChanged?: NamespaceChanged;
4208
+ /** Emitted when Studio is attached. */
4209
+ studioAssigned?: StudioAssigned;
4210
+ /** Emitted when Studio is detached. */
4211
+ studioUnassigned?: StudioUnassigned;
4168
4212
  /**
4169
- * Translated membership name. Defaults to `original` when not provided.
4170
- * @maxLength 100
4213
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4214
+ * the actual URL.
4215
+ *
4216
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4217
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4171
4218
  */
4172
- translated?: string | null;
4219
+ urlChanged?: SiteUrlChanged;
4220
+ /** Site is marked as PurgedExternally */
4221
+ sitePurgedExternally?: SitePurgedExternally;
4222
+ /** Emitted when Odeditor is attached. */
4223
+ odeditorAssigned?: OdeditorAssigned;
4224
+ /** Emitted when Odeditor is detached. */
4225
+ odeditorUnassigned?: OdeditorUnassigned;
4226
+ /** Emitted when Picasso is attached. */
4227
+ picassoAssigned?: PicassoAssigned;
4228
+ /** Emitted when Picasso is detached. */
4229
+ picassoUnassigned?: PicassoUnassigned;
4230
+ /** Emitted when Wixel is attached. */
4231
+ wixelAssigned?: WixelAssigned;
4232
+ /** Emitted when Wixel is detached. */
4233
+ wixelUnassigned?: WixelUnassigned;
4234
+ /** Emitted when StudioTwo is attached. */
4235
+ studioTwoAssigned?: StudioTwoAssigned;
4236
+ /** Emitted when StudioTwo is detached. */
4237
+ studioTwoUnassigned?: StudioTwoUnassigned;
4238
+ /** Emitted when media from user domain is enabled. */
4239
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4240
+ /** Emitted when media from user domain is disabled. */
4241
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4242
+ /** Emitted when Editorless is attached. */
4243
+ editorlessAssigned?: EditorlessAssigned;
4244
+ /** Emitted when Editorless is detached. */
4245
+ editorlessUnassigned?: EditorlessUnassigned;
4173
4246
  }
4174
- interface ServiceProperties {
4247
+ interface Asset {
4175
4248
  /**
4176
- * 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.
4177
- * For example, the start time of a class.
4249
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4250
+ * @maxLength 36
4178
4251
  */
4179
- scheduledDate?: Date | null;
4252
+ appDefId?: string;
4180
4253
  /**
4181
- * 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.
4182
- * @min 1
4183
- * @max 10000
4254
+ * An instance id. For legacy reasons may be UUID or a string.
4255
+ * @maxLength 200
4184
4256
  */
4185
- numberOfParticipants?: number | null;
4257
+ instanceId?: string;
4258
+ /** An application state. */
4259
+ state?: StateWithLiterals;
4186
4260
  }
4187
- interface ChargeMembershipsResponse {
4261
+ declare enum State {
4262
+ UNKNOWN = "UNKNOWN",
4263
+ ENABLED = "ENABLED",
4264
+ DISABLED = "DISABLED",
4265
+ PENDING = "PENDING",
4266
+ DEMO = "DEMO"
4188
4267
  }
4189
- interface TriggerRefundRequest {
4268
+ /** @enumType */
4269
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4270
+ interface SiteCreated {
4190
4271
  /**
4191
- * The order this refund related to
4192
- * @minLength 1
4193
- * @maxLength 100
4272
+ * A template identifier (empty if not created from a template).
4273
+ * @maxLength 36
4194
4274
  */
4195
- ecomOrderId: string;
4275
+ originTemplateId?: string;
4196
4276
  /**
4197
- * Refund operations information
4198
- * @minSize 1
4199
- * @maxSize 1
4277
+ * An account id of the owner.
4278
+ * @format GUID
4200
4279
  */
4201
- payments: PaymentRefund[];
4202
- /** Business model of a refund */
4203
- details?: RefundDetails;
4204
- /** Side effect details related to refund */
4205
- sideEffects?: RefundSideEffects;
4206
- }
4207
- interface PaymentRefund {
4280
+ ownerId?: string;
4281
+ /** A context in which meta site was created. */
4282
+ context?: SiteCreatedContextWithLiterals;
4208
4283
  /**
4209
- * Specific payment within the order to refund
4284
+ * A meta site id from which this site was created.
4285
+ *
4286
+ * In case of a creation from a template it's a template id.
4287
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4210
4288
  * @format GUID
4211
4289
  */
4212
- paymentId?: string;
4213
- /** Refund amount. Not relevant for membership and gift card refunds. */
4214
- amount?: Price;
4290
+ originMetaSiteId?: string | null;
4215
4291
  /**
4216
- * Whether refund is made externally and manually (on the payment provider's side)
4217
- * 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.
4218
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4292
+ * A meta site name (URL slug).
4293
+ * @maxLength 20
4219
4294
  */
4220
- externalRefund?: boolean;
4295
+ siteName?: string;
4296
+ /** A namespace. */
4297
+ namespace?: NamespaceWithLiterals;
4221
4298
  }
4222
- /** Business model of a refund request */
4223
- interface RefundDetails {
4224
- /**
4225
- * Order line item IDs and quantities that were refunded.
4226
- * @maxSize 300
4227
- */
4228
- items?: RefundItem[];
4229
- /** Whether the shipping fee was also refunded. */
4230
- shippingIncluded?: boolean;
4299
+ declare enum SiteCreatedContext {
4300
+ /** A valid option, we don't expose all reasons why site might be created. */
4301
+ OTHER = "OTHER",
4302
+ /** A meta site was created from template. */
4303
+ FROM_TEMPLATE = "FROM_TEMPLATE",
4304
+ /** A meta site was created by copying of the transfferred meta site. */
4305
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4306
+ /** A copy of existing meta site. */
4307
+ DUPLICATE = "DUPLICATE",
4308
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4309
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4310
+ /** deprecated A meta site was created for Flash editor. */
4311
+ FLASH = "FLASH"
4312
+ }
4313
+ /** @enumType */
4314
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4315
+ declare enum Namespace {
4316
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4317
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4318
+ WIX = "WIX",
4319
+ /** 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. */
4320
+ SHOUT_OUT = "SHOUT_OUT",
4321
+ /** 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. */
4322
+ ALBUMS = "ALBUMS",
4323
+ /** 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. */
4324
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4325
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4326
+ HOTELS = "HOTELS",
4327
+ /** 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. */
4328
+ CLUBS = "CLUBS",
4329
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4330
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4331
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4332
+ DEV_SITE = "DEV_SITE",
4333
+ /** 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. */
4334
+ LOGOS = "LOGOS",
4335
+ /** 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. */
4336
+ VIDEO_MAKER = "VIDEO_MAKER",
4337
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4338
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4339
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4340
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4231
4341
  /**
4232
- * Reason for the refund, provided by customer (optional).
4233
- * @maxLength 200
4342
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4343
+ *
4344
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
4234
4345
  */
4235
- reason?: string | null;
4346
+ HTML_DRAFT = "HTML_DRAFT",
4236
4347
  /**
4237
- * Line items that were refunded.
4238
- * @maxSize 300
4348
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4349
+ * Will be accessible from Site List and will not have a website app.
4350
+ * Once the user attaches a site, the site will become a regular wixsite.
4239
4351
  */
4240
- lineItems?: LineItemRefund[];
4352
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
4353
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4354
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
4355
+ /** It is to be used in the Business First efforts. */
4356
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
4357
+ /** Bookings business flow with no site. */
4358
+ ANYWHERE = "ANYWHERE",
4359
+ /** Namespace for Headless Backoffice with no editor */
4360
+ HEADLESS = "HEADLESS",
4241
4361
  /**
4242
- * Additional fees that were refunded.
4243
- * @maxSize 100
4362
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4363
+ * The site will be used for account level CSM feature for enterprise
4244
4364
  */
4245
- additionalFees?: AdditionalFeeRefund[];
4246
- /** Shipping amount that was refunded. */
4247
- shipping?: ShippingRefund;
4248
- }
4249
- interface RefundItem {
4365
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4366
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4367
+ RISE = "RISE",
4250
4368
  /**
4251
- * Line item ID the refunded line item.
4252
- * @format GUID
4369
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4370
+ * There's a blank site behind the scene but it's blank).
4371
+ * The Mobile company will be the owner of this namespace.
4253
4372
  */
4254
- lineItemId?: string;
4373
+ BRANDED_FIRST = "BRANDED_FIRST",
4374
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4375
+ NOWNIA = "NOWNIA",
4255
4376
  /**
4256
- * Line item quantity refunded.
4257
- * @min 1
4258
- * @max 100000
4377
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
4378
+ * The Partners company owns this namespace.
4259
4379
  */
4260
- quantity?: number;
4261
- }
4262
- interface LineItemRefund {
4380
+ UGC_TEMPLATE = "UGC_TEMPLATE",
4381
+ /** Codux Headless Sites */
4382
+ CODUX = "CODUX",
4383
+ /** Bobb - AI Design Creator. */
4384
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4263
4385
  /**
4264
- * Line item ID.
4265
- * @format GUID
4266
- * @immutable
4386
+ * Shared Blog Site is a unique single site across Enterprise account,
4387
+ * This site will hold all Blog posts related to the Marketing product.
4267
4388
  */
4268
- lineItemId?: string;
4389
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4390
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4391
+ STANDALONE_FORMS = "STANDALONE_FORMS",
4392
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4393
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
4394
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4395
+ MIMIR = "MIMIR",
4396
+ /** Wix Twins platform. */
4397
+ TWINS = "TWINS",
4398
+ /** Wix Nano. */
4399
+ NANO = "NANO",
4400
+ /** Base44 headless sites. */
4401
+ BASE44 = "BASE44",
4402
+ /** Wix Channels Sites */
4403
+ CHANNELS = "CHANNELS",
4404
+ /** Nautilus platform. */
4405
+ NAUTILUS = "NAUTILUS",
4269
4406
  /**
4270
- * Refund quantity.
4271
- * @min 1
4272
- * @max 100000
4273
- * @immutable
4407
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
4408
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
4274
4409
  */
4275
- quantity?: number;
4410
+ SYMPHONY = "SYMPHONY",
4411
+ /** Nautilus platform app. */
4412
+ NAUTILUS_APPS = "NAUTILUS_APPS"
4276
4413
  }
4277
- interface AdditionalFeeRefund {
4414
+ /** @enumType */
4415
+ 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';
4416
+ /** Site transferred to another user. */
4417
+ interface SiteTransferred {
4278
4418
  /**
4279
- * Additional fee ID.
4419
+ * A previous owner id (user that transfers meta site).
4280
4420
  * @format GUID
4281
- * @immutable
4282
4421
  */
4283
- additionalFeeId?: string;
4422
+ oldOwnerId?: string;
4284
4423
  /**
4285
- * Refund amount.
4286
- * @immutable
4424
+ * A new owner id (user that accepts meta site).
4425
+ * @format GUID
4287
4426
  */
4288
- amount?: Price;
4427
+ newOwnerId?: string;
4289
4428
  }
4290
- interface ShippingRefund {
4291
- /**
4292
- * Refund amount.
4293
- * @immutable
4294
- */
4295
- amount?: Price;
4429
+ /** Soft deletion of the meta site. Could be restored. */
4430
+ interface SiteDeleted {
4431
+ /** A deletion context. */
4432
+ deleteContext?: DeleteContext;
4296
4433
  }
4297
- interface RefundSideEffects {
4298
- /** Inventory restock details as part of this refund. */
4299
- restockInfo?: RestockInfo;
4300
- /** Whether to send a refund confirmation email to the customer. */
4301
- sendOrderRefundedEmail?: boolean;
4434
+ interface DeleteContext {
4435
+ /** When the meta site was deleted. */
4436
+ dateDeleted?: Date | null;
4437
+ /** A status. */
4438
+ deleteStatus?: DeleteStatusWithLiterals;
4302
4439
  /**
4303
- * Custom message added to the refund confirmation email.
4304
- * @minLength 1
4305
- * @maxLength 1000
4440
+ * A reason (flow).
4441
+ * @maxLength 255
4306
4442
  */
4307
- customMessage?: string | null;
4308
- }
4309
- interface RestockInfo {
4310
- /** Restock type. */
4311
- type?: RestockTypeWithLiterals;
4443
+ deleteOrigin?: string;
4312
4444
  /**
4313
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4314
- * @maxSize 300
4445
+ * A service that deleted it.
4446
+ * @maxLength 255
4315
4447
  */
4316
- items?: RestockItem[];
4448
+ initiatorId?: string | null;
4317
4449
  }
4318
- declare enum RestockType {
4319
- NO_ITEMS = "NO_ITEMS",
4320
- ALL_ITEMS = "ALL_ITEMS",
4321
- SOME_ITEMS = "SOME_ITEMS"
4450
+ declare enum DeleteStatus {
4451
+ UNKNOWN = "UNKNOWN",
4452
+ TRASH = "TRASH",
4453
+ DELETED = "DELETED",
4454
+ PENDING_PURGE = "PENDING_PURGE",
4455
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4456
+ }
4457
+ /** @enumType */
4458
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4459
+ /** Restoration of the meta site. */
4460
+ interface SiteUndeleted {
4322
4461
  }
4323
- /** @enumType */
4324
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4325
- interface RestockItem {
4326
- /**
4327
- * ID of the line item being restocked.
4328
- * @format GUID
4329
- */
4330
- lineItemId?: string;
4462
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
4463
+ interface SitePublished {
4464
+ }
4465
+ interface SiteUnpublished {
4331
4466
  /**
4332
- * Line item quantity being restocked.
4333
- * @min 1
4334
- * @max 100000
4467
+ * A list of URLs previously associated with the meta site.
4468
+ * @maxLength 4000
4469
+ * @maxSize 10000
4335
4470
  */
4336
- quantity?: number;
4471
+ urls?: string[];
4337
4472
  }
4338
- interface TriggerRefundResponse {
4339
- /** All order's transactions after the refunds were added */
4340
- orderTransactions?: OrderTransactions;
4341
- /** Created refund ID */
4342
- refundId?: string | null;
4343
- /** Payment ID's that the refund execution had failed for */
4344
- failedPaymentIds?: ItemMetadata[];
4473
+ interface SiteMarkedAsTemplate {
4474
+ }
4475
+ interface SiteMarkedAsWixSite {
4345
4476
  }
4346
4477
  /**
4347
- * A record of all payments and refunds associated with an order.
4478
+ * Represents a service provisioned a site.
4348
4479
  *
4349
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4480
+ * Note on `origin_instance_id`:
4481
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4482
+ * This is because of the following scenario:
4483
+ *
4484
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
4485
+ * such as a product catalog. When you create a site from this template, you inherit this
4486
+ * default product catalog. However, if the template's product catalog is modified,
4487
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
4488
+ * your site remains consistent with what you initially received and does not include any
4489
+ * changes made to the original template afterward.
4490
+ * To ensure this, the TPA on the template gets a new instance_id.
4350
4491
  */
4351
- interface OrderTransactions {
4352
- /**
4353
- * Order ID.
4354
- * @format GUID
4355
- */
4356
- orderId?: string;
4492
+ interface ServiceProvisioned {
4357
4493
  /**
4358
- * Record of payments made to the merchant.
4359
- * @maxSize 100
4494
+ * Either UUID or EmbeddedServiceType.
4495
+ * @maxLength 36
4360
4496
  */
4361
- payments?: Payment[];
4497
+ appDefId?: string;
4362
4498
  /**
4363
- * Record of refunds made to the buyer.
4364
- * @maxSize 300
4499
+ * Not only UUID. Something here could be something weird.
4500
+ * @maxLength 36
4365
4501
  */
4366
- refunds?: Refund[];
4367
- }
4368
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
4369
- /** Regular payment details. */
4370
- regularPaymentDetails?: RegularPaymentDetails;
4371
- /** Gift card payment details. */
4372
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4502
+ instanceId?: string;
4373
4503
  /**
4374
- * Payment ID.
4375
- * @format GUID
4376
- * @readonly
4504
+ * An instance id from which this instance is originated.
4505
+ * @maxLength 36
4377
4506
  */
4378
- _id?: string | null;
4379
- /** 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. */
4380
- _createdDate?: Date | null;
4507
+ originInstanceId?: string;
4381
4508
  /**
4382
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4383
- * @readonly
4509
+ * A version.
4510
+ * @maxLength 500
4384
4511
  */
4385
- _updatedDate?: Date | null;
4386
- /** Payment amount. */
4387
- amount?: Price;
4512
+ version?: string | null;
4388
4513
  /**
4389
- * Whether refunds for this payment are disabled.
4390
- * + `true`: This payment is not refundable.
4391
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4514
+ * The origin meta site id
4515
+ * @format GUID
4392
4516
  */
4393
- refundDisabled?: boolean;
4394
- /** Details about cash rounding applied to this payment, when relevant. */
4395
- cashRounding?: CashRoundingDetails;
4396
- }
4397
- /** @oneof */
4398
- interface PaymentPaymentDetailsOneOf {
4399
- /** Regular payment details. */
4400
- regularPaymentDetails?: RegularPaymentDetails;
4401
- /** Gift card payment details. */
4402
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4403
- }
4404
- /** @oneof */
4405
- interface PaymentReceiptInfoOneOf {
4517
+ originMetaSiteId?: string | null;
4406
4518
  }
4407
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4408
- /** Credit card details. */
4409
- creditCardDetails?: CreditCardPaymentMethodDetails;
4410
- /**
4411
- * Wix Payments order ID.
4412
- * @maxLength 100
4413
- */
4414
- paymentOrderId?: string | null;
4519
+ interface ServiceRemoved {
4415
4520
  /**
4416
- * Payment gateway's transaction ID.
4417
- * This field is only returned when the value of `offline_payment` is `false`.
4418
- * @maxLength 100
4521
+ * Either UUID or EmbeddedServiceType.
4522
+ * @maxLength 36
4419
4523
  */
4420
- gatewayTransactionId?: string | null;
4524
+ appDefId?: string;
4421
4525
  /**
4422
- * Payment method.
4423
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4424
- * Non-exhaustive list of supported values:
4425
- * + `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`
4426
- * @maxLength 100
4427
- * @deprecated Payment method.
4428
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4429
- * Non-exhaustive list of supported values:
4430
- * + `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`
4431
- * @replacedBy payment_method_name
4432
- * @targetRemovalDate 2026-07-01
4526
+ * Not only UUID. Something here could be something weird.
4527
+ * @maxLength 36
4433
4528
  */
4434
- paymentMethod?: string | null;
4529
+ instanceId?: string;
4435
4530
  /**
4436
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4437
- * @maxLength 100
4531
+ * A version.
4532
+ * @maxLength 500
4438
4533
  */
4439
- providerTransactionId?: string | null;
4440
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4441
- offlinePayment?: boolean;
4442
- /** Payment status. */
4443
- status?: TransactionStatusWithLiterals;
4444
- /** Whether there is a payment agreement that allows for future charges. */
4445
- savedPaymentMethod?: boolean;
4446
- /** Authorization details. */
4447
- authorizationDetails?: AuthorizationDetails;
4534
+ version?: string | null;
4535
+ }
4536
+ /** Rename of the site. Meaning, free public url has been changed as well. */
4537
+ interface SiteRenamed {
4448
4538
  /**
4449
- * Record of chargebacks made by the buyer.
4450
- * @maxSize 6
4539
+ * A new meta site name (URL slug).
4540
+ * @maxLength 20
4451
4541
  */
4452
- chargebacks?: Chargeback[];
4453
- /** Platform fee amount associated with this payment. */
4454
- platformFee?: Price;
4542
+ newSiteName?: string;
4455
4543
  /**
4456
- * Payment method with buyer and optional owner translations.
4457
- * Non-exhaustive list of supported values:
4458
- * + `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`
4544
+ * A previous meta site name (URL slug).
4545
+ * @maxLength 255
4459
4546
  */
4460
- paymentMethodName?: PaymentMethodName;
4547
+ oldSiteName?: string;
4461
4548
  }
4462
- /** @oneof */
4463
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4464
- /** Credit card details. */
4465
- creditCardDetails?: CreditCardPaymentMethodDetails;
4549
+ /**
4550
+ * Hard deletion of the meta site.
4551
+ *
4552
+ * Could not be restored. Therefore it's desirable to cleanup data.
4553
+ */
4554
+ interface SiteHardDeleted {
4555
+ /** A deletion context. */
4556
+ deleteContext?: DeleteContext;
4466
4557
  }
4467
- declare enum TransactionStatus {
4468
- UNDEFINED = "UNDEFINED",
4469
- APPROVED = "APPROVED",
4470
- PENDING = "PENDING",
4471
- PENDING_MERCHANT = "PENDING_MERCHANT",
4472
- CANCELED = "CANCELED",
4473
- DECLINED = "DECLINED",
4474
- REFUNDED = "REFUNDED",
4475
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4476
- AUTHORIZED = "AUTHORIZED",
4477
- VOIDED = "VOIDED"
4558
+ interface NamespaceChanged {
4559
+ /** A previous namespace. */
4560
+ oldNamespace?: NamespaceWithLiterals;
4561
+ /** A new namespace. */
4562
+ newNamespace?: NamespaceWithLiterals;
4478
4563
  }
4479
- /** @enumType */
4480
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4481
- interface CreditCardPaymentMethodDetails {
4482
- /**
4483
- * The last 4 digits of the card number.
4484
- * @maxLength 4
4485
- */
4486
- lastFourDigits?: string | null;
4564
+ /** Assigned Studio editor */
4565
+ interface StudioAssigned {
4566
+ }
4567
+ /** Unassigned Studio editor */
4568
+ interface StudioUnassigned {
4569
+ }
4570
+ /**
4571
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4572
+ *
4573
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4574
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
4575
+ *
4576
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4577
+ */
4578
+ interface SiteUrlChanged {
4579
+ }
4580
+ /**
4581
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4582
+ * Consumed by other teams to remove relevant data.
4583
+ */
4584
+ interface SitePurgedExternally {
4487
4585
  /**
4488
- * Card issuer's brand.
4489
- * @maxLength 100
4586
+ * @maxLength 2048
4587
+ * @maxSize 100
4588
+ * @deprecated
4589
+ * @targetRemovalDate 2025-04-15
4490
4590
  */
4491
- brand?: string | null;
4591
+ appDefId?: string[];
4592
+ }
4593
+ /** Assigned Odeditor */
4594
+ interface OdeditorAssigned {
4595
+ }
4596
+ /** Unassigned Odeditor */
4597
+ interface OdeditorUnassigned {
4598
+ }
4599
+ /** Assigned Picasso editor */
4600
+ interface PicassoAssigned {
4601
+ }
4602
+ /** Unassigned Picasso */
4603
+ interface PicassoUnassigned {
4604
+ }
4605
+ /** Assigned Wixel */
4606
+ interface WixelAssigned {
4607
+ }
4608
+ /** Unassigned Wixel */
4609
+ interface WixelUnassigned {
4610
+ }
4611
+ /** Assigned StudioTwo */
4612
+ interface StudioTwoAssigned {
4613
+ }
4614
+ /** Unassigned StudioTwo */
4615
+ interface StudioTwoUnassigned {
4492
4616
  }
4493
- interface AuthorizationDetails {
4494
- /**
4495
- * Whether the authorized payment is of a delayed capture.
4496
- * @readonly
4497
- */
4498
- delayedCapture?: boolean;
4499
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4500
- authorizedDate?: Date | null;
4501
- /**
4502
- * List of captures associated with payment
4503
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4504
- * @maxSize 1
4505
- */
4506
- captures?: AuthorizationCapture[];
4507
- /** Void associated with payment */
4508
- void?: AuthorizationVoid;
4509
- /** Scheduled action for this transaction */
4510
- scheduledAction?: V1ScheduledAction;
4617
+ /** Media from user domain is enabled. */
4618
+ interface UserDomainMediaEnabled {
4511
4619
  }
4512
- interface AuthorizationCapture {
4513
- /**
4514
- * Capture ID.
4515
- * @format GUID
4516
- * @readonly
4517
- */
4518
- _id?: string | null;
4519
- /** Status of this capture action */
4520
- status?: AuthorizationCaptureStatusWithLiterals;
4521
- /**
4522
- * Amount of this capture
4523
- * @immutable
4524
- */
4525
- amount?: Price;
4526
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4527
- _createdDate?: Date | null;
4528
- /** In case of status is FAILED may contain failure details */
4529
- failureDetails?: AuthorizationActionFailureDetails;
4620
+ /** Media from user domain is disabled. */
4621
+ interface UserDomainMediaDisabled {
4530
4622
  }
4531
- declare enum AuthorizationCaptureStatus {
4532
- /** Capture operation still in progress. */
4533
- PENDING = "PENDING",
4534
- /** Capture operation succeeded. */
4535
- SUCCEEDED = "SUCCEEDED",
4536
- /** Capture operation failed. */
4537
- FAILED = "FAILED"
4623
+ /** Assigned Editorless */
4624
+ interface EditorlessAssigned {
4538
4625
  }
4539
- /** @enumType */
4540
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4541
- interface AuthorizationActionFailureDetails {
4542
- /** @maxLength 100 */
4543
- failureCode?: string;
4626
+ /** Unassigned Editorless */
4627
+ interface EditorlessUnassigned {
4544
4628
  }
4545
- interface AuthorizationVoid {
4546
- /** Status of this void action */
4547
- status?: AuthorizationVoidStatusWithLiterals;
4548
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4549
- voidedDate?: Date | null;
4550
- /** In case of status is FAILED may contain failure details */
4551
- failureDetails?: AuthorizationActionFailureDetails;
4552
- /** Reason of void action */
4553
- reason?: ReasonWithLiterals;
4629
+ interface HasCustomEmailConfigurationsRequest {
4554
4630
  }
4555
- declare enum AuthorizationVoidStatus {
4556
- /** Void operation still in progress. */
4557
- PENDING = "PENDING",
4558
- /** Void operation succeeded. */
4559
- SUCCEEDED = "SUCCEEDED",
4560
- /** Void operation failed. */
4561
- FAILED = "FAILED"
4631
+ interface HasCustomEmailConfigurationsResponse {
4632
+ hasCustomConfigurations?: boolean;
4562
4633
  }
4563
- /** @enumType */
4564
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4565
- /** Reason the authorization was voided. */
4566
- declare enum Reason {
4567
- /** Authorization was voided by user. */
4568
- MANUAL = "MANUAL",
4569
- /** Authorization passed execution date. */
4570
- SCHEDULED = "SCHEDULED"
4634
+ interface AddToAutomationMigrationPopulationRequest {
4635
+ /** When true, sends custom email configurations to automation system via email */
4636
+ sendCustomEmailConfigs?: boolean;
4637
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4638
+ origin?: OriginWithLiterals;
4639
+ }
4640
+ declare enum Origin {
4641
+ OPT_IN = "OPT_IN",
4642
+ MIGRATION = "MIGRATION"
4571
4643
  }
4572
4644
  /** @enumType */
4573
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4574
- interface V1ScheduledAction {
4575
- /** Type of the action. */
4576
- actionType?: ActionTypeWithLiterals;
4577
- /** The date and time of the action. */
4578
- executionDate?: Date | null;
4645
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4646
+ interface AddToAutomationMigrationPopulationResponse {
4647
+ success?: boolean;
4579
4648
  }
4580
- declare enum ActionType {
4581
- VOID = "VOID",
4582
- CAPTURE = "CAPTURE"
4649
+ interface IsInAutomationMigrationPopulationRequest {
4583
4650
  }
4584
- /** @enumType */
4585
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4586
- interface Chargeback {
4651
+ interface IsInAutomationMigrationPopulationResponse {
4652
+ inPopulation?: boolean;
4653
+ }
4654
+ interface PreparePaymentCollectionRequest {
4587
4655
  /**
4588
- * Chargeback ID.
4589
- * @format GUID
4590
- * @readonly
4591
- * @immutable
4656
+ * Ecom order ID.
4657
+ * @minLength 1
4658
+ * @maxLength 100
4592
4659
  */
4593
- _id?: string;
4660
+ ecomOrderId: string;
4661
+ /** Amount to collect */
4662
+ amount: Price;
4594
4663
  /**
4595
- * 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.
4596
- * @readonly
4597
- * @immutable
4664
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4665
+ * Existing payment gateway order will be updated with a new amount.
4666
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4598
4667
  */
4599
- _createdDate?: Date | null;
4668
+ paymentGatewayOrderId?: string | null;
4600
4669
  /**
4601
- * 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.
4602
- * @readonly
4670
+ * Whether to delay capture of the payment.
4671
+ * Default: false
4672
+ * @deprecated Whether to delay capture of the payment.
4673
+ * Default: false
4674
+ * @replacedBy delayed_capture_settings.scheduled_action
4675
+ * @targetRemovalDate 2024-09-30
4603
4676
  */
4604
- _updatedDate?: Date | null;
4677
+ delayedCapture?: boolean;
4678
+ /** Delayed capture payment settings */
4679
+ delayedCaptureSettings?: DelayedCaptureSettings;
4680
+ }
4681
+ interface RedirectUrls {
4605
4682
  /**
4606
- * Amount.
4607
- * @readonly
4608
- * @immutable
4683
+ * URL to redirect buyer in case of approved (successful) transaction
4684
+ * @format WEB_URL
4609
4685
  */
4610
- amount?: Price;
4686
+ successUrl?: string | null;
4611
4687
  /**
4612
- * Reversal amount. Present only when status is REVERSED.
4613
- * @readonly
4688
+ * URL to redirect buyer in case of buyer canceled the transaction
4689
+ * @format WEB_URL
4614
4690
  */
4615
- reversalAmount?: Price;
4691
+ cancelUrl?: string | null;
4616
4692
  /**
4617
- * Status.
4618
- *
4619
- * Default: `"APPROVED"`.
4693
+ * URL to redirect buyer in case of failed/rejected transaction
4694
+ * @format WEB_URL
4620
4695
  */
4621
- status?: ChargebackStatusWithLiterals;
4696
+ errorUrl?: string | null;
4622
4697
  /**
4623
- * External chargeback ID.
4624
- * @format GUID
4625
- * @readonly
4626
- * @immutable
4698
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4699
+ * @format WEB_URL
4627
4700
  */
4628
- externalId?: string | null;
4701
+ pendingUrl?: string | null;
4629
4702
  }
4630
- declare enum ChargebackStatus {
4631
- /** Chargeback was approved. */
4632
- APPROVED = "APPROVED",
4633
- /** Chargeback was reversed. */
4634
- REVERSED = "REVERSED"
4703
+ interface DelayedCaptureSettings {
4704
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4705
+ scheduledAction?: ScheduledActionWithLiterals;
4706
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4707
+ delayDuration?: Duration;
4708
+ }
4709
+ declare enum ScheduledAction {
4710
+ /** Whether payment will be auto-voided when duration passes */
4711
+ VOID = "VOID",
4712
+ /** Whether payment will be auto-captured when duration passes */
4713
+ CAPTURE = "CAPTURE"
4635
4714
  }
4636
4715
  /** @enumType */
4637
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
4638
- interface PaymentMethodName {
4639
- /**
4640
- * Translated payment method name in buyer language.
4641
- * @maxLength 100
4642
- */
4643
- buyerLanguageName?: string | null;
4644
- /**
4645
- * Translated payment method name in site owner language.
4646
- * @maxLength 100
4647
- */
4648
- siteLanguageName?: string | null;
4716
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4717
+ interface Duration {
4649
4718
  /**
4650
- * User-provided payment method name.
4651
- *
4652
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
4719
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4720
+ * @min 1
4653
4721
  */
4654
- userDefinedName?: UserDefinedPaymentMethodName;
4722
+ count?: number;
4723
+ /** Duration unit: MINUTES, HOURS and DAYS */
4724
+ unit?: DurationUnitWithLiterals;
4655
4725
  }
4656
- interface GiftCardPaymentDetails {
4726
+ declare enum DurationUnit {
4727
+ MINUTES = "MINUTES",
4728
+ HOURS = "HOURS",
4729
+ DAYS = "DAYS"
4730
+ }
4731
+ /** @enumType */
4732
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4733
+ interface PreparePaymentCollectionResponse {
4734
+ /** Payment gateway order id which is associated with given payment */
4735
+ paymentGatewayOrderId?: string;
4736
+ }
4737
+ interface GetPaymentCollectabilityStatusRequest {
4657
4738
  /**
4658
- * Gift card payment ID.
4739
+ * Ecom order ID.
4740
+ * @minLength 1
4659
4741
  * @maxLength 100
4660
4742
  */
4661
- giftCardPaymentId?: string;
4662
- /**
4663
- * ID of the app that created the gift card.
4664
- * @format GUID
4665
- */
4666
- appId?: string;
4667
- /**
4668
- * Whether the gift card is voided.
4669
- * @readonly
4670
- */
4671
- voided?: boolean;
4743
+ ecomOrderId: string;
4744
+ }
4745
+ interface GetPaymentCollectabilityStatusResponse {
4746
+ /** Payment collectability status */
4747
+ status?: PaymentCollectabilityStatusWithLiterals;
4748
+ /** Collectable order amount */
4749
+ amount?: Price;
4750
+ }
4751
+ declare enum PaymentCollectabilityStatus {
4752
+ UNKNOWN = "UNKNOWN",
4753
+ COLLECTABLE = "COLLECTABLE",
4754
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4755
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4756
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4757
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4758
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4759
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4760
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4761
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4762
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4763
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
4672
4764
  }
4673
- interface MembershipPaymentDetails {
4765
+ /** @enumType */
4766
+ 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';
4767
+ interface RecordManuallyCollectedPaymentRequest {
4674
4768
  /**
4675
- * Membership ID.
4769
+ * Order ID.
4770
+ * @minLength 1
4676
4771
  * @maxLength 100
4677
4772
  */
4678
- membershipId?: string;
4773
+ orderId: string;
4774
+ /** Amount to be recorded as approved manual payment for given order */
4775
+ amount: Price;
4776
+ }
4777
+ /**
4778
+ * User-defined payment method name.
4779
+ * Allows specifying either a predefined type or a custom name.
4780
+ */
4781
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4782
+ /** Predefined payment method. */
4783
+ predefined?: PredefinedPaymentMethodWithLiterals;
4679
4784
  /**
4680
- * ID of the line item this membership applies to.
4785
+ * Custom payment method name provided by user.
4786
+ *
4787
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4681
4788
  * @minLength 1
4682
4789
  * @maxLength 100
4683
4790
  */
4684
- lineItemId?: string;
4685
- /** Payment status. */
4686
- status?: MembershipPaymentStatusWithLiterals;
4687
- /** Membership name. */
4688
- name?: MembershipName;
4791
+ custom?: string | null;
4792
+ }
4793
+ /** @oneof */
4794
+ interface UserDefinedPaymentMethodNameKindOneOf {
4795
+ /** Predefined payment method. */
4796
+ predefined?: PredefinedPaymentMethodWithLiterals;
4689
4797
  /**
4690
- * The transaction ID in the membership system. Can be used to void the transaction.
4798
+ * Custom payment method name provided by user.
4799
+ *
4800
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4691
4801
  * @minLength 1
4692
4802
  * @maxLength 100
4693
4803
  */
4694
- externalTransactionId?: string | null;
4695
- /**
4696
- * Whether the membership is voided.
4697
- * @readonly
4698
- */
4699
- voided?: boolean;
4700
- /**
4701
- * ID of the application providing this payment option.
4702
- * @format GUID
4703
- */
4704
- providerAppId?: string;
4705
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
4706
- futureMembership?: FutureMembershipDetails;
4804
+ custom?: string | null;
4707
4805
  }
4708
- declare enum MembershipPaymentStatus {
4709
- /** Payment was charged. */
4710
- CHARGED = "CHARGED",
4711
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
4712
- CHARGE_FAILED = "CHARGE_FAILED",
4713
- /** Payment is pending. */
4714
- CHARGE_PENDING = "CHARGE_PENDING",
4715
- /** Payment was voided. */
4716
- VOIDED = "VOIDED"
4806
+ /** Predefined payment method types for offline/manual payments. */
4807
+ declare enum PredefinedPaymentMethod {
4808
+ /** Cash payment. */
4809
+ CASH = "CASH",
4810
+ /** Bank transfer. */
4811
+ BANK_TRANSFER = "BANK_TRANSFER",
4812
+ /** Payment by check. */
4813
+ CHECK = "CHECK"
4717
4814
  }
4718
4815
  /** @enumType */
4719
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
4720
- interface FutureMembershipDetails {
4721
- /**
4722
- * ID of the plan line item in the order from which the membership will be created.
4723
- * @format GUID
4724
- */
4725
- lineItemId?: string;
4726
- /**
4727
- * ID of the benefit the future membership will grant.
4728
- * @maxLength 200
4729
- */
4730
- benefitId?: string;
4816
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4817
+ interface RecordManuallyCollectedPaymentResponse {
4731
4818
  }
4732
- interface WixReceiptInfo {
4819
+ interface MarkOrderAsPaidRequest {
4733
4820
  /**
4734
- * Receipt ID
4735
- * @format GUID
4821
+ * Ecom order ID.
4822
+ * @minLength 1
4823
+ * @maxLength 100
4736
4824
  */
4737
- receiptId?: string;
4825
+ ecomOrderId: string;
4826
+ }
4827
+ interface MarkOrderAsPaidResponse {
4828
+ /** Updated order. */
4829
+ order?: Order;
4830
+ }
4831
+ interface BulkMarkOrdersAsPaidRequest {
4738
4832
  /**
4739
- * Display number of receipt
4833
+ * IDs of orders to mark as paid.
4834
+ * @minSize 1
4835
+ * @maxSize 100
4740
4836
  * @minLength 1
4741
- * @maxLength 40
4837
+ * @maxLength 100
4742
4838
  */
4743
- displayNumber?: string | null;
4839
+ ecomOrderIds: string[];
4744
4840
  }
4745
- interface ExternalReceiptInfo {
4841
+ interface BulkMarkOrdersAsPaidResponse {
4746
4842
  /**
4747
- * External receipt ID
4748
- * @maxLength 100
4843
+ * Items updated by the bulk action.
4844
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4749
4845
  */
4750
- receiptId?: string | null;
4846
+ results?: BulkOrderResult[];
4847
+ /** Bulk action metadata. */
4848
+ bulkActionMetadata?: BulkActionMetadata;
4849
+ }
4850
+ interface BulkOrderResult {
4851
+ /** Item metadata. */
4852
+ itemMetadata?: ItemMetadata;
4751
4853
  /**
4752
- * ID of the app providing the receipt
4753
- * @format GUID
4854
+ * Updated order.
4855
+ *
4856
+ * Returned when `returnFullEntity = true`.
4754
4857
  */
4755
- appId?: string | null;
4858
+ item?: Order;
4859
+ }
4860
+ interface ItemMetadata {
4861
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4862
+ _id?: string | null;
4863
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
4864
+ originalIndex?: number;
4865
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4866
+ success?: boolean;
4867
+ /** Details about the error in case of failure. */
4868
+ error?: ApplicationError;
4869
+ }
4870
+ interface ApplicationError {
4871
+ /** Error code. */
4872
+ code?: string;
4873
+ /** Description of the error. */
4874
+ description?: string;
4875
+ /** Data related to the error. */
4876
+ data?: Record<string, any> | null;
4877
+ }
4878
+ interface BulkActionMetadata {
4879
+ /** Number of items that were successfully processed. */
4880
+ totalSuccesses?: number;
4881
+ /** Number of items that couldn't be processed. */
4882
+ totalFailures?: number;
4883
+ /** Number of failures without details because detailed failure threshold was exceeded. */
4884
+ undetailedFailures?: number;
4885
+ }
4886
+ interface GetRefundabilityStatusRequest {
4756
4887
  /**
4757
- * Display number of receipt
4888
+ * Order ID.
4758
4889
  * @minLength 1
4759
- * @maxLength 40
4890
+ * @maxLength 100
4760
4891
  */
4761
- displayNumber?: string | null;
4892
+ ecomOrderId: string;
4762
4893
  }
4763
- interface CashRoundingDetails {
4894
+ interface GetRefundabilityStatusResponse {
4764
4895
  /**
4765
- * Payment amount before cash rounding was applied.
4766
- * When provided, balance and status calculations use this value instead of `amount`
4767
- * to prevent false overpayment or underpayment due to rounding.
4896
+ * Refundability details.
4897
+ * @maxSize 300
4768
4898
  */
4769
- unroundedAmount?: Price;
4899
+ refundabilities?: Refundability[];
4770
4900
  /**
4771
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
4772
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
4773
- * @readonly
4901
+ * Whether the order supports refunding per item.
4902
+ * @deprecated
4774
4903
  */
4775
- roundingAdjustment?: CashRounding;
4776
- }
4777
- declare enum PaymentStatus {
4778
- APPROVED = "APPROVED",
4779
- PENDING = "PENDING",
4780
- PENDING_MERCHANT = "PENDING_MERCHANT",
4781
- CANCELED = "CANCELED",
4782
- DECLINED = "DECLINED",
4783
- REFUNDED = "REFUNDED",
4784
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4785
- AUTHORIZED = "AUTHORIZED",
4786
- VOIDED = "VOIDED"
4904
+ refundablePerItem?: boolean;
4787
4905
  }
4788
- /** @enumType */
4789
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4790
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
4906
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4907
+ /** Reason why payment is not refundable. */
4908
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4909
+ /** Reason why payment is only refundable manually. */
4910
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4911
+ /** Payment ID. */
4912
+ paymentId?: string;
4913
+ /** Payment refundability status. */
4914
+ refundabilityStatus?: RefundableStatusWithLiterals;
4915
+ /** Link to payment provider dashboard. */
4916
+ providerLink?: string | null;
4791
4917
  }
4792
4918
  /** @oneof */
4793
- interface PaymentStatusDetailsStatusDetailsOneOf {
4794
- }
4795
- interface CanceledStatusDetails {
4796
- reason?: CanceledReasonWithLiterals;
4797
- }
4798
- declare enum CanceledReason {
4799
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
4800
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
4801
- /** Payment was not completed by user and expired. */
4802
- EXPIRED = "EXPIRED"
4803
- }
4804
- /** @enumType */
4805
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
4806
- interface DeclinedStatusDetails {
4807
- reason?: DeclinedReasonWithLiterals;
4919
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
4920
+ /** Reason why payment is not refundable. */
4921
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4922
+ /** Reason why payment is only refundable manually. */
4923
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4808
4924
  }
4809
- declare enum DeclinedReason {
4810
- /** Corresponding charge failed. */
4811
- CHARGE_FAILED = "CHARGE_FAILED",
4812
- /** Payment details expired. */
4813
- EXPIRED = "EXPIRED",
4814
- /** Insufficient funds. */
4815
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
4816
- /** Gift card was disabled before charge was attempted. */
4817
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
4925
+ declare enum RefundableStatus {
4926
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
4927
+ MANUAL = "MANUAL",
4928
+ REFUNDABLE = "REFUNDABLE"
4818
4929
  }
4819
4930
  /** @enumType */
4820
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
4821
- interface VoidedStatusDetails {
4822
- reason?: VoidedReasonWithLiterals;
4931
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4932
+ declare enum NonRefundableReason {
4933
+ NONE = "NONE",
4934
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
4935
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4936
+ INTERNAL_ERROR = "INTERNAL_ERROR",
4937
+ NOT_PAID = "NOT_PAID",
4938
+ ACCESS_DENIED = "ACCESS_DENIED",
4939
+ ZERO_PRICE = "ZERO_PRICE",
4940
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4941
+ PENDING_REFUND = "PENDING_REFUND",
4942
+ FORBIDDEN = "FORBIDDEN",
4943
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4944
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
4945
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4823
4946
  }
4824
- declare enum VoidedReason {
4825
- /** Payment was voided by merchant request. */
4826
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
4827
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
4828
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
4947
+ /** @enumType */
4948
+ 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';
4949
+ declare enum ManuallyRefundableReason {
4950
+ EXPIRED = "EXPIRED",
4951
+ NOT_SUPPORTED = "NOT_SUPPORTED",
4952
+ OFFLINE = "OFFLINE",
4953
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4829
4954
  }
4830
4955
  /** @enumType */
4831
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
4832
- interface Refund {
4956
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4957
+ interface CreatePaymentGatewayOrderRequest {
4833
4958
  /**
4834
- * Refund ID.
4959
+ * Ecom order ID.
4960
+ * @minLength 1
4961
+ * @maxLength 100
4962
+ */
4963
+ ecomOrderId: string;
4964
+ /** Information about the user who initiated the payment. */
4965
+ chargedBy?: ChargedBy;
4966
+ }
4967
+ interface ChargedBy {
4968
+ /**
4969
+ * ID - id of the user who initiated the payment
4835
4970
  * @format GUID
4836
- * @readonly
4837
4971
  */
4838
4972
  _id?: string;
4839
4973
  /**
4840
- * List of transactions.
4841
- * @maxSize 50
4974
+ * Full name - name of the user who initiated the payment
4975
+ * @minLength 1
4976
+ * @maxLength 200
4842
4977
  */
4843
- transactions?: RefundTransaction[];
4844
- /** Refund business details. */
4845
- details?: RefundDetails;
4978
+ fullName?: string | null;
4979
+ }
4980
+ interface CreatePaymentGatewayOrderResponse {
4981
+ /** ID of the order created in the payment gateway */
4982
+ paymentGatewayOrderId?: string;
4983
+ }
4984
+ interface ChargeMembershipsRequest {
4846
4985
  /**
4847
- * 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.
4848
- * @readonly
4849
- * @immutable
4986
+ * Order ID.
4987
+ * @minLength 1
4988
+ * @maxLength 100
4850
4989
  */
4851
- _createdDate?: Date | null;
4990
+ ecomOrderId: string;
4852
4991
  /**
4853
- * Aggregated refund summary.
4854
- * @readonly
4992
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4993
+ * but a user which is using the membership on behalf of the a member
4994
+ * @format GUID
4855
4995
  */
4856
- summary?: AggregatedRefundSummary;
4996
+ memberId: string;
4857
4997
  /**
4858
- * ID of the app that initiated this refund.
4859
- * @format GUID
4860
- * @readonly
4861
- * @immutable
4998
+ * List of items to be paid by memberships
4999
+ * @minSize 1
5000
+ * @maxSize 300
4862
5001
  */
4863
- requestingServiceAppId?: string | null;
5002
+ membershipCharges?: MembershipChargeItem[];
4864
5003
  }
4865
- interface RefundTransaction {
5004
+ interface MembershipChargeItem {
4866
5005
  /**
4867
- * ID of the payment associated with this refund.
4868
- * @format GUID
4869
- * @immutable
5006
+ * The id of used membership
5007
+ * @minLength 1
5008
+ * @maxLength 100
4870
5009
  */
4871
- paymentId?: string;
5010
+ membershipId?: string;
4872
5011
  /**
4873
- * Refund amount.
4874
- * @immutable
5012
+ * ID of the application providing this payment option
5013
+ * @format GUID
4875
5014
  */
4876
- amount?: Price;
4877
- /** Refund status. */
4878
- refundStatus?: RefundStatusWithLiterals;
4879
- /** Optional details of current refund status. */
4880
- refundStatusInfo?: RefundStatusInfo;
5015
+ appId?: string;
5016
+ /** The name of used membership */
5017
+ membershipName?: MembershipName;
5018
+ /** Additional data about this membership */
5019
+ membershipAdditionalData?: Record<string, any> | null;
5020
+ /** Catalog and item reference info. */
5021
+ catalogReference?: CatalogReference;
5022
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5023
+ serviceProperties?: ServiceProperties;
4881
5024
  /**
4882
- * Payment gateway's refund ID.
4883
- * This field is only returned when the value of `external_refund` is `false`.
4884
- * @format GUID
5025
+ * Usually would be the same as catalogReference.catalogItemId
5026
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5027
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5028
+ * @minLength 1
5029
+ * @maxLength 36
4885
5030
  */
4886
- gatewayRefundId?: string | null;
4887
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
4888
- providerRefundId?: string | null;
5031
+ rootCatalogItemId?: string | null;
4889
5032
  /**
4890
- * Whether refund was made externally and manually on the payment provider's side.
4891
- * @immutable
5033
+ * line item id of Checkout/Order line item
5034
+ * @minLength 1
5035
+ * @maxLength 100
4892
5036
  */
4893
- externalRefund?: boolean;
4894
- }
4895
- /** Refund transaction status. */
4896
- declare enum RefundStatus {
4897
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
4898
- PENDING = "PENDING",
4899
- /** Refund transaction succeeded. */
4900
- SUCCEEDED = "SUCCEEDED",
4901
- /** Refund transaction failed. */
4902
- FAILED = "FAILED",
4903
- /** Refund request acknowledged, and will be executed soon. */
4904
- SCHEDULED = "SCHEDULED",
4905
- /** Refund was initiated on payment provider side. */
4906
- STARTED = "STARTED"
5037
+ lineItemId?: string;
4907
5038
  }
4908
- /** @enumType */
4909
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
4910
- interface RefundStatusInfo {
5039
+ interface MembershipName {
4911
5040
  /**
4912
- * Reason code for the refund's current status.
4913
- *
4914
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
4915
- * @minLength 1
4916
- * @maxLength 10
5041
+ * Membership name.
5042
+ * @maxLength 100
4917
5043
  */
4918
- paymentGatewayReasonCode?: string | null;
5044
+ original?: string;
4919
5045
  /**
4920
- * Free text explanation of current refund status.
4921
- * @minLength 1
4922
- * @maxLength 1000
5046
+ * Translated membership name. Defaults to `original` when not provided.
5047
+ * @maxLength 100
4923
5048
  */
4924
- description?: string | null;
4925
- }
4926
- interface AggregatedRefundSummary {
4927
- /** Total amount requested for refund. */
4928
- requestedRefund?: Price;
4929
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
4930
- pendingRefund?: Price;
4931
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
4932
- refunded?: Price;
4933
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
4934
- failedRefundAmount?: Price;
4935
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
4936
- pending?: boolean;
4937
- /** Breakdown of refunded items. Available only after refund is complete. */
4938
- breakdown?: RefundItemsBreakdown;
5049
+ translated?: string | null;
4939
5050
  }
4940
- interface RefundItemsBreakdown {
5051
+ interface ServiceProperties {
4941
5052
  /**
4942
- * Refunded line items and the amount refunded for each.
4943
- * @maxSize 300
5053
+ * 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.
5054
+ * For example, the start time of a class.
4944
5055
  */
4945
- lineItems?: LineItemRefundSummary[];
4946
- }
4947
- interface LineItemRefundSummary {
5056
+ scheduledDate?: Date | null;
4948
5057
  /**
4949
- * ID of the refunded line item.
4950
- * @format GUID
5058
+ * 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.
5059
+ * @min 1
5060
+ * @max 10000
4951
5061
  */
4952
- lineItemId?: string;
4953
- /** Total refunded amount for the line item. */
4954
- totalRefundedAmount?: Price;
5062
+ numberOfParticipants?: number | null;
4955
5063
  }
4956
- interface CalculateRefundRequest {
5064
+ interface ChargeMembershipsResponse {
5065
+ }
5066
+ interface TriggerRefundRequest {
4957
5067
  /**
4958
- * Order ID
5068
+ * The order this refund related to
4959
5069
  * @minLength 1
4960
5070
  * @maxLength 100
4961
5071
  */
4962
- ecomOrderId?: string;
5072
+ ecomOrderId: string;
4963
5073
  /**
4964
- * Refunded line items and quantity
4965
- * @maxSize 300
5074
+ * Refund operations information
5075
+ * @minSize 1
5076
+ * @maxSize 1
4966
5077
  */
4967
- refundItems?: CalculateRefundItemRequest[];
4968
- /** Should include shipping in refund calculation */
4969
- refundShipping?: boolean;
5078
+ payments: PaymentRefund[];
5079
+ /** Business model of a refund */
5080
+ details?: RefundDetails;
5081
+ /** Side effect details related to refund */
5082
+ sideEffects?: RefundSideEffects;
4970
5083
  }
4971
- interface CalculateRefundItemRequest {
5084
+ interface PaymentRefund {
4972
5085
  /**
4973
- * ID of the line item being refunded
5086
+ * Specific payment within the order to refund
4974
5087
  * @format GUID
4975
5088
  */
4976
- _id?: string;
5089
+ paymentId?: string;
5090
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5091
+ amount?: Price;
4977
5092
  /**
4978
- * How much of that line item is being refunded
4979
- * @min 1
4980
- * @max 100000
5093
+ * Whether refund is made externally and manually (on the payment provider's side)
5094
+ * 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.
5095
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4981
5096
  */
4982
- quantity?: number;
5097
+ externalRefund?: boolean;
4983
5098
  }
4984
- interface CalculateRefundResponse {
4985
- /** Total refundable amount */
4986
- total?: Price;
4987
- /** Tax cost of the order */
4988
- tax?: Price;
4989
- /** Discount given for this order */
4990
- discount?: Price;
4991
- /** Total cost of the order (without tax) */
4992
- subtotal?: Price;
4993
- /** Total shipping cost for order */
4994
- shipping?: Price;
4995
- /** Previous refund given on that order */
4996
- previouslyRefundedAmount?: Price;
5099
+ interface RefundSideEffects {
5100
+ /** Inventory restock details as part of this refund. */
5101
+ restockInfo?: RestockInfo;
5102
+ /** Whether to send a refund confirmation email to the customer. */
5103
+ sendOrderRefundedEmail?: boolean;
4997
5104
  /**
4998
- * The refundable items of that order
4999
- * @maxSize 300
5105
+ * Custom message added to the refund confirmation email.
5106
+ * @minLength 1
5107
+ * @maxLength 1000
5000
5108
  */
5001
- items?: CalculateRefundItemResponse[];
5109
+ customMessage?: string | null;
5002
5110
  }
5003
- interface CalculateRefundItemResponse {
5111
+ interface RestockInfo {
5112
+ /** Restock type. */
5113
+ type?: RestockTypeWithLiterals;
5004
5114
  /**
5005
- * Line item ID
5006
- * @format GUID
5115
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5116
+ * @maxSize 300
5007
5117
  */
5008
- _id?: string;
5009
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5010
- price?: Price;
5118
+ items?: RestockItem[];
5011
5119
  }
5012
- interface VoidAuthorizedPaymentsRequest {
5120
+ declare enum RestockType {
5121
+ NO_ITEMS = "NO_ITEMS",
5122
+ ALL_ITEMS = "ALL_ITEMS",
5123
+ SOME_ITEMS = "SOME_ITEMS"
5124
+ }
5125
+ /** @enumType */
5126
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5127
+ interface RestockItem {
5013
5128
  /**
5014
- * Wix eCommerce order ID
5015
- * @minLength 1
5016
- * @maxLength 100
5129
+ * ID of the line item being restocked.
5130
+ * @format GUID
5017
5131
  */
5018
- ecomOrderId: string;
5132
+ lineItemId?: string;
5019
5133
  /**
5020
- * Payment IDs
5021
- * @minSize 1
5022
- * @maxSize 100
5023
- * @format GUID
5134
+ * Line item quantity being restocked.
5135
+ * @min 1
5136
+ * @max 100000
5024
5137
  */
5025
- paymentIds: string[];
5138
+ quantity?: number;
5026
5139
  }
5027
- interface VoidAuthorizedPaymentsResponse {
5028
- /** All order's transactions after the void was triggered */
5140
+ interface TriggerRefundResponse {
5141
+ /** All order's transactions after the refunds were added */
5029
5142
  orderTransactions?: OrderTransactions;
5143
+ /** Created refund ID */
5144
+ refundId?: string | null;
5145
+ /** Payment ID's that the refund execution had failed for */
5146
+ failedPaymentIds?: ItemMetadata[];
5030
5147
  }
5031
- interface CaptureAuthorizedPaymentsRequest {
5148
+ /**
5149
+ * A record of all payments and refunds associated with an order.
5150
+ *
5151
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5152
+ */
5153
+ interface OrderTransactions {
5032
5154
  /**
5033
- * Wix eCommerce order ID
5034
- * @minLength 1
5035
- * @maxLength 100
5155
+ * Order ID.
5156
+ * @format GUID
5036
5157
  */
5037
- ecomOrderId: string;
5158
+ orderId?: string;
5038
5159
  /**
5039
- * Capture payments information
5040
- * @minSize 1
5160
+ * Record of payments made to the merchant.
5041
5161
  * @maxSize 100
5042
5162
  */
5043
- payments: PaymentCapture[];
5163
+ payments?: Payment[];
5164
+ /**
5165
+ * Record of refunds made to the buyer.
5166
+ * @maxSize 300
5167
+ */
5168
+ refunds?: Refund[];
5044
5169
  }
5045
- interface PaymentCapture {
5170
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
5171
+ /** Regular payment details. */
5172
+ regularPaymentDetails?: RegularPaymentDetails;
5173
+ /** Gift card payment details. */
5174
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5046
5175
  /**
5047
- * Payment ID
5176
+ * Payment ID.
5048
5177
  * @format GUID
5178
+ * @readonly
5049
5179
  */
5050
- paymentId?: string | null;
5180
+ _id?: string | null;
5181
+ /** 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. */
5182
+ _createdDate?: Date | null;
5051
5183
  /**
5052
- * Capture amount.
5053
- * If not provided - full authorized amount will be captured.
5184
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5185
+ * @readonly
5054
5186
  */
5187
+ _updatedDate?: Date | null;
5188
+ /** Payment amount. */
5055
5189
  amount?: Price;
5056
- }
5057
- interface CaptureAuthorizedPaymentsResponse {
5058
- /** All order's transactions after the capture was triggered */
5059
- orderTransactions?: OrderTransactions;
5060
- }
5061
- interface ChargeSavedPaymentMethodRequest {
5062
5190
  /**
5063
- * Ecom Order ID.
5064
- * @minLength 1
5065
- * @maxLength 100
5191
+ * Whether refunds for this payment are disabled.
5192
+ * + `true`: This payment is not refundable.
5193
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5066
5194
  */
5067
- ecomOrderId?: string;
5068
- /** Amount to be charged */
5069
- amount?: Price;
5070
- }
5071
- interface ChargeSavedPaymentMethodResponse {
5072
- /** Payment gateway's order ID (e.g Wix Payments) */
5073
- paymentGatewayOrderId?: string;
5195
+ refundDisabled?: boolean;
5196
+ /** Details about cash rounding applied to this payment, when relevant. */
5197
+ cashRounding?: CashRoundingDetails;
5074
5198
  }
5075
- interface SendBuyerConfirmationEmailRequest {
5076
- /** @format GUID */
5077
- orderId?: string;
5199
+ /** @oneof */
5200
+ interface PaymentPaymentDetailsOneOf {
5201
+ /** Regular payment details. */
5202
+ regularPaymentDetails?: RegularPaymentDetails;
5203
+ /** Gift card payment details. */
5204
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5078
5205
  }
5079
- interface SendBuyerConfirmationEmailResponse {
5206
+ /** @oneof */
5207
+ interface PaymentReceiptInfoOneOf {
5080
5208
  }
5081
- interface SendBuyerPaymentsReceivedEmailRequest {
5209
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5210
+ /** Credit card details. */
5211
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5082
5212
  /**
5083
- * @minLength 1
5213
+ * Wix Payments order ID.
5084
5214
  * @maxLength 100
5085
5215
  */
5086
- orderId?: string;
5087
- }
5088
- interface SendBuyerPaymentsReceivedEmailResponse {
5089
- }
5090
- interface SendBuyerPickupConfirmationEmailRequest {
5216
+ paymentOrderId?: string | null;
5091
5217
  /**
5092
- * @minLength 1
5218
+ * Payment gateway's transaction ID.
5219
+ * This field is only returned when the value of `offline_payment` is `false`.
5093
5220
  * @maxLength 100
5094
5221
  */
5095
- orderId?: string;
5096
- }
5097
- interface SendBuyerPickupConfirmationEmailResponse {
5098
- }
5099
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
5222
+ gatewayTransactionId?: string | null;
5100
5223
  /**
5101
- * IDs of orders to send pickup emails for.
5102
- * @minSize 1
5103
- * @maxSize 300
5224
+ * Payment method.
5225
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5226
+ * Non-exhaustive list of supported values:
5227
+ * + `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`
5228
+ * @maxLength 100
5229
+ * @deprecated Payment method.
5230
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5231
+ * Non-exhaustive list of supported values:
5232
+ * + `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`
5233
+ * @replacedBy payment_method_name
5234
+ * @targetRemovalDate 2026-07-01
5104
5235
  */
5105
- orderIds?: string[];
5106
- }
5107
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
5108
- }
5109
- interface SendBuyerShippingConfirmationEmailRequest {
5236
+ paymentMethod?: string | null;
5110
5237
  /**
5111
- * @minLength 1
5238
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5112
5239
  * @maxLength 100
5113
5240
  */
5114
- orderId?: string;
5115
- }
5116
- interface SendBuyerShippingConfirmationEmailResponse {
5117
- }
5118
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
5241
+ providerTransactionId?: string | null;
5242
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5243
+ offlinePayment?: boolean;
5244
+ /** Payment status. */
5245
+ status?: TransactionStatusWithLiterals;
5246
+ /** Whether there is a payment agreement that allows for future charges. */
5247
+ savedPaymentMethod?: boolean;
5248
+ /** Authorization details. */
5249
+ authorizationDetails?: AuthorizationDetails;
5119
5250
  /**
5120
- * IDs of orders to send pickup emails for.
5121
- * @minSize 1
5122
- * @maxSize 300
5251
+ * Record of chargebacks made by the buyer.
5252
+ * @maxSize 6
5123
5253
  */
5124
- orderIds?: string[];
5125
- }
5126
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
5127
- }
5128
- interface SendMerchantOrderReceivedNotificationRequest {
5254
+ chargebacks?: Chargeback[];
5255
+ /** Platform fee amount associated with this payment. */
5256
+ platformFee?: Price;
5129
5257
  /**
5130
- * @minLength 1
5131
- * @maxLength 100
5258
+ * Payment method with buyer and optional owner translations.
5259
+ * Non-exhaustive list of supported values:
5260
+ * + `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`
5132
5261
  */
5133
- orderId?: string;
5262
+ paymentMethodName?: PaymentMethodName;
5134
5263
  }
5135
- interface SendMerchantOrderReceivedNotificationResponse {
5264
+ /** @oneof */
5265
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5266
+ /** Credit card details. */
5267
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5136
5268
  }
5137
- interface SendCancelRefundEmailRequest {
5269
+ declare enum TransactionStatus {
5270
+ UNDEFINED = "UNDEFINED",
5271
+ APPROVED = "APPROVED",
5272
+ PENDING = "PENDING",
5273
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5274
+ CANCELED = "CANCELED",
5275
+ DECLINED = "DECLINED",
5276
+ REFUNDED = "REFUNDED",
5277
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5278
+ AUTHORIZED = "AUTHORIZED",
5279
+ VOIDED = "VOIDED"
5280
+ }
5281
+ /** @enumType */
5282
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5283
+ interface CreditCardPaymentMethodDetails {
5138
5284
  /**
5139
- * The ID of order that is canceled/refunded
5140
- * @minLength 1
5141
- * @maxLength 100
5285
+ * The last 4 digits of the card number.
5286
+ * @maxLength 4
5142
5287
  */
5143
- orderId?: string;
5288
+ lastFourDigits?: string | null;
5144
5289
  /**
5145
- * Personal note added to the email (optional)
5146
- * @minLength 1
5147
- * @maxLength 1000
5290
+ * Card issuer's brand.
5291
+ * @maxLength 100
5148
5292
  */
5149
- customMessage?: string | null;
5150
- /** Refund amount */
5151
- refundAmount?: Price;
5293
+ brand?: string | null;
5294
+ }
5295
+ interface AuthorizationDetails {
5152
5296
  /**
5153
- * Refund ID. (Optional)
5154
- * @format GUID
5297
+ * Whether the authorized payment is of a delayed capture.
5298
+ * @readonly
5155
5299
  */
5156
- refundId?: string | null;
5157
- }
5158
- interface SendCancelRefundEmailResponse {
5159
- }
5160
- interface SendRefundEmailRequest {
5300
+ delayedCapture?: boolean;
5301
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5302
+ authorizedDate?: Date | null;
5161
5303
  /**
5162
- * The ID of order that is refunded
5163
- * @format GUID
5304
+ * List of captures associated with payment
5305
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5306
+ * @maxSize 1
5164
5307
  */
5165
- orderId?: string;
5308
+ captures?: AuthorizationCapture[];
5309
+ /** Void associated with payment */
5310
+ void?: AuthorizationVoid;
5311
+ /** Scheduled action for this transaction */
5312
+ scheduledAction?: V1ScheduledAction;
5313
+ }
5314
+ interface AuthorizationCapture {
5166
5315
  /**
5167
- * Refund ID
5316
+ * Capture ID.
5168
5317
  * @format GUID
5318
+ * @readonly
5169
5319
  */
5170
- refundId?: string;
5320
+ _id?: string | null;
5321
+ /** Status of this capture action */
5322
+ status?: AuthorizationCaptureStatusWithLiterals;
5171
5323
  /**
5172
- * Personal note added to the email (optional)
5173
- * @minLength 1
5174
- * @maxLength 1000
5324
+ * Amount of this capture
5325
+ * @immutable
5175
5326
  */
5176
- customMessage?: string | null;
5327
+ amount?: Price;
5328
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5329
+ _createdDate?: Date | null;
5330
+ /** In case of status is FAILED may contain failure details */
5331
+ failureDetails?: AuthorizationActionFailureDetails;
5177
5332
  }
5178
- interface SendRefundEmailResponse {
5333
+ declare enum AuthorizationCaptureStatus {
5334
+ /** Capture operation still in progress. */
5335
+ PENDING = "PENDING",
5336
+ /** Capture operation succeeded. */
5337
+ SUCCEEDED = "SUCCEEDED",
5338
+ /** Capture operation failed. */
5339
+ FAILED = "FAILED"
5179
5340
  }
5180
- interface SendFulfillmentEmailRequest {
5181
- /** @format GUID */
5182
- orderId?: string;
5183
- /** @format GUID */
5184
- fulfillerId?: string;
5341
+ /** @enumType */
5342
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5343
+ interface AuthorizationActionFailureDetails {
5344
+ /** @maxLength 100 */
5345
+ failureCode?: string;
5185
5346
  }
5186
- interface SendFulfillmentEmailResponse {
5347
+ interface AuthorizationVoid {
5348
+ /** Status of this void action */
5349
+ status?: AuthorizationVoidStatusWithLiterals;
5350
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5351
+ voidedDate?: Date | null;
5352
+ /** In case of status is FAILED may contain failure details */
5353
+ failureDetails?: AuthorizationActionFailureDetails;
5354
+ /** Reason of void action */
5355
+ reason?: ReasonWithLiterals;
5187
5356
  }
5188
- interface SendMerchantOrderReceivedPushRequest {
5189
- /**
5190
- * @minLength 1
5191
- * @maxLength 100
5192
- */
5193
- orderId?: string;
5357
+ declare enum AuthorizationVoidStatus {
5358
+ /** Void operation still in progress. */
5359
+ PENDING = "PENDING",
5360
+ /** Void operation succeeded. */
5361
+ SUCCEEDED = "SUCCEEDED",
5362
+ /** Void operation failed. */
5363
+ FAILED = "FAILED"
5194
5364
  }
5195
- interface SendMerchantOrderReceivedPushResponse {
5365
+ /** @enumType */
5366
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5367
+ /** Reason the authorization was voided. */
5368
+ declare enum Reason {
5369
+ /** Authorization was voided by user. */
5370
+ MANUAL = "MANUAL",
5371
+ /** Authorization passed execution date. */
5372
+ SCHEDULED = "SCHEDULED"
5196
5373
  }
5197
- interface PreviewEmailByTypeRequest {
5198
- emailType?: PreviewEmailTypeWithLiterals;
5374
+ /** @enumType */
5375
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5376
+ interface V1ScheduledAction {
5377
+ /** Type of the action. */
5378
+ actionType?: ActionTypeWithLiterals;
5379
+ /** The date and time of the action. */
5380
+ executionDate?: Date | null;
5199
5381
  }
5200
- declare enum PreviewEmailType {
5201
- ORDER_PLACED = "ORDER_PLACED",
5202
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5203
- ORDER_SHIPPED = "ORDER_SHIPPED",
5204
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5382
+ declare enum ActionType {
5383
+ VOID = "VOID",
5384
+ CAPTURE = "CAPTURE"
5205
5385
  }
5206
5386
  /** @enumType */
5207
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5208
- interface PreviewEmailByTypeResponse {
5209
- emailPreview?: string;
5210
- }
5211
- interface PreviewRefundEmailRequest {
5212
- /**
5213
- * @minLength 1
5214
- * @maxLength 100
5215
- */
5216
- orderId?: string;
5217
- /** Refund amount */
5218
- refundAmount?: Price;
5219
- /** Refund business details */
5220
- details?: RefundDetails;
5387
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5388
+ interface Chargeback {
5221
5389
  /**
5222
- * Personal note added to the email (optional)
5223
- * @minLength 1
5224
- * @maxLength 1000
5390
+ * Chargeback ID.
5391
+ * @format GUID
5392
+ * @readonly
5393
+ * @immutable
5225
5394
  */
5226
- customMessage?: string | null;
5395
+ _id?: string;
5227
5396
  /**
5228
- * Refund ID. (Optional)
5229
- * @format GUID
5397
+ * 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.
5398
+ * @readonly
5399
+ * @immutable
5230
5400
  */
5231
- refundId?: string | null;
5232
- }
5233
- interface PreviewRefundEmailResponse {
5234
- emailPreview?: string;
5235
- }
5236
- interface PreviewCancelEmailRequest {
5401
+ _createdDate?: Date | null;
5237
5402
  /**
5238
- * @minLength 1
5239
- * @maxLength 100
5403
+ * 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.
5404
+ * @readonly
5240
5405
  */
5241
- orderId?: string;
5406
+ _updatedDate?: Date | null;
5242
5407
  /**
5243
- * Personal note added to the email (optional)
5244
- * @minLength 1
5245
- * @maxLength 1000
5408
+ * Amount.
5409
+ * @readonly
5410
+ * @immutable
5246
5411
  */
5247
- customMessage?: string | null;
5248
- }
5249
- interface PreviewCancelEmailResponse {
5250
- emailPreview?: string;
5251
- }
5252
- interface PreviewCancelRefundEmailRequest {
5412
+ amount?: Price;
5253
5413
  /**
5254
- * @minLength 1
5255
- * @maxLength 100
5414
+ * Reversal amount. Present only when status is REVERSED.
5415
+ * @readonly
5256
5416
  */
5257
- orderId?: string;
5417
+ reversalAmount?: Price;
5258
5418
  /**
5259
- * Personal note added to the email (optional)
5260
- * @minLength 1
5261
- * @maxLength 1000
5419
+ * Status.
5420
+ *
5421
+ * Default: `"APPROVED"`.
5262
5422
  */
5263
- customMessage?: string | null;
5264
- /** Refund amount */
5265
- refundAmount?: Price;
5423
+ status?: ChargebackStatusWithLiterals;
5266
5424
  /**
5267
- * Refund ID. (Optional)
5425
+ * External chargeback ID.
5268
5426
  * @format GUID
5427
+ * @readonly
5428
+ * @immutable
5269
5429
  */
5270
- refundId?: string | null;
5271
- }
5272
- interface PreviewCancelRefundEmailResponse {
5273
- emailPreview?: string;
5274
- }
5275
- interface PreviewBuyerPaymentsReceivedEmailRequest {
5276
- }
5277
- interface PreviewBuyerPaymentsReceivedEmailResponse {
5278
- emailPreview?: string;
5279
- }
5280
- interface PreviewBuyerConfirmationEmailRequest {
5281
- }
5282
- interface PreviewBuyerConfirmationEmailResponse {
5283
- emailPreview?: string;
5284
- }
5285
- interface PreviewBuyerPickupConfirmationEmailRequest {
5286
- }
5287
- interface PreviewBuyerPickupConfirmationEmailResponse {
5288
- emailPreview?: string;
5289
- }
5290
- interface PreviewShippingConfirmationEmailRequest {
5291
- }
5292
- interface PreviewShippingConfirmationEmailResponse {
5293
- emailPreview?: string;
5294
- }
5295
- interface PreviewResendDownloadLinksEmailRequest {
5430
+ externalId?: string | null;
5296
5431
  }
5297
- interface PreviewResendDownloadLinksEmailResponse {
5298
- emailPreview?: string;
5432
+ declare enum ChargebackStatus {
5433
+ /** Chargeback was approved. */
5434
+ APPROVED = "APPROVED",
5435
+ /** Chargeback was reversed. */
5436
+ REVERSED = "REVERSED"
5299
5437
  }
5300
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5301
- /** Emitted on a meta site creation. */
5302
- siteCreated?: SiteCreated;
5303
- /** Emitted on a meta site transfer completion. */
5304
- siteTransferred?: SiteTransferred;
5305
- /** Emitted on a meta site deletion. */
5306
- siteDeleted?: SiteDeleted;
5307
- /** Emitted on a meta site restoration. */
5308
- siteUndeleted?: SiteUndeleted;
5309
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5310
- sitePublished?: SitePublished;
5311
- /** Emitted on a meta site unpublish. */
5312
- siteUnpublished?: SiteUnpublished;
5313
- /** Emitted when meta site is marked as template. */
5314
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5315
- /** Emitted when meta site is marked as a WixSite. */
5316
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5317
- /** Emitted when an application is provisioned (installed). */
5318
- serviceProvisioned?: ServiceProvisioned;
5319
- /** Emitted when an application is removed (uninstalled). */
5320
- serviceRemoved?: ServiceRemoved;
5321
- /** Emitted when meta site name (URL slug) is changed. */
5322
- siteRenamedPayload?: SiteRenamed;
5323
- /** Emitted when meta site was permanently deleted. */
5324
- hardDeleted?: SiteHardDeleted;
5325
- /** Emitted on a namespace change. */
5326
- namespaceChanged?: NamespaceChanged;
5327
- /** Emitted when Studio is attached. */
5328
- studioAssigned?: StudioAssigned;
5329
- /** Emitted when Studio is detached. */
5330
- studioUnassigned?: StudioUnassigned;
5331
- /**
5332
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5333
- * the actual URL.
5334
- *
5335
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5336
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5337
- */
5338
- urlChanged?: SiteUrlChanged;
5339
- /** Site is marked as PurgedExternally */
5340
- sitePurgedExternally?: SitePurgedExternally;
5341
- /** Emitted when Odeditor is attached. */
5342
- odeditorAssigned?: OdeditorAssigned;
5343
- /** Emitted when Odeditor is detached. */
5344
- odeditorUnassigned?: OdeditorUnassigned;
5345
- /** Emitted when Picasso is attached. */
5346
- picassoAssigned?: PicassoAssigned;
5347
- /** Emitted when Picasso is detached. */
5348
- picassoUnassigned?: PicassoUnassigned;
5349
- /** Emitted when Wixel is attached. */
5350
- wixelAssigned?: WixelAssigned;
5351
- /** Emitted when Wixel is detached. */
5352
- wixelUnassigned?: WixelUnassigned;
5353
- /** Emitted when StudioTwo is attached. */
5354
- studioTwoAssigned?: StudioTwoAssigned;
5355
- /** Emitted when StudioTwo is detached. */
5356
- studioTwoUnassigned?: StudioTwoUnassigned;
5357
- /** Emitted when media from user domain is enabled. */
5358
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5359
- /** Emitted when media from user domain is disabled. */
5360
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5361
- /** Emitted when Editorless is attached. */
5362
- editorlessAssigned?: EditorlessAssigned;
5363
- /** Emitted when Editorless is detached. */
5364
- editorlessUnassigned?: EditorlessUnassigned;
5438
+ /** @enumType */
5439
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5440
+ interface PaymentMethodName {
5365
5441
  /**
5366
- * A meta site id.
5367
- * @format GUID
5442
+ * Translated payment method name in buyer language.
5443
+ * @maxLength 100
5368
5444
  */
5369
- metaSiteId?: string;
5370
- /** A meta site version. Monotonically increasing. */
5371
- version?: string;
5372
- /** A timestamp of the event. */
5373
- timestamp?: string;
5445
+ buyerLanguageName?: string | null;
5374
5446
  /**
5375
- * TODO(meta-site): Change validation once validations are disabled for consumers
5376
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5377
- * @maxSize 4000
5447
+ * Translated payment method name in site owner language.
5448
+ * @maxLength 100
5378
5449
  */
5379
- assets?: Asset[];
5380
- }
5381
- /** @oneof */
5382
- interface MetaSiteSpecialEventPayloadOneOf {
5383
- /** Emitted on a meta site creation. */
5384
- siteCreated?: SiteCreated;
5385
- /** Emitted on a meta site transfer completion. */
5386
- siteTransferred?: SiteTransferred;
5387
- /** Emitted on a meta site deletion. */
5388
- siteDeleted?: SiteDeleted;
5389
- /** Emitted on a meta site restoration. */
5390
- siteUndeleted?: SiteUndeleted;
5391
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5392
- sitePublished?: SitePublished;
5393
- /** Emitted on a meta site unpublish. */
5394
- siteUnpublished?: SiteUnpublished;
5395
- /** Emitted when meta site is marked as template. */
5396
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5397
- /** Emitted when meta site is marked as a WixSite. */
5398
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5399
- /** Emitted when an application is provisioned (installed). */
5400
- serviceProvisioned?: ServiceProvisioned;
5401
- /** Emitted when an application is removed (uninstalled). */
5402
- serviceRemoved?: ServiceRemoved;
5403
- /** Emitted when meta site name (URL slug) is changed. */
5404
- siteRenamedPayload?: SiteRenamed;
5405
- /** Emitted when meta site was permanently deleted. */
5406
- hardDeleted?: SiteHardDeleted;
5407
- /** Emitted on a namespace change. */
5408
- namespaceChanged?: NamespaceChanged;
5409
- /** Emitted when Studio is attached. */
5410
- studioAssigned?: StudioAssigned;
5411
- /** Emitted when Studio is detached. */
5412
- studioUnassigned?: StudioUnassigned;
5450
+ siteLanguageName?: string | null;
5413
5451
  /**
5414
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5415
- * the actual URL.
5452
+ * User-provided payment method name.
5416
5453
  *
5417
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5418
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5454
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5419
5455
  */
5420
- urlChanged?: SiteUrlChanged;
5421
- /** Site is marked as PurgedExternally */
5422
- sitePurgedExternally?: SitePurgedExternally;
5423
- /** Emitted when Odeditor is attached. */
5424
- odeditorAssigned?: OdeditorAssigned;
5425
- /** Emitted when Odeditor is detached. */
5426
- odeditorUnassigned?: OdeditorUnassigned;
5427
- /** Emitted when Picasso is attached. */
5428
- picassoAssigned?: PicassoAssigned;
5429
- /** Emitted when Picasso is detached. */
5430
- picassoUnassigned?: PicassoUnassigned;
5431
- /** Emitted when Wixel is attached. */
5432
- wixelAssigned?: WixelAssigned;
5433
- /** Emitted when Wixel is detached. */
5434
- wixelUnassigned?: WixelUnassigned;
5435
- /** Emitted when StudioTwo is attached. */
5436
- studioTwoAssigned?: StudioTwoAssigned;
5437
- /** Emitted when StudioTwo is detached. */
5438
- studioTwoUnassigned?: StudioTwoUnassigned;
5439
- /** Emitted when media from user domain is enabled. */
5440
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5441
- /** Emitted when media from user domain is disabled. */
5442
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5443
- /** Emitted when Editorless is attached. */
5444
- editorlessAssigned?: EditorlessAssigned;
5445
- /** Emitted when Editorless is detached. */
5446
- editorlessUnassigned?: EditorlessUnassigned;
5456
+ userDefinedName?: UserDefinedPaymentMethodName;
5447
5457
  }
5448
- interface Asset {
5458
+ interface GiftCardPaymentDetails {
5449
5459
  /**
5450
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5451
- * @maxLength 36
5460
+ * Gift card payment ID.
5461
+ * @maxLength 100
5452
5462
  */
5453
- appDefId?: string;
5463
+ giftCardPaymentId?: string;
5454
5464
  /**
5455
- * An instance id. For legacy reasons may be UUID or a string.
5456
- * @maxLength 200
5465
+ * ID of the app that created the gift card.
5466
+ * @format GUID
5457
5467
  */
5458
- instanceId?: string;
5459
- /** An application state. */
5460
- state?: StateWithLiterals;
5468
+ appId?: string;
5469
+ /**
5470
+ * Whether the gift card is voided.
5471
+ * @readonly
5472
+ */
5473
+ voided?: boolean;
5461
5474
  }
5462
- declare enum State {
5463
- UNKNOWN = "UNKNOWN",
5464
- ENABLED = "ENABLED",
5465
- DISABLED = "DISABLED",
5466
- PENDING = "PENDING",
5467
- DEMO = "DEMO"
5475
+ interface MembershipPaymentDetails {
5476
+ /**
5477
+ * Membership ID.
5478
+ * @maxLength 100
5479
+ */
5480
+ membershipId?: string;
5481
+ /**
5482
+ * ID of the line item this membership applies to.
5483
+ * @minLength 1
5484
+ * @maxLength 100
5485
+ */
5486
+ lineItemId?: string;
5487
+ /** Payment status. */
5488
+ status?: MembershipPaymentStatusWithLiterals;
5489
+ /** Membership name. */
5490
+ name?: MembershipName;
5491
+ /**
5492
+ * The transaction ID in the membership system. Can be used to void the transaction.
5493
+ * @minLength 1
5494
+ * @maxLength 100
5495
+ */
5496
+ externalTransactionId?: string | null;
5497
+ /**
5498
+ * Whether the membership is voided.
5499
+ * @readonly
5500
+ */
5501
+ voided?: boolean;
5502
+ /**
5503
+ * ID of the application providing this payment option.
5504
+ * @format GUID
5505
+ */
5506
+ providerAppId?: string;
5507
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5508
+ futureMembership?: FutureMembershipDetails;
5509
+ }
5510
+ declare enum MembershipPaymentStatus {
5511
+ /** Payment was charged. */
5512
+ CHARGED = "CHARGED",
5513
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5514
+ CHARGE_FAILED = "CHARGE_FAILED",
5515
+ /** Payment is pending. */
5516
+ CHARGE_PENDING = "CHARGE_PENDING",
5517
+ /** Payment was voided. */
5518
+ VOIDED = "VOIDED"
5468
5519
  }
5469
5520
  /** @enumType */
5470
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5471
- interface SiteCreated {
5521
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5522
+ interface FutureMembershipDetails {
5472
5523
  /**
5473
- * A template identifier (empty if not created from a template).
5474
- * @maxLength 36
5524
+ * ID of the plan line item in the order from which the membership will be created.
5525
+ * @format GUID
5475
5526
  */
5476
- originTemplateId?: string;
5527
+ lineItemId?: string;
5477
5528
  /**
5478
- * An account id of the owner.
5479
- * @format GUID
5529
+ * ID of the benefit the future membership will grant.
5530
+ * @maxLength 200
5480
5531
  */
5481
- ownerId?: string;
5482
- /** A context in which meta site was created. */
5483
- context?: SiteCreatedContextWithLiterals;
5532
+ benefitId?: string;
5533
+ }
5534
+ interface WixReceiptInfo {
5484
5535
  /**
5485
- * A meta site id from which this site was created.
5486
- *
5487
- * In case of a creation from a template it's a template id.
5488
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5536
+ * Receipt ID
5489
5537
  * @format GUID
5490
5538
  */
5491
- originMetaSiteId?: string | null;
5539
+ receiptId?: string;
5492
5540
  /**
5493
- * A meta site name (URL slug).
5494
- * @maxLength 20
5541
+ * Display number of receipt
5542
+ * @minLength 1
5543
+ * @maxLength 40
5495
5544
  */
5496
- siteName?: string;
5497
- /** A namespace. */
5498
- namespace?: NamespaceWithLiterals;
5545
+ displayNumber?: string | null;
5499
5546
  }
5500
- declare enum SiteCreatedContext {
5501
- /** A valid option, we don't expose all reasons why site might be created. */
5502
- OTHER = "OTHER",
5503
- /** A meta site was created from template. */
5504
- FROM_TEMPLATE = "FROM_TEMPLATE",
5505
- /** A meta site was created by copying of the transfferred meta site. */
5506
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5507
- /** A copy of existing meta site. */
5508
- DUPLICATE = "DUPLICATE",
5509
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5510
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5511
- /** deprecated A meta site was created for Flash editor. */
5512
- FLASH = "FLASH"
5547
+ interface ExternalReceiptInfo {
5548
+ /**
5549
+ * External receipt ID
5550
+ * @maxLength 100
5551
+ */
5552
+ receiptId?: string | null;
5553
+ /**
5554
+ * ID of the app providing the receipt
5555
+ * @format GUID
5556
+ */
5557
+ appId?: string | null;
5558
+ /**
5559
+ * Display number of receipt
5560
+ * @minLength 1
5561
+ * @maxLength 40
5562
+ */
5563
+ displayNumber?: string | null;
5513
5564
  }
5514
- /** @enumType */
5515
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5516
- declare enum Namespace {
5517
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5518
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5519
- WIX = "WIX",
5520
- /** 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. */
5521
- SHOUT_OUT = "SHOUT_OUT",
5522
- /** 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. */
5523
- ALBUMS = "ALBUMS",
5524
- /** 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. */
5525
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5526
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5527
- HOTELS = "HOTELS",
5528
- /** 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. */
5529
- CLUBS = "CLUBS",
5530
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5531
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5532
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5533
- DEV_SITE = "DEV_SITE",
5534
- /** 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. */
5535
- LOGOS = "LOGOS",
5536
- /** 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. */
5537
- VIDEO_MAKER = "VIDEO_MAKER",
5538
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5539
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5540
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5541
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5565
+ interface CashRoundingDetails {
5542
5566
  /**
5543
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5544
- *
5545
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5567
+ * Payment amount before cash rounding was applied.
5568
+ * When provided, balance and status calculations use this value instead of `amount`
5569
+ * to prevent false overpayment or underpayment due to rounding.
5546
5570
  */
5547
- HTML_DRAFT = "HTML_DRAFT",
5571
+ unroundedAmount?: Price;
5548
5572
  /**
5549
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5550
- * Will be accessible from Site List and will not have a website app.
5551
- * Once the user attaches a site, the site will become a regular wixsite.
5573
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5574
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5575
+ * @readonly
5552
5576
  */
5553
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5554
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5555
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5556
- /** It is to be used in the Business First efforts. */
5557
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5558
- /** Bookings business flow with no site. */
5559
- ANYWHERE = "ANYWHERE",
5560
- /** Namespace for Headless Backoffice with no editor */
5561
- HEADLESS = "HEADLESS",
5577
+ roundingAdjustment?: CashRounding;
5578
+ }
5579
+ declare enum PaymentStatus {
5580
+ APPROVED = "APPROVED",
5581
+ PENDING = "PENDING",
5582
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5583
+ CANCELED = "CANCELED",
5584
+ DECLINED = "DECLINED",
5585
+ REFUNDED = "REFUNDED",
5586
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5587
+ AUTHORIZED = "AUTHORIZED",
5588
+ VOIDED = "VOIDED"
5589
+ }
5590
+ /** @enumType */
5591
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5592
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5593
+ }
5594
+ /** @oneof */
5595
+ interface PaymentStatusDetailsStatusDetailsOneOf {
5596
+ }
5597
+ interface CanceledStatusDetails {
5598
+ reason?: CanceledReasonWithLiterals;
5599
+ }
5600
+ declare enum CanceledReason {
5601
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5602
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5603
+ /** Payment was not completed by user and expired. */
5604
+ EXPIRED = "EXPIRED"
5605
+ }
5606
+ /** @enumType */
5607
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5608
+ interface DeclinedStatusDetails {
5609
+ reason?: DeclinedReasonWithLiterals;
5610
+ }
5611
+ declare enum DeclinedReason {
5612
+ /** Corresponding charge failed. */
5613
+ CHARGE_FAILED = "CHARGE_FAILED",
5614
+ /** Payment details expired. */
5615
+ EXPIRED = "EXPIRED",
5616
+ /** Insufficient funds. */
5617
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5618
+ /** Gift card was disabled before charge was attempted. */
5619
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5620
+ }
5621
+ /** @enumType */
5622
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5623
+ interface VoidedStatusDetails {
5624
+ reason?: VoidedReasonWithLiterals;
5625
+ }
5626
+ declare enum VoidedReason {
5627
+ /** Payment was voided by merchant request. */
5628
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5629
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5630
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5631
+ }
5632
+ /** @enumType */
5633
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5634
+ interface Refund {
5562
5635
  /**
5563
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5564
- * The site will be used for account level CSM feature for enterprise
5636
+ * Refund ID.
5637
+ * @format GUID
5638
+ * @readonly
5565
5639
  */
5566
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5567
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5568
- RISE = "RISE",
5640
+ _id?: string;
5569
5641
  /**
5570
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5571
- * There's a blank site behind the scene but it's blank).
5572
- * The Mobile company will be the owner of this namespace.
5642
+ * List of transactions.
5643
+ * @maxSize 50
5573
5644
  */
5574
- BRANDED_FIRST = "BRANDED_FIRST",
5575
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5576
- NOWNIA = "NOWNIA",
5645
+ transactions?: RefundTransaction[];
5646
+ /** Refund business details. */
5647
+ details?: RefundDetails;
5577
5648
  /**
5578
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5579
- * The Partners company owns this namespace.
5649
+ * 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.
5650
+ * @readonly
5651
+ * @immutable
5580
5652
  */
5581
- UGC_TEMPLATE = "UGC_TEMPLATE",
5582
- /** Codux Headless Sites */
5583
- CODUX = "CODUX",
5584
- /** Bobb - AI Design Creator. */
5585
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5653
+ _createdDate?: Date | null;
5586
5654
  /**
5587
- * Shared Blog Site is a unique single site across Enterprise account,
5588
- * This site will hold all Blog posts related to the Marketing product.
5655
+ * Aggregated refund summary.
5656
+ * @readonly
5589
5657
  */
5590
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5591
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5592
- STANDALONE_FORMS = "STANDALONE_FORMS",
5593
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5594
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5595
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5596
- MIMIR = "MIMIR",
5597
- /** Wix Twins platform. */
5598
- TWINS = "TWINS",
5599
- /** Wix Nano. */
5600
- NANO = "NANO",
5601
- /** Base44 headless sites. */
5602
- BASE44 = "BASE44",
5603
- /** Wix Channels Sites */
5604
- CHANNELS = "CHANNELS",
5605
- /** Nautilus platform. */
5606
- NAUTILUS = "NAUTILUS",
5658
+ summary?: AggregatedRefundSummary;
5607
5659
  /**
5608
- * Symphony a siteless site representing a project within Symphony (the evolution of Orion).
5609
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5660
+ * ID of the app that initiated this refund.
5661
+ * @format GUID
5662
+ * @readonly
5663
+ * @immutable
5610
5664
  */
5611
- SYMPHONY = "SYMPHONY",
5612
- /** Nautilus platform app. */
5613
- NAUTILUS_APPS = "NAUTILUS_APPS"
5665
+ requestingServiceAppId?: string | null;
5614
5666
  }
5615
- /** @enumType */
5616
- 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';
5617
- /** Site transferred to another user. */
5618
- interface SiteTransferred {
5667
+ interface RefundTransaction {
5619
5668
  /**
5620
- * A previous owner id (user that transfers meta site).
5669
+ * ID of the payment associated with this refund.
5621
5670
  * @format GUID
5671
+ * @immutable
5622
5672
  */
5623
- oldOwnerId?: string;
5673
+ paymentId?: string;
5624
5674
  /**
5625
- * A new owner id (user that accepts meta site).
5626
- * @format GUID
5675
+ * Refund amount.
5676
+ * @immutable
5627
5677
  */
5628
- newOwnerId?: string;
5629
- }
5630
- /** Soft deletion of the meta site. Could be restored. */
5631
- interface SiteDeleted {
5632
- /** A deletion context. */
5633
- deleteContext?: DeleteContext;
5634
- }
5635
- interface DeleteContext {
5636
- /** When the meta site was deleted. */
5637
- dateDeleted?: Date | null;
5638
- /** A status. */
5639
- deleteStatus?: DeleteStatusWithLiterals;
5678
+ amount?: Price;
5679
+ /** Refund status. */
5680
+ refundStatus?: RefundStatusWithLiterals;
5681
+ /** Optional details of current refund status. */
5682
+ refundStatusInfo?: RefundStatusInfo;
5640
5683
  /**
5641
- * A reason (flow).
5642
- * @maxLength 255
5684
+ * Payment gateway's refund ID.
5685
+ * This field is only returned when the value of `external_refund` is `false`.
5686
+ * @format GUID
5643
5687
  */
5644
- deleteOrigin?: string;
5688
+ gatewayRefundId?: string | null;
5689
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5690
+ providerRefundId?: string | null;
5645
5691
  /**
5646
- * A service that deleted it.
5647
- * @maxLength 255
5692
+ * Whether refund was made externally and manually on the payment provider's side.
5693
+ * @immutable
5648
5694
  */
5649
- initiatorId?: string | null;
5695
+ externalRefund?: boolean;
5650
5696
  }
5651
- declare enum DeleteStatus {
5652
- UNKNOWN = "UNKNOWN",
5653
- TRASH = "TRASH",
5654
- DELETED = "DELETED",
5655
- PENDING_PURGE = "PENDING_PURGE",
5656
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5697
+ /** Refund transaction status. */
5698
+ declare enum RefundStatus {
5699
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5700
+ PENDING = "PENDING",
5701
+ /** Refund transaction succeeded. */
5702
+ SUCCEEDED = "SUCCEEDED",
5703
+ /** Refund transaction failed. */
5704
+ FAILED = "FAILED",
5705
+ /** Refund request acknowledged, and will be executed soon. */
5706
+ SCHEDULED = "SCHEDULED",
5707
+ /** Refund was initiated on payment provider side. */
5708
+ STARTED = "STARTED"
5657
5709
  }
5658
5710
  /** @enumType */
5659
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5660
- /** Restoration of the meta site. */
5661
- interface SiteUndeleted {
5662
- }
5663
- /** First publish of a meta site. Or subsequent publish after unpublish. */
5664
- interface SitePublished {
5665
- }
5666
- interface SiteUnpublished {
5711
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5712
+ interface RefundStatusInfo {
5667
5713
  /**
5668
- * A list of URLs previously associated with the meta site.
5669
- * @maxLength 4000
5670
- * @maxSize 10000
5714
+ * Reason code for the refund's current status.
5715
+ *
5716
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5717
+ * @minLength 1
5718
+ * @maxLength 10
5671
5719
  */
5672
- urls?: string[];
5673
- }
5674
- interface SiteMarkedAsTemplate {
5675
- }
5676
- interface SiteMarkedAsWixSite {
5720
+ paymentGatewayReasonCode?: string | null;
5721
+ /**
5722
+ * Free text explanation of current refund status.
5723
+ * @minLength 1
5724
+ * @maxLength 1000
5725
+ */
5726
+ description?: string | null;
5677
5727
  }
5678
- /**
5679
- * Represents a service provisioned a site.
5680
- *
5681
- * Note on `origin_instance_id`:
5682
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5683
- * This is because of the following scenario:
5684
- *
5685
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
5686
- * such as a product catalog. When you create a site from this template, you inherit this
5687
- * default product catalog. However, if the template's product catalog is modified,
5688
- * your site will retain the catalog as it was at the time of site creation. This ensures that
5689
- * your site remains consistent with what you initially received and does not include any
5690
- * changes made to the original template afterward.
5691
- * To ensure this, the TPA on the template gets a new instance_id.
5692
- */
5693
- interface ServiceProvisioned {
5728
+ interface AggregatedRefundSummary {
5729
+ /** Total amount requested for refund. */
5730
+ requestedRefund?: Price;
5731
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5732
+ pendingRefund?: Price;
5733
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5734
+ refunded?: Price;
5735
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
5736
+ failedRefundAmount?: Price;
5737
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
5738
+ pending?: boolean;
5739
+ /** Breakdown of refunded items. Available only after refund is complete. */
5740
+ breakdown?: RefundItemsBreakdown;
5741
+ }
5742
+ interface RefundItemsBreakdown {
5694
5743
  /**
5695
- * Either UUID or EmbeddedServiceType.
5696
- * @maxLength 36
5744
+ * Refunded line items and the amount refunded for each.
5745
+ * @maxSize 300
5697
5746
  */
5698
- appDefId?: string;
5747
+ lineItems?: LineItemRefundSummary[];
5748
+ }
5749
+ interface LineItemRefundSummary {
5699
5750
  /**
5700
- * Not only UUID. Something here could be something weird.
5701
- * @maxLength 36
5751
+ * ID of the refunded line item.
5752
+ * @format GUID
5702
5753
  */
5703
- instanceId?: string;
5754
+ lineItemId?: string;
5755
+ /** Total refunded amount for the line item. */
5756
+ totalRefundedAmount?: Price;
5757
+ }
5758
+ interface CalculateRefundRequest {
5704
5759
  /**
5705
- * An instance id from which this instance is originated.
5706
- * @maxLength 36
5760
+ * Order ID
5761
+ * @minLength 1
5762
+ * @maxLength 100
5707
5763
  */
5708
- originInstanceId?: string;
5764
+ ecomOrderId?: string;
5709
5765
  /**
5710
- * A version.
5711
- * @maxLength 500
5766
+ * Refunded line items and quantity
5767
+ * @maxSize 300
5712
5768
  */
5713
- version?: string | null;
5769
+ refundItems?: CalculateRefundItemRequest[];
5770
+ /** Should include shipping in refund calculation */
5771
+ refundShipping?: boolean;
5772
+ }
5773
+ interface CalculateRefundItemRequest {
5714
5774
  /**
5715
- * The origin meta site id
5775
+ * ID of the line item being refunded
5716
5776
  * @format GUID
5717
5777
  */
5718
- originMetaSiteId?: string | null;
5719
- }
5720
- interface ServiceRemoved {
5778
+ _id?: string;
5721
5779
  /**
5722
- * Either UUID or EmbeddedServiceType.
5723
- * @maxLength 36
5780
+ * How much of that line item is being refunded
5781
+ * @min 1
5782
+ * @max 100000
5724
5783
  */
5725
- appDefId?: string;
5784
+ quantity?: number;
5785
+ }
5786
+ interface CalculateRefundResponse {
5787
+ /** Total refundable amount */
5788
+ total?: Price;
5789
+ /** Tax cost of the order */
5790
+ tax?: Price;
5791
+ /** Discount given for this order */
5792
+ discount?: Price;
5793
+ /** Total cost of the order (without tax) */
5794
+ subtotal?: Price;
5795
+ /** Total shipping cost for order */
5796
+ shipping?: Price;
5797
+ /** Previous refund given on that order */
5798
+ previouslyRefundedAmount?: Price;
5726
5799
  /**
5727
- * Not only UUID. Something here could be something weird.
5728
- * @maxLength 36
5800
+ * The refundable items of that order
5801
+ * @maxSize 300
5729
5802
  */
5730
- instanceId?: string;
5803
+ items?: CalculateRefundItemResponse[];
5804
+ }
5805
+ interface CalculateRefundItemResponse {
5731
5806
  /**
5732
- * A version.
5733
- * @maxLength 500
5807
+ * Line item ID
5808
+ * @format GUID
5734
5809
  */
5735
- version?: string | null;
5810
+ _id?: string;
5811
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5812
+ price?: Price;
5736
5813
  }
5737
- /** Rename of the site. Meaning, free public url has been changed as well. */
5738
- interface SiteRenamed {
5814
+ interface VoidAuthorizedPaymentsRequest {
5739
5815
  /**
5740
- * A new meta site name (URL slug).
5741
- * @maxLength 20
5816
+ * Wix eCommerce order ID
5817
+ * @minLength 1
5818
+ * @maxLength 100
5742
5819
  */
5743
- newSiteName?: string;
5820
+ ecomOrderId: string;
5744
5821
  /**
5745
- * A previous meta site name (URL slug).
5746
- * @maxLength 255
5822
+ * Payment IDs
5823
+ * @minSize 1
5824
+ * @maxSize 100
5825
+ * @format GUID
5747
5826
  */
5748
- oldSiteName?: string;
5749
- }
5750
- /**
5751
- * Hard deletion of the meta site.
5752
- *
5753
- * Could not be restored. Therefore it's desirable to cleanup data.
5754
- */
5755
- interface SiteHardDeleted {
5756
- /** A deletion context. */
5757
- deleteContext?: DeleteContext;
5758
- }
5759
- interface NamespaceChanged {
5760
- /** A previous namespace. */
5761
- oldNamespace?: NamespaceWithLiterals;
5762
- /** A new namespace. */
5763
- newNamespace?: NamespaceWithLiterals;
5764
- }
5765
- /** Assigned Studio editor */
5766
- interface StudioAssigned {
5767
- }
5768
- /** Unassigned Studio editor */
5769
- interface StudioUnassigned {
5827
+ paymentIds: string[];
5770
5828
  }
5771
- /**
5772
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5773
- *
5774
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5775
- * with sites and its urls, you need to listen to another topic/event. Read about it:
5776
- *
5777
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5778
- */
5779
- interface SiteUrlChanged {
5829
+ interface VoidAuthorizedPaymentsResponse {
5830
+ /** All order's transactions after the void was triggered */
5831
+ orderTransactions?: OrderTransactions;
5780
5832
  }
5781
- /**
5782
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5783
- * Consumed by other teams to remove relevant data.
5784
- */
5785
- interface SitePurgedExternally {
5833
+ interface CaptureAuthorizedPaymentsRequest {
5786
5834
  /**
5787
- * @maxLength 2048
5835
+ * Wix eCommerce order ID
5836
+ * @minLength 1
5837
+ * @maxLength 100
5838
+ */
5839
+ ecomOrderId: string;
5840
+ /**
5841
+ * Capture payments information
5842
+ * @minSize 1
5788
5843
  * @maxSize 100
5789
- * @deprecated
5790
- * @targetRemovalDate 2025-04-15
5791
5844
  */
5792
- appDefId?: string[];
5793
- }
5794
- /** Assigned Odeditor */
5795
- interface OdeditorAssigned {
5796
- }
5797
- /** Unassigned Odeditor */
5798
- interface OdeditorUnassigned {
5799
- }
5800
- /** Assigned Picasso editor */
5801
- interface PicassoAssigned {
5802
- }
5803
- /** Unassigned Picasso */
5804
- interface PicassoUnassigned {
5805
- }
5806
- /** Assigned Wixel */
5807
- interface WixelAssigned {
5808
- }
5809
- /** Unassigned Wixel */
5810
- interface WixelUnassigned {
5811
- }
5812
- /** Assigned StudioTwo */
5813
- interface StudioTwoAssigned {
5814
- }
5815
- /** Unassigned StudioTwo */
5816
- interface StudioTwoUnassigned {
5817
- }
5818
- /** Media from user domain is enabled. */
5819
- interface UserDomainMediaEnabled {
5820
- }
5821
- /** Media from user domain is disabled. */
5822
- interface UserDomainMediaDisabled {
5823
- }
5824
- /** Assigned Editorless */
5825
- interface EditorlessAssigned {
5826
- }
5827
- /** Unassigned Editorless */
5828
- interface EditorlessUnassigned {
5845
+ payments: PaymentCapture[];
5829
5846
  }
5830
- interface HasCustomEmailConfigurationsRequest {
5847
+ interface PaymentCapture {
5848
+ /**
5849
+ * Payment ID
5850
+ * @format GUID
5851
+ */
5852
+ paymentId?: string | null;
5853
+ /**
5854
+ * Capture amount.
5855
+ * If not provided - full authorized amount will be captured.
5856
+ */
5857
+ amount?: Price;
5831
5858
  }
5832
- interface HasCustomEmailConfigurationsResponse {
5833
- hasCustomConfigurations?: boolean;
5859
+ interface CaptureAuthorizedPaymentsResponse {
5860
+ /** All order's transactions after the capture was triggered */
5861
+ orderTransactions?: OrderTransactions;
5834
5862
  }
5835
- interface AddToAutomationMigrationPopulationRequest {
5836
- /** When true, sends custom email configurations to automation system via email */
5837
- sendCustomEmailConfigs?: boolean;
5838
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5839
- origin?: OriginWithLiterals;
5863
+ interface ChargeSavedPaymentMethodRequest {
5864
+ /**
5865
+ * Ecom Order ID.
5866
+ * @minLength 1
5867
+ * @maxLength 100
5868
+ */
5869
+ ecomOrderId?: string;
5870
+ /** Amount to be charged */
5871
+ amount?: Price;
5840
5872
  }
5841
- declare enum Origin {
5842
- OPT_IN = "OPT_IN",
5843
- MIGRATION = "MIGRATION"
5873
+ interface ChargeSavedPaymentMethodResponse {
5874
+ /** Payment gateway's order ID (e.g Wix Payments) */
5875
+ paymentGatewayOrderId?: string;
5844
5876
  }
5845
- /** @enumType */
5846
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5847
- interface AddToAutomationMigrationPopulationResponse {
5848
- success?: boolean;
5877
+ interface V1TriggerReindexRequest {
5878
+ /** @format GUID */
5879
+ metasiteId?: string;
5880
+ /**
5881
+ * @minLength 1
5882
+ * @maxLength 100
5883
+ * @maxSize 100
5884
+ */
5885
+ orderIds?: string[];
5849
5886
  }
5850
- interface IsInAutomationMigrationPopulationRequest {
5887
+ interface V1TriggerReindexResponse {
5851
5888
  }
5852
- interface IsInAutomationMigrationPopulationResponse {
5853
- inPopulation?: boolean;
5889
+ interface V1TriggerReindexOrderRequest {
5890
+ /** @format GUID */
5891
+ metasiteId?: string;
5892
+ /**
5893
+ * @minLength 1
5894
+ * @maxLength 100
5895
+ */
5896
+ orderId?: string;
5854
5897
  }
5855
5898
  interface DiffmatokyPayload {
5856
5899
  left?: string;
@@ -8869,4 +8912,4 @@ interface BulkUpdateOrderTagsOptions {
8869
8912
  unassignTags?: TagsTags;
8870
8913
  }
8871
8914
 
8872
- export { ActivityType as $, type AddActivitiesOptions as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, PaymentOptionType as E, SubscriptionFrequency as F, type GetPaymentCollectabilityStatusResponse as G, ProductPeriodAlignment as H, ItemTypePreset as I, JurisdictionType as J, AdjustmentType as K, PaymentStatusEnumPaymentStatus as L, type MaskedOrder as M, FulfillmentStatus as N, type Order as O, type Price as P, VatType as Q, PickupMethod as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, OrderStatus as X, DiscountType as Y, DiscountReason as Z, LineItemQuantityChangeType as _, type PreparePaymentCollectionOptions as a, type LineItemTaxBreakdown as a$, OrderActivityTypeEnumActivityType as a0, AttributionSource as a1, ChannelType as a2, AdditionalFeeSource as a3, OrderActionType as a4, SpecificItemsCouponBehavior as a5, ChargeType as a6, VersioningMode as a7, DeltaPaymentOptionType as a8, InventoryAction as a9, Origin as aA, SortOrder as aB, OrderApprovalStrategy as aC, Placement as aD, SubdivisionType as aE, SourceType as aF, CustomFieldGroup as aG, ValueType as aH, DepositType as aI, InvoiceStatus as aJ, type OrderLineItem as aK, type ProductName as aL, type CatalogReference as aM, type DescriptionLine as aN, type DescriptionLineValueOneOf as aO, type DescriptionLineDescriptionLineValueOneOf as aP, type DescriptionLineName as aQ, type PlainTextValue as aR, type Color as aS, type FocalPoint as aT, type PhysicalProperties as aU, type Dimensions as aV, type ItemType as aW, type ItemTypeItemTypeDataOneOf as aX, type RestockLocation as aY, type ItemTaxFullDetails as aZ, type LineItemTaxInfo as a_, WebhookIdentityType as aa, ScheduledAction as ab, DurationUnit as ac, PaymentCollectabilityStatus as ad, PredefinedPaymentMethod as ae, RefundableStatus as af, NonRefundableReason as ag, ManuallyRefundableReason as ah, RestockType as ai, TransactionStatus as aj, AuthorizationCaptureStatus as ak, AuthorizationVoidStatus as al, Reason as am, ActionType as an, ChargebackStatus as ao, MembershipPaymentStatus as ap, PaymentStatus as aq, CanceledReason as ar, DeclinedReason as as, VoidedReason as at, RefundStatus as au, PreviewEmailType as av, State as aw, SiteCreatedContext as ax, Namespace as ay, DeleteStatus as az, type PreparePaymentCollectionResponse as b, type LineItemDescriptionLineChange as b$, type DigitalFile as b0, type SubscriptionInfo as b1, type SubscriptionTitle as b2, type SubscriptionDescription as b3, type SubscriptionSettings as b4, type FreeTrialPeriod as b5, type BillingSettings as b6, type BillingAdjustment as b7, type BillingAdjustmentPriceSummary as b8, type PriceDescription as b9, type OrderTaxInfo as bA, type OrderTaxBreakdown as bB, type AppliedDiscount as bC, type AppliedDiscountDiscountSourceOneOf as bD, type Coupon as bE, type MerchantDiscount as bF, type MerchantDiscountMerchantDiscountReasonOneOf as bG, type DiscountRule as bH, type DiscountRuleName as bI, type LineItemDiscount as bJ, type ItemCombination as bK, type ItemCombinationLineItem as bL, type Activity as bM, type ActivityContentOneOf as bN, type CustomActivity as bO, type MerchantComment as bP, type OrderRefunded as bQ, type OrderCreatedFromExchange as bR, type NewExchangeOrderCreated as bS, type LineItemExchangeData as bT, type DraftOrderChangesApplied as bU, type OrderChange as bV, type OrderChangeValueOneOf as bW, type LineItemChanges as bX, type LineItemQuantityChange as bY, type LineItemPriceChange as bZ, type LineItemProductNameChange as b_, type LocationAndQuantity as ba, type TaxableAddress as bb, type TaxableAddressTaxableAddressDataOneOf as bc, type ExtendedFields as bd, type ModifierGroup as be, type TranslatableString as bf, type ItemModifier as bg, type BuyerInfo as bh, type BuyerInfoIdOneOf as bi, type CurrencyConversionDetails as bj, type PriceSummary as bk, type AddressWithContact as bl, type Address as bm, type StreetAddress as bn, type AddressLocation as bo, type FullAddressContactDetails as bp, type VatId as bq, type V1ShippingInformation as br, type DeliveryLogistics as bs, type DeliveryLogisticsAddressOneOf as bt, type PickupDetails as bu, type PickupAddress as bv, type DeliveryTimeSlot as bw, type ShippingPrice as bx, type ShippingRegion as by, type TaxSummary as bz, type PreparePaymentCollectionApplicationErrors as c, type InternalDocumentUpdateOperation as c$, type LineItemModifiersChange as c0, type ManagedLineItem as c1, type ManagedDiscount as c2, type TranslatedValue as c3, type LineItemAmount as c4, type ManagedAdditionalFee as c5, type TotalPriceChange as c6, type ShippingInformationChange as c7, type ShippingInformation as c8, type SavedPaymentMethod as c9, type ReceiptSentReceiptInfoOneOf as cA, type ChargebackCreated as cB, type ChargebackReversed as cC, type CreatedBy as cD, type CreatedByStringOneOf as cE, type ChannelInfo as cF, type CustomField as cG, type BalanceSummary as cH, type Balance as cI, type CashRounding as cJ, type AdditionalFee as cK, type FulfillmentStatusesAggregate as cL, type Tags as cM, type TagList as cN, type Location as cO, type OrderSettings as cP, type OrderSettingsAllowedActionsOneOf as cQ, type OrderSettingsEditableByOneOf as cR, type CustomAllowedActions as cS, type OwnerApps as cT, type FormInfo as cU, type FormIdentifier as cV, type PlatformFeeSummary as cW, type PlatformFee as cX, type UpdateInternalDocumentsEvent as cY, type UpdateInternalDocumentsEventOperationOneOf as cZ, type InternalDocument as c_, type AuthorizedPaymentCreated as ca, type AuthorizedPaymentCaptured as cb, type AuthorizedPaymentVoided as cc, type RefundInitiated as cd, type RefundedPayment as ce, type RefundedPaymentKindOneOf as cf, type RegularPaymentRefund as cg, type GiftCardPaymentRefund as ch, type MembershipPaymentRefund as ci, type PaymentRefunded as cj, type PaymentRefundFailed as ck, type RefundedAsStoreCredit as cl, type PaymentPending as cm, type PaymentPendingPaymentDetailsOneOf as cn, type RegularPayment as co, type RegularPaymentPaymentMethodDetailsOneOf as cp, type CreditCardDetails as cq, type PaymentCanceled as cr, type PaymentCanceledPaymentDetailsOneOf as cs, type PaymentDeclined as ct, type PaymentDeclinedPaymentDetailsOneOf as cu, type ReceiptCreated as cv, type ReceiptCreatedReceiptInfoOneOf as cw, type WixReceipt as cx, type ExternalReceipt as cy, type ReceiptSent as cz, type VoidAuthorizedPaymentsApplicationErrors as d, type RecordManuallyCollectedPaymentResponse as d$, type DeleteByIdsOperation as d0, type DeleteByFilterOperation as d1, type InternalDocumentUpdateByFilterOperation as d2, type InternalUpdateExistingOperation as d3, type VersionedDocumentUpdateOperation as d4, type VersionedDeleteByIdsOperation as d5, type VersionedDocumentId as d6, type OrderApproved as d7, type OrdersExperiments as d8, type OrderRejectedEventOrderRejected as d9, type RestoreInfo as dA, type EntityUpdatedEvent as dB, type EntityDeletedEvent as dC, type ActionEvent as dD, type Empty as dE, type TriggerReindexOrderRequest as dF, type MessageEnvelope as dG, type IdentificationData as dH, type IdentificationDataIdOneOf as dI, type AccountInfo as dJ, type ImportOrderRequest as dK, type ImportOrderResponse as dL, type SetOrderNumberCounterRequest as dM, type SetOrderNumberCounterResponse as dN, type BulkDeleteImportedOrdersRequest as dO, type BulkDeleteImportedOrdersResponse as dP, type V1TriggerReindexRequest as dQ, type V1TriggerReindexResponse as dR, type V1TriggerReindexOrderRequest as dS, type PreparePaymentCollectionRequest as dT, type RedirectUrls as dU, type DelayedCaptureSettings as dV, type Duration as dW, type GetPaymentCollectabilityStatusRequest as dX, type RecordManuallyCollectedPaymentRequest as dY, type UserDefinedPaymentMethodName as dZ, type UserDefinedPaymentMethodNameKindOneOf as d_, type OrderItemsRestocked as da, type V1RestockItem as db, type OrderImported as dc, type ImportedOrderDeleted as dd, type PaymentStatusUpdated as de, type FulfillmentStatusUpdated as df, type OrderCanceledEventOrderCanceled as dg, type OrderDeltasCommitted as dh, type CommittedDiffs as di, type CommittedDiffsShippingUpdateInfoOneOf as dj, type ItemChangedDetails as dk, type OrderLineItemChangedDetails as dl, type LineItemDelta as dm, type LineItemDeltaDeltaOneOf as dn, type AppliedDiscountDelta as dp, type AppliedDiscountDeltaDeltaOneOf as dq, type AdditionalFeeDelta as dr, type AdditionalFeeDeltaDeltaOneOf as ds, type DraftOrderCommitSettings as dt, type InventoryUpdateDetails as du, type TriggerReindexRequest as dv, type TriggerReindexResponse as dw, type DomainEvent as dx, type DomainEventBodyOneOf as dy, type EntityCreatedEvent as dz, type PaymentCapture as e, type CalculateRefundItemRequest as e$, type MarkOrderAsPaidRequest as e0, type MarkOrderAsPaidResponse as e1, type BulkMarkOrdersAsPaidRequest as e2, type BulkMarkOrdersAsPaidResponse as e3, type BulkOrderResult as e4, type ItemMetadata as e5, type ApplicationError as e6, type BulkActionMetadata as e7, type GetRefundabilityStatusRequest as e8, type GetRefundabilityStatusResponse as e9, type RegularPaymentDetailsPaymentMethodDetailsOneOf as eA, type CreditCardPaymentMethodDetails as eB, type AuthorizationDetails as eC, type AuthorizationCapture as eD, type AuthorizationActionFailureDetails as eE, type AuthorizationVoid as eF, type V1ScheduledAction as eG, type Chargeback as eH, type PaymentMethodName as eI, type GiftCardPaymentDetails as eJ, type MembershipPaymentDetails as eK, type FutureMembershipDetails as eL, type WixReceiptInfo as eM, type ExternalReceiptInfo as eN, type CashRoundingDetails as eO, type PaymentStatusDetails as eP, type PaymentStatusDetailsStatusDetailsOneOf as eQ, type CanceledStatusDetails as eR, type DeclinedStatusDetails as eS, type VoidedStatusDetails as eT, type Refund as eU, type RefundTransaction as eV, type RefundStatusInfo as eW, type AggregatedRefundSummary as eX, type RefundItemsBreakdown as eY, type LineItemRefundSummary as eZ, type CalculateRefundRequest as e_, type Refundability as ea, type RefundabilityAdditionalRefundabilityInfoOneOf as eb, type CreatePaymentGatewayOrderRequest as ec, type ChargedBy as ed, type CreatePaymentGatewayOrderResponse as ee, type ChargeMembershipsRequest as ef, type MembershipChargeItem as eg, type MembershipName as eh, type ServiceProperties as ei, type ChargeMembershipsResponse as ej, type TriggerRefundRequest as ek, type PaymentRefund as el, type RefundDetails as em, type RefundItem as en, type LineItemRefund as eo, type AdditionalFeeRefund as ep, type ShippingRefund as eq, type RefundSideEffects as er, type RestockInfo as es, type RestockItem as et, type TriggerRefundResponse as eu, type OrderTransactions as ev, type Payment as ew, type PaymentPaymentDetailsOneOf as ex, type PaymentReceiptInfoOneOf as ey, type RegularPaymentDetails as ez, type CaptureAuthorizedPaymentsApplicationErrors as f, type StudioAssigned as f$, type CalculateRefundResponse as f0, type CalculateRefundItemResponse as f1, type VoidAuthorizedPaymentsRequest as f2, type CaptureAuthorizedPaymentsRequest as f3, type ChargeSavedPaymentMethodRequest as f4, type ChargeSavedPaymentMethodResponse as f5, type SendBuyerConfirmationEmailRequest as f6, type SendBuyerConfirmationEmailResponse as f7, type SendBuyerPaymentsReceivedEmailRequest as f8, type SendBuyerPaymentsReceivedEmailResponse as f9, type PreviewBuyerPaymentsReceivedEmailRequest as fA, type PreviewBuyerPaymentsReceivedEmailResponse as fB, type PreviewBuyerConfirmationEmailRequest as fC, type PreviewBuyerConfirmationEmailResponse as fD, type PreviewBuyerPickupConfirmationEmailRequest as fE, type PreviewBuyerPickupConfirmationEmailResponse as fF, type PreviewShippingConfirmationEmailRequest as fG, type PreviewShippingConfirmationEmailResponse as fH, type PreviewResendDownloadLinksEmailRequest as fI, type PreviewResendDownloadLinksEmailResponse as fJ, type MetaSiteSpecialEvent as fK, type MetaSiteSpecialEventPayloadOneOf as fL, type Asset as fM, type SiteCreated as fN, type SiteTransferred as fO, type SiteDeleted as fP, type DeleteContext as fQ, type SiteUndeleted as fR, type SitePublished as fS, type SiteUnpublished as fT, type SiteMarkedAsTemplate as fU, type SiteMarkedAsWixSite as fV, type ServiceProvisioned as fW, type ServiceRemoved as fX, type SiteRenamed as fY, type SiteHardDeleted as fZ, type NamespaceChanged as f_, type SendBuyerPickupConfirmationEmailRequest as fa, type SendBuyerPickupConfirmationEmailResponse as fb, type BulkSendBuyerPickupConfirmationEmailsRequest as fc, type BulkSendBuyerPickupConfirmationEmailsResponse as fd, type SendBuyerShippingConfirmationEmailRequest as fe, type SendBuyerShippingConfirmationEmailResponse as ff, type BulkSendBuyerShippingConfirmationEmailsRequest as fg, type BulkSendBuyerShippingConfirmationEmailsResponse as fh, type SendMerchantOrderReceivedNotificationRequest as fi, type SendMerchantOrderReceivedNotificationResponse as fj, type SendCancelRefundEmailRequest as fk, type SendCancelRefundEmailResponse as fl, type SendRefundEmailRequest as fm, type SendRefundEmailResponse as fn, type SendFulfillmentEmailRequest as fo, type SendFulfillmentEmailResponse as fp, type SendMerchantOrderReceivedPushRequest as fq, type SendMerchantOrderReceivedPushResponse as fr, type PreviewEmailByTypeRequest as fs, type PreviewEmailByTypeResponse as ft, type PreviewRefundEmailRequest as fu, type PreviewRefundEmailResponse as fv, type PreviewCancelEmailRequest as fw, type PreviewCancelEmailResponse as fx, type PreviewCancelRefundEmailRequest as fy, type PreviewCancelRefundEmailResponse as fz, type GetOrderApplicationErrors as g, type UnArchiveOrderRequest as g$, type StudioUnassigned as g0, type SiteUrlChanged as g1, type SitePurgedExternally as g2, type OdeditorAssigned as g3, type OdeditorUnassigned as g4, type PicassoAssigned as g5, type PicassoUnassigned as g6, type WixelAssigned as g7, type WixelUnassigned as g8, type StudioTwoAssigned as g9, type SearchOrdersRequest as gA, type CursorSearch as gB, type CursorSearchPagingMethodOneOf as gC, type CursorPagingMetadata as gD, type CreateOrderRequest as gE, type OrderCreationSettings as gF, type OrderCreationSettingsEditableByOneOf as gG, type OrderCreateNotifications as gH, type CreateOrderResponse as gI, type UpdateOrderRequest as gJ, type UpdateOrderResponse as gK, type BulkUpdateOrdersRequest as gL, type CommitDeltasRequest as gM, type DraftOrderDiffs as gN, type DraftOrderDiffsShippingUpdateInfoOneOf as gO, type DraftOrderDiffsBuyerUpdateInfoOneOf as gP, type DraftOrderDiffsBillingUpdateInfoOneOf as gQ, type DraftOrderDiffsRecipientUpdateInfoOneOf as gR, type V1LineItemDelta as gS, type V1LineItemDeltaDeltaOneOf as gT, type CommitDeltasResponse as gU, type ArchiveOrderRequest as gV, type ArchiveOrderResponse as gW, type BulkArchiveOrdersRequest as gX, type BulkArchiveOrdersResponse as gY, type BulkArchiveOrdersByFilterRequest as gZ, type BulkArchiveOrdersByFilterResponse as g_, type StudioTwoUnassigned as ga, type UserDomainMediaEnabled as gb, type UserDomainMediaDisabled as gc, type EditorlessAssigned as gd, type EditorlessUnassigned as ge, type HasCustomEmailConfigurationsRequest as gf, type HasCustomEmailConfigurationsResponse as gg, type AddToAutomationMigrationPopulationRequest as gh, type AddToAutomationMigrationPopulationResponse as gi, type IsInAutomationMigrationPopulationRequest as gj, type IsInAutomationMigrationPopulationResponse as gk, type DiffmatokyPayload as gl, type ErrorInformation as gm, type GetOrderRequest as gn, type GetOrderResponse as go, type InternalQueryOrdersRequest as gp, type PlatformQuery as gq, type PlatformQueryPagingMethodOneOf as gr, type Sorting as gs, type PlatformPaging as gt, type CursorPaging as gu, type InternalQueryOrdersResponse as gv, type PlatformPagingMetadata as gw, type Cursors as gx, type QueryOrderRequest as gy, type QueryOrderResponse as gz, type OrderSearch as h, type BulkMarkAsFulfilledByFilterRequest as h$, type UnArchiveOrderResponse as h0, type BulkUnArchiveOrdersRequest as h1, type BulkUnArchiveOrdersResponse as h2, type BulkUnArchiveOrdersByFilterRequest as h3, type BulkUnArchiveOrdersByFilterResponse as h4, type UpdateBuyerInfoRequest as h5, type BuyerInfoUpdate as h6, type UpdateBuyerInfoResponse as h7, type UpdateBuyerEmailRequest as h8, type UpdateBuyerEmailResponse as h9, type EmailEdited as hA, type PickupReadyEmailSent as hB, type OrderPartiallyPaid as hC, type OrderPending as hD, type OrderRejected as hE, type AddInternalActivityResponse as hF, type AddActivityRequest as hG, type PublicActivity as hH, type PublicActivityContentOneOf as hI, type AddActivityResponse as hJ, type AddActivitiesRequest as hK, type UpdateActivityRequest as hL, type UpdateActivityResponse as hM, type DeleteActivityRequest as hN, type DeleteActivityResponse as hO, type UpdateLineItemsDescriptionLinesRequest as hP, type LineItemUpdate as hQ, type UpdateLineItemsDescriptionLinesResponse as hR, type MarkOrderAsSeenByHumanRequest as hS, type MarkOrderAsSeenByHumanResponse as hT, type CancelOrderRequest as hU, type UpdateOrderStatusRequest as hV, type UpdateOrderStatusResponse as hW, type MarkAsFulfilledRequest as hX, type MarkAsFulfilledResponse as hY, type BulkMarkAsFulfilledRequest as hZ, type BulkMarkAsFulfilledResponse as h_, type UpdateOrderShippingAddressRequest as ha, type UpdateOrderShippingAddressResponse as hb, type UpdateBillingContactDetailsRequest as hc, type UpdateBillingContactDetailsResponse as hd, type UpdateOrderLineItemRequest as he, type UpdateOrderLineItemResponse as hf, type UpdateOrderLineItemsRequest as hg, type MaskedOrderLineItem as hh, type UpdateOrderLineItemsResponse as hi, type AddInternalActivityRequest as hj, type InternalActivity as hk, type InternalActivityContentOneOf as hl, type OrderPlaced as hm, type OrderPaid as hn, type OrderFulfilled as ho, type OrderNotFulfilled as hp, type OrderCanceled as hq, type DownloadLinkSent as hr, type TrackingNumberAdded as hs, type TrackingNumberEdited as ht, type TrackingLinkAdded as hu, type ShippingConfirmationEmailSent as hv, type InvoiceAdded as hw, type InvoiceSent as hx, type FulfillerEmailSent as hy, type ShippingAddressEdited as hz, type CreateOrderOptions as i, type CalculatedTaxes as i$, type BulkMarkAsFulfilledByFilterResponse as i0, type MarkAsUnfulfilledRequest as i1, type MarkAsUnfulfilledResponse as i2, type BulkMarkAsUnfulfilledRequest as i3, type BulkMarkAsUnfulfilledResponse as i4, type BulkMarkAsUnfulfilledByFilterRequest as i5, type BulkMarkAsUnfulfilledByFilterResponse as i6, type BulkSetBusinessLocationRequest as i7, type BulkSetBusinessLocationResponse as i8, type BulkSetBusinessLocationResult as i9, type Cancel as iA, type Reschedule as iB, type InvoiceSentEvent as iC, type IdAndVersion as iD, type InvoiceFields as iE, type Customer as iF, type Email as iG, type QuotesAddress as iH, type AddressDescription as iI, type Phone as iJ, type Company as iK, type CommonAddress as iL, type CommonAddressStreetOneOf as iM, type Subdivision as iN, type StandardDetails as iO, type InvoiceDates as iP, type LineItems as iQ, type LineItem as iR, type BigDecimalWrapper as iS, type LineItemTax as iT, type Source as iU, type LineItemMetaData as iV, type Locale as iW, type TotalPrice as iX, type ItemizedFee as iY, type Discount as iZ, type DiscountOneDiscountTypeOneOf as i_, type V1MarkOrderAsPaidRequest as ia, type V1MarkOrderAsPaidResponse as ib, type V1BulkMarkOrdersAsPaidRequest as ic, type V1BulkMarkOrdersAsPaidResponse as id, type V1CreatePaymentGatewayOrderRequest as ie, type V1CreatePaymentGatewayOrderResponse as ig, type GetShipmentsRequest as ih, type GetShipmentsResponse as ii, type AggregateOrdersRequest as ij, type AggregateOrdersResponse as ik, type DecrementItemsQuantityRequest as il, type DecrementData as im, type DecrementItemsQuantityResponse as io, type BulkUpdateOrderTagsRequest as ip, type TagsTags as iq, type TagsTagList as ir, type BulkUpdateOrderTagsResult as is, type SendOrderUpdatedDomainEventRequest as it, type SendOrderUpdatedDomainEventResponse as iu, type Task as iv, type TaskKey as iw, type TaskAction as ix, type TaskActionActionOneOf as iy, type Complete as iz, type CreateOrderApplicationErrors as j, type AuthorizationCaptureStatusWithLiterals as j$, type CalculatedTax as j0, type Payments as j1, type InvoicesPayment as j2, type MetaData as j3, type InvoiceDynamicPriceTotals as j4, type CustomFieldValue as j5, type Value as j6, type Deposit as j7, type BaseEventMetadata as j8, type EventMetadata as j9, type VatTypeWithLiterals as jA, type PickupMethodWithLiterals as jB, type OrderStatusWithLiterals as jC, type DiscountTypeWithLiterals as jD, type DiscountReasonWithLiterals as jE, type LineItemQuantityChangeTypeWithLiterals as jF, type ActivityTypeWithLiterals as jG, type OrderActivityTypeEnumActivityTypeWithLiterals as jH, type AttributionSourceWithLiterals as jI, type ChannelTypeWithLiterals as jJ, type AdditionalFeeSourceWithLiterals as jK, type OrderActionTypeWithLiterals as jL, type SpecificItemsCouponBehaviorWithLiterals as jM, type ChargeTypeWithLiterals as jN, type VersioningModeWithLiterals as jO, type DeltaPaymentOptionTypeWithLiterals as jP, type InventoryActionWithLiterals as jQ, type WebhookIdentityTypeWithLiterals as jR, type ScheduledActionWithLiterals as jS, type DurationUnitWithLiterals as jT, type PaymentCollectabilityStatusWithLiterals as jU, type PredefinedPaymentMethodWithLiterals as jV, type RefundableStatusWithLiterals as jW, type NonRefundableReasonWithLiterals as jX, type ManuallyRefundableReasonWithLiterals as jY, type RestockTypeWithLiterals as jZ, type TransactionStatusWithLiterals as j_, type AccountInfoMetadata as ja, type SetOrderNumberCounterOptions as jb, type RecordManuallyCollectedPaymentOptions as jc, type PaymentCollectionMarkOrderAsPaidOptions as jd, type PaymentCollectionCreatePaymentGatewayOrderOptions as je, type ChargeMembershipsOptions as jf, type TriggerRefundOptions as jg, type OrderSearchSpec as jh, type UpdateOrderLineItemIdentifiers as ji, type UpdateOrderLineItem as jj, type UpdateActivityIdentifiers as jk, type DeleteActivityIdentifiers as jl, type AggregateOrdersOptions as jm, utils as jn, type DescriptionLineTypeWithLiterals as jo, type DimensionsUnitWithLiterals as jp, type ItemTypePresetWithLiterals as jq, type PaymentOptionTypeWithLiterals as jr, type JurisdictionTypeWithLiterals as js, type SubscriptionFrequencyWithLiterals as jt, type ProductPeriodAlignmentWithLiterals as ju, type AdjustmentTypeWithLiterals as jv, type TaxableAddressTypeWithLiterals as jw, type PaymentStatusEnumPaymentStatusWithLiterals as jx, type FulfillmentStatusWithLiterals as jy, type WeightUnitWithLiterals as jz, type UpdateOrderApplicationErrors as k, type AuthorizationVoidStatusWithLiterals as k0, type ReasonWithLiterals as k1, type ActionTypeWithLiterals as k2, type ChargebackStatusWithLiterals as k3, type MembershipPaymentStatusWithLiterals as k4, type PaymentStatusWithLiterals as k5, type CanceledReasonWithLiterals as k6, type DeclinedReasonWithLiterals as k7, type VoidedReasonWithLiterals as k8, type RefundStatusWithLiterals as k9, onOrderCreated as kA, onOrderFulfilled as kB, onOrderPaymentStatusUpdated as kC, onOrderUpdated as kD, preparePaymentCollection as kE, getPaymentCollectabilityStatus as kF, voidAuthorizedPayments as kG, captureAuthorizedPayments as kH, getOrder as kI, createOrder as kJ, updateOrder as kK, bulkUpdateOrders as kL, addActivities as kM, cancelOrder as kN, bulkUpdateOrderTags as kO, type PreviewEmailTypeWithLiterals as ka, type StateWithLiterals as kb, type SiteCreatedContextWithLiterals as kc, type NamespaceWithLiterals as kd, type DeleteStatusWithLiterals as ke, type OriginWithLiterals as kf, type SortOrderWithLiterals as kg, type OrderApprovalStrategyWithLiterals as kh, type PlacementWithLiterals as ki, type SubdivisionTypeWithLiterals as kj, type SourceTypeWithLiterals as kk, type CustomFieldGroupWithLiterals as kl, type ValueTypeWithLiterals as km, type DepositTypeWithLiterals as kn, type InvoiceStatusWithLiterals as ko, type ImportOrderApplicationErrors as kp, type SetOrderNumberCounterApplicationErrors as kq, type RecordManuallyCollectedPaymentApplicationErrors as kr, type PaymentCollectionMarkOrderAsPaidApplicationErrors as ks, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kt, type TriggerRefundApplicationErrors as ku, type UpdateOrderStatusApplicationErrors as kv, type CommonSearchWithEntityContext as kw, onOrderApproved as kx, onOrderCanceled as ky, onOrderCommitted as kz, type BulkUpdateOrdersResponse as l, type AddActivitiesResponse as m, type CancelOrderOptions as n, type CancelOrderResponse as o, type CancelOrderApplicationErrors as p, type BulkUpdateOrderTagsOptions as q, type BulkUpdateOrderTagsResponse as r, type OrderApprovedEnvelope as s, type OrderCanceledEnvelope as t, type OrderCommittedEnvelope as u, type OrderCreatedEnvelope as v, type OrderFulfilledEnvelope as w, type OrderPaymentStatusUpdatedEnvelope as x, type OrderUpdatedEnvelope as y, DimensionsUnit as z };
8915
+ export { LineItemQuantityChangeType as $, type AddActivitiesOptions as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, PaymentOptionType as E, SubscriptionFrequency as F, type GetPaymentCollectabilityStatusResponse as G, ProductPeriodAlignment as H, ItemTypePreset as I, JurisdictionType as J, AdjustmentType as K, MeasurementUnit as L, type MaskedOrder as M, PaymentStatusEnumPaymentStatus as N, type Order as O, type Price as P, FulfillmentStatus as Q, VatType as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, PickupMethod as X, OrderStatus as Y, DiscountType as Z, DiscountReason as _, type PreparePaymentCollectionOptions as a, type LineItemTaxInfo as a$, ActivityType as a0, OrderActivityTypeEnumActivityType as a1, AttributionSource as a2, ChannelType as a3, AdditionalFeeSource as a4, OrderActionType as a5, SpecificItemsCouponBehavior as a6, ChargeType as a7, VersioningMode as a8, DeltaPaymentOptionType as a9, VoidedReason as aA, RefundStatus as aB, SortOrder as aC, OrderApprovalStrategy as aD, Placement as aE, SubdivisionType as aF, SourceType as aG, CustomFieldGroup as aH, ValueType as aI, DepositType as aJ, InvoiceStatus as aK, type OrderLineItem as aL, type ProductName as aM, type CatalogReference as aN, type DescriptionLine as aO, type DescriptionLineValueOneOf as aP, type DescriptionLineDescriptionLineValueOneOf as aQ, type DescriptionLineName as aR, type PlainTextValue as aS, type Color as aT, type FocalPoint as aU, type PhysicalProperties as aV, type Dimensions as aW, type ItemType as aX, type ItemTypeItemTypeDataOneOf as aY, type RestockLocation as aZ, type ItemTaxFullDetails as a_, InventoryAction as aa, WebhookIdentityType as ab, PreviewEmailType as ac, State as ad, SiteCreatedContext as ae, Namespace as af, DeleteStatus as ag, Origin as ah, ScheduledAction as ai, DurationUnit as aj, PaymentCollectabilityStatus as ak, PredefinedPaymentMethod as al, RefundableStatus as am, NonRefundableReason as an, ManuallyRefundableReason as ao, RestockType as ap, TransactionStatus as aq, AuthorizationCaptureStatus as ar, AuthorizationVoidStatus as as, Reason as at, ActionType as au, ChargebackStatus as av, MembershipPaymentStatus as aw, PaymentStatus as ax, CanceledReason as ay, DeclinedReason as az, type PreparePaymentCollectionResponse as b, type LineItemQuantityChange as b$, type LineItemTaxBreakdown as b0, type DigitalFile as b1, type SubscriptionInfo as b2, type SubscriptionTitle as b3, type SubscriptionDescription as b4, type SubscriptionSettings as b5, type FreeTrialPeriod as b6, type BillingSettings as b7, type BillingAdjustment as b8, type BillingAdjustmentPriceSummary as b9, type ShippingPrice as bA, type ShippingRegion as bB, type TaxSummary as bC, type OrderTaxInfo as bD, type OrderTaxBreakdown as bE, type AppliedDiscount as bF, type AppliedDiscountDiscountSourceOneOf as bG, type Coupon as bH, type MerchantDiscount as bI, type MerchantDiscountMerchantDiscountReasonOneOf as bJ, type DiscountRule as bK, type DiscountRuleName as bL, type LineItemDiscount as bM, type ItemCombination as bN, type ItemCombinationLineItem as bO, type Activity as bP, type ActivityContentOneOf as bQ, type CustomActivity as bR, type MerchantComment as bS, type OrderRefunded as bT, type OrderCreatedFromExchange as bU, type NewExchangeOrderCreated as bV, type LineItemExchangeData as bW, type DraftOrderChangesApplied as bX, type OrderChange as bY, type OrderChangeValueOneOf as bZ, type LineItemChanges as b_, type PriceDescription as ba, type LocationAndQuantity as bb, type TaxableAddress as bc, type TaxableAddressTaxableAddressDataOneOf as bd, type DecimalQuantity as be, type DecimalQuantityUnitOneOf as bf, type TranslatableString as bg, type ExtendedFields as bh, type ModifierGroup as bi, type ItemModifier as bj, type BuyerInfo as bk, type BuyerInfoIdOneOf as bl, type CurrencyConversionDetails as bm, type PriceSummary as bn, type AddressWithContact as bo, type Address as bp, type StreetAddress as bq, type AddressLocation as br, type FullAddressContactDetails as bs, type VatId as bt, type V1ShippingInformation as bu, type DeliveryLogistics as bv, type DeliveryLogisticsAddressOneOf as bw, type PickupDetails as bx, type PickupAddress as by, type DeliveryTimeSlot as bz, type PreparePaymentCollectionApplicationErrors as c, type UpdateInternalDocumentsEvent as c$, type LineItemPriceChange as c0, type LineItemProductNameChange as c1, type LineItemDescriptionLineChange as c2, type LineItemModifiersChange as c3, type ManagedLineItem as c4, type ManagedDiscount as c5, type TranslatedValue as c6, type LineItemAmount as c7, type ManagedAdditionalFee as c8, type TotalPriceChange as c9, type WixReceipt as cA, type ExternalReceipt as cB, type ReceiptSent as cC, type ReceiptSentReceiptInfoOneOf as cD, type ChargebackCreated as cE, type ChargebackReversed as cF, type CreatedBy as cG, type CreatedByStringOneOf as cH, type ChannelInfo as cI, type CustomField as cJ, type BalanceSummary as cK, type Balance as cL, type CashRounding as cM, type AdditionalFee as cN, type FulfillmentStatusesAggregate as cO, type Tags as cP, type TagList as cQ, type Location as cR, type OrderSettings as cS, type OrderSettingsAllowedActionsOneOf as cT, type OrderSettingsEditableByOneOf as cU, type CustomAllowedActions as cV, type OwnerApps as cW, type FormInfo as cX, type FormIdentifier as cY, type PlatformFeeSummary as cZ, type PlatformFee as c_, type ShippingInformationChange as ca, type ShippingInformation as cb, type SavedPaymentMethod as cc, type AuthorizedPaymentCreated as cd, type AuthorizedPaymentCaptured as ce, type AuthorizedPaymentVoided as cf, type RefundInitiated as cg, type RefundedPayment as ch, type RefundedPaymentKindOneOf as ci, type RegularPaymentRefund as cj, type GiftCardPaymentRefund as ck, type MembershipPaymentRefund as cl, type PaymentRefunded as cm, type PaymentRefundFailed as cn, type RefundedAsStoreCredit as co, type PaymentPending as cp, type PaymentPendingPaymentDetailsOneOf as cq, type RegularPayment as cr, type RegularPaymentPaymentMethodDetailsOneOf as cs, type CreditCardDetails as ct, type PaymentCanceled as cu, type PaymentCanceledPaymentDetailsOneOf as cv, type PaymentDeclined as cw, type PaymentDeclinedPaymentDetailsOneOf as cx, type ReceiptCreated as cy, type ReceiptCreatedReceiptInfoOneOf as cz, type VoidAuthorizedPaymentsApplicationErrors as d, type SendBuyerShippingConfirmationEmailRequest as d$, type UpdateInternalDocumentsEventOperationOneOf as d0, type InternalDocument as d1, type InternalDocumentUpdateOperation as d2, type DeleteByIdsOperation as d3, type DeleteByFilterOperation as d4, type InternalDocumentUpdateByFilterOperation as d5, type InternalUpdateExistingOperation as d6, type VersionedDocumentUpdateOperation as d7, type VersionedDeleteByIdsOperation as d8, type VersionedDocumentId as d9, type DomainEvent as dA, type DomainEventBodyOneOf as dB, type EntityCreatedEvent as dC, type RestoreInfo as dD, type EntityUpdatedEvent as dE, type EntityDeletedEvent as dF, type ActionEvent as dG, type Empty as dH, type TriggerReindexOrderRequest as dI, type MessageEnvelope as dJ, type IdentificationData as dK, type IdentificationDataIdOneOf as dL, type AccountInfo as dM, type ImportOrderRequest as dN, type ImportOrderResponse as dO, type SetOrderNumberCounterRequest as dP, type SetOrderNumberCounterResponse as dQ, type BulkDeleteImportedOrdersRequest as dR, type BulkDeleteImportedOrdersResponse as dS, type SendBuyerConfirmationEmailRequest as dT, type SendBuyerConfirmationEmailResponse as dU, type SendBuyerPaymentsReceivedEmailRequest as dV, type SendBuyerPaymentsReceivedEmailResponse as dW, type SendBuyerPickupConfirmationEmailRequest as dX, type SendBuyerPickupConfirmationEmailResponse as dY, type BulkSendBuyerPickupConfirmationEmailsRequest as dZ, type BulkSendBuyerPickupConfirmationEmailsResponse as d_, type OrderApproved as da, type OrdersExperiments as db, type OrderRejectedEventOrderRejected as dc, type OrderItemsRestocked as dd, type V1RestockItem as de, type OrderImported as df, type ImportedOrderDeleted as dg, type PaymentStatusUpdated as dh, type FulfillmentStatusUpdated as di, type OrderCanceledEventOrderCanceled as dj, type OrderDeltasCommitted as dk, type CommittedDiffs as dl, type CommittedDiffsShippingUpdateInfoOneOf as dm, type ItemChangedDetails as dn, type OrderLineItemChangedDetails as dp, type LineItemDelta as dq, type LineItemDeltaDeltaOneOf as dr, type AppliedDiscountDelta as ds, type AppliedDiscountDeltaDeltaOneOf as dt, type AdditionalFeeDelta as du, type AdditionalFeeDeltaDeltaOneOf as dv, type DraftOrderCommitSettings as dw, type InventoryUpdateDetails as dx, type TriggerReindexRequest as dy, type TriggerReindexResponse as dz, type PaymentCapture as e, type StudioTwoAssigned as e$, type SendBuyerShippingConfirmationEmailResponse as e0, type BulkSendBuyerShippingConfirmationEmailsRequest as e1, type BulkSendBuyerShippingConfirmationEmailsResponse as e2, type SendMerchantOrderReceivedNotificationRequest as e3, type SendMerchantOrderReceivedNotificationResponse as e4, type SendCancelRefundEmailRequest as e5, type SendCancelRefundEmailResponse as e6, type SendRefundEmailRequest as e7, type SendRefundEmailResponse as e8, type SendFulfillmentEmailRequest as e9, type MetaSiteSpecialEvent as eA, type MetaSiteSpecialEventPayloadOneOf as eB, type Asset as eC, type SiteCreated as eD, type SiteTransferred as eE, type SiteDeleted as eF, type DeleteContext as eG, type SiteUndeleted as eH, type SitePublished as eI, type SiteUnpublished as eJ, type SiteMarkedAsTemplate as eK, type SiteMarkedAsWixSite as eL, type ServiceProvisioned as eM, type ServiceRemoved as eN, type SiteRenamed as eO, type SiteHardDeleted as eP, type NamespaceChanged as eQ, type StudioAssigned as eR, type StudioUnassigned as eS, type SiteUrlChanged as eT, type SitePurgedExternally as eU, type OdeditorAssigned as eV, type OdeditorUnassigned as eW, type PicassoAssigned as eX, type PicassoUnassigned as eY, type WixelAssigned as eZ, type WixelUnassigned as e_, type SendFulfillmentEmailResponse as ea, type SendMerchantOrderReceivedPushRequest as eb, type SendMerchantOrderReceivedPushResponse as ec, type PreviewEmailByTypeRequest as ed, type PreviewEmailByTypeResponse as ee, type PreviewRefundEmailRequest as ef, type RefundDetails as eg, type RefundItem as eh, type LineItemRefund as ei, type AdditionalFeeRefund as ej, type ShippingRefund as ek, type PreviewRefundEmailResponse as el, type PreviewCancelEmailRequest as em, type PreviewCancelEmailResponse as en, type PreviewCancelRefundEmailRequest as eo, type PreviewCancelRefundEmailResponse as ep, type PreviewBuyerPaymentsReceivedEmailRequest as eq, type PreviewBuyerPaymentsReceivedEmailResponse as er, type PreviewBuyerConfirmationEmailRequest as es, type PreviewBuyerConfirmationEmailResponse as et, type PreviewBuyerPickupConfirmationEmailRequest as eu, type PreviewBuyerPickupConfirmationEmailResponse as ev, type PreviewShippingConfirmationEmailRequest as ew, type PreviewShippingConfirmationEmailResponse as ex, type PreviewResendDownloadLinksEmailRequest as ey, type PreviewResendDownloadLinksEmailResponse as ez, type CaptureAuthorizedPaymentsApplicationErrors as f, type WixReceiptInfo as f$, type StudioTwoUnassigned as f0, type UserDomainMediaEnabled as f1, type UserDomainMediaDisabled as f2, type EditorlessAssigned as f3, type EditorlessUnassigned as f4, type HasCustomEmailConfigurationsRequest as f5, type HasCustomEmailConfigurationsResponse as f6, type AddToAutomationMigrationPopulationRequest as f7, type AddToAutomationMigrationPopulationResponse as f8, type IsInAutomationMigrationPopulationRequest as f9, type MembershipChargeItem as fA, type MembershipName as fB, type ServiceProperties as fC, type ChargeMembershipsResponse as fD, type TriggerRefundRequest as fE, type PaymentRefund as fF, type RefundSideEffects as fG, type RestockInfo as fH, type RestockItem as fI, type TriggerRefundResponse as fJ, type OrderTransactions as fK, type Payment as fL, type PaymentPaymentDetailsOneOf as fM, type PaymentReceiptInfoOneOf as fN, type RegularPaymentDetails as fO, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fP, type CreditCardPaymentMethodDetails as fQ, type AuthorizationDetails as fR, type AuthorizationCapture as fS, type AuthorizationActionFailureDetails as fT, type AuthorizationVoid as fU, type V1ScheduledAction as fV, type Chargeback as fW, type PaymentMethodName as fX, type GiftCardPaymentDetails as fY, type MembershipPaymentDetails as fZ, type FutureMembershipDetails as f_, type IsInAutomationMigrationPopulationResponse as fa, type PreparePaymentCollectionRequest as fb, type RedirectUrls as fc, type DelayedCaptureSettings as fd, type Duration as fe, type GetPaymentCollectabilityStatusRequest as ff, type RecordManuallyCollectedPaymentRequest as fg, type UserDefinedPaymentMethodName as fh, type UserDefinedPaymentMethodNameKindOneOf as fi, type RecordManuallyCollectedPaymentResponse as fj, type MarkOrderAsPaidRequest as fk, type MarkOrderAsPaidResponse as fl, type BulkMarkOrdersAsPaidRequest as fm, type BulkMarkOrdersAsPaidResponse as fn, type BulkOrderResult as fo, type ItemMetadata as fp, type ApplicationError as fq, type BulkActionMetadata as fr, type GetRefundabilityStatusRequest as fs, type GetRefundabilityStatusResponse as ft, type Refundability as fu, type RefundabilityAdditionalRefundabilityInfoOneOf as fv, type CreatePaymentGatewayOrderRequest as fw, type ChargedBy as fx, type CreatePaymentGatewayOrderResponse as fy, type ChargeMembershipsRequest as fz, type GetOrderApplicationErrors as g, type BulkArchiveOrdersResponse as g$, type ExternalReceiptInfo as g0, type CashRoundingDetails as g1, type PaymentStatusDetails as g2, type PaymentStatusDetailsStatusDetailsOneOf as g3, type CanceledStatusDetails as g4, type DeclinedStatusDetails as g5, type VoidedStatusDetails as g6, type Refund as g7, type RefundTransaction as g8, type RefundStatusInfo as g9, type Cursors as gA, type QueryOrderRequest as gB, type QueryOrderResponse as gC, type SearchOrdersRequest as gD, type CursorSearch as gE, type CursorSearchPagingMethodOneOf as gF, type CursorPagingMetadata as gG, type CreateOrderRequest as gH, type OrderCreationSettings as gI, type OrderCreationSettingsEditableByOneOf as gJ, type OrderCreateNotifications as gK, type CreateOrderResponse as gL, type UpdateOrderRequest as gM, type UpdateOrderResponse as gN, type BulkUpdateOrdersRequest as gO, type CommitDeltasRequest as gP, type DraftOrderDiffs as gQ, type DraftOrderDiffsShippingUpdateInfoOneOf as gR, type DraftOrderDiffsBuyerUpdateInfoOneOf as gS, type DraftOrderDiffsBillingUpdateInfoOneOf as gT, type DraftOrderDiffsRecipientUpdateInfoOneOf as gU, type V1LineItemDelta as gV, type V1LineItemDeltaDeltaOneOf as gW, type CommitDeltasResponse as gX, type ArchiveOrderRequest as gY, type ArchiveOrderResponse as gZ, type BulkArchiveOrdersRequest as g_, type AggregatedRefundSummary as ga, type RefundItemsBreakdown as gb, type LineItemRefundSummary as gc, type CalculateRefundRequest as gd, type CalculateRefundItemRequest as ge, type CalculateRefundResponse as gf, type CalculateRefundItemResponse as gg, type VoidAuthorizedPaymentsRequest as gh, type CaptureAuthorizedPaymentsRequest as gi, type ChargeSavedPaymentMethodRequest as gj, type ChargeSavedPaymentMethodResponse as gk, type V1TriggerReindexRequest as gl, type V1TriggerReindexResponse as gm, type V1TriggerReindexOrderRequest as gn, type DiffmatokyPayload as go, type ErrorInformation as gp, type GetOrderRequest as gq, type GetOrderResponse as gr, type InternalQueryOrdersRequest as gs, type PlatformQuery as gt, type PlatformQueryPagingMethodOneOf as gu, type Sorting as gv, type PlatformPaging as gw, type CursorPaging as gx, type InternalQueryOrdersResponse as gy, type PlatformPagingMetadata as gz, type OrderSearch as h, type MarkAsFulfilledResponse as h$, type BulkArchiveOrdersByFilterRequest as h0, type BulkArchiveOrdersByFilterResponse as h1, type UnArchiveOrderRequest as h2, type UnArchiveOrderResponse as h3, type BulkUnArchiveOrdersRequest as h4, type BulkUnArchiveOrdersResponse as h5, type BulkUnArchiveOrdersByFilterRequest as h6, type BulkUnArchiveOrdersByFilterResponse as h7, type UpdateBuyerInfoRequest as h8, type BuyerInfoUpdate as h9, type InvoiceSent as hA, type FulfillerEmailSent as hB, type ShippingAddressEdited as hC, type EmailEdited as hD, type PickupReadyEmailSent as hE, type OrderPartiallyPaid as hF, type OrderPending as hG, type OrderRejected as hH, type AddInternalActivityResponse as hI, type AddActivityRequest as hJ, type PublicActivity as hK, type PublicActivityContentOneOf as hL, type AddActivityResponse as hM, type AddActivitiesRequest as hN, type UpdateActivityRequest as hO, type UpdateActivityResponse as hP, type DeleteActivityRequest as hQ, type DeleteActivityResponse as hR, type UpdateLineItemsDescriptionLinesRequest as hS, type LineItemUpdate as hT, type UpdateLineItemsDescriptionLinesResponse as hU, type MarkOrderAsSeenByHumanRequest as hV, type MarkOrderAsSeenByHumanResponse as hW, type CancelOrderRequest as hX, type UpdateOrderStatusRequest as hY, type UpdateOrderStatusResponse as hZ, type MarkAsFulfilledRequest as h_, type UpdateBuyerInfoResponse as ha, type UpdateBuyerEmailRequest as hb, type UpdateBuyerEmailResponse as hc, type UpdateOrderShippingAddressRequest as hd, type UpdateOrderShippingAddressResponse as he, type UpdateBillingContactDetailsRequest as hf, type UpdateBillingContactDetailsResponse as hg, type UpdateOrderLineItemRequest as hh, type UpdateOrderLineItemResponse as hi, type UpdateOrderLineItemsRequest as hj, type MaskedOrderLineItem as hk, type UpdateOrderLineItemsResponse as hl, type AddInternalActivityRequest as hm, type InternalActivity as hn, type InternalActivityContentOneOf as ho, type OrderPlaced as hp, type OrderPaid as hq, type OrderFulfilled as hr, type OrderNotFulfilled as hs, type OrderCanceled as ht, type DownloadLinkSent as hu, type TrackingNumberAdded as hv, type TrackingNumberEdited as hw, type TrackingLinkAdded as hx, type ShippingConfirmationEmailSent as hy, type InvoiceAdded as hz, type CreateOrderOptions as i, type ItemizedFee as i$, type BulkMarkAsFulfilledRequest as i0, type BulkMarkAsFulfilledResponse as i1, type BulkMarkAsFulfilledByFilterRequest as i2, type BulkMarkAsFulfilledByFilterResponse as i3, type MarkAsUnfulfilledRequest as i4, type MarkAsUnfulfilledResponse as i5, type BulkMarkAsUnfulfilledRequest as i6, type BulkMarkAsUnfulfilledResponse as i7, type BulkMarkAsUnfulfilledByFilterRequest as i8, type BulkMarkAsUnfulfilledByFilterResponse as i9, type TaskAction as iA, type TaskActionActionOneOf as iB, type Complete as iC, type Cancel as iD, type Reschedule as iE, type InvoiceSentEvent as iF, type IdAndVersion as iG, type InvoiceFields as iH, type Customer as iI, type Email as iJ, type QuotesAddress as iK, type AddressDescription as iL, type Phone as iM, type Company as iN, type CommonAddress as iO, type CommonAddressStreetOneOf as iP, type Subdivision as iQ, type StandardDetails as iR, type InvoiceDates as iS, type LineItems as iT, type LineItem as iU, type BigDecimalWrapper as iV, type LineItemTax as iW, type Source as iX, type LineItemMetaData as iY, type Locale as iZ, type TotalPrice as i_, type BulkSetBusinessLocationRequest as ia, type BulkSetBusinessLocationResponse as ib, type BulkSetBusinessLocationResult as ic, type V1MarkOrderAsPaidRequest as id, type V1MarkOrderAsPaidResponse as ie, type V1BulkMarkOrdersAsPaidRequest as ig, type V1BulkMarkOrdersAsPaidResponse as ih, type V1CreatePaymentGatewayOrderRequest as ii, type V1CreatePaymentGatewayOrderResponse as ij, type GetShipmentsRequest as ik, type GetShipmentsResponse as il, type AggregateOrdersRequest as im, type AggregateOrdersResponse as io, type DecrementItemsQuantityRequest as ip, type DecrementData as iq, type DecrementItemsQuantityResponse as ir, type BulkUpdateOrderTagsRequest as is, type TagsTags as it, type TagsTagList as iu, type BulkUpdateOrderTagsResult as iv, type SendOrderUpdatedDomainEventRequest as iw, type SendOrderUpdatedDomainEventResponse as ix, type Task as iy, type TaskKey as iz, type CreateOrderApplicationErrors as j, type OriginWithLiterals as j$, type Discount as j0, type DiscountOneDiscountTypeOneOf as j1, type CalculatedTaxes as j2, type CalculatedTax as j3, type Payments as j4, type InvoicesPayment as j5, type MetaData as j6, type InvoiceDynamicPriceTotals as j7, type CustomFieldValue as j8, type Value as j9, type MeasurementUnitWithLiterals as jA, type PaymentStatusEnumPaymentStatusWithLiterals as jB, type FulfillmentStatusWithLiterals as jC, type WeightUnitWithLiterals as jD, type VatTypeWithLiterals as jE, type PickupMethodWithLiterals as jF, type OrderStatusWithLiterals as jG, type DiscountTypeWithLiterals as jH, type DiscountReasonWithLiterals as jI, type LineItemQuantityChangeTypeWithLiterals as jJ, type ActivityTypeWithLiterals as jK, type OrderActivityTypeEnumActivityTypeWithLiterals as jL, type AttributionSourceWithLiterals as jM, type ChannelTypeWithLiterals as jN, type AdditionalFeeSourceWithLiterals as jO, type OrderActionTypeWithLiterals as jP, type SpecificItemsCouponBehaviorWithLiterals as jQ, type ChargeTypeWithLiterals as jR, type VersioningModeWithLiterals as jS, type DeltaPaymentOptionTypeWithLiterals as jT, type InventoryActionWithLiterals as jU, type WebhookIdentityTypeWithLiterals as jV, type PreviewEmailTypeWithLiterals as jW, type StateWithLiterals as jX, type SiteCreatedContextWithLiterals as jY, type NamespaceWithLiterals as jZ, type DeleteStatusWithLiterals as j_, type Deposit as ja, type BaseEventMetadata as jb, type EventMetadata as jc, type AccountInfoMetadata as jd, type SetOrderNumberCounterOptions as je, type RecordManuallyCollectedPaymentOptions as jf, type PaymentCollectionMarkOrderAsPaidOptions as jg, type PaymentCollectionCreatePaymentGatewayOrderOptions as jh, type ChargeMembershipsOptions as ji, type TriggerRefundOptions as jj, type OrderSearchSpec as jk, type UpdateOrderLineItemIdentifiers as jl, type UpdateOrderLineItem as jm, type UpdateActivityIdentifiers as jn, type DeleteActivityIdentifiers as jo, type AggregateOrdersOptions as jp, utils as jq, type DescriptionLineTypeWithLiterals as jr, type DimensionsUnitWithLiterals as js, type ItemTypePresetWithLiterals as jt, type PaymentOptionTypeWithLiterals as ju, type JurisdictionTypeWithLiterals as jv, type SubscriptionFrequencyWithLiterals as jw, type ProductPeriodAlignmentWithLiterals as jx, type AdjustmentTypeWithLiterals as jy, type TaxableAddressTypeWithLiterals as jz, type UpdateOrderApplicationErrors as k, type ScheduledActionWithLiterals as k0, type DurationUnitWithLiterals as k1, type PaymentCollectabilityStatusWithLiterals as k2, type PredefinedPaymentMethodWithLiterals as k3, type RefundableStatusWithLiterals as k4, type NonRefundableReasonWithLiterals as k5, type ManuallyRefundableReasonWithLiterals as k6, type RestockTypeWithLiterals as k7, type TransactionStatusWithLiterals as k8, type AuthorizationCaptureStatusWithLiterals as k9, type CommonSearchWithEntityContext as kA, onOrderApproved as kB, onOrderCanceled as kC, onOrderCommitted as kD, onOrderCreated as kE, onOrderFulfilled as kF, onOrderPaymentStatusUpdated as kG, onOrderUpdated as kH, preparePaymentCollection as kI, getPaymentCollectabilityStatus as kJ, voidAuthorizedPayments as kK, captureAuthorizedPayments as kL, getOrder as kM, createOrder as kN, updateOrder as kO, bulkUpdateOrders as kP, addActivities as kQ, cancelOrder as kR, bulkUpdateOrderTags as kS, type AuthorizationVoidStatusWithLiterals as ka, type ReasonWithLiterals as kb, type ActionTypeWithLiterals as kc, type ChargebackStatusWithLiterals as kd, type MembershipPaymentStatusWithLiterals as ke, type PaymentStatusWithLiterals as kf, type CanceledReasonWithLiterals as kg, type DeclinedReasonWithLiterals as kh, type VoidedReasonWithLiterals as ki, type RefundStatusWithLiterals as kj, type SortOrderWithLiterals as kk, type OrderApprovalStrategyWithLiterals as kl, type PlacementWithLiterals as km, type SubdivisionTypeWithLiterals as kn, type SourceTypeWithLiterals as ko, type CustomFieldGroupWithLiterals as kp, type ValueTypeWithLiterals as kq, type DepositTypeWithLiterals as kr, type InvoiceStatusWithLiterals as ks, type ImportOrderApplicationErrors as kt, type SetOrderNumberCounterApplicationErrors as ku, type RecordManuallyCollectedPaymentApplicationErrors as kv, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kw, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kx, type TriggerRefundApplicationErrors as ky, type UpdateOrderStatusApplicationErrors as kz, type BulkUpdateOrdersResponse as l, type AddActivitiesResponse as m, type CancelOrderOptions as n, type CancelOrderResponse as o, type CancelOrderApplicationErrors as p, type BulkUpdateOrderTagsOptions as q, type BulkUpdateOrderTagsResponse as r, type OrderApprovedEnvelope as s, type OrderCanceledEnvelope as t, type OrderCommittedEnvelope as u, type OrderCreatedEnvelope as v, type OrderFulfilledEnvelope as w, type OrderPaymentStatusUpdatedEnvelope as x, type OrderUpdatedEnvelope as y, DimensionsUnit as z };