@wix/auto_sdk_ecom_orders 1.0.304 → 1.0.306

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