@wix/auto_sdk_ecom_orders 1.0.252 → 1.0.254

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