@wix/auto_sdk_ecom_orders 1.0.330 → 1.0.332

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