@wix/auto_sdk_ecom_orders 1.0.322 → 1.0.323

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