@wix/auto_sdk_ecom_orders 1.0.306 → 1.0.307

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