@wix/auto_sdk_ecom_orders 1.0.327 → 1.0.328

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