@wix/auto_sdk_ecom_orders 1.0.315 → 1.0.317

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