@wix/auto_sdk_ecom_orders 1.0.308 → 1.0.309

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