@wix/auto_sdk_ecom_orders 1.0.279 → 1.0.281

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 (41) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-CYkv7meU.d.ts → ecom-v1-order-orders.universal-CRdLHWV5.d.ts} +1637 -1639
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +79 -79
  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 +79 -79
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1638 -1638
  9. package/build/cjs/meta.js +79 -79
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-CYkv7meU.d.mts → ecom-v1-order-orders.universal-CRdLHWV5.d.mts} +1637 -1639
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +79 -79
  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 +79 -79
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1638 -1638
  19. package/build/es/meta.mjs +79 -79
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-NjFLhvro.d.ts → ecom-v1-order-orders.universal-l9fropDd.d.ts} +1792 -1794
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.js +79 -79
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +2 -2
  26. package/build/internal/cjs/index.typings.js +79 -79
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +1792 -1792
  29. package/build/internal/cjs/meta.js +79 -79
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/internal/es/{ecom-v1-order-orders.universal-NjFLhvro.d.mts → ecom-v1-order-orders.universal-l9fropDd.d.mts} +1792 -1794
  32. package/build/internal/es/index.d.mts +2 -2
  33. package/build/internal/es/index.mjs +79 -79
  34. package/build/internal/es/index.mjs.map +1 -1
  35. package/build/internal/es/index.typings.d.mts +2 -2
  36. package/build/internal/es/index.typings.mjs +79 -79
  37. package/build/internal/es/index.typings.mjs.map +1 -1
  38. package/build/internal/es/meta.d.mts +1792 -1792
  39. package/build/internal/es/meta.mjs +79 -79
  40. package/build/internal/es/meta.mjs.map +1 -1
  41. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { em as ImportOrderRequest$1, I as ImportOrderResponse$1, en as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eo as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fJ as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fN as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fO as RecordManuallyCollectedPaymentRequest$1, fR as RecordManuallyCollectedPaymentResponse$1, fS as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, fT as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, fY as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, f$ as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, g1 as ChargeMembershipsRequest$1, g5 as ChargeMembershipsResponse$1, g6 as TriggerRefundRequest$1, p as TriggerRefundResponse$1, gK as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gL as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, gT as GetOrderRequest$1, gU as GetOrderResponse$1, h4 as SearchOrdersRequest$1, x as SearchOrdersResponse$1, h8 as CreateOrderRequest$1, hc as CreateOrderResponse$1, hd as UpdateOrderRequest$1, he as UpdateOrderResponse$1, hf as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hK as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, i9 as AddActivityRequest$1, N as AddActivityResponse$1, ib as AddActivitiesRequest$1, W as AddActivitiesResponse$1, ic as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, id as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, ik as CancelOrderRequest$1, a0 as CancelOrderResponse$1, il as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iK as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iO as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-NjFLhvro.mjs';
1
+ import { en as ImportOrderRequest$1, I as ImportOrderResponse$1, eo as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, ep as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, et as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, ex as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, ey as RecordManuallyCollectedPaymentRequest$1, eB as RecordManuallyCollectedPaymentResponse$1, eC as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, eD as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, eI as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, eL as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, eN as ChargeMembershipsRequest$1, eQ as ChargeMembershipsResponse$1, eR as TriggerRefundRequest$1, p as TriggerRefundResponse$1, fy as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fz as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, gT as GetOrderRequest$1, gU as GetOrderResponse$1, h4 as SearchOrdersRequest$1, x as SearchOrdersResponse$1, h8 as CreateOrderRequest$1, hc as CreateOrderResponse$1, hd as UpdateOrderRequest$1, he as UpdateOrderResponse$1, hf as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hK as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, i9 as AddActivityRequest$1, N as AddActivityResponse$1, ib as AddActivitiesRequest$1, W as AddActivitiesResponse$1, ic as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, id as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, ik as CancelOrderRequest$1, a0 as CancelOrderResponse$1, il as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iK as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iO as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-l9fropDd.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -1295,6 +1295,25 @@ interface ItemModifier {
1295
1295
  /** The price of the modifier. */
1296
1296
  price?: Price;
1297
1297
  }
1298
+ interface ServiceProperties {
1299
+ /**
1300
+ * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
1301
+ * For example, the start time of a class.
1302
+ */
1303
+ scheduledDate?: Date | null;
1304
+ /**
1305
+ * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
1306
+ * @min 1
1307
+ * @max 10000
1308
+ */
1309
+ numberOfParticipants?: number | null;
1310
+ /**
1311
+ * Date and time the service is to be ended, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
1312
+ * For example, the date and time a class will end.
1313
+ * @internal
1314
+ */
1315
+ endDate?: Date | null;
1316
+ }
1298
1317
  /** Buyer information. */
1299
1318
  interface BuyerInfo extends BuyerInfoIdOneOf {
1300
1319
  /**
@@ -4471,1564 +4490,1243 @@ interface BulkDeleteImportedOrdersResponse {
4471
4490
  */
4472
4491
  jobId?: string;
4473
4492
  }
4474
- interface SendBuyerConfirmationEmailRequest {
4493
+ interface V1TriggerReindexRequest {
4475
4494
  /** @format GUID */
4476
- orderId?: string;
4477
- }
4478
- interface SendBuyerConfirmationEmailResponse {
4479
- }
4480
- interface SendBuyerPaymentsReceivedEmailRequest {
4495
+ metasiteId?: string;
4481
4496
  /**
4482
4497
  * @minLength 1
4483
4498
  * @maxLength 100
4499
+ * @maxSize 100
4484
4500
  */
4485
- orderId?: string;
4501
+ orderIds?: string[];
4486
4502
  }
4487
- interface SendBuyerPaymentsReceivedEmailResponse {
4503
+ interface V1TriggerReindexResponse {
4488
4504
  }
4489
- interface SendBuyerPickupConfirmationEmailRequest {
4505
+ interface V1TriggerReindexOrderRequest {
4506
+ /** @format GUID */
4507
+ metasiteId?: string;
4490
4508
  /**
4491
4509
  * @minLength 1
4492
4510
  * @maxLength 100
4493
4511
  */
4494
4512
  orderId?: string;
4495
4513
  }
4496
- interface SendBuyerPickupConfirmationEmailResponse {
4497
- }
4498
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
4499
- /**
4500
- * IDs of orders to send pickup emails for.
4501
- * @minSize 1
4502
- * @maxSize 300
4503
- */
4504
- orderIds?: string[];
4505
- }
4506
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
4507
- }
4508
- interface SendBuyerShippingConfirmationEmailRequest {
4514
+ interface PreparePaymentCollectionRequest {
4509
4515
  /**
4516
+ * Ecom order ID.
4510
4517
  * @minLength 1
4511
4518
  * @maxLength 100
4512
4519
  */
4513
- orderId?: string;
4514
- }
4515
- interface SendBuyerShippingConfirmationEmailResponse {
4516
- }
4517
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
4520
+ ecomOrderId: string;
4521
+ /** Amount to collect */
4522
+ amount: Price;
4518
4523
  /**
4519
- * IDs of orders to send pickup emails for.
4520
- * @minSize 1
4521
- * @maxSize 300
4524
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4525
+ * Existing payment gateway order will be updated with a new amount.
4526
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4522
4527
  */
4523
- orderIds?: string[];
4524
- }
4525
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
4526
- }
4527
- interface SendMerchantOrderReceivedNotificationRequest {
4528
+ paymentGatewayOrderId?: string | null;
4528
4529
  /**
4529
- * @minLength 1
4530
- * @maxLength 100
4530
+ * Whether to delay capture of the payment.
4531
+ * Default: false
4532
+ * @deprecated Whether to delay capture of the payment.
4533
+ * Default: false
4534
+ * @replacedBy delayed_capture_settings.scheduled_action
4535
+ * @targetRemovalDate 2024-09-30
4531
4536
  */
4532
- orderId?: string;
4533
- }
4534
- interface SendMerchantOrderReceivedNotificationResponse {
4535
- }
4536
- interface SendCancelRefundEmailRequest {
4537
+ delayedCapture?: boolean;
4537
4538
  /**
4538
- * The ID of order that is canceled/refunded
4539
- * @minLength 1
4540
- * @maxLength 100
4539
+ * Specifies whether payment collection is initiated by Merchant or User of User
4540
+ * Default: `true`
4541
+ * @internal
4541
4542
  */
4542
- orderId?: string;
4543
+ merchantInitiated?: boolean | null;
4543
4544
  /**
4544
- * Personal note added to the email (optional)
4545
- * @minLength 1
4546
- * @maxLength 1000
4545
+ * Redirect urls which are used to return buyer to third party system.
4546
+ * @internal
4547
4547
  */
4548
- customMessage?: string | null;
4549
- /** Refund amount */
4550
- refundAmount?: Price;
4548
+ redirectUrls?: RedirectUrls;
4549
+ /** Delayed capture payment settings */
4550
+ delayedCaptureSettings?: DelayedCaptureSettings;
4551
+ }
4552
+ interface RedirectUrls {
4551
4553
  /**
4552
- * Refund ID. (Optional)
4553
- * @format GUID
4554
+ * URL to redirect buyer in case of approved (successful) transaction
4555
+ * @format WEB_URL
4554
4556
  */
4555
- refundId?: string | null;
4556
- }
4557
- interface SendCancelRefundEmailResponse {
4558
- }
4559
- interface SendRefundEmailRequest {
4557
+ successUrl?: string | null;
4560
4558
  /**
4561
- * The ID of order that is refunded
4562
- * @format GUID
4559
+ * URL to redirect buyer in case of buyer canceled the transaction
4560
+ * @format WEB_URL
4563
4561
  */
4564
- orderId?: string;
4562
+ cancelUrl?: string | null;
4565
4563
  /**
4566
- * Refund ID
4567
- * @format GUID
4564
+ * URL to redirect buyer in case of failed/rejected transaction
4565
+ * @format WEB_URL
4568
4566
  */
4569
- refundId?: string;
4567
+ errorUrl?: string | null;
4570
4568
  /**
4571
- * Personal note added to the email (optional)
4572
- * @minLength 1
4573
- * @maxLength 1000
4569
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4570
+ * @format WEB_URL
4574
4571
  */
4575
- customMessage?: string | null;
4576
- }
4577
- interface SendRefundEmailResponse {
4572
+ pendingUrl?: string | null;
4578
4573
  }
4579
- interface SendFulfillmentEmailRequest {
4580
- /** @format GUID */
4581
- orderId?: string;
4582
- /** @format GUID */
4583
- fulfillerId?: string;
4574
+ interface DelayedCaptureSettings {
4575
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4576
+ scheduledAction?: ScheduledActionWithLiterals;
4577
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4578
+ delayDuration?: Duration;
4584
4579
  }
4585
- interface SendFulfillmentEmailResponse {
4580
+ declare enum ScheduledAction {
4581
+ /** Whether payment will be auto-voided when duration passes */
4582
+ VOID = "VOID",
4583
+ /** Whether payment will be auto-captured when duration passes */
4584
+ CAPTURE = "CAPTURE"
4586
4585
  }
4587
- interface SendMerchantOrderReceivedPushRequest {
4586
+ /** @enumType */
4587
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4588
+ interface Duration {
4588
4589
  /**
4589
- * @minLength 1
4590
- * @maxLength 100
4590
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4591
+ * @min 1
4591
4592
  */
4592
- orderId?: string;
4593
- }
4594
- interface SendMerchantOrderReceivedPushResponse {
4595
- }
4596
- interface PreviewEmailByTypeRequest {
4597
- emailType?: PreviewEmailTypeWithLiterals;
4593
+ count?: number;
4594
+ /** Duration unit: MINUTES, HOURS and DAYS */
4595
+ unit?: DurationUnitWithLiterals;
4598
4596
  }
4599
- declare enum PreviewEmailType {
4600
- ORDER_PLACED = "ORDER_PLACED",
4601
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4602
- ORDER_SHIPPED = "ORDER_SHIPPED",
4603
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4597
+ declare enum DurationUnit {
4598
+ MINUTES = "MINUTES",
4599
+ HOURS = "HOURS",
4600
+ DAYS = "DAYS"
4604
4601
  }
4605
4602
  /** @enumType */
4606
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4607
- interface PreviewEmailByTypeResponse {
4608
- emailPreview?: string;
4603
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4604
+ interface PreparePaymentCollectionResponse {
4605
+ /** Payment gateway order id which is associated with given payment */
4606
+ paymentGatewayOrderId?: string;
4609
4607
  }
4610
- interface PreviewRefundEmailRequest {
4608
+ interface GetPaymentCollectabilityStatusRequest {
4611
4609
  /**
4610
+ * Ecom order ID.
4612
4611
  * @minLength 1
4613
4612
  * @maxLength 100
4614
4613
  */
4615
- orderId?: string;
4616
- /** Refund amount */
4617
- refundAmount?: Price;
4618
- /** Refund business details */
4619
- details?: RefundDetails;
4614
+ ecomOrderId: string;
4615
+ }
4616
+ interface GetPaymentCollectabilityStatusResponse {
4617
+ /** Payment collectability status */
4618
+ status?: PaymentCollectabilityStatusWithLiterals;
4619
+ /** Collectable order amount */
4620
+ amount?: Price;
4620
4621
  /**
4621
- * Personal note added to the email (optional)
4622
- * @minLength 1
4623
- * @maxLength 1000
4622
+ * Whether authorization supported
4623
+ * @internal
4624
4624
  */
4625
- customMessage?: string | null;
4625
+ authorizationSupported?: boolean;
4626
4626
  /**
4627
- * Refund ID. (Optional)
4628
- * @format GUID
4627
+ * Whether custom amount is supported for payment collection
4628
+ * @internal
4629
4629
  */
4630
- refundId?: string | null;
4630
+ customAmountSupported?: boolean;
4631
4631
  }
4632
- /** Business model of a refund request */
4633
- interface RefundDetails {
4634
- /**
4635
- * Order line item IDs and quantities that were refunded.
4636
- * @maxSize 300
4637
- */
4638
- items?: RefundItem[];
4639
- /** Whether the shipping fee was also refunded. */
4640
- shippingIncluded?: boolean;
4632
+ declare enum PaymentCollectabilityStatus {
4633
+ UNKNOWN = "UNKNOWN",
4634
+ COLLECTABLE = "COLLECTABLE",
4635
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4636
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4637
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4638
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4639
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4640
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4641
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4642
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4643
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4644
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
4645
+ }
4646
+ /** @enumType */
4647
+ 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';
4648
+ interface RecordManuallyCollectedPaymentRequest {
4641
4649
  /**
4642
- * Reason for the refund, provided by customer (optional).
4643
- * @maxLength 200
4650
+ * Order ID.
4651
+ * @minLength 1
4652
+ * @maxLength 100
4644
4653
  */
4645
- reason?: string | null;
4654
+ orderId: string;
4655
+ /** Amount to be recorded as approved manual payment for given order */
4656
+ amount: Price;
4646
4657
  /**
4647
- * Line items that were refunded.
4648
- * @maxSize 300
4658
+ * Payment method name provided by user.
4659
+ *
4660
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4661
+ * @internal
4649
4662
  */
4650
- lineItems?: LineItemRefund[];
4651
- /**
4652
- * Additional fees that were refunded.
4653
- * @maxSize 100
4654
- */
4655
- additionalFees?: AdditionalFeeRefund[];
4656
- /** Shipping amount that was refunded. */
4657
- shipping?: ShippingRefund;
4663
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4658
4664
  }
4659
- interface RefundItem {
4665
+ /**
4666
+ * User-defined payment method name.
4667
+ * Allows specifying either a predefined type or a custom name.
4668
+ */
4669
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4670
+ /** Predefined payment method. */
4671
+ predefined?: PredefinedPaymentMethodWithLiterals;
4660
4672
  /**
4661
- * Line item ID the refunded line item.
4662
- * @format GUID
4673
+ * Custom payment method name provided by user.
4674
+ *
4675
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4676
+ * @minLength 1
4677
+ * @maxLength 150
4663
4678
  */
4664
- lineItemId?: string;
4679
+ custom?: string | null;
4680
+ }
4681
+ /** @oneof */
4682
+ interface UserDefinedPaymentMethodNameKindOneOf {
4683
+ /** Predefined payment method. */
4684
+ predefined?: PredefinedPaymentMethodWithLiterals;
4665
4685
  /**
4666
- * Line item quantity refunded.
4667
- * @min 1
4668
- * @max 100000
4686
+ * Custom payment method name provided by user.
4687
+ *
4688
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4689
+ * @minLength 1
4690
+ * @maxLength 150
4669
4691
  */
4670
- quantity?: number;
4692
+ custom?: string | null;
4671
4693
  }
4672
- interface LineItemRefund {
4694
+ /** Predefined payment method types for offline/manual payments. */
4695
+ declare enum PredefinedPaymentMethod {
4696
+ /** Cash payment. */
4697
+ CASH = "CASH",
4698
+ /** Bank transfer. */
4699
+ BANK_TRANSFER = "BANK_TRANSFER",
4700
+ /** Payment by check. */
4701
+ CHECK = "CHECK"
4702
+ }
4703
+ /** @enumType */
4704
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4705
+ interface RecordManuallyCollectedPaymentResponse {
4706
+ }
4707
+ interface MarkOrderAsPaidRequest {
4673
4708
  /**
4674
- * Line item ID.
4675
- * @format GUID
4676
- * @immutable
4709
+ * Ecom order ID.
4710
+ * @minLength 1
4711
+ * @maxLength 100
4677
4712
  */
4678
- lineItemId?: string;
4713
+ ecomOrderId: string;
4679
4714
  /**
4680
- * Refund quantity.
4681
- * @min 1
4682
- * @max 100000
4683
- * @immutable
4715
+ * Payment method name provided by user.
4716
+ *
4717
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4718
+ * @internal
4684
4719
  */
4685
- quantity?: number;
4720
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4686
4721
  }
4687
- interface AdditionalFeeRefund {
4722
+ interface MarkOrderAsPaidResponse {
4723
+ /** Updated order. */
4724
+ order?: Order;
4725
+ }
4726
+ interface BulkMarkOrdersAsPaidRequest {
4688
4727
  /**
4689
- * Additional fee ID.
4690
- * @format GUID
4691
- * @immutable
4728
+ * IDs of orders to mark as paid.
4729
+ * @minSize 1
4730
+ * @maxSize 100
4731
+ * @minLength 1
4732
+ * @maxLength 100
4692
4733
  */
4693
- additionalFeeId?: string;
4734
+ ecomOrderIds: string[];
4735
+ }
4736
+ interface BulkMarkOrdersAsPaidResponse {
4694
4737
  /**
4695
- * Refund amount.
4696
- * @immutable
4738
+ * Items updated by the bulk action.
4739
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4697
4740
  */
4698
- amount?: Price;
4741
+ results?: BulkOrderResult[];
4742
+ /** Bulk action metadata. */
4743
+ bulkActionMetadata?: BulkActionMetadata;
4699
4744
  }
4700
- interface ShippingRefund {
4745
+ interface BulkOrderResult {
4746
+ /** Item metadata. */
4747
+ itemMetadata?: ItemMetadata;
4701
4748
  /**
4702
- * Refund amount.
4703
- * @immutable
4749
+ * Updated order.
4750
+ *
4751
+ * Returned when `returnFullEntity = true`.
4704
4752
  */
4705
- amount?: Price;
4753
+ item?: Order;
4706
4754
  }
4707
- interface PreviewRefundEmailResponse {
4708
- emailPreview?: string;
4755
+ interface ItemMetadata {
4756
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4757
+ id?: string | null;
4758
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
4759
+ originalIndex?: number;
4760
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4761
+ success?: boolean;
4762
+ /** Details about the error in case of failure. */
4763
+ error?: ApplicationError;
4709
4764
  }
4710
- interface PreviewCancelEmailRequest {
4765
+ interface ApplicationError {
4766
+ /** Error code. */
4767
+ code?: string;
4768
+ /** Description of the error. */
4769
+ description?: string;
4770
+ /** Data related to the error. */
4771
+ data?: Record<string, any> | null;
4772
+ }
4773
+ interface BulkActionMetadata {
4774
+ /** Number of items that were successfully processed. */
4775
+ totalSuccesses?: number;
4776
+ /** Number of items that couldn't be processed. */
4777
+ totalFailures?: number;
4778
+ /** Number of failures without details because detailed failure threshold was exceeded. */
4779
+ undetailedFailures?: number;
4780
+ }
4781
+ interface GetRefundabilityStatusRequest {
4711
4782
  /**
4783
+ * Order ID.
4712
4784
  * @minLength 1
4713
4785
  * @maxLength 100
4714
4786
  */
4715
- orderId?: string;
4787
+ ecomOrderId: string;
4788
+ }
4789
+ interface GetRefundabilityStatusResponse {
4716
4790
  /**
4717
- * Personal note added to the email (optional)
4718
- * @minLength 1
4719
- * @maxLength 1000
4791
+ * Refundability details.
4792
+ * @maxSize 300
4720
4793
  */
4721
- customMessage?: string | null;
4794
+ refundabilities?: Refundability[];
4795
+ /**
4796
+ * Whether the order supports refunding per item.
4797
+ * @deprecated
4798
+ */
4799
+ refundablePerItem?: boolean;
4722
4800
  }
4723
- interface PreviewCancelEmailResponse {
4724
- emailPreview?: string;
4801
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4802
+ /** Reason why payment is not refundable. */
4803
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4804
+ /** Reason why payment is only refundable manually. */
4805
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4806
+ /** Payment ID. */
4807
+ paymentId?: string;
4808
+ /** Payment refundability status. */
4809
+ refundabilityStatus?: RefundableStatusWithLiterals;
4810
+ /** Link to payment provider dashboard. */
4811
+ providerLink?: string | null;
4725
4812
  }
4726
- interface PreviewCancelRefundEmailRequest {
4813
+ /** @oneof */
4814
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
4815
+ /** Reason why payment is not refundable. */
4816
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4817
+ /** Reason why payment is only refundable manually. */
4818
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4819
+ }
4820
+ declare enum RefundableStatus {
4821
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
4822
+ MANUAL = "MANUAL",
4823
+ REFUNDABLE = "REFUNDABLE"
4824
+ }
4825
+ /** @enumType */
4826
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4827
+ declare enum NonRefundableReason {
4828
+ NONE = "NONE",
4829
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
4830
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4831
+ INTERNAL_ERROR = "INTERNAL_ERROR",
4832
+ NOT_PAID = "NOT_PAID",
4833
+ ACCESS_DENIED = "ACCESS_DENIED",
4834
+ ZERO_PRICE = "ZERO_PRICE",
4835
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4836
+ PENDING_REFUND = "PENDING_REFUND",
4837
+ FORBIDDEN = "FORBIDDEN",
4838
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4839
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
4840
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4841
+ }
4842
+ /** @enumType */
4843
+ 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';
4844
+ declare enum ManuallyRefundableReason {
4845
+ EXPIRED = "EXPIRED",
4846
+ NOT_SUPPORTED = "NOT_SUPPORTED",
4847
+ OFFLINE = "OFFLINE",
4848
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4849
+ }
4850
+ /** @enumType */
4851
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4852
+ interface CreatePaymentGatewayOrderRequest {
4727
4853
  /**
4854
+ * Ecom order ID.
4728
4855
  * @minLength 1
4729
4856
  * @maxLength 100
4730
4857
  */
4731
- orderId?: string;
4858
+ ecomOrderId: string;
4859
+ /** Information about the user who initiated the payment. */
4860
+ chargedBy?: ChargedBy;
4732
4861
  /**
4733
- * Personal note added to the email (optional)
4734
- * @minLength 1
4735
- * @maxLength 1000
4862
+ * Whether to delay capture of the payment.
4863
+ *
4864
+ * Default: false
4865
+ * @internal
4736
4866
  */
4737
- customMessage?: string | null;
4738
- /** Refund amount */
4739
- refundAmount?: Price;
4867
+ delayedCapture?: boolean;
4868
+ }
4869
+ interface ChargedBy {
4740
4870
  /**
4741
- * Refund ID. (Optional)
4871
+ * ID - id of the user who initiated the payment
4742
4872
  * @format GUID
4743
4873
  */
4744
- refundId?: string | null;
4745
- }
4746
- interface PreviewCancelRefundEmailResponse {
4747
- emailPreview?: string;
4748
- }
4749
- interface PreviewBuyerPaymentsReceivedEmailRequest {
4750
- }
4751
- interface PreviewBuyerPaymentsReceivedEmailResponse {
4752
- emailPreview?: string;
4753
- }
4754
- interface PreviewBuyerConfirmationEmailRequest {
4755
- }
4756
- interface PreviewBuyerConfirmationEmailResponse {
4757
- emailPreview?: string;
4874
+ id?: string;
4875
+ /**
4876
+ * Full name - name of the user who initiated the payment
4877
+ * @minLength 1
4878
+ * @maxLength 200
4879
+ */
4880
+ fullName?: string | null;
4758
4881
  }
4759
- interface PreviewBuyerPickupConfirmationEmailRequest {
4882
+ interface CreatePaymentGatewayOrderResponse {
4883
+ /** ID of the order created in the payment gateway */
4884
+ paymentGatewayOrderId?: string;
4760
4885
  }
4761
- interface PreviewBuyerPickupConfirmationEmailResponse {
4762
- emailPreview?: string;
4763
- }
4764
- interface PreviewShippingConfirmationEmailRequest {
4765
- }
4766
- interface PreviewShippingConfirmationEmailResponse {
4767
- emailPreview?: string;
4768
- }
4769
- interface PreviewResendDownloadLinksEmailRequest {
4770
- }
4771
- interface PreviewResendDownloadLinksEmailResponse {
4772
- emailPreview?: string;
4773
- }
4774
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4775
- /** Emitted on a meta site creation. */
4776
- siteCreated?: SiteCreated;
4777
- /** Emitted on a meta site transfer completion. */
4778
- siteTransferred?: SiteTransferred;
4779
- /** Emitted on a meta site deletion. */
4780
- siteDeleted?: SiteDeleted;
4781
- /** Emitted on a meta site restoration. */
4782
- siteUndeleted?: SiteUndeleted;
4783
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4784
- sitePublished?: SitePublished;
4785
- /** Emitted on a meta site unpublish. */
4786
- siteUnpublished?: SiteUnpublished;
4787
- /** Emitted when meta site is marked as template. */
4788
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4789
- /** Emitted when meta site is marked as a WixSite. */
4790
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4791
- /** Emitted when an application is provisioned (installed). */
4792
- serviceProvisioned?: ServiceProvisioned;
4793
- /** Emitted when an application is removed (uninstalled). */
4794
- serviceRemoved?: ServiceRemoved;
4795
- /** Emitted when meta site name (URL slug) is changed. */
4796
- siteRenamedPayload?: SiteRenamed;
4797
- /** Emitted when meta site was permanently deleted. */
4798
- hardDeleted?: SiteHardDeleted;
4799
- /** Emitted on a namespace change. */
4800
- namespaceChanged?: NamespaceChanged;
4801
- /** Emitted when Studio is attached. */
4802
- studioAssigned?: StudioAssigned;
4803
- /** Emitted when Studio is detached. */
4804
- studioUnassigned?: StudioUnassigned;
4886
+ interface ChargeMembershipsRequest {
4805
4887
  /**
4806
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4807
- * the actual URL.
4808
- *
4809
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4810
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4888
+ * Order ID.
4889
+ * @minLength 1
4890
+ * @maxLength 100
4811
4891
  */
4812
- urlChanged?: SiteUrlChanged;
4813
- /** Site is marked as PurgedExternally */
4814
- sitePurgedExternally?: SitePurgedExternally;
4815
- /** Emitted when Odeditor is attached. */
4816
- odeditorAssigned?: OdeditorAssigned;
4817
- /** Emitted when Odeditor is detached. */
4818
- odeditorUnassigned?: OdeditorUnassigned;
4819
- /** Emitted when Picasso is attached. */
4820
- picassoAssigned?: PicassoAssigned;
4821
- /** Emitted when Picasso is detached. */
4822
- picassoUnassigned?: PicassoUnassigned;
4823
- /** Emitted when Wixel is attached. */
4824
- wixelAssigned?: WixelAssigned;
4825
- /** Emitted when Wixel is detached. */
4826
- wixelUnassigned?: WixelUnassigned;
4827
- /** Emitted when StudioTwo is attached. */
4828
- studioTwoAssigned?: StudioTwoAssigned;
4829
- /** Emitted when StudioTwo is detached. */
4830
- studioTwoUnassigned?: StudioTwoUnassigned;
4831
- /** Emitted when media from user domain is enabled. */
4832
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4833
- /** Emitted when media from user domain is disabled. */
4834
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4835
- /** Emitted when Editorless is attached. */
4836
- editorlessAssigned?: EditorlessAssigned;
4837
- /** Emitted when Editorless is detached. */
4838
- editorlessUnassigned?: EditorlessUnassigned;
4892
+ ecomOrderId: string;
4839
4893
  /**
4840
- * A meta site id.
4894
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4895
+ * but a user which is using the membership on behalf of the a member
4841
4896
  * @format GUID
4842
4897
  */
4843
- metaSiteId?: string;
4844
- /** A meta site version. Monotonically increasing. */
4845
- version?: string;
4846
- /** A timestamp of the event. */
4847
- timestamp?: string;
4898
+ memberId: string;
4848
4899
  /**
4849
- * TODO(meta-site): Change validation once validations are disabled for consumers
4850
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4851
- * @maxSize 4000
4900
+ * List of items to be paid by memberships
4901
+ * @minSize 1
4902
+ * @maxSize 300
4852
4903
  */
4853
- assets?: Asset[];
4904
+ membershipCharges?: MembershipChargeItem[];
4854
4905
  }
4855
- /** @oneof */
4856
- interface MetaSiteSpecialEventPayloadOneOf {
4857
- /** Emitted on a meta site creation. */
4858
- siteCreated?: SiteCreated;
4859
- /** Emitted on a meta site transfer completion. */
4860
- siteTransferred?: SiteTransferred;
4861
- /** Emitted on a meta site deletion. */
4862
- siteDeleted?: SiteDeleted;
4863
- /** Emitted on a meta site restoration. */
4864
- siteUndeleted?: SiteUndeleted;
4865
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4866
- sitePublished?: SitePublished;
4867
- /** Emitted on a meta site unpublish. */
4868
- siteUnpublished?: SiteUnpublished;
4869
- /** Emitted when meta site is marked as template. */
4870
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4871
- /** Emitted when meta site is marked as a WixSite. */
4872
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4873
- /** Emitted when an application is provisioned (installed). */
4874
- serviceProvisioned?: ServiceProvisioned;
4875
- /** Emitted when an application is removed (uninstalled). */
4876
- serviceRemoved?: ServiceRemoved;
4877
- /** Emitted when meta site name (URL slug) is changed. */
4878
- siteRenamedPayload?: SiteRenamed;
4879
- /** Emitted when meta site was permanently deleted. */
4880
- hardDeleted?: SiteHardDeleted;
4881
- /** Emitted on a namespace change. */
4882
- namespaceChanged?: NamespaceChanged;
4883
- /** Emitted when Studio is attached. */
4884
- studioAssigned?: StudioAssigned;
4885
- /** Emitted when Studio is detached. */
4886
- studioUnassigned?: StudioUnassigned;
4906
+ interface MembershipChargeItem {
4887
4907
  /**
4888
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4889
- * the actual URL.
4890
- *
4891
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4892
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4908
+ * The id of used membership
4909
+ * @minLength 1
4910
+ * @maxLength 100
4893
4911
  */
4894
- urlChanged?: SiteUrlChanged;
4895
- /** Site is marked as PurgedExternally */
4896
- sitePurgedExternally?: SitePurgedExternally;
4897
- /** Emitted when Odeditor is attached. */
4898
- odeditorAssigned?: OdeditorAssigned;
4899
- /** Emitted when Odeditor is detached. */
4900
- odeditorUnassigned?: OdeditorUnassigned;
4901
- /** Emitted when Picasso is attached. */
4902
- picassoAssigned?: PicassoAssigned;
4903
- /** Emitted when Picasso is detached. */
4904
- picassoUnassigned?: PicassoUnassigned;
4905
- /** Emitted when Wixel is attached. */
4906
- wixelAssigned?: WixelAssigned;
4907
- /** Emitted when Wixel is detached. */
4908
- wixelUnassigned?: WixelUnassigned;
4909
- /** Emitted when StudioTwo is attached. */
4910
- studioTwoAssigned?: StudioTwoAssigned;
4911
- /** Emitted when StudioTwo is detached. */
4912
- studioTwoUnassigned?: StudioTwoUnassigned;
4913
- /** Emitted when media from user domain is enabled. */
4914
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4915
- /** Emitted when media from user domain is disabled. */
4916
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4917
- /** Emitted when Editorless is attached. */
4918
- editorlessAssigned?: EditorlessAssigned;
4919
- /** Emitted when Editorless is detached. */
4920
- editorlessUnassigned?: EditorlessUnassigned;
4921
- }
4922
- interface Asset {
4912
+ membershipId?: string;
4923
4913
  /**
4924
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4914
+ * ID of the application providing this payment option
4915
+ * @format GUID
4916
+ */
4917
+ appId?: string;
4918
+ /** The name of used membership */
4919
+ membershipName?: MembershipName;
4920
+ /** Additional data about this membership */
4921
+ membershipAdditionalData?: Record<string, any> | null;
4922
+ /** Catalog and item reference info. */
4923
+ catalogReference?: CatalogReference;
4924
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
4925
+ serviceProperties?: ServiceProperties;
4926
+ /**
4927
+ * Usually would be the same as catalogReference.catalogItemId
4928
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
4929
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4930
+ * @minLength 1
4925
4931
  * @maxLength 36
4926
4932
  */
4927
- appDefId?: string;
4933
+ rootCatalogItemId?: string | null;
4928
4934
  /**
4929
- * An instance id. For legacy reasons may be UUID or a string.
4930
- * @maxLength 200
4935
+ * line item id of Checkout/Order line item
4936
+ * @minLength 1
4937
+ * @maxLength 100
4931
4938
  */
4932
- instanceId?: string;
4933
- /** An application state. */
4934
- state?: StateWithLiterals;
4939
+ lineItemId?: string;
4935
4940
  }
4936
- declare enum State {
4937
- UNKNOWN = "UNKNOWN",
4938
- ENABLED = "ENABLED",
4939
- DISABLED = "DISABLED",
4940
- PENDING = "PENDING",
4941
- DEMO = "DEMO"
4941
+ interface MembershipName {
4942
+ /**
4943
+ * Membership name.
4944
+ * @maxLength 100
4945
+ */
4946
+ original?: string;
4947
+ /**
4948
+ * Translated membership name. Defaults to `original` when not provided.
4949
+ * @maxLength 100
4950
+ */
4951
+ translated?: string | null;
4942
4952
  }
4943
- /** @enumType */
4944
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4945
- interface SiteCreated {
4953
+ interface ChargeMembershipsResponse {
4954
+ }
4955
+ interface TriggerRefundRequest {
4946
4956
  /**
4947
- * A template identifier (empty if not created from a template).
4948
- * @maxLength 36
4957
+ * The order this refund related to
4958
+ * @minLength 1
4959
+ * @maxLength 100
4949
4960
  */
4950
- originTemplateId?: string;
4961
+ ecomOrderId: string;
4951
4962
  /**
4952
- * An account id of the owner.
4953
- * @format GUID
4963
+ * Refund operations information
4964
+ * @minSize 1
4965
+ * @maxSize 1
4954
4966
  */
4955
- ownerId?: string;
4956
- /** A context in which meta site was created. */
4957
- context?: SiteCreatedContextWithLiterals;
4967
+ payments: PaymentRefund[];
4968
+ /** Business model of a refund */
4969
+ details?: RefundDetails;
4970
+ /** Side effect details related to refund */
4971
+ sideEffects?: RefundSideEffects;
4972
+ }
4973
+ interface PaymentRefund {
4958
4974
  /**
4959
- * A meta site id from which this site was created.
4960
- *
4961
- * In case of a creation from a template it's a template id.
4962
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4975
+ * Specific payment within the order to refund
4963
4976
  * @format GUID
4964
4977
  */
4965
- originMetaSiteId?: string | null;
4978
+ paymentId?: string;
4979
+ /** Refund amount. Not relevant for membership and gift card refunds. */
4980
+ amount?: Price;
4966
4981
  /**
4967
- * A meta site name (URL slug).
4968
- * @maxLength 20
4982
+ * Whether refund is made externally and manually (on the payment provider's side)
4983
+ * 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.
4984
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4969
4985
  */
4970
- siteName?: string;
4971
- /** A namespace. */
4972
- namespace?: NamespaceWithLiterals;
4973
- }
4974
- declare enum SiteCreatedContext {
4975
- /** A valid option, we don't expose all reasons why site might be created. */
4976
- OTHER = "OTHER",
4977
- /** A meta site was created from template. */
4978
- FROM_TEMPLATE = "FROM_TEMPLATE",
4979
- /** A meta site was created by copying of the transfferred meta site. */
4980
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4981
- /** A copy of existing meta site. */
4982
- DUPLICATE = "DUPLICATE",
4983
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4984
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4985
- /** deprecated A meta site was created for Flash editor. */
4986
- FLASH = "FLASH"
4987
- }
4988
- /** @enumType */
4989
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4990
- declare enum Namespace {
4991
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4992
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4993
- WIX = "WIX",
4994
- /** 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. */
4995
- SHOUT_OUT = "SHOUT_OUT",
4996
- /** 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. */
4997
- ALBUMS = "ALBUMS",
4998
- /** 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. */
4999
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5000
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5001
- HOTELS = "HOTELS",
5002
- /** 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. */
5003
- CLUBS = "CLUBS",
5004
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5005
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5006
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5007
- DEV_SITE = "DEV_SITE",
5008
- /** 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. */
5009
- LOGOS = "LOGOS",
5010
- /** 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. */
5011
- VIDEO_MAKER = "VIDEO_MAKER",
5012
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5013
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5014
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5015
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4986
+ externalRefund?: boolean;
5016
4987
  /**
5017
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5018
- *
5019
- * Meta site with this namespace will *not* be shown in a user's site list by default.
4988
+ * Gateway refund id. When param is present, new refund is not created.
4989
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
4990
+ * and all side effects from request will be executed.
4991
+ * @internal
4992
+ * @minLength 1
4993
+ * @maxLength 100
5020
4994
  */
5021
- HTML_DRAFT = "HTML_DRAFT",
4995
+ gatewayRefundId?: string | null;
4996
+ }
4997
+ /** Business model of a refund request */
4998
+ interface RefundDetails {
5022
4999
  /**
5023
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5024
- * Will be accessible from Site List and will not have a website app.
5025
- * Once the user attaches a site, the site will become a regular wixsite.
5000
+ * Order line item IDs and quantities that were refunded.
5001
+ * @maxSize 300
5026
5002
  */
5027
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5028
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5029
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5030
- /** It is to be used in the Business First efforts. */
5031
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5032
- /** Bookings business flow with no site. */
5033
- ANYWHERE = "ANYWHERE",
5034
- /** Namespace for Headless Backoffice with no editor */
5035
- HEADLESS = "HEADLESS",
5003
+ items?: RefundItem[];
5004
+ /** Whether the shipping fee was also refunded. */
5005
+ shippingIncluded?: boolean;
5036
5006
  /**
5037
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5038
- * The site will be used for account level CSM feature for enterprise
5007
+ * Reason for the refund, provided by customer (optional).
5008
+ * @maxLength 200
5039
5009
  */
5040
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5041
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5042
- RISE = "RISE",
5010
+ reason?: string | null;
5043
5011
  /**
5044
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5045
- * There's a blank site behind the scene but it's blank).
5046
- * The Mobile company will be the owner of this namespace.
5012
+ * Line items that were refunded.
5013
+ * @maxSize 300
5047
5014
  */
5048
- BRANDED_FIRST = "BRANDED_FIRST",
5049
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5050
- NOWNIA = "NOWNIA",
5015
+ lineItems?: LineItemRefund[];
5051
5016
  /**
5052
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5053
- * The Partners company owns this namespace.
5017
+ * Additional fees that were refunded.
5018
+ * @maxSize 100
5054
5019
  */
5055
- UGC_TEMPLATE = "UGC_TEMPLATE",
5056
- /** Codux Headless Sites */
5057
- CODUX = "CODUX",
5058
- /** Bobb - AI Design Creator. */
5059
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5020
+ additionalFees?: AdditionalFeeRefund[];
5021
+ /** Shipping amount that was refunded. */
5022
+ shipping?: ShippingRefund;
5023
+ }
5024
+ interface RefundItem {
5060
5025
  /**
5061
- * Shared Blog Site is a unique single site across Enterprise account,
5062
- * This site will hold all Blog posts related to the Marketing product.
5026
+ * Line item ID the refunded line item.
5027
+ * @format GUID
5063
5028
  */
5064
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5065
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5066
- STANDALONE_FORMS = "STANDALONE_FORMS",
5067
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5068
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5069
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5070
- MIMIR = "MIMIR",
5071
- /** Wix Twins platform. */
5072
- TWINS = "TWINS",
5073
- /** Wix Nano. */
5074
- NANO = "NANO",
5075
- /** Base44 headless sites. */
5076
- BASE44 = "BASE44",
5077
- /** Wix Channels Sites */
5078
- CHANNELS = "CHANNELS",
5079
- /** Nautilus platform. */
5080
- NAUTILUS = "NAUTILUS",
5029
+ lineItemId?: string;
5081
5030
  /**
5082
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5083
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5031
+ * Line item quantity refunded.
5032
+ * @min 1
5033
+ * @max 100000
5084
5034
  */
5085
- SYMPHONY = "SYMPHONY",
5086
- /** Nautilus platform app. */
5087
- NAUTILUS_APPS = "NAUTILUS_APPS",
5035
+ quantity?: number;
5036
+ }
5037
+ interface LineItemRefund {
5088
5038
  /**
5089
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5090
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5039
+ * Line item ID.
5040
+ * @format GUID
5041
+ * @immutable
5091
5042
  */
5092
- VIBU = "VIBU",
5043
+ lineItemId?: string;
5093
5044
  /**
5094
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5095
- * (an Enterprise account may have several), holding that BrandKit's brand definition
5096
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5097
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
5045
+ * Refund quantity.
5046
+ * @min 1
5047
+ * @max 100000
5048
+ * @immutable
5098
5049
  */
5099
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT"
5050
+ quantity?: number;
5100
5051
  }
5101
- /** @enumType */
5102
- 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';
5103
- /** Site transferred to another user. */
5104
- interface SiteTransferred {
5052
+ interface AdditionalFeeRefund {
5105
5053
  /**
5106
- * A previous owner id (user that transfers meta site).
5054
+ * Additional fee ID.
5107
5055
  * @format GUID
5056
+ * @immutable
5108
5057
  */
5109
- oldOwnerId?: string;
5058
+ additionalFeeId?: string;
5110
5059
  /**
5111
- * A new owner id (user that accepts meta site).
5112
- * @format GUID
5060
+ * Refund amount.
5061
+ * @immutable
5113
5062
  */
5114
- newOwnerId?: string;
5063
+ amount?: Price;
5115
5064
  }
5116
- /** Soft deletion of the meta site. Could be restored. */
5117
- interface SiteDeleted {
5118
- /** A deletion context. */
5119
- deleteContext?: DeleteContext;
5065
+ interface ShippingRefund {
5066
+ /**
5067
+ * Refund amount.
5068
+ * @immutable
5069
+ */
5070
+ amount?: Price;
5120
5071
  }
5121
- interface DeleteContext {
5122
- /** When the meta site was deleted. */
5123
- dateDeleted?: Date | null;
5124
- /** A status. */
5125
- deleteStatus?: DeleteStatusWithLiterals;
5072
+ interface RefundSideEffects {
5073
+ /** Inventory restock details as part of this refund. */
5074
+ restockInfo?: RestockInfo;
5075
+ /** Whether to send a refund confirmation email to the customer. */
5076
+ sendOrderRefundedEmail?: boolean;
5126
5077
  /**
5127
- * A reason (flow).
5128
- * @maxLength 255
5078
+ * Custom message added to the refund confirmation email.
5079
+ * @minLength 1
5080
+ * @maxLength 1000
5129
5081
  */
5130
- deleteOrigin?: string;
5082
+ customMessage?: string | null;
5083
+ }
5084
+ interface RestockInfo {
5085
+ /** Restock type. */
5086
+ type?: RestockTypeWithLiterals;
5131
5087
  /**
5132
- * A service that deleted it.
5133
- * @maxLength 255
5088
+ * Deprecated, use items instead
5089
+ * @internal
5090
+ * @maxSize 300
5091
+ * @deprecated
5134
5092
  */
5135
- initiatorId?: string | null;
5093
+ lineItemIds?: string[];
5094
+ /**
5095
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5096
+ * @maxSize 300
5097
+ */
5098
+ items?: RestockItem[];
5136
5099
  }
5137
- declare enum DeleteStatus {
5138
- UNKNOWN = "UNKNOWN",
5139
- TRASH = "TRASH",
5140
- DELETED = "DELETED",
5141
- PENDING_PURGE = "PENDING_PURGE",
5142
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5100
+ declare enum RestockType {
5101
+ NO_ITEMS = "NO_ITEMS",
5102
+ ALL_ITEMS = "ALL_ITEMS",
5103
+ SOME_ITEMS = "SOME_ITEMS"
5143
5104
  }
5144
5105
  /** @enumType */
5145
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5146
- /** Restoration of the meta site. */
5147
- interface SiteUndeleted {
5148
- }
5149
- /** First publish of a meta site. Or subsequent publish after unpublish. */
5150
- interface SitePublished {
5151
- }
5152
- interface SiteUnpublished {
5106
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5107
+ interface RestockItem {
5153
5108
  /**
5154
- * A list of URLs previously associated with the meta site.
5155
- * @maxLength 4000
5156
- * @maxSize 10000
5109
+ * ID of the line item being restocked.
5110
+ * @format GUID
5157
5111
  */
5158
- urls?: string[];
5159
- }
5160
- interface SiteMarkedAsTemplate {
5161
- }
5162
- interface SiteMarkedAsWixSite {
5163
- }
5164
- /**
5165
- * Represents a service provisioned a site.
5166
- *
5167
- * Note on `origin_instance_id`:
5168
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5169
- * This is because of the following scenario:
5170
- *
5171
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
5172
- * such as a product catalog. When you create a site from this template, you inherit this
5173
- * default product catalog. However, if the template's product catalog is modified,
5174
- * your site will retain the catalog as it was at the time of site creation. This ensures that
5175
- * your site remains consistent with what you initially received and does not include any
5176
- * changes made to the original template afterward.
5177
- * To ensure this, the TPA on the template gets a new instance_id.
5178
- */
5179
- interface ServiceProvisioned {
5112
+ lineItemId?: string;
5180
5113
  /**
5181
- * Either UUID or EmbeddedServiceType.
5182
- * @maxLength 36
5114
+ * Line item quantity being restocked.
5115
+ * @min 1
5116
+ * @max 100000
5183
5117
  */
5184
- appDefId?: string;
5118
+ quantity?: number;
5185
5119
  /**
5186
- * Not only UUID. Something here could be something weird.
5187
- * @maxLength 36
5120
+ * Per-location breakdown of restock quantities.
5121
+ * @internal
5122
+ * @maxSize 5
5188
5123
  */
5189
- instanceId?: string;
5124
+ restockLocations?: RestockLocation[];
5125
+ }
5126
+ interface TriggerRefundResponse {
5127
+ /** All order's transactions after the refunds were added */
5128
+ orderTransactions?: OrderTransactions;
5129
+ /** Created refund ID */
5130
+ refundId?: string | null;
5131
+ /** Payment ID's that the refund execution had failed for */
5132
+ failedPaymentIds?: ItemMetadata[];
5133
+ }
5134
+ /**
5135
+ * A record of all payments and refunds associated with an order.
5136
+ *
5137
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5138
+ */
5139
+ interface OrderTransactions {
5190
5140
  /**
5191
- * An instance id from which this instance is originated.
5192
- * @maxLength 36
5141
+ * Order ID.
5142
+ * @format GUID
5193
5143
  */
5194
- originInstanceId?: string;
5144
+ orderId?: string;
5195
5145
  /**
5196
- * A version.
5197
- * @maxLength 500
5146
+ * Record of payments made to the merchant.
5147
+ * @maxSize 100
5198
5148
  */
5199
- version?: string | null;
5149
+ payments?: Payment[];
5200
5150
  /**
5201
- * The origin meta site id
5202
- * @format GUID
5151
+ * Record of refunds made to the buyer.
5152
+ * @maxSize 300
5203
5153
  */
5204
- originMetaSiteId?: string | null;
5154
+ refunds?: Refund[];
5205
5155
  }
5206
- interface ServiceRemoved {
5156
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5157
+ /** Regular payment details. */
5158
+ regularPaymentDetails?: RegularPaymentDetails;
5159
+ /** Gift card payment details. */
5160
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5207
5161
  /**
5208
- * Either UUID or EmbeddedServiceType.
5209
- * @maxLength 36
5162
+ * Membership payment details.
5163
+ * @internal
5210
5164
  */
5211
- appDefId?: string;
5165
+ membershipPaymentDetails?: MembershipPaymentDetails;
5212
5166
  /**
5213
- * Not only UUID. Something here could be something weird.
5214
- * @maxLength 36
5167
+ * Receipt created by Wix
5168
+ * @internal
5215
5169
  */
5216
- instanceId?: string;
5170
+ wixReceipt?: WixReceiptInfo;
5217
5171
  /**
5218
- * A version.
5219
- * @maxLength 500
5172
+ * Receipt created by an external system.
5173
+ * @internal
5220
5174
  */
5221
- version?: string | null;
5222
- }
5223
- /** Rename of the site. Meaning, free public url has been changed as well. */
5224
- interface SiteRenamed {
5175
+ externalReceipt?: ExternalReceiptInfo;
5176
+ /** @internal */
5177
+ canceled?: CanceledStatusDetails;
5178
+ /** @internal */
5179
+ declined?: DeclinedStatusDetails;
5180
+ /** @internal */
5181
+ voided?: VoidedStatusDetails;
5225
5182
  /**
5226
- * A new meta site name (URL slug).
5227
- * @maxLength 20
5183
+ * Payment ID.
5184
+ * @format GUID
5185
+ * @readonly
5228
5186
  */
5229
- newSiteName?: string;
5187
+ id?: string | null;
5188
+ /** 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. */
5189
+ createdDate?: Date | null;
5230
5190
  /**
5231
- * A previous meta site name (URL slug).
5232
- * @maxLength 255
5191
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5192
+ * @readonly
5233
5193
  */
5234
- oldSiteName?: string;
5235
- }
5236
- /**
5237
- * Hard deletion of the meta site.
5238
- *
5239
- * Could not be restored. Therefore it's desirable to cleanup data.
5240
- */
5241
- interface SiteHardDeleted {
5242
- /** A deletion context. */
5243
- deleteContext?: DeleteContext;
5244
- }
5245
- interface NamespaceChanged {
5246
- /** A previous namespace. */
5247
- oldNamespace?: NamespaceWithLiterals;
5248
- /** A new namespace. */
5249
- newNamespace?: NamespaceWithLiterals;
5250
- }
5251
- /** Assigned Studio editor */
5252
- interface StudioAssigned {
5253
- }
5254
- /** Unassigned Studio editor */
5255
- interface StudioUnassigned {
5256
- }
5257
- /**
5258
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5259
- *
5260
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5261
- * with sites and its urls, you need to listen to another topic/event. Read about it:
5262
- *
5263
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5264
- */
5265
- interface SiteUrlChanged {
5266
- }
5267
- /**
5268
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5269
- * Consumed by other teams to remove relevant data.
5270
- */
5271
- interface SitePurgedExternally {
5194
+ updatedDate?: Date | null;
5195
+ /** Payment amount. */
5196
+ amount?: Price;
5272
5197
  /**
5273
- * @maxLength 2048
5274
- * @maxSize 100
5275
- * @deprecated
5276
- * @targetRemovalDate 2025-04-15
5198
+ * Whether refunds for this payment are disabled.
5199
+ * + `true`: This payment is not refundable.
5200
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5277
5201
  */
5278
- appDefId?: string[];
5279
- }
5280
- /** Assigned Odeditor */
5281
- interface OdeditorAssigned {
5282
- }
5283
- /** Unassigned Odeditor */
5284
- interface OdeditorUnassigned {
5285
- }
5286
- /** Assigned Picasso editor */
5287
- interface PicassoAssigned {
5288
- }
5289
- /** Unassigned Picasso */
5290
- interface PicassoUnassigned {
5291
- }
5292
- /** Assigned Wixel */
5293
- interface WixelAssigned {
5294
- }
5295
- /** Unassigned Wixel */
5296
- interface WixelUnassigned {
5297
- }
5298
- /** Assigned StudioTwo */
5299
- interface StudioTwoAssigned {
5300
- }
5301
- /** Unassigned StudioTwo */
5302
- interface StudioTwoUnassigned {
5303
- }
5304
- /** Media from user domain is enabled. */
5305
- interface UserDomainMediaEnabled {
5306
- }
5307
- /** Media from user domain is disabled. */
5308
- interface UserDomainMediaDisabled {
5309
- }
5310
- /** Assigned Editorless */
5311
- interface EditorlessAssigned {
5312
- }
5313
- /** Unassigned Editorless */
5314
- interface EditorlessUnassigned {
5315
- }
5316
- interface HasCustomEmailConfigurationsRequest {
5317
- }
5318
- interface HasCustomEmailConfigurationsResponse {
5319
- hasCustomConfigurations?: boolean;
5320
- }
5321
- interface AddToAutomationMigrationPopulationRequest {
5322
- /** When true, sends custom email configurations to automation system via email */
5323
- sendCustomEmailConfigs?: boolean;
5324
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5325
- origin?: OriginWithLiterals;
5326
- }
5327
- declare enum Origin {
5328
- OPT_IN = "OPT_IN",
5329
- MIGRATION = "MIGRATION"
5330
- }
5331
- /** @enumType */
5332
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5333
- interface AddToAutomationMigrationPopulationResponse {
5334
- success?: boolean;
5335
- }
5336
- interface IsInAutomationMigrationPopulationRequest {
5337
- }
5338
- interface IsInAutomationMigrationPopulationResponse {
5339
- inPopulation?: boolean;
5340
- }
5341
- interface PreparePaymentCollectionRequest {
5202
+ refundDisabled?: boolean;
5342
5203
  /**
5343
- * Ecom order ID.
5344
- * @minLength 1
5345
- * @maxLength 100
5204
+ * Whether receipt generation for this payment are allowed.
5205
+ * + `true`: This payment supports receipt generation.
5206
+ * + `false`: This payment not supports receipt generation, or receipt already generated
5207
+ * @internal
5208
+ * @readonly
5346
5209
  */
5347
- ecomOrderId: string;
5348
- /** Amount to collect */
5349
- amount: Price;
5210
+ supportReceiptGeneration?: boolean;
5211
+ /** Details about cash rounding applied to this payment, when relevant. */
5212
+ cashRounding?: CashRoundingDetails;
5213
+ /** @internal */
5214
+ status?: PaymentStatusWithLiterals;
5350
5215
  /**
5351
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5352
- * Existing payment gateway order will be updated with a new amount.
5353
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
5216
+ * Detailed payment status information including gateway reason codes and status-specific details.
5217
+ * @internal
5354
5218
  */
5355
- paymentGatewayOrderId?: string | null;
5219
+ paymentStatusDetails?: PaymentStatusDetails;
5356
5220
  /**
5357
- * Whether to delay capture of the payment.
5358
- * Default: false
5359
- * @deprecated Whether to delay capture of the payment.
5360
- * Default: false
5361
- * @replacedBy delayed_capture_settings.scheduled_action
5362
- * @targetRemovalDate 2024-09-30
5221
+ * Location where the payment was processed.
5222
+ * @internal
5223
+ * @format GUID
5224
+ * @immutable
5363
5225
  */
5364
- delayedCapture?: boolean;
5226
+ locationId?: string | null;
5365
5227
  /**
5366
- * Specifies whether payment collection is initiated by Merchant or User of User
5367
- * Default: `true`
5228
+ * ID linking this payment to the charge request that created it.
5368
5229
  * @internal
5230
+ * @format GUID
5369
5231
  */
5370
- merchantInitiated?: boolean | null;
5232
+ chargeCorrelationId?: string | null;
5233
+ }
5234
+ /** @oneof */
5235
+ interface PaymentPaymentDetailsOneOf {
5236
+ /** Regular payment details. */
5237
+ regularPaymentDetails?: RegularPaymentDetails;
5238
+ /** Gift card payment details. */
5239
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5371
5240
  /**
5372
- * Redirect urls which are used to return buyer to third party system.
5241
+ * Membership payment details.
5373
5242
  * @internal
5374
5243
  */
5375
- redirectUrls?: RedirectUrls;
5376
- /** Delayed capture payment settings */
5377
- delayedCaptureSettings?: DelayedCaptureSettings;
5244
+ membershipPaymentDetails?: MembershipPaymentDetails;
5378
5245
  }
5379
- interface RedirectUrls {
5380
- /**
5381
- * URL to redirect buyer in case of approved (successful) transaction
5382
- * @format WEB_URL
5383
- */
5384
- successUrl?: string | null;
5385
- /**
5386
- * URL to redirect buyer in case of buyer canceled the transaction
5387
- * @format WEB_URL
5388
- */
5389
- cancelUrl?: string | null;
5246
+ /** @oneof */
5247
+ interface PaymentReceiptInfoOneOf {
5390
5248
  /**
5391
- * URL to redirect buyer in case of failed/rejected transaction
5392
- * @format WEB_URL
5249
+ * Receipt created by Wix
5250
+ * @internal
5393
5251
  */
5394
- errorUrl?: string | null;
5252
+ wixReceipt?: WixReceiptInfo;
5395
5253
  /**
5396
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
5397
- * @format WEB_URL
5254
+ * Receipt created by an external system.
5255
+ * @internal
5398
5256
  */
5399
- pendingUrl?: string | null;
5400
- }
5401
- interface DelayedCaptureSettings {
5402
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5403
- scheduledAction?: ScheduledActionWithLiterals;
5404
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
5405
- delayDuration?: Duration;
5257
+ externalReceipt?: ExternalReceiptInfo;
5406
5258
  }
5407
- declare enum ScheduledAction {
5408
- /** Whether payment will be auto-voided when duration passes */
5409
- VOID = "VOID",
5410
- /** Whether payment will be auto-captured when duration passes */
5411
- CAPTURE = "CAPTURE"
5259
+ /** @oneof */
5260
+ interface PaymentStatusDetailsOneOf {
5261
+ /** @internal */
5262
+ canceled?: CanceledStatusDetails;
5263
+ /** @internal */
5264
+ declined?: DeclinedStatusDetails;
5265
+ /** @internal */
5266
+ voided?: VoidedStatusDetails;
5412
5267
  }
5413
- /** @enumType */
5414
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5415
- interface Duration {
5268
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5269
+ /** Credit card details. */
5270
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5416
5271
  /**
5417
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5418
- * @min 1
5272
+ * Wix Payments order ID.
5273
+ * @maxLength 100
5419
5274
  */
5420
- count?: number;
5421
- /** Duration unit: MINUTES, HOURS and DAYS */
5422
- unit?: DurationUnitWithLiterals;
5423
- }
5424
- declare enum DurationUnit {
5425
- MINUTES = "MINUTES",
5426
- HOURS = "HOURS",
5427
- DAYS = "DAYS"
5428
- }
5429
- /** @enumType */
5430
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5431
- interface PreparePaymentCollectionResponse {
5432
- /** Payment gateway order id which is associated with given payment */
5433
- paymentGatewayOrderId?: string;
5434
- }
5435
- interface GetPaymentCollectabilityStatusRequest {
5275
+ paymentOrderId?: string | null;
5436
5276
  /**
5437
- * Ecom order ID.
5438
- * @minLength 1
5277
+ * Payment gateway's transaction ID.
5278
+ * This field is only returned when the value of `offline_payment` is `false`.
5439
5279
  * @maxLength 100
5440
5280
  */
5441
- ecomOrderId: string;
5442
- }
5443
- interface GetPaymentCollectabilityStatusResponse {
5444
- /** Payment collectability status */
5445
- status?: PaymentCollectabilityStatusWithLiterals;
5446
- /** Collectable order amount */
5447
- amount?: Price;
5281
+ gatewayTransactionId?: string | null;
5448
5282
  /**
5449
- * Whether authorization supported
5450
- * @internal
5283
+ * Payment method.
5284
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5285
+ * Non-exhaustive list of supported values:
5286
+ * + `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`
5287
+ * @maxLength 150
5288
+ * @deprecated Payment method.
5289
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5290
+ * Non-exhaustive list of supported values:
5291
+ * + `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`
5292
+ * @replacedBy payment_method_name
5293
+ * @targetRemovalDate 2026-07-01
5451
5294
  */
5452
- authorizationSupported?: boolean;
5295
+ paymentMethod?: string | null;
5453
5296
  /**
5454
- * Whether custom amount is supported for payment collection
5297
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5298
+ * @maxLength 100
5299
+ */
5300
+ providerTransactionId?: string | null;
5301
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5302
+ offlinePayment?: boolean;
5303
+ /** Payment status. */
5304
+ status?: TransactionStatusWithLiterals;
5305
+ /** Whether there is a payment agreement that allows for future charges. */
5306
+ savedPaymentMethod?: boolean;
5307
+ /** Authorization details. */
5308
+ authorizationDetails?: AuthorizationDetails;
5309
+ /**
5310
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5455
5311
  * @internal
5312
+ * @maxLength 300
5456
5313
  */
5457
- customAmountSupported?: boolean;
5458
- }
5459
- declare enum PaymentCollectabilityStatus {
5460
- UNKNOWN = "UNKNOWN",
5461
- COLLECTABLE = "COLLECTABLE",
5462
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5463
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5464
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5465
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5466
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5467
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5468
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5469
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5470
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5471
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
5472
- }
5473
- /** @enumType */
5474
- 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';
5475
- interface RecordManuallyCollectedPaymentRequest {
5314
+ paymentProvider?: string | null;
5476
5315
  /**
5477
- * Order ID.
5478
- * @minLength 1
5479
- * @maxLength 100
5316
+ * Record of chargebacks made by the buyer.
5317
+ * @maxSize 6
5480
5318
  */
5481
- orderId: string;
5482
- /** Amount to be recorded as approved manual payment for given order */
5483
- amount: Price;
5319
+ chargebacks?: Chargeback[];
5484
5320
  /**
5485
- * Payment method name provided by user.
5486
- *
5487
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5321
+ * Payment method ID.
5488
5322
  * @internal
5323
+ * @maxLength 36
5489
5324
  */
5490
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5491
- }
5492
- /**
5493
- * User-defined payment method name.
5494
- * Allows specifying either a predefined type or a custom name.
5495
- */
5496
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5497
- /** Predefined payment method. */
5498
- predefined?: PredefinedPaymentMethodWithLiterals;
5325
+ paymentMethodId?: string | null;
5326
+ /** Platform fee amount associated with this payment. */
5327
+ platformFee?: Price;
5499
5328
  /**
5500
- * Custom payment method name provided by user.
5501
- *
5502
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5503
- * @minLength 1
5504
- * @maxLength 150
5329
+ * Payment method with buyer and optional owner translations.
5330
+ * Non-exhaustive list of supported values:
5331
+ * + `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`
5505
5332
  */
5506
- custom?: string | null;
5333
+ paymentMethodName?: PaymentMethodName;
5507
5334
  }
5508
5335
  /** @oneof */
5509
- interface UserDefinedPaymentMethodNameKindOneOf {
5510
- /** Predefined payment method. */
5511
- predefined?: PredefinedPaymentMethodWithLiterals;
5512
- /**
5513
- * Custom payment method name provided by user.
5514
- *
5515
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5516
- * @minLength 1
5517
- * @maxLength 150
5518
- */
5519
- custom?: string | null;
5336
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5337
+ /** Credit card details. */
5338
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5520
5339
  }
5521
- /** Predefined payment method types for offline/manual payments. */
5522
- declare enum PredefinedPaymentMethod {
5523
- /** Cash payment. */
5524
- CASH = "CASH",
5525
- /** Bank transfer. */
5526
- BANK_TRANSFER = "BANK_TRANSFER",
5527
- /** Payment by check. */
5528
- CHECK = "CHECK"
5340
+ declare enum TransactionStatus {
5341
+ UNDEFINED = "UNDEFINED",
5342
+ APPROVED = "APPROVED",
5343
+ PENDING = "PENDING",
5344
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5345
+ CANCELED = "CANCELED",
5346
+ DECLINED = "DECLINED",
5347
+ REFUNDED = "REFUNDED",
5348
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5349
+ AUTHORIZED = "AUTHORIZED",
5350
+ VOIDED = "VOIDED"
5529
5351
  }
5530
5352
  /** @enumType */
5531
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5532
- interface RecordManuallyCollectedPaymentResponse {
5533
- }
5534
- interface MarkOrderAsPaidRequest {
5535
- /**
5536
- * Ecom order ID.
5537
- * @minLength 1
5538
- * @maxLength 100
5539
- */
5540
- ecomOrderId: string;
5353
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5354
+ interface CreditCardPaymentMethodDetails {
5541
5355
  /**
5542
- * Payment method name provided by user.
5543
- *
5544
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5545
- * @internal
5356
+ * The last 4 digits of the card number.
5357
+ * @maxLength 4
5546
5358
  */
5547
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5548
- }
5549
- interface MarkOrderAsPaidResponse {
5550
- /** Updated order. */
5551
- order?: Order;
5552
- }
5553
- interface BulkMarkOrdersAsPaidRequest {
5359
+ lastFourDigits?: string | null;
5554
5360
  /**
5555
- * IDs of orders to mark as paid.
5556
- * @minSize 1
5557
- * @maxSize 100
5558
- * @minLength 1
5361
+ * Card issuer's brand.
5559
5362
  * @maxLength 100
5560
5363
  */
5561
- ecomOrderIds: string[];
5364
+ brand?: string | null;
5562
5365
  }
5563
- interface BulkMarkOrdersAsPaidResponse {
5366
+ interface AuthorizationDetails {
5564
5367
  /**
5565
- * Items updated by the bulk action.
5566
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5567
- */
5568
- results?: BulkOrderResult[];
5569
- /** Bulk action metadata. */
5570
- bulkActionMetadata?: BulkActionMetadata;
5571
- }
5572
- interface BulkOrderResult {
5573
- /** Item metadata. */
5574
- itemMetadata?: ItemMetadata;
5575
- /**
5576
- * Updated order.
5577
- *
5578
- * Returned when `returnFullEntity = true`.
5368
+ * Whether the authorized payment is of a delayed capture.
5369
+ * @readonly
5579
5370
  */
5580
- item?: Order;
5581
- }
5582
- interface ItemMetadata {
5583
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5584
- id?: string | null;
5585
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5586
- originalIndex?: number;
5587
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5588
- success?: boolean;
5589
- /** Details about the error in case of failure. */
5590
- error?: ApplicationError;
5591
- }
5592
- interface ApplicationError {
5593
- /** Error code. */
5594
- code?: string;
5595
- /** Description of the error. */
5596
- description?: string;
5597
- /** Data related to the error. */
5598
- data?: Record<string, any> | null;
5599
- }
5600
- interface BulkActionMetadata {
5601
- /** Number of items that were successfully processed. */
5602
- totalSuccesses?: number;
5603
- /** Number of items that couldn't be processed. */
5604
- totalFailures?: number;
5605
- /** Number of failures without details because detailed failure threshold was exceeded. */
5606
- undetailedFailures?: number;
5607
- }
5608
- interface GetRefundabilityStatusRequest {
5371
+ delayedCapture?: boolean;
5372
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5373
+ authorizedDate?: Date | null;
5609
5374
  /**
5610
- * Order ID.
5611
- * @minLength 1
5612
- * @maxLength 100
5375
+ * List of captures associated with payment
5376
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5377
+ * @maxSize 1
5613
5378
  */
5614
- ecomOrderId: string;
5379
+ captures?: AuthorizationCapture[];
5380
+ /** Void associated with payment */
5381
+ void?: AuthorizationVoid;
5382
+ /** Scheduled action for this transaction */
5383
+ scheduledAction?: V1ScheduledAction;
5615
5384
  }
5616
- interface GetRefundabilityStatusResponse {
5385
+ interface AuthorizationCapture {
5617
5386
  /**
5618
- * Refundability details.
5619
- * @maxSize 300
5387
+ * Capture ID.
5388
+ * @format GUID
5389
+ * @readonly
5620
5390
  */
5621
- refundabilities?: Refundability[];
5391
+ id?: string | null;
5392
+ /** Status of this capture action */
5393
+ status?: AuthorizationCaptureStatusWithLiterals;
5622
5394
  /**
5623
- * Whether the order supports refunding per item.
5624
- * @deprecated
5395
+ * Amount of this capture
5396
+ * @immutable
5625
5397
  */
5626
- refundablePerItem?: boolean;
5398
+ amount?: Price;
5399
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5400
+ createdDate?: Date | null;
5401
+ /** In case of status is FAILED may contain failure details */
5402
+ failureDetails?: AuthorizationActionFailureDetails;
5627
5403
  }
5628
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5629
- /** Reason why payment is not refundable. */
5630
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5631
- /** Reason why payment is only refundable manually. */
5632
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5633
- /** Payment ID. */
5634
- paymentId?: string;
5635
- /** Payment refundability status. */
5636
- refundabilityStatus?: RefundableStatusWithLiterals;
5637
- /** Link to payment provider dashboard. */
5638
- providerLink?: string | null;
5404
+ declare enum AuthorizationCaptureStatus {
5405
+ /** Capture operation still in progress. */
5406
+ PENDING = "PENDING",
5407
+ /** Capture operation succeeded. */
5408
+ SUCCEEDED = "SUCCEEDED",
5409
+ /** Capture operation failed. */
5410
+ FAILED = "FAILED"
5639
5411
  }
5640
- /** @oneof */
5641
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5642
- /** Reason why payment is not refundable. */
5643
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5644
- /** Reason why payment is only refundable manually. */
5645
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5412
+ /** @enumType */
5413
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5414
+ interface AuthorizationActionFailureDetails {
5415
+ /** @maxLength 100 */
5416
+ failureCode?: string;
5646
5417
  }
5647
- declare enum RefundableStatus {
5648
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5649
- MANUAL = "MANUAL",
5650
- REFUNDABLE = "REFUNDABLE"
5418
+ interface AuthorizationVoid {
5419
+ /** Status of this void action */
5420
+ status?: AuthorizationVoidStatusWithLiterals;
5421
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5422
+ voidedDate?: Date | null;
5423
+ /** In case of status is FAILED may contain failure details */
5424
+ failureDetails?: AuthorizationActionFailureDetails;
5425
+ /** Reason of void action */
5426
+ reason?: ReasonWithLiterals;
5427
+ }
5428
+ declare enum AuthorizationVoidStatus {
5429
+ /** Void operation still in progress. */
5430
+ PENDING = "PENDING",
5431
+ /** Void operation succeeded. */
5432
+ SUCCEEDED = "SUCCEEDED",
5433
+ /** Void operation failed. */
5434
+ FAILED = "FAILED"
5651
5435
  }
5652
5436
  /** @enumType */
5653
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5654
- declare enum NonRefundableReason {
5655
- NONE = "NONE",
5656
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5657
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5658
- INTERNAL_ERROR = "INTERNAL_ERROR",
5659
- NOT_PAID = "NOT_PAID",
5660
- ACCESS_DENIED = "ACCESS_DENIED",
5661
- ZERO_PRICE = "ZERO_PRICE",
5662
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5663
- PENDING_REFUND = "PENDING_REFUND",
5664
- FORBIDDEN = "FORBIDDEN",
5665
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5666
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5667
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5437
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5438
+ /** Reason the authorization was voided. */
5439
+ declare enum Reason {
5440
+ /** Authorization was voided by user. */
5441
+ MANUAL = "MANUAL",
5442
+ /** Authorization passed execution date. */
5443
+ SCHEDULED = "SCHEDULED"
5668
5444
  }
5669
5445
  /** @enumType */
5670
- 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';
5671
- declare enum ManuallyRefundableReason {
5672
- EXPIRED = "EXPIRED",
5673
- NOT_SUPPORTED = "NOT_SUPPORTED",
5674
- OFFLINE = "OFFLINE",
5675
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5446
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5447
+ interface V1ScheduledAction {
5448
+ /** Type of the action. */
5449
+ actionType?: ActionTypeWithLiterals;
5450
+ /** The date and time of the action. */
5451
+ executionDate?: Date | null;
5452
+ }
5453
+ declare enum ActionType {
5454
+ VOID = "VOID",
5455
+ CAPTURE = "CAPTURE"
5676
5456
  }
5677
5457
  /** @enumType */
5678
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5679
- interface CreatePaymentGatewayOrderRequest {
5458
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5459
+ interface Chargeback {
5680
5460
  /**
5681
- * Ecom order ID.
5682
- * @minLength 1
5683
- * @maxLength 100
5461
+ * Chargeback ID.
5462
+ * @format GUID
5463
+ * @readonly
5464
+ * @immutable
5684
5465
  */
5685
- ecomOrderId: string;
5686
- /** Information about the user who initiated the payment. */
5687
- chargedBy?: ChargedBy;
5466
+ id?: string;
5688
5467
  /**
5689
- * Whether to delay capture of the payment.
5690
- *
5691
- * Default: false
5692
- * @internal
5468
+ * 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.
5469
+ * @readonly
5470
+ * @immutable
5693
5471
  */
5694
- delayedCapture?: boolean;
5695
- }
5696
- interface ChargedBy {
5472
+ createdDate?: Date | null;
5697
5473
  /**
5698
- * ID - id of the user who initiated the payment
5699
- * @format GUID
5474
+ * 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.
5475
+ * @readonly
5700
5476
  */
5701
- id?: string;
5477
+ updatedDate?: Date | null;
5702
5478
  /**
5703
- * Full name - name of the user who initiated the payment
5704
- * @minLength 1
5705
- * @maxLength 200
5479
+ * Amount.
5480
+ * @readonly
5481
+ * @immutable
5706
5482
  */
5707
- fullName?: string | null;
5708
- }
5709
- interface CreatePaymentGatewayOrderResponse {
5710
- /** ID of the order created in the payment gateway */
5711
- paymentGatewayOrderId?: string;
5712
- }
5713
- interface ChargeMembershipsRequest {
5483
+ amount?: Price;
5714
5484
  /**
5715
- * Order ID.
5716
- * @minLength 1
5717
- * @maxLength 100
5485
+ * Reversal amount. Present only when status is REVERSED.
5486
+ * @readonly
5718
5487
  */
5719
- ecomOrderId: string;
5488
+ reversalAmount?: Price;
5720
5489
  /**
5721
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5722
- * but a user which is using the membership on behalf of the a member
5723
- * @format GUID
5490
+ * Status.
5491
+ *
5492
+ * Default: `"APPROVED"`.
5724
5493
  */
5725
- memberId: string;
5494
+ status?: ChargebackStatusWithLiterals;
5726
5495
  /**
5727
- * List of items to be paid by memberships
5728
- * @minSize 1
5729
- * @maxSize 300
5496
+ * External chargeback ID.
5497
+ * @format GUID
5498
+ * @readonly
5499
+ * @immutable
5730
5500
  */
5731
- membershipCharges?: MembershipChargeItem[];
5501
+ externalId?: string | null;
5732
5502
  }
5733
- interface MembershipChargeItem {
5503
+ declare enum ChargebackStatus {
5504
+ /** Chargeback was approved. */
5505
+ APPROVED = "APPROVED",
5506
+ /** Chargeback was reversed. */
5507
+ REVERSED = "REVERSED"
5508
+ }
5509
+ /** @enumType */
5510
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5511
+ interface PaymentMethodName {
5734
5512
  /**
5735
- * The id of used membership
5736
- * @minLength 1
5737
- * @maxLength 100
5513
+ * Translated payment method name in buyer language.
5514
+ * @maxLength 150
5738
5515
  */
5739
- membershipId?: string;
5516
+ buyerLanguageName?: string | null;
5740
5517
  /**
5741
- * ID of the application providing this payment option
5742
- * @format GUID
5743
- */
5744
- appId?: string;
5745
- /** The name of used membership */
5746
- membershipName?: MembershipName;
5747
- /** Additional data about this membership */
5748
- membershipAdditionalData?: Record<string, any> | null;
5749
- /** Catalog and item reference info. */
5750
- catalogReference?: CatalogReference;
5751
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5752
- serviceProperties?: ServiceProperties;
5753
- /**
5754
- * Usually would be the same as catalogReference.catalogItemId
5755
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5756
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5757
- * @minLength 1
5758
- * @maxLength 36
5518
+ * Translated payment method name in site owner language.
5519
+ * @maxLength 150
5759
5520
  */
5760
- rootCatalogItemId?: string | null;
5521
+ siteLanguageName?: string | null;
5761
5522
  /**
5762
- * line item id of Checkout/Order line item
5763
- * @minLength 1
5764
- * @maxLength 100
5523
+ * User-provided payment method name.
5524
+ *
5525
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5765
5526
  */
5766
- lineItemId?: string;
5527
+ userDefinedName?: UserDefinedPaymentMethodName;
5767
5528
  }
5768
- interface MembershipName {
5529
+ interface GiftCardPaymentDetails {
5769
5530
  /**
5770
- * Membership name.
5531
+ * Gift card payment ID.
5771
5532
  * @maxLength 100
5772
5533
  */
5773
- original?: string;
5534
+ giftCardPaymentId?: string;
5774
5535
  /**
5775
- * Translated membership name. Defaults to `original` when not provided.
5776
- * @maxLength 100
5536
+ * Gift card ID.
5537
+ * @internal
5538
+ * @deprecated
5777
5539
  */
5778
- translated?: string | null;
5779
- }
5780
- interface ServiceProperties {
5540
+ giftCardId?: string;
5781
5541
  /**
5782
- * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5783
- * For example, the start time of a class.
5542
+ * ID of the app that created the gift card.
5543
+ * @format GUID
5784
5544
  */
5785
- scheduledDate?: Date | null;
5545
+ appId?: string;
5786
5546
  /**
5787
- * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
5788
- * @min 1
5789
- * @max 10000
5547
+ * Whether the gift card is voided.
5548
+ * @readonly
5790
5549
  */
5791
- numberOfParticipants?: number | null;
5550
+ voided?: boolean;
5792
5551
  /**
5793
- * Date and time the service is to be ended, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5794
- * For example, the date and time a class will end.
5552
+ * Gift card obfuscated code.
5795
5553
  * @internal
5554
+ * @maxLength 30
5555
+ * @immutable
5796
5556
  */
5797
- endDate?: Date | null;
5798
- }
5799
- interface ChargeMembershipsResponse {
5557
+ obfuscatedCode?: string | null;
5800
5558
  }
5801
- interface TriggerRefundRequest {
5559
+ interface MembershipPaymentDetails {
5802
5560
  /**
5803
- * The order this refund related to
5804
- * @minLength 1
5561
+ * Membership ID.
5805
5562
  * @maxLength 100
5806
5563
  */
5807
- ecomOrderId: string;
5808
- /**
5809
- * Refund operations information
5810
- * @minSize 1
5811
- * @maxSize 1
5812
- */
5813
- payments: PaymentRefund[];
5814
- /** Business model of a refund */
5815
- details?: RefundDetails;
5816
- /** Side effect details related to refund */
5817
- sideEffects?: RefundSideEffects;
5818
- }
5819
- interface PaymentRefund {
5820
- /**
5821
- * Specific payment within the order to refund
5822
- * @format GUID
5823
- */
5824
- paymentId?: string;
5825
- /** Refund amount. Not relevant for membership and gift card refunds. */
5826
- amount?: Price;
5827
- /**
5828
- * Whether refund is made externally and manually (on the payment provider's side)
5829
- * 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.
5830
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5831
- */
5832
- externalRefund?: boolean;
5564
+ membershipId?: string;
5833
5565
  /**
5834
- * Gateway refund id. When param is present, new refund is not created.
5835
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5836
- * and all side effects from request will be executed.
5837
- * @internal
5566
+ * ID of the line item this membership applies to.
5838
5567
  * @minLength 1
5839
5568
  * @maxLength 100
5840
5569
  */
5841
- gatewayRefundId?: string | null;
5842
- }
5843
- interface RefundSideEffects {
5844
- /** Inventory restock details as part of this refund. */
5845
- restockInfo?: RestockInfo;
5846
- /** Whether to send a refund confirmation email to the customer. */
5847
- sendOrderRefundedEmail?: boolean;
5570
+ lineItemId?: string;
5571
+ /** Payment status. */
5572
+ status?: MembershipPaymentStatusWithLiterals;
5573
+ /** Membership name. */
5574
+ name?: MembershipName;
5848
5575
  /**
5849
- * Custom message added to the refund confirmation email.
5576
+ * The transaction ID in the membership system. Can be used to void the transaction.
5850
5577
  * @minLength 1
5851
- * @maxLength 1000
5578
+ * @maxLength 100
5852
5579
  */
5853
- customMessage?: string | null;
5854
- }
5855
- interface RestockInfo {
5856
- /** Restock type. */
5857
- type?: RestockTypeWithLiterals;
5580
+ externalTransactionId?: string | null;
5858
5581
  /**
5859
- * Deprecated, use items instead
5860
- * @internal
5861
- * @maxSize 300
5862
- * @deprecated
5582
+ * Whether the membership is voided.
5583
+ * @readonly
5863
5584
  */
5864
- lineItemIds?: string[];
5585
+ voided?: boolean;
5865
5586
  /**
5866
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5867
- * @maxSize 300
5587
+ * ID of the application providing this payment option.
5588
+ * @format GUID
5868
5589
  */
5869
- items?: RestockItem[];
5590
+ providerAppId?: string;
5591
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5592
+ futureMembership?: FutureMembershipDetails;
5870
5593
  }
5871
- declare enum RestockType {
5872
- NO_ITEMS = "NO_ITEMS",
5873
- ALL_ITEMS = "ALL_ITEMS",
5874
- SOME_ITEMS = "SOME_ITEMS"
5594
+ declare enum MembershipPaymentStatus {
5595
+ /** Payment was charged. */
5596
+ CHARGED = "CHARGED",
5597
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5598
+ CHARGE_FAILED = "CHARGE_FAILED",
5599
+ /** Payment is pending. */
5600
+ CHARGE_PENDING = "CHARGE_PENDING",
5601
+ /** Payment was voided. */
5602
+ VOIDED = "VOIDED"
5875
5603
  }
5876
5604
  /** @enumType */
5877
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5878
- interface RestockItem {
5605
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5606
+ interface FutureMembershipDetails {
5879
5607
  /**
5880
- * ID of the line item being restocked.
5608
+ * ID of the plan line item in the order from which the membership will be created.
5881
5609
  * @format GUID
5882
5610
  */
5883
5611
  lineItemId?: string;
5884
5612
  /**
5885
- * Line item quantity being restocked.
5886
- * @min 1
5887
- * @max 100000
5888
- */
5889
- quantity?: number;
5890
- /**
5891
- * Per-location breakdown of restock quantities.
5892
- * @internal
5893
- * @maxSize 5
5613
+ * ID of the benefit the future membership will grant.
5614
+ * @maxLength 200
5894
5615
  */
5895
- restockLocations?: RestockLocation[];
5896
- }
5897
- interface TriggerRefundResponse {
5898
- /** All order's transactions after the refunds were added */
5899
- orderTransactions?: OrderTransactions;
5900
- /** Created refund ID */
5901
- refundId?: string | null;
5902
- /** Payment ID's that the refund execution had failed for */
5903
- failedPaymentIds?: ItemMetadata[];
5616
+ benefitId?: string;
5904
5617
  }
5905
- /**
5906
- * A record of all payments and refunds associated with an order.
5907
- *
5908
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5909
- */
5910
- interface OrderTransactions {
5618
+ interface WixReceiptInfo {
5911
5619
  /**
5912
- * Order ID.
5620
+ * Receipt ID
5913
5621
  * @format GUID
5914
5622
  */
5915
- orderId?: string;
5916
- /**
5917
- * Record of payments made to the merchant.
5918
- * @maxSize 100
5919
- */
5920
- payments?: Payment[];
5623
+ receiptId?: string;
5921
5624
  /**
5922
- * Record of refunds made to the buyer.
5923
- * @maxSize 300
5625
+ * Display number of receipt
5626
+ * @minLength 1
5627
+ * @maxLength 40
5924
5628
  */
5925
- refunds?: Refund[];
5629
+ displayNumber?: string | null;
5926
5630
  }
5927
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5928
- /** Regular payment details. */
5929
- regularPaymentDetails?: RegularPaymentDetails;
5930
- /** Gift card payment details. */
5931
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5631
+ interface ExternalReceiptInfo {
5932
5632
  /**
5933
- * Membership payment details.
5934
- * @internal
5633
+ * External receipt ID
5634
+ * @maxLength 100
5935
5635
  */
5936
- membershipPaymentDetails?: MembershipPaymentDetails;
5636
+ receiptId?: string | null;
5937
5637
  /**
5938
- * Receipt created by Wix
5939
- * @internal
5638
+ * ID of the app providing the receipt
5639
+ * @format GUID
5940
5640
  */
5941
- wixReceipt?: WixReceiptInfo;
5641
+ appId?: string | null;
5942
5642
  /**
5943
- * Receipt created by an external system.
5944
- * @internal
5643
+ * Display number of receipt
5644
+ * @minLength 1
5645
+ * @maxLength 40
5945
5646
  */
5946
- externalReceipt?: ExternalReceiptInfo;
5947
- /** @internal */
5948
- canceled?: CanceledStatusDetails;
5949
- /** @internal */
5950
- declined?: DeclinedStatusDetails;
5951
- /** @internal */
5952
- voided?: VoidedStatusDetails;
5647
+ displayNumber?: string | null;
5648
+ }
5649
+ interface CashRoundingDetails {
5953
5650
  /**
5954
- * Payment ID.
5955
- * @format GUID
5956
- * @readonly
5651
+ * Payment amount before cash rounding was applied.
5652
+ * When provided, balance and status calculations use this value instead of `amount`
5653
+ * to prevent false overpayment or underpayment due to rounding.
5957
5654
  */
5958
- id?: string | null;
5959
- /** 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. */
5960
- createdDate?: Date | null;
5655
+ unroundedAmount?: Price;
5961
5656
  /**
5962
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5657
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5658
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5963
5659
  * @readonly
5964
5660
  */
5965
- updatedDate?: Date | null;
5966
- /** Payment amount. */
5967
- amount?: Price;
5968
- /**
5969
- * Whether refunds for this payment are disabled.
5970
- * + `true`: This payment is not refundable.
5971
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5972
- */
5973
- refundDisabled?: boolean;
5974
- /**
5975
- * Whether receipt generation for this payment are allowed.
5976
- * + `true`: This payment supports receipt generation.
5977
- * + `false`: This payment not supports receipt generation, or receipt already generated
5978
- * @internal
5979
- * @readonly
5980
- */
5981
- supportReceiptGeneration?: boolean;
5982
- /** Details about cash rounding applied to this payment, when relevant. */
5983
- cashRounding?: CashRoundingDetails;
5984
- /** @internal */
5985
- status?: PaymentStatusWithLiterals;
5986
- /**
5987
- * Detailed payment status information including gateway reason codes and status-specific details.
5988
- * @internal
5989
- */
5990
- paymentStatusDetails?: PaymentStatusDetails;
5991
- /**
5992
- * Location where the payment was processed.
5993
- * @internal
5994
- * @format GUID
5995
- * @immutable
5996
- */
5997
- locationId?: string | null;
5998
- /**
5999
- * ID linking this payment to the charge request that created it.
6000
- * @internal
6001
- * @format GUID
6002
- */
6003
- chargeCorrelationId?: string | null;
5661
+ roundingAdjustment?: CashRounding;
6004
5662
  }
6005
- /** @oneof */
6006
- interface PaymentPaymentDetailsOneOf {
6007
- /** Regular payment details. */
6008
- regularPaymentDetails?: RegularPaymentDetails;
6009
- /** Gift card payment details. */
6010
- giftcardPaymentDetails?: GiftCardPaymentDetails;
6011
- /**
6012
- * Membership payment details.
6013
- * @internal
6014
- */
6015
- membershipPaymentDetails?: MembershipPaymentDetails;
5663
+ declare enum PaymentStatus {
5664
+ APPROVED = "APPROVED",
5665
+ PENDING = "PENDING",
5666
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5667
+ CANCELED = "CANCELED",
5668
+ DECLINED = "DECLINED",
5669
+ REFUNDED = "REFUNDED",
5670
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5671
+ AUTHORIZED = "AUTHORIZED",
5672
+ VOIDED = "VOIDED"
6016
5673
  }
6017
- /** @oneof */
6018
- interface PaymentReceiptInfoOneOf {
6019
- /**
6020
- * Receipt created by Wix
6021
- * @internal
6022
- */
6023
- wixReceipt?: WixReceiptInfo;
5674
+ /** @enumType */
5675
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5676
+ interface CanceledStatusDetails {
5677
+ reason?: CanceledReasonWithLiterals;
5678
+ }
5679
+ declare enum CanceledReason {
5680
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5681
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5682
+ /** Payment was not completed by user and expired. */
5683
+ EXPIRED = "EXPIRED"
5684
+ }
5685
+ /** @enumType */
5686
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5687
+ interface DeclinedStatusDetails {
5688
+ reason?: DeclinedReasonWithLiterals;
5689
+ }
5690
+ declare enum DeclinedReason {
5691
+ /** Corresponding charge failed. */
5692
+ CHARGE_FAILED = "CHARGE_FAILED",
5693
+ /** Payment details expired. */
5694
+ EXPIRED = "EXPIRED",
5695
+ /** Insufficient funds. */
5696
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5697
+ /** Gift card was disabled before charge was attempted. */
5698
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5699
+ }
5700
+ /** @enumType */
5701
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5702
+ interface VoidedStatusDetails {
5703
+ reason?: VoidedReasonWithLiterals;
5704
+ }
5705
+ declare enum VoidedReason {
5706
+ /** Payment was voided by merchant request. */
5707
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5708
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5709
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5710
+ }
5711
+ /** @enumType */
5712
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5713
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5714
+ /** @internal */
5715
+ canceled?: CanceledStatusDetails;
5716
+ /** @internal */
5717
+ declined?: DeclinedStatusDetails;
5718
+ /** @internal */
5719
+ voided?: VoidedStatusDetails;
6024
5720
  /**
6025
- * Receipt created by an external system.
5721
+ * Reason code from the payment gateway.
6026
5722
  * @internal
5723
+ * @minLength 1
5724
+ * @maxLength 10
6027
5725
  */
6028
- externalReceipt?: ExternalReceiptInfo;
5726
+ paymentGatewayReasonCode?: string | null;
6029
5727
  }
6030
5728
  /** @oneof */
6031
- interface PaymentStatusDetailsOneOf {
5729
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6032
5730
  /** @internal */
6033
5731
  canceled?: CanceledStatusDetails;
6034
5732
  /** @internal */
@@ -6036,745 +5734,1047 @@ interface PaymentStatusDetailsOneOf {
6036
5734
  /** @internal */
6037
5735
  voided?: VoidedStatusDetails;
6038
5736
  }
6039
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6040
- /** Credit card details. */
6041
- creditCardDetails?: CreditCardPaymentMethodDetails;
5737
+ interface Refund {
6042
5738
  /**
6043
- * Wix Payments order ID.
6044
- * @maxLength 100
5739
+ * Refund ID.
5740
+ * @format GUID
5741
+ * @readonly
6045
5742
  */
6046
- paymentOrderId?: string | null;
5743
+ id?: string;
6047
5744
  /**
6048
- * Payment gateway's transaction ID.
6049
- * This field is only returned when the value of `offline_payment` is `false`.
6050
- * @maxLength 100
5745
+ * List of transactions.
5746
+ * @maxSize 50
6051
5747
  */
6052
- gatewayTransactionId?: string | null;
5748
+ transactions?: RefundTransaction[];
5749
+ /** Refund business details. */
5750
+ details?: RefundDetails;
6053
5751
  /**
6054
- * Payment method.
6055
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6056
- * Non-exhaustive list of supported values:
6057
- * + `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`
6058
- * @maxLength 150
6059
- * @deprecated Payment method.
6060
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6061
- * Non-exhaustive list of supported values:
6062
- * + `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`
6063
- * @replacedBy payment_method_name
6064
- * @targetRemovalDate 2026-07-01
5752
+ * 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.
5753
+ * @readonly
5754
+ * @immutable
6065
5755
  */
6066
- paymentMethod?: string | null;
5756
+ createdDate?: Date | null;
6067
5757
  /**
6068
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6069
- * @maxLength 100
5758
+ * Aggregated refund summary.
5759
+ * @readonly
6070
5760
  */
6071
- providerTransactionId?: string | null;
6072
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6073
- offlinePayment?: boolean;
6074
- /** Payment status. */
6075
- status?: TransactionStatusWithLiterals;
6076
- /** Whether there is a payment agreement that allows for future charges. */
6077
- savedPaymentMethod?: boolean;
6078
- /** Authorization details. */
6079
- authorizationDetails?: AuthorizationDetails;
5761
+ summary?: AggregatedRefundSummary;
6080
5762
  /**
6081
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6082
- * @internal
6083
- * @maxLength 300
5763
+ * ID of the app that initiated this refund.
5764
+ * @format GUID
5765
+ * @readonly
5766
+ * @immutable
6084
5767
  */
6085
- paymentProvider?: string | null;
5768
+ requestingServiceAppId?: string | null;
5769
+ }
5770
+ interface RefundTransaction {
6086
5771
  /**
6087
- * Record of chargebacks made by the buyer.
6088
- * @maxSize 6
5772
+ * ID of the payment associated with this refund.
5773
+ * @format GUID
5774
+ * @immutable
6089
5775
  */
6090
- chargebacks?: Chargeback[];
5776
+ paymentId?: string;
6091
5777
  /**
6092
- * Payment method ID.
6093
- * @internal
6094
- * @maxLength 36
5778
+ * Refund amount.
5779
+ * @immutable
6095
5780
  */
6096
- paymentMethodId?: string | null;
6097
- /** Platform fee amount associated with this payment. */
6098
- platformFee?: Price;
5781
+ amount?: Price;
5782
+ /** Refund status. */
5783
+ refundStatus?: RefundStatusWithLiterals;
5784
+ /** Optional details of current refund status. */
5785
+ refundStatusInfo?: RefundStatusInfo;
6099
5786
  /**
6100
- * Payment method with buyer and optional owner translations.
6101
- * Non-exhaustive list of supported values:
6102
- * + `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`
5787
+ * Payment gateway's refund ID.
5788
+ * This field is only returned when the value of `external_refund` is `false`.
5789
+ * @format GUID
6103
5790
  */
6104
- paymentMethodName?: PaymentMethodName;
6105
- }
6106
- /** @oneof */
6107
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6108
- /** Credit card details. */
6109
- creditCardDetails?: CreditCardPaymentMethodDetails;
5791
+ gatewayRefundId?: string | null;
5792
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5793
+ providerRefundId?: string | null;
5794
+ /**
5795
+ * Whether refund was made externally and manually on the payment provider's side.
5796
+ * @immutable
5797
+ */
5798
+ externalRefund?: boolean;
5799
+ /**
5800
+ * Location where the refund was processed.
5801
+ * @internal
5802
+ * @format GUID
5803
+ * @immutable
5804
+ */
5805
+ locationId?: string | null;
6110
5806
  }
6111
- declare enum TransactionStatus {
6112
- UNDEFINED = "UNDEFINED",
6113
- APPROVED = "APPROVED",
5807
+ /** Refund transaction status. */
5808
+ declare enum RefundStatus {
5809
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6114
5810
  PENDING = "PENDING",
6115
- PENDING_MERCHANT = "PENDING_MERCHANT",
6116
- CANCELED = "CANCELED",
6117
- DECLINED = "DECLINED",
6118
- REFUNDED = "REFUNDED",
6119
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6120
- AUTHORIZED = "AUTHORIZED",
6121
- VOIDED = "VOIDED"
5811
+ /** Refund transaction succeeded. */
5812
+ SUCCEEDED = "SUCCEEDED",
5813
+ /** Refund transaction failed. */
5814
+ FAILED = "FAILED",
5815
+ /** Refund request acknowledged, and will be executed soon. */
5816
+ SCHEDULED = "SCHEDULED",
5817
+ /** Refund was initiated on payment provider side. */
5818
+ STARTED = "STARTED"
6122
5819
  }
6123
5820
  /** @enumType */
6124
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6125
- interface CreditCardPaymentMethodDetails {
5821
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5822
+ interface RefundStatusInfo {
6126
5823
  /**
6127
- * The last 4 digits of the card number.
6128
- * @maxLength 4
5824
+ * Reason code for the refund's current status.
5825
+ *
5826
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5827
+ * @minLength 1
5828
+ * @maxLength 10
6129
5829
  */
6130
- lastFourDigits?: string | null;
5830
+ paymentGatewayReasonCode?: string | null;
6131
5831
  /**
6132
- * Card issuer's brand.
6133
- * @maxLength 100
5832
+ * Free text explanation of current refund status.
5833
+ * @minLength 1
5834
+ * @maxLength 1000
6134
5835
  */
6135
- brand?: string | null;
5836
+ description?: string | null;
6136
5837
  }
6137
- interface AuthorizationDetails {
5838
+ interface AggregatedRefundSummary {
5839
+ /** Total amount requested for refund. */
5840
+ requestedRefund?: Price;
5841
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5842
+ pendingRefund?: Price;
5843
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5844
+ refunded?: Price;
5845
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
5846
+ failedRefundAmount?: Price;
5847
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
5848
+ pending?: boolean;
5849
+ /** Breakdown of refunded items. Available only after refund is complete. */
5850
+ breakdown?: RefundItemsBreakdown;
5851
+ }
5852
+ interface RefundItemsBreakdown {
6138
5853
  /**
6139
- * Whether the authorized payment is of a delayed capture.
6140
- * @readonly
5854
+ * Refunded line items and the amount refunded for each.
5855
+ * @maxSize 300
6141
5856
  */
6142
- delayedCapture?: boolean;
6143
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6144
- authorizedDate?: Date | null;
5857
+ lineItems?: LineItemRefundSummary[];
5858
+ }
5859
+ interface LineItemRefundSummary {
6145
5860
  /**
6146
- * List of captures associated with payment
6147
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6148
- * @maxSize 1
5861
+ * ID of the refunded line item.
5862
+ * @format GUID
6149
5863
  */
6150
- captures?: AuthorizationCapture[];
6151
- /** Void associated with payment */
6152
- void?: AuthorizationVoid;
6153
- /** Scheduled action for this transaction */
6154
- scheduledAction?: V1ScheduledAction;
5864
+ lineItemId?: string;
5865
+ /** Total refunded amount for the line item. */
5866
+ totalRefundedAmount?: Price;
6155
5867
  }
6156
- interface AuthorizationCapture {
5868
+ interface CalculateRefundRequest {
6157
5869
  /**
6158
- * Capture ID.
6159
- * @format GUID
6160
- * @readonly
5870
+ * Order ID
5871
+ * @minLength 1
5872
+ * @maxLength 100
6161
5873
  */
6162
- id?: string | null;
6163
- /** Status of this capture action */
6164
- status?: AuthorizationCaptureStatusWithLiterals;
5874
+ ecomOrderId?: string;
6165
5875
  /**
6166
- * Amount of this capture
6167
- * @immutable
5876
+ * Refunded line items and quantity
5877
+ * @maxSize 300
6168
5878
  */
6169
- amount?: Price;
6170
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6171
- createdDate?: Date | null;
6172
- /** In case of status is FAILED may contain failure details */
6173
- failureDetails?: AuthorizationActionFailureDetails;
6174
- }
6175
- declare enum AuthorizationCaptureStatus {
6176
- /** Capture operation still in progress. */
6177
- PENDING = "PENDING",
6178
- /** Capture operation succeeded. */
6179
- SUCCEEDED = "SUCCEEDED",
6180
- /** Capture operation failed. */
6181
- FAILED = "FAILED"
6182
- }
6183
- /** @enumType */
6184
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6185
- interface AuthorizationActionFailureDetails {
6186
- /** @maxLength 100 */
6187
- failureCode?: string;
6188
- }
6189
- interface AuthorizationVoid {
6190
- /** Status of this void action */
6191
- status?: AuthorizationVoidStatusWithLiterals;
6192
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6193
- voidedDate?: Date | null;
6194
- /** In case of status is FAILED may contain failure details */
6195
- failureDetails?: AuthorizationActionFailureDetails;
6196
- /** Reason of void action */
6197
- reason?: ReasonWithLiterals;
6198
- }
6199
- declare enum AuthorizationVoidStatus {
6200
- /** Void operation still in progress. */
6201
- PENDING = "PENDING",
6202
- /** Void operation succeeded. */
6203
- SUCCEEDED = "SUCCEEDED",
6204
- /** Void operation failed. */
6205
- FAILED = "FAILED"
6206
- }
6207
- /** @enumType */
6208
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6209
- /** Reason the authorization was voided. */
6210
- declare enum Reason {
6211
- /** Authorization was voided by user. */
6212
- MANUAL = "MANUAL",
6213
- /** Authorization passed execution date. */
6214
- SCHEDULED = "SCHEDULED"
6215
- }
6216
- /** @enumType */
6217
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6218
- interface V1ScheduledAction {
6219
- /** Type of the action. */
6220
- actionType?: ActionTypeWithLiterals;
6221
- /** The date and time of the action. */
6222
- executionDate?: Date | null;
6223
- }
6224
- declare enum ActionType {
6225
- VOID = "VOID",
6226
- CAPTURE = "CAPTURE"
5879
+ refundItems?: CalculateRefundItemRequest[];
5880
+ /** Should include shipping in refund calculation */
5881
+ refundShipping?: boolean;
6227
5882
  }
6228
- /** @enumType */
6229
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6230
- interface Chargeback {
5883
+ interface CalculateRefundItemRequest {
6231
5884
  /**
6232
- * Chargeback ID.
5885
+ * ID of the line item being refunded
6233
5886
  * @format GUID
6234
- * @readonly
6235
- * @immutable
6236
5887
  */
6237
5888
  id?: string;
6238
5889
  /**
6239
- * 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.
6240
- * @readonly
6241
- * @immutable
6242
- */
6243
- createdDate?: Date | null;
6244
- /**
6245
- * 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.
6246
- * @readonly
6247
- */
6248
- updatedDate?: Date | null;
6249
- /**
6250
- * Amount.
6251
- * @readonly
6252
- * @immutable
6253
- */
6254
- amount?: Price;
6255
- /**
6256
- * Reversal amount. Present only when status is REVERSED.
6257
- * @readonly
5890
+ * How much of that line item is being refunded
5891
+ * @min 1
5892
+ * @max 100000
6258
5893
  */
6259
- reversalAmount?: Price;
5894
+ quantity?: number;
5895
+ }
5896
+ interface CalculateRefundResponse {
5897
+ /** Total refundable amount */
5898
+ total?: Price;
5899
+ /** Tax cost of the order */
5900
+ tax?: Price;
5901
+ /** Discount given for this order */
5902
+ discount?: Price;
5903
+ /** Total cost of the order (without tax) */
5904
+ subtotal?: Price;
5905
+ /** Total shipping cost for order */
5906
+ shipping?: Price;
5907
+ /** Previous refund given on that order */
5908
+ previouslyRefundedAmount?: Price;
6260
5909
  /**
6261
- * Status.
6262
- *
6263
- * Default: `"APPROVED"`.
5910
+ * The refundable items of that order
5911
+ * @maxSize 300
6264
5912
  */
6265
- status?: ChargebackStatusWithLiterals;
5913
+ items?: CalculateRefundItemResponse[];
5914
+ }
5915
+ interface CalculateRefundItemResponse {
6266
5916
  /**
6267
- * External chargeback ID.
5917
+ * Line item ID
6268
5918
  * @format GUID
6269
- * @readonly
6270
- * @immutable
6271
5919
  */
6272
- externalId?: string | null;
6273
- }
6274
- declare enum ChargebackStatus {
6275
- /** Chargeback was approved. */
6276
- APPROVED = "APPROVED",
6277
- /** Chargeback was reversed. */
6278
- REVERSED = "REVERSED"
5920
+ id?: string;
5921
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5922
+ price?: Price;
6279
5923
  }
6280
- /** @enumType */
6281
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6282
- interface PaymentMethodName {
6283
- /**
6284
- * Translated payment method name in buyer language.
6285
- * @maxLength 150
6286
- */
6287
- buyerLanguageName?: string | null;
5924
+ interface VoidAuthorizedPaymentsRequest {
6288
5925
  /**
6289
- * Translated payment method name in site owner language.
6290
- * @maxLength 150
5926
+ * Wix eCommerce order ID
5927
+ * @minLength 1
5928
+ * @maxLength 100
6291
5929
  */
6292
- siteLanguageName?: string | null;
5930
+ ecomOrderId: string;
6293
5931
  /**
6294
- * User-provided payment method name.
6295
- *
6296
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5932
+ * Payment IDs
5933
+ * @minSize 1
5934
+ * @maxSize 100
5935
+ * @format GUID
6297
5936
  */
6298
- userDefinedName?: UserDefinedPaymentMethodName;
5937
+ paymentIds: string[];
6299
5938
  }
6300
- interface GiftCardPaymentDetails {
5939
+ interface VoidAuthorizedPaymentsResponse {
5940
+ /** All order's transactions after the void was triggered */
5941
+ orderTransactions?: OrderTransactions;
5942
+ }
5943
+ interface CaptureAuthorizedPaymentsRequest {
6301
5944
  /**
6302
- * Gift card payment ID.
5945
+ * Wix eCommerce order ID
5946
+ * @minLength 1
6303
5947
  * @maxLength 100
6304
5948
  */
6305
- giftCardPaymentId?: string;
5949
+ ecomOrderId: string;
6306
5950
  /**
6307
- * Gift card ID.
6308
- * @internal
6309
- * @deprecated
5951
+ * Capture payments information
5952
+ * @minSize 1
5953
+ * @maxSize 100
6310
5954
  */
6311
- giftCardId?: string;
5955
+ payments: PaymentCapture[];
5956
+ }
5957
+ interface PaymentCapture {
6312
5958
  /**
6313
- * ID of the app that created the gift card.
5959
+ * Payment ID
6314
5960
  * @format GUID
6315
5961
  */
6316
- appId?: string;
6317
- /**
6318
- * Whether the gift card is voided.
6319
- * @readonly
6320
- */
6321
- voided?: boolean;
5962
+ paymentId?: string | null;
6322
5963
  /**
6323
- * Gift card obfuscated code.
6324
- * @internal
6325
- * @maxLength 30
6326
- * @immutable
5964
+ * Capture amount.
5965
+ * If not provided - full authorized amount will be captured.
6327
5966
  */
6328
- obfuscatedCode?: string | null;
5967
+ amount?: Price;
6329
5968
  }
6330
- interface MembershipPaymentDetails {
5969
+ interface CaptureAuthorizedPaymentsResponse {
5970
+ /** All order's transactions after the capture was triggered */
5971
+ orderTransactions?: OrderTransactions;
5972
+ }
5973
+ interface ChargeSavedPaymentMethodRequest {
6331
5974
  /**
6332
- * Membership ID.
5975
+ * Ecom Order ID.
5976
+ * @minLength 1
6333
5977
  * @maxLength 100
6334
5978
  */
6335
- membershipId?: string;
5979
+ ecomOrderId?: string;
5980
+ /** Amount to be charged */
5981
+ amount?: Price;
5982
+ }
5983
+ interface ChargeSavedPaymentMethodResponse {
5984
+ /** Payment gateway's order ID (e.g Wix Payments) */
5985
+ paymentGatewayOrderId?: string;
5986
+ }
5987
+ interface SendBuyerConfirmationEmailRequest {
5988
+ /** @format GUID */
5989
+ orderId?: string;
5990
+ }
5991
+ interface SendBuyerConfirmationEmailResponse {
5992
+ }
5993
+ interface SendBuyerPaymentsReceivedEmailRequest {
6336
5994
  /**
6337
- * ID of the line item this membership applies to.
6338
5995
  * @minLength 1
6339
5996
  * @maxLength 100
6340
5997
  */
6341
- lineItemId?: string;
6342
- /** Payment status. */
6343
- status?: MembershipPaymentStatusWithLiterals;
6344
- /** Membership name. */
6345
- name?: MembershipName;
5998
+ orderId?: string;
5999
+ }
6000
+ interface SendBuyerPaymentsReceivedEmailResponse {
6001
+ }
6002
+ interface SendBuyerPickupConfirmationEmailRequest {
6346
6003
  /**
6347
- * The transaction ID in the membership system. Can be used to void the transaction.
6348
6004
  * @minLength 1
6349
6005
  * @maxLength 100
6350
6006
  */
6351
- externalTransactionId?: string | null;
6007
+ orderId?: string;
6008
+ }
6009
+ interface SendBuyerPickupConfirmationEmailResponse {
6010
+ }
6011
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
6352
6012
  /**
6353
- * Whether the membership is voided.
6354
- * @readonly
6013
+ * IDs of orders to send pickup emails for.
6014
+ * @minSize 1
6015
+ * @maxSize 300
6355
6016
  */
6356
- voided?: boolean;
6017
+ orderIds?: string[];
6018
+ }
6019
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
6020
+ }
6021
+ interface SendBuyerShippingConfirmationEmailRequest {
6357
6022
  /**
6358
- * ID of the application providing this payment option.
6359
- * @format GUID
6023
+ * @minLength 1
6024
+ * @maxLength 100
6360
6025
  */
6361
- providerAppId?: string;
6362
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6363
- futureMembership?: FutureMembershipDetails;
6026
+ orderId?: string;
6364
6027
  }
6365
- declare enum MembershipPaymentStatus {
6366
- /** Payment was charged. */
6367
- CHARGED = "CHARGED",
6368
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
6369
- CHARGE_FAILED = "CHARGE_FAILED",
6370
- /** Payment is pending. */
6371
- CHARGE_PENDING = "CHARGE_PENDING",
6372
- /** Payment was voided. */
6373
- VOIDED = "VOIDED"
6028
+ interface SendBuyerShippingConfirmationEmailResponse {
6374
6029
  }
6375
- /** @enumType */
6376
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6377
- interface FutureMembershipDetails {
6030
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
6378
6031
  /**
6379
- * ID of the plan line item in the order from which the membership will be created.
6380
- * @format GUID
6032
+ * IDs of orders to send pickup emails for.
6033
+ * @minSize 1
6034
+ * @maxSize 300
6381
6035
  */
6382
- lineItemId?: string;
6036
+ orderIds?: string[];
6037
+ }
6038
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
6039
+ }
6040
+ interface SendMerchantOrderReceivedNotificationRequest {
6383
6041
  /**
6384
- * ID of the benefit the future membership will grant.
6385
- * @maxLength 200
6042
+ * @minLength 1
6043
+ * @maxLength 100
6386
6044
  */
6387
- benefitId?: string;
6045
+ orderId?: string;
6388
6046
  }
6389
- interface WixReceiptInfo {
6047
+ interface SendMerchantOrderReceivedNotificationResponse {
6048
+ }
6049
+ interface SendCancelRefundEmailRequest {
6390
6050
  /**
6391
- * Receipt ID
6051
+ * The ID of order that is canceled/refunded
6052
+ * @minLength 1
6053
+ * @maxLength 100
6054
+ */
6055
+ orderId?: string;
6056
+ /**
6057
+ * Personal note added to the email (optional)
6058
+ * @minLength 1
6059
+ * @maxLength 1000
6060
+ */
6061
+ customMessage?: string | null;
6062
+ /** Refund amount */
6063
+ refundAmount?: Price;
6064
+ /**
6065
+ * Refund ID. (Optional)
6392
6066
  * @format GUID
6393
6067
  */
6394
- receiptId?: string;
6068
+ refundId?: string | null;
6069
+ }
6070
+ interface SendCancelRefundEmailResponse {
6071
+ }
6072
+ interface SendRefundEmailRequest {
6395
6073
  /**
6396
- * Display number of receipt
6074
+ * The ID of order that is refunded
6075
+ * @format GUID
6076
+ */
6077
+ orderId?: string;
6078
+ /**
6079
+ * Refund ID
6080
+ * @format GUID
6081
+ */
6082
+ refundId?: string;
6083
+ /**
6084
+ * Personal note added to the email (optional)
6397
6085
  * @minLength 1
6398
- * @maxLength 40
6086
+ * @maxLength 1000
6399
6087
  */
6400
- displayNumber?: string | null;
6088
+ customMessage?: string | null;
6401
6089
  }
6402
- interface ExternalReceiptInfo {
6090
+ interface SendRefundEmailResponse {
6091
+ }
6092
+ interface SendFulfillmentEmailRequest {
6093
+ /** @format GUID */
6094
+ orderId?: string;
6095
+ /** @format GUID */
6096
+ fulfillerId?: string;
6097
+ }
6098
+ interface SendFulfillmentEmailResponse {
6099
+ }
6100
+ interface SendMerchantOrderReceivedPushRequest {
6403
6101
  /**
6404
- * External receipt ID
6102
+ * @minLength 1
6405
6103
  * @maxLength 100
6406
6104
  */
6407
- receiptId?: string | null;
6105
+ orderId?: string;
6106
+ }
6107
+ interface SendMerchantOrderReceivedPushResponse {
6108
+ }
6109
+ interface PreviewEmailByTypeRequest {
6110
+ emailType?: PreviewEmailTypeWithLiterals;
6111
+ }
6112
+ declare enum PreviewEmailType {
6113
+ ORDER_PLACED = "ORDER_PLACED",
6114
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6115
+ ORDER_SHIPPED = "ORDER_SHIPPED",
6116
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6117
+ }
6118
+ /** @enumType */
6119
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6120
+ interface PreviewEmailByTypeResponse {
6121
+ emailPreview?: string;
6122
+ }
6123
+ interface PreviewRefundEmailRequest {
6408
6124
  /**
6409
- * ID of the app providing the receipt
6125
+ * @minLength 1
6126
+ * @maxLength 100
6127
+ */
6128
+ orderId?: string;
6129
+ /** Refund amount */
6130
+ refundAmount?: Price;
6131
+ /** Refund business details */
6132
+ details?: RefundDetails;
6133
+ /**
6134
+ * Personal note added to the email (optional)
6135
+ * @minLength 1
6136
+ * @maxLength 1000
6137
+ */
6138
+ customMessage?: string | null;
6139
+ /**
6140
+ * Refund ID. (Optional)
6410
6141
  * @format GUID
6411
6142
  */
6412
- appId?: string | null;
6143
+ refundId?: string | null;
6144
+ }
6145
+ interface PreviewRefundEmailResponse {
6146
+ emailPreview?: string;
6147
+ }
6148
+ interface PreviewCancelEmailRequest {
6413
6149
  /**
6414
- * Display number of receipt
6415
6150
  * @minLength 1
6416
- * @maxLength 40
6151
+ * @maxLength 100
6417
6152
  */
6418
- displayNumber?: string | null;
6153
+ orderId?: string;
6154
+ /**
6155
+ * Personal note added to the email (optional)
6156
+ * @minLength 1
6157
+ * @maxLength 1000
6158
+ */
6159
+ customMessage?: string | null;
6419
6160
  }
6420
- interface CashRoundingDetails {
6161
+ interface PreviewCancelEmailResponse {
6162
+ emailPreview?: string;
6163
+ }
6164
+ interface PreviewCancelRefundEmailRequest {
6421
6165
  /**
6422
- * Payment amount before cash rounding was applied.
6423
- * When provided, balance and status calculations use this value instead of `amount`
6424
- * to prevent false overpayment or underpayment due to rounding.
6166
+ * @minLength 1
6167
+ * @maxLength 100
6425
6168
  */
6426
- unroundedAmount?: Price;
6169
+ orderId?: string;
6427
6170
  /**
6428
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6429
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6430
- * @readonly
6171
+ * Personal note added to the email (optional)
6172
+ * @minLength 1
6173
+ * @maxLength 1000
6431
6174
  */
6432
- roundingAdjustment?: CashRounding;
6175
+ customMessage?: string | null;
6176
+ /** Refund amount */
6177
+ refundAmount?: Price;
6178
+ /**
6179
+ * Refund ID. (Optional)
6180
+ * @format GUID
6181
+ */
6182
+ refundId?: string | null;
6433
6183
  }
6434
- declare enum PaymentStatus {
6435
- APPROVED = "APPROVED",
6436
- PENDING = "PENDING",
6437
- PENDING_MERCHANT = "PENDING_MERCHANT",
6438
- CANCELED = "CANCELED",
6439
- DECLINED = "DECLINED",
6440
- REFUNDED = "REFUNDED",
6441
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6442
- AUTHORIZED = "AUTHORIZED",
6443
- VOIDED = "VOIDED"
6184
+ interface PreviewCancelRefundEmailResponse {
6185
+ emailPreview?: string;
6444
6186
  }
6445
- /** @enumType */
6446
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6447
- interface CanceledStatusDetails {
6448
- reason?: CanceledReasonWithLiterals;
6187
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
6449
6188
  }
6450
- declare enum CanceledReason {
6451
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
6452
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6453
- /** Payment was not completed by user and expired. */
6454
- EXPIRED = "EXPIRED"
6189
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
6190
+ emailPreview?: string;
6455
6191
  }
6456
- /** @enumType */
6457
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6458
- interface DeclinedStatusDetails {
6459
- reason?: DeclinedReasonWithLiterals;
6192
+ interface PreviewBuyerConfirmationEmailRequest {
6460
6193
  }
6461
- declare enum DeclinedReason {
6462
- /** Corresponding charge failed. */
6463
- CHARGE_FAILED = "CHARGE_FAILED",
6464
- /** Payment details expired. */
6465
- EXPIRED = "EXPIRED",
6466
- /** Insufficient funds. */
6467
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6468
- /** Gift card was disabled before charge was attempted. */
6469
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6194
+ interface PreviewBuyerConfirmationEmailResponse {
6195
+ emailPreview?: string;
6470
6196
  }
6471
- /** @enumType */
6472
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6473
- interface VoidedStatusDetails {
6474
- reason?: VoidedReasonWithLiterals;
6197
+ interface PreviewBuyerPickupConfirmationEmailRequest {
6475
6198
  }
6476
- declare enum VoidedReason {
6477
- /** Payment was voided by merchant request. */
6478
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
6479
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6480
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6199
+ interface PreviewBuyerPickupConfirmationEmailResponse {
6200
+ emailPreview?: string;
6201
+ }
6202
+ interface PreviewShippingConfirmationEmailRequest {
6203
+ }
6204
+ interface PreviewShippingConfirmationEmailResponse {
6205
+ emailPreview?: string;
6206
+ }
6207
+ interface PreviewResendDownloadLinksEmailRequest {
6208
+ }
6209
+ interface PreviewResendDownloadLinksEmailResponse {
6210
+ emailPreview?: string;
6211
+ }
6212
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6213
+ /** Emitted on a meta site creation. */
6214
+ siteCreated?: SiteCreated;
6215
+ /** Emitted on a meta site transfer completion. */
6216
+ siteTransferred?: SiteTransferred;
6217
+ /** Emitted on a meta site deletion. */
6218
+ siteDeleted?: SiteDeleted;
6219
+ /** Emitted on a meta site restoration. */
6220
+ siteUndeleted?: SiteUndeleted;
6221
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6222
+ sitePublished?: SitePublished;
6223
+ /** Emitted on a meta site unpublish. */
6224
+ siteUnpublished?: SiteUnpublished;
6225
+ /** Emitted when meta site is marked as template. */
6226
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6227
+ /** Emitted when meta site is marked as a WixSite. */
6228
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6229
+ /** Emitted when an application is provisioned (installed). */
6230
+ serviceProvisioned?: ServiceProvisioned;
6231
+ /** Emitted when an application is removed (uninstalled). */
6232
+ serviceRemoved?: ServiceRemoved;
6233
+ /** Emitted when meta site name (URL slug) is changed. */
6234
+ siteRenamedPayload?: SiteRenamed;
6235
+ /** Emitted when meta site was permanently deleted. */
6236
+ hardDeleted?: SiteHardDeleted;
6237
+ /** Emitted on a namespace change. */
6238
+ namespaceChanged?: NamespaceChanged;
6239
+ /** Emitted when Studio is attached. */
6240
+ studioAssigned?: StudioAssigned;
6241
+ /** Emitted when Studio is detached. */
6242
+ studioUnassigned?: StudioUnassigned;
6243
+ /**
6244
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6245
+ * the actual URL.
6246
+ *
6247
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6248
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6249
+ */
6250
+ urlChanged?: SiteUrlChanged;
6251
+ /** Site is marked as PurgedExternally */
6252
+ sitePurgedExternally?: SitePurgedExternally;
6253
+ /** Emitted when Odeditor is attached. */
6254
+ odeditorAssigned?: OdeditorAssigned;
6255
+ /** Emitted when Odeditor is detached. */
6256
+ odeditorUnassigned?: OdeditorUnassigned;
6257
+ /** Emitted when Picasso is attached. */
6258
+ picassoAssigned?: PicassoAssigned;
6259
+ /** Emitted when Picasso is detached. */
6260
+ picassoUnassigned?: PicassoUnassigned;
6261
+ /** Emitted when Wixel is attached. */
6262
+ wixelAssigned?: WixelAssigned;
6263
+ /** Emitted when Wixel is detached. */
6264
+ wixelUnassigned?: WixelUnassigned;
6265
+ /** Emitted when StudioTwo is attached. */
6266
+ studioTwoAssigned?: StudioTwoAssigned;
6267
+ /** Emitted when StudioTwo is detached. */
6268
+ studioTwoUnassigned?: StudioTwoUnassigned;
6269
+ /** Emitted when media from user domain is enabled. */
6270
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6271
+ /** Emitted when media from user domain is disabled. */
6272
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6273
+ /** Emitted when Editorless is attached. */
6274
+ editorlessAssigned?: EditorlessAssigned;
6275
+ /** Emitted when Editorless is detached. */
6276
+ editorlessUnassigned?: EditorlessUnassigned;
6277
+ /**
6278
+ * A meta site id.
6279
+ * @format GUID
6280
+ */
6281
+ metaSiteId?: string;
6282
+ /** A meta site version. Monotonically increasing. */
6283
+ version?: string;
6284
+ /** A timestamp of the event. */
6285
+ timestamp?: string;
6286
+ /**
6287
+ * TODO(meta-site): Change validation once validations are disabled for consumers
6288
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6289
+ * @maxSize 4000
6290
+ */
6291
+ assets?: Asset[];
6292
+ }
6293
+ /** @oneof */
6294
+ interface MetaSiteSpecialEventPayloadOneOf {
6295
+ /** Emitted on a meta site creation. */
6296
+ siteCreated?: SiteCreated;
6297
+ /** Emitted on a meta site transfer completion. */
6298
+ siteTransferred?: SiteTransferred;
6299
+ /** Emitted on a meta site deletion. */
6300
+ siteDeleted?: SiteDeleted;
6301
+ /** Emitted on a meta site restoration. */
6302
+ siteUndeleted?: SiteUndeleted;
6303
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6304
+ sitePublished?: SitePublished;
6305
+ /** Emitted on a meta site unpublish. */
6306
+ siteUnpublished?: SiteUnpublished;
6307
+ /** Emitted when meta site is marked as template. */
6308
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6309
+ /** Emitted when meta site is marked as a WixSite. */
6310
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6311
+ /** Emitted when an application is provisioned (installed). */
6312
+ serviceProvisioned?: ServiceProvisioned;
6313
+ /** Emitted when an application is removed (uninstalled). */
6314
+ serviceRemoved?: ServiceRemoved;
6315
+ /** Emitted when meta site name (URL slug) is changed. */
6316
+ siteRenamedPayload?: SiteRenamed;
6317
+ /** Emitted when meta site was permanently deleted. */
6318
+ hardDeleted?: SiteHardDeleted;
6319
+ /** Emitted on a namespace change. */
6320
+ namespaceChanged?: NamespaceChanged;
6321
+ /** Emitted when Studio is attached. */
6322
+ studioAssigned?: StudioAssigned;
6323
+ /** Emitted when Studio is detached. */
6324
+ studioUnassigned?: StudioUnassigned;
6325
+ /**
6326
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6327
+ * the actual URL.
6328
+ *
6329
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6330
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6331
+ */
6332
+ urlChanged?: SiteUrlChanged;
6333
+ /** Site is marked as PurgedExternally */
6334
+ sitePurgedExternally?: SitePurgedExternally;
6335
+ /** Emitted when Odeditor is attached. */
6336
+ odeditorAssigned?: OdeditorAssigned;
6337
+ /** Emitted when Odeditor is detached. */
6338
+ odeditorUnassigned?: OdeditorUnassigned;
6339
+ /** Emitted when Picasso is attached. */
6340
+ picassoAssigned?: PicassoAssigned;
6341
+ /** Emitted when Picasso is detached. */
6342
+ picassoUnassigned?: PicassoUnassigned;
6343
+ /** Emitted when Wixel is attached. */
6344
+ wixelAssigned?: WixelAssigned;
6345
+ /** Emitted when Wixel is detached. */
6346
+ wixelUnassigned?: WixelUnassigned;
6347
+ /** Emitted when StudioTwo is attached. */
6348
+ studioTwoAssigned?: StudioTwoAssigned;
6349
+ /** Emitted when StudioTwo is detached. */
6350
+ studioTwoUnassigned?: StudioTwoUnassigned;
6351
+ /** Emitted when media from user domain is enabled. */
6352
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6353
+ /** Emitted when media from user domain is disabled. */
6354
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6355
+ /** Emitted when Editorless is attached. */
6356
+ editorlessAssigned?: EditorlessAssigned;
6357
+ /** Emitted when Editorless is detached. */
6358
+ editorlessUnassigned?: EditorlessUnassigned;
6359
+ }
6360
+ interface Asset {
6361
+ /**
6362
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6363
+ * @maxLength 36
6364
+ */
6365
+ appDefId?: string;
6366
+ /**
6367
+ * An instance id. For legacy reasons may be UUID or a string.
6368
+ * @maxLength 200
6369
+ */
6370
+ instanceId?: string;
6371
+ /** An application state. */
6372
+ state?: StateWithLiterals;
6373
+ }
6374
+ declare enum State {
6375
+ UNKNOWN = "UNKNOWN",
6376
+ ENABLED = "ENABLED",
6377
+ DISABLED = "DISABLED",
6378
+ PENDING = "PENDING",
6379
+ DEMO = "DEMO"
6481
6380
  }
6482
6381
  /** @enumType */
6483
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6484
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6485
- /** @internal */
6486
- canceled?: CanceledStatusDetails;
6487
- /** @internal */
6488
- declined?: DeclinedStatusDetails;
6489
- /** @internal */
6490
- voided?: VoidedStatusDetails;
6382
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6383
+ interface SiteCreated {
6384
+ /**
6385
+ * A template identifier (empty if not created from a template).
6386
+ * @maxLength 36
6387
+ */
6388
+ originTemplateId?: string;
6389
+ /**
6390
+ * An account id of the owner.
6391
+ * @format GUID
6392
+ */
6393
+ ownerId?: string;
6394
+ /** A context in which meta site was created. */
6395
+ context?: SiteCreatedContextWithLiterals;
6396
+ /**
6397
+ * A meta site id from which this site was created.
6398
+ *
6399
+ * In case of a creation from a template it's a template id.
6400
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6401
+ * @format GUID
6402
+ */
6403
+ originMetaSiteId?: string | null;
6404
+ /**
6405
+ * A meta site name (URL slug).
6406
+ * @maxLength 20
6407
+ */
6408
+ siteName?: string;
6409
+ /** A namespace. */
6410
+ namespace?: NamespaceWithLiterals;
6411
+ }
6412
+ declare enum SiteCreatedContext {
6413
+ /** A valid option, we don't expose all reasons why site might be created. */
6414
+ OTHER = "OTHER",
6415
+ /** A meta site was created from template. */
6416
+ FROM_TEMPLATE = "FROM_TEMPLATE",
6417
+ /** A meta site was created by copying of the transfferred meta site. */
6418
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6419
+ /** A copy of existing meta site. */
6420
+ DUPLICATE = "DUPLICATE",
6421
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6422
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6423
+ /** deprecated A meta site was created for Flash editor. */
6424
+ FLASH = "FLASH"
6425
+ }
6426
+ /** @enumType */
6427
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6428
+ declare enum Namespace {
6429
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6430
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6431
+ WIX = "WIX",
6432
+ /** 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. */
6433
+ SHOUT_OUT = "SHOUT_OUT",
6434
+ /** 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. */
6435
+ ALBUMS = "ALBUMS",
6436
+ /** 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. */
6437
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6438
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6439
+ HOTELS = "HOTELS",
6440
+ /** 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. */
6441
+ CLUBS = "CLUBS",
6442
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6443
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6444
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6445
+ DEV_SITE = "DEV_SITE",
6446
+ /** 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. */
6447
+ LOGOS = "LOGOS",
6448
+ /** 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. */
6449
+ VIDEO_MAKER = "VIDEO_MAKER",
6450
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6451
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6452
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6453
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6491
6454
  /**
6492
- * Reason code from the payment gateway.
6493
- * @internal
6494
- * @minLength 1
6495
- * @maxLength 10
6455
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6456
+ *
6457
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
6496
6458
  */
6497
- paymentGatewayReasonCode?: string | null;
6498
- }
6499
- /** @oneof */
6500
- interface PaymentStatusDetailsStatusDetailsOneOf {
6501
- /** @internal */
6502
- canceled?: CanceledStatusDetails;
6503
- /** @internal */
6504
- declined?: DeclinedStatusDetails;
6505
- /** @internal */
6506
- voided?: VoidedStatusDetails;
6507
- }
6508
- interface Refund {
6459
+ HTML_DRAFT = "HTML_DRAFT",
6509
6460
  /**
6510
- * Refund ID.
6511
- * @format GUID
6512
- * @readonly
6461
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6462
+ * Will be accessible from Site List and will not have a website app.
6463
+ * Once the user attaches a site, the site will become a regular wixsite.
6513
6464
  */
6514
- id?: string;
6465
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
6466
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6467
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
6468
+ /** It is to be used in the Business First efforts. */
6469
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
6470
+ /** Bookings business flow with no site. */
6471
+ ANYWHERE = "ANYWHERE",
6472
+ /** Namespace for Headless Backoffice with no editor */
6473
+ HEADLESS = "HEADLESS",
6515
6474
  /**
6516
- * List of transactions.
6517
- * @maxSize 50
6475
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6476
+ * The site will be used for account level CSM feature for enterprise
6518
6477
  */
6519
- transactions?: RefundTransaction[];
6520
- /** Refund business details. */
6521
- details?: RefundDetails;
6478
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6479
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6480
+ RISE = "RISE",
6522
6481
  /**
6523
- * 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.
6524
- * @readonly
6525
- * @immutable
6482
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6483
+ * There's a blank site behind the scene but it's blank).
6484
+ * The Mobile company will be the owner of this namespace.
6526
6485
  */
6527
- createdDate?: Date | null;
6486
+ BRANDED_FIRST = "BRANDED_FIRST",
6487
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6488
+ NOWNIA = "NOWNIA",
6528
6489
  /**
6529
- * Aggregated refund summary.
6530
- * @readonly
6490
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
6491
+ * The Partners company owns this namespace.
6531
6492
  */
6532
- summary?: AggregatedRefundSummary;
6493
+ UGC_TEMPLATE = "UGC_TEMPLATE",
6494
+ /** Codux Headless Sites */
6495
+ CODUX = "CODUX",
6496
+ /** Bobb - AI Design Creator. */
6497
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6533
6498
  /**
6534
- * ID of the app that initiated this refund.
6535
- * @format GUID
6536
- * @readonly
6537
- * @immutable
6499
+ * Shared Blog Site is a unique single site across Enterprise account,
6500
+ * This site will hold all Blog posts related to the Marketing product.
6538
6501
  */
6539
- requestingServiceAppId?: string | null;
6540
- }
6541
- interface RefundTransaction {
6502
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6503
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6504
+ STANDALONE_FORMS = "STANDALONE_FORMS",
6505
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6506
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
6507
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6508
+ MIMIR = "MIMIR",
6509
+ /** Wix Twins platform. */
6510
+ TWINS = "TWINS",
6511
+ /** Wix Nano. */
6512
+ NANO = "NANO",
6513
+ /** Base44 headless sites. */
6514
+ BASE44 = "BASE44",
6515
+ /** Wix Channels Sites */
6516
+ CHANNELS = "CHANNELS",
6517
+ /** Nautilus platform. */
6518
+ NAUTILUS = "NAUTILUS",
6542
6519
  /**
6543
- * ID of the payment associated with this refund.
6544
- * @format GUID
6545
- * @immutable
6520
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6521
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6546
6522
  */
6547
- paymentId?: string;
6523
+ SYMPHONY = "SYMPHONY",
6524
+ /** Nautilus platform app. */
6525
+ NAUTILUS_APPS = "NAUTILUS_APPS",
6548
6526
  /**
6549
- * Refund amount.
6550
- * @immutable
6527
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6528
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6551
6529
  */
6552
- amount?: Price;
6553
- /** Refund status. */
6554
- refundStatus?: RefundStatusWithLiterals;
6555
- /** Optional details of current refund status. */
6556
- refundStatusInfo?: RefundStatusInfo;
6530
+ VIBU = "VIBU",
6557
6531
  /**
6558
- * Payment gateway's refund ID.
6559
- * This field is only returned when the value of `external_refund` is `false`.
6560
- * @format GUID
6532
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6533
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
6534
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6535
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
6561
6536
  */
6562
- gatewayRefundId?: string | null;
6563
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6564
- providerRefundId?: string | null;
6537
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT"
6538
+ }
6539
+ /** @enumType */
6540
+ 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';
6541
+ /** Site transferred to another user. */
6542
+ interface SiteTransferred {
6565
6543
  /**
6566
- * Whether refund was made externally and manually on the payment provider's side.
6567
- * @immutable
6544
+ * A previous owner id (user that transfers meta site).
6545
+ * @format GUID
6568
6546
  */
6569
- externalRefund?: boolean;
6547
+ oldOwnerId?: string;
6570
6548
  /**
6571
- * Location where the refund was processed.
6572
- * @internal
6549
+ * A new owner id (user that accepts meta site).
6573
6550
  * @format GUID
6574
- * @immutable
6575
6551
  */
6576
- locationId?: string | null;
6552
+ newOwnerId?: string;
6577
6553
  }
6578
- /** Refund transaction status. */
6579
- declare enum RefundStatus {
6580
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6581
- PENDING = "PENDING",
6582
- /** Refund transaction succeeded. */
6583
- SUCCEEDED = "SUCCEEDED",
6584
- /** Refund transaction failed. */
6585
- FAILED = "FAILED",
6586
- /** Refund request acknowledged, and will be executed soon. */
6587
- SCHEDULED = "SCHEDULED",
6588
- /** Refund was initiated on payment provider side. */
6589
- STARTED = "STARTED"
6554
+ /** Soft deletion of the meta site. Could be restored. */
6555
+ interface SiteDeleted {
6556
+ /** A deletion context. */
6557
+ deleteContext?: DeleteContext;
6590
6558
  }
6591
- /** @enumType */
6592
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6593
- interface RefundStatusInfo {
6559
+ interface DeleteContext {
6560
+ /** When the meta site was deleted. */
6561
+ dateDeleted?: Date | null;
6562
+ /** A status. */
6563
+ deleteStatus?: DeleteStatusWithLiterals;
6594
6564
  /**
6595
- * Reason code for the refund's current status.
6596
- *
6597
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6598
- * @minLength 1
6599
- * @maxLength 10
6565
+ * A reason (flow).
6566
+ * @maxLength 255
6600
6567
  */
6601
- paymentGatewayReasonCode?: string | null;
6568
+ deleteOrigin?: string;
6602
6569
  /**
6603
- * Free text explanation of current refund status.
6604
- * @minLength 1
6605
- * @maxLength 1000
6570
+ * A service that deleted it.
6571
+ * @maxLength 255
6606
6572
  */
6607
- description?: string | null;
6573
+ initiatorId?: string | null;
6608
6574
  }
6609
- interface AggregatedRefundSummary {
6610
- /** Total amount requested for refund. */
6611
- requestedRefund?: Price;
6612
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6613
- pendingRefund?: Price;
6614
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6615
- refunded?: Price;
6616
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
6617
- failedRefundAmount?: Price;
6618
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
6619
- pending?: boolean;
6620
- /** Breakdown of refunded items. Available only after refund is complete. */
6621
- breakdown?: RefundItemsBreakdown;
6575
+ declare enum DeleteStatus {
6576
+ UNKNOWN = "UNKNOWN",
6577
+ TRASH = "TRASH",
6578
+ DELETED = "DELETED",
6579
+ PENDING_PURGE = "PENDING_PURGE",
6580
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6622
6581
  }
6623
- interface RefundItemsBreakdown {
6582
+ /** @enumType */
6583
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6584
+ /** Restoration of the meta site. */
6585
+ interface SiteUndeleted {
6586
+ }
6587
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
6588
+ interface SitePublished {
6589
+ }
6590
+ interface SiteUnpublished {
6591
+ /**
6592
+ * A list of URLs previously associated with the meta site.
6593
+ * @maxLength 4000
6594
+ * @maxSize 10000
6595
+ */
6596
+ urls?: string[];
6597
+ }
6598
+ interface SiteMarkedAsTemplate {
6599
+ }
6600
+ interface SiteMarkedAsWixSite {
6601
+ }
6602
+ /**
6603
+ * Represents a service provisioned a site.
6604
+ *
6605
+ * Note on `origin_instance_id`:
6606
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6607
+ * This is because of the following scenario:
6608
+ *
6609
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
6610
+ * such as a product catalog. When you create a site from this template, you inherit this
6611
+ * default product catalog. However, if the template's product catalog is modified,
6612
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
6613
+ * your site remains consistent with what you initially received and does not include any
6614
+ * changes made to the original template afterward.
6615
+ * To ensure this, the TPA on the template gets a new instance_id.
6616
+ */
6617
+ interface ServiceProvisioned {
6624
6618
  /**
6625
- * Refunded line items and the amount refunded for each.
6626
- * @maxSize 300
6619
+ * Either UUID or EmbeddedServiceType.
6620
+ * @maxLength 36
6627
6621
  */
6628
- lineItems?: LineItemRefundSummary[];
6629
- }
6630
- interface LineItemRefundSummary {
6622
+ appDefId?: string;
6631
6623
  /**
6632
- * ID of the refunded line item.
6633
- * @format GUID
6624
+ * Not only UUID. Something here could be something weird.
6625
+ * @maxLength 36
6634
6626
  */
6635
- lineItemId?: string;
6636
- /** Total refunded amount for the line item. */
6637
- totalRefundedAmount?: Price;
6638
- }
6639
- interface CalculateRefundRequest {
6627
+ instanceId?: string;
6640
6628
  /**
6641
- * Order ID
6642
- * @minLength 1
6643
- * @maxLength 100
6629
+ * An instance id from which this instance is originated.
6630
+ * @maxLength 36
6644
6631
  */
6645
- ecomOrderId?: string;
6632
+ originInstanceId?: string;
6646
6633
  /**
6647
- * Refunded line items and quantity
6648
- * @maxSize 300
6634
+ * A version.
6635
+ * @maxLength 500
6649
6636
  */
6650
- refundItems?: CalculateRefundItemRequest[];
6651
- /** Should include shipping in refund calculation */
6652
- refundShipping?: boolean;
6653
- }
6654
- interface CalculateRefundItemRequest {
6637
+ version?: string | null;
6655
6638
  /**
6656
- * ID of the line item being refunded
6639
+ * The origin meta site id
6657
6640
  * @format GUID
6658
6641
  */
6659
- id?: string;
6642
+ originMetaSiteId?: string | null;
6643
+ }
6644
+ interface ServiceRemoved {
6660
6645
  /**
6661
- * How much of that line item is being refunded
6662
- * @min 1
6663
- * @max 100000
6646
+ * Either UUID or EmbeddedServiceType.
6647
+ * @maxLength 36
6664
6648
  */
6665
- quantity?: number;
6666
- }
6667
- interface CalculateRefundResponse {
6668
- /** Total refundable amount */
6669
- total?: Price;
6670
- /** Tax cost of the order */
6671
- tax?: Price;
6672
- /** Discount given for this order */
6673
- discount?: Price;
6674
- /** Total cost of the order (without tax) */
6675
- subtotal?: Price;
6676
- /** Total shipping cost for order */
6677
- shipping?: Price;
6678
- /** Previous refund given on that order */
6679
- previouslyRefundedAmount?: Price;
6649
+ appDefId?: string;
6680
6650
  /**
6681
- * The refundable items of that order
6682
- * @maxSize 300
6651
+ * Not only UUID. Something here could be something weird.
6652
+ * @maxLength 36
6683
6653
  */
6684
- items?: CalculateRefundItemResponse[];
6685
- }
6686
- interface CalculateRefundItemResponse {
6654
+ instanceId?: string;
6687
6655
  /**
6688
- * Line item ID
6689
- * @format GUID
6656
+ * A version.
6657
+ * @maxLength 500
6690
6658
  */
6691
- id?: string;
6692
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6693
- price?: Price;
6659
+ version?: string | null;
6694
6660
  }
6695
- interface VoidAuthorizedPaymentsRequest {
6661
+ /** Rename of the site. Meaning, free public url has been changed as well. */
6662
+ interface SiteRenamed {
6696
6663
  /**
6697
- * Wix eCommerce order ID
6698
- * @minLength 1
6699
- * @maxLength 100
6664
+ * A new meta site name (URL slug).
6665
+ * @maxLength 20
6700
6666
  */
6701
- ecomOrderId: string;
6667
+ newSiteName?: string;
6702
6668
  /**
6703
- * Payment IDs
6704
- * @minSize 1
6705
- * @maxSize 100
6706
- * @format GUID
6669
+ * A previous meta site name (URL slug).
6670
+ * @maxLength 255
6707
6671
  */
6708
- paymentIds: string[];
6672
+ oldSiteName?: string;
6709
6673
  }
6710
- interface VoidAuthorizedPaymentsResponse {
6711
- /** All order's transactions after the void was triggered */
6712
- orderTransactions?: OrderTransactions;
6674
+ /**
6675
+ * Hard deletion of the meta site.
6676
+ *
6677
+ * Could not be restored. Therefore it's desirable to cleanup data.
6678
+ */
6679
+ interface SiteHardDeleted {
6680
+ /** A deletion context. */
6681
+ deleteContext?: DeleteContext;
6713
6682
  }
6714
- interface CaptureAuthorizedPaymentsRequest {
6715
- /**
6716
- * Wix eCommerce order ID
6717
- * @minLength 1
6718
- * @maxLength 100
6719
- */
6720
- ecomOrderId: string;
6683
+ interface NamespaceChanged {
6684
+ /** A previous namespace. */
6685
+ oldNamespace?: NamespaceWithLiterals;
6686
+ /** A new namespace. */
6687
+ newNamespace?: NamespaceWithLiterals;
6688
+ }
6689
+ /** Assigned Studio editor */
6690
+ interface StudioAssigned {
6691
+ }
6692
+ /** Unassigned Studio editor */
6693
+ interface StudioUnassigned {
6694
+ }
6695
+ /**
6696
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6697
+ *
6698
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6699
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
6700
+ *
6701
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6702
+ */
6703
+ interface SiteUrlChanged {
6704
+ }
6705
+ /**
6706
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6707
+ * Consumed by other teams to remove relevant data.
6708
+ */
6709
+ interface SitePurgedExternally {
6721
6710
  /**
6722
- * Capture payments information
6723
- * @minSize 1
6711
+ * @maxLength 2048
6724
6712
  * @maxSize 100
6713
+ * @deprecated
6714
+ * @targetRemovalDate 2025-04-15
6725
6715
  */
6726
- payments: PaymentCapture[];
6716
+ appDefId?: string[];
6727
6717
  }
6728
- interface PaymentCapture {
6729
- /**
6730
- * Payment ID
6731
- * @format GUID
6732
- */
6733
- paymentId?: string | null;
6734
- /**
6735
- * Capture amount.
6736
- * If not provided - full authorized amount will be captured.
6737
- */
6738
- amount?: Price;
6718
+ /** Assigned Odeditor */
6719
+ interface OdeditorAssigned {
6739
6720
  }
6740
- interface CaptureAuthorizedPaymentsResponse {
6741
- /** All order's transactions after the capture was triggered */
6742
- orderTransactions?: OrderTransactions;
6721
+ /** Unassigned Odeditor */
6722
+ interface OdeditorUnassigned {
6743
6723
  }
6744
- interface ChargeSavedPaymentMethodRequest {
6745
- /**
6746
- * Ecom Order ID.
6747
- * @minLength 1
6748
- * @maxLength 100
6749
- */
6750
- ecomOrderId?: string;
6751
- /** Amount to be charged */
6752
- amount?: Price;
6724
+ /** Assigned Picasso editor */
6725
+ interface PicassoAssigned {
6753
6726
  }
6754
- interface ChargeSavedPaymentMethodResponse {
6755
- /** Payment gateway's order ID (e.g Wix Payments) */
6756
- paymentGatewayOrderId?: string;
6727
+ /** Unassigned Picasso */
6728
+ interface PicassoUnassigned {
6757
6729
  }
6758
- interface V1TriggerReindexRequest {
6759
- /** @format GUID */
6760
- metasiteId?: string;
6761
- /**
6762
- * @minLength 1
6763
- * @maxLength 100
6764
- * @maxSize 100
6765
- */
6766
- orderIds?: string[];
6730
+ /** Assigned Wixel */
6731
+ interface WixelAssigned {
6767
6732
  }
6768
- interface V1TriggerReindexResponse {
6733
+ /** Unassigned Wixel */
6734
+ interface WixelUnassigned {
6769
6735
  }
6770
- interface V1TriggerReindexOrderRequest {
6771
- /** @format GUID */
6772
- metasiteId?: string;
6773
- /**
6774
- * @minLength 1
6775
- * @maxLength 100
6776
- */
6777
- orderId?: string;
6736
+ /** Assigned StudioTwo */
6737
+ interface StudioTwoAssigned {
6738
+ }
6739
+ /** Unassigned StudioTwo */
6740
+ interface StudioTwoUnassigned {
6741
+ }
6742
+ /** Media from user domain is enabled. */
6743
+ interface UserDomainMediaEnabled {
6744
+ }
6745
+ /** Media from user domain is disabled. */
6746
+ interface UserDomainMediaDisabled {
6747
+ }
6748
+ /** Assigned Editorless */
6749
+ interface EditorlessAssigned {
6750
+ }
6751
+ /** Unassigned Editorless */
6752
+ interface EditorlessUnassigned {
6753
+ }
6754
+ interface HasCustomEmailConfigurationsRequest {
6755
+ }
6756
+ interface HasCustomEmailConfigurationsResponse {
6757
+ hasCustomConfigurations?: boolean;
6758
+ }
6759
+ interface AddToAutomationMigrationPopulationRequest {
6760
+ /** When true, sends custom email configurations to automation system via email */
6761
+ sendCustomEmailConfigs?: boolean;
6762
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6763
+ origin?: OriginWithLiterals;
6764
+ }
6765
+ declare enum Origin {
6766
+ OPT_IN = "OPT_IN",
6767
+ MIGRATION = "MIGRATION"
6768
+ }
6769
+ /** @enumType */
6770
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6771
+ interface AddToAutomationMigrationPopulationResponse {
6772
+ success?: boolean;
6773
+ }
6774
+ interface IsInAutomationMigrationPopulationRequest {
6775
+ }
6776
+ interface IsInAutomationMigrationPopulationResponse {
6777
+ inPopulation?: boolean;
6778
6778
  }
6779
6779
  interface DiffmatokyPayload {
6780
6780
  left?: string;