@wix/auto_sdk_ecom_orders 1.0.252 → 1.0.253

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